MyGUI_ComboBox.h

Go to the documentation of this file.

/*
 * This source file is part of MyGUI. For the latest info, see http://mygui.info/
 * Distributed under the MIT License
 * (See accompanying file COPYING.MIT or copy at http://opensource.org/licenses/MIT)
 */
 
#ifndef MYGUI_COMBO_BOX_H_
#define MYGUI_COMBO_BOX_H_
 
#include "MyGUI_Prerequest.h"
#include "MyGUI_EditBox.h"
#include "MyGUI_ListBox.h"
#include "MyGUI_Any.h"
#include "MyGUI_EventPair.h"
#include "MyGUI_ControllerFadeAlpha.h"
#include "MyGUI_FlowDirection.h"
#include "MyGUI_IItem.h"
#include "MyGUI_IItemContainer.h"
 
namespace MyGUI
{
 
    using EventHandle_ComboBoxPtrSizeT = delegates::MultiDelegate<ComboBox*, size_t>;
 
    class MYGUI_EXPORT ComboBox : public EditBox, public IItemContainer, public MemberObsolete<ComboBox>
    {
        MYGUI_RTTI_DERIVED(ComboBox)
 
    public:
        //------------------------------------------------------------------------------//
        // манипуляции айтемами
 
        size_t getItemCount() const;
 
        void insertItemAt(size_t _index, const UString& _item, Any _data = Any::Null);
 
        void addItem(const UString& _name, Any _data = Any::Null);
 
        void removeItemAt(size_t _index);
 
        void removeAllItems();
 
 
        size_t findItemIndexWith(const UString& _name);
 
 
        //------------------------------------------------------------------------------//
        // манипуляции выделениями
 
        size_t getIndexSelected() const;
 
        void setIndexSelected(size_t _index);
 
        void clearIndexSelected();
 
 
        //------------------------------------------------------------------------------//
        // манипуляции данными
 
        void setItemDataAt(size_t _index, Any _data);
 
        void clearItemDataAt(size_t _index);
 
        template<typename ValueType>
        ValueType* getItemDataAt(size_t _index, bool _throw = true)
        {
            return mList->getItemDataAt<ValueType>(_index, _throw);
        }
 
 
        //------------------------------------------------------------------------------//
        // манипуляции отображением
 
        void setItemNameAt(size_t _index, const UString& _name);
 
        const UString& getItemNameAt(size_t _index) const;
 
 
        //------------------------------------------------------------------------------//
        // манипуляции выдимостью
 
        void beginToItemAt(size_t _index);
 
        void beginToItemFirst();
 
        void beginToItemLast();
 
        void beginToItemSelected();
 
 
        //------------------------------------------------------------------------------------//
        // методы для управления отображением
 
        void setComboModeDrop(bool _drop);
        bool getComboModeDrop() const;
 
        void setSmoothShow(bool _value);
        bool getSmoothShow() const;
 
        void setMaxListLength(int _value);
        int getMaxListLength() const;
 
        // RENAME
        void setFlowDirection(FlowDirection _value);
        FlowDirection getFlowDirection() const;
 
        /*events:*/
        EventPairAddParameter<EventHandle_WidgetVoid, EventHandle_ComboBoxPtrSizeT> eventComboAccept;
 
        EventPair<EventHandle_WidgetSizeT, EventHandle_ComboBoxPtrSizeT> eventComboChangePosition;
 
        /*internal:*/
        // IItemContainer impl
        size_t _getItemCount() const override;
        void _addItem(const MyGUI::UString& _name) override;
        void _removeItemAt(size_t _index) override;
        void _setItemNameAt(size_t _index, const UString& _name) override;
        const UString& _getItemNameAt(size_t _index) const override;
 
        void _resetContainer(bool _update) override;
 
    protected:
        void initialiseOverride() override;
        void shutdownOverride() override;
 
        void onKeyButtonPressed(KeyCode _key, Char _char) override;
 
        void setPropertyOverride(std::string_view _key, std::string_view _value) override;
 
    private:
        void notifyButtonPressed(Widget* _sender, int _left, int _top, MouseButton _id);
        void notifyListLostFocus(Widget* _sender, MyGUI::Widget* _new);
        void notifyListSelectAccept(ListBox* _widget, size_t _position);
        void notifyListMouseItemActivate(ListBox* _widget, size_t _position);
        void notifyListChangePosition(ListBox* _widget, size_t _position);
        void notifyMouseWheel(Widget* _sender, int _rel);
        void notifyMousePressed(Widget* _sender, int _left, int _top, MouseButton _id);
        void notifyEditTextChange(EditBox* _sender);
        void notifyToolTip(Widget* _sender, const ToolTipInfo& _info);
 
        void showList();
        void hideList();
 
        void actionWidgetHide(Widget* _widget, ControllerItem* _controller);
 
        ControllerFadeAlpha* createControllerFadeAlpha(float _alpha, float _coef, bool _enable);
        IntCoord calculateListPosition();
 
    private:
        Button* mButton{nullptr};
        ListBox* mList{nullptr};
 
        bool mListShow{false};
        int mMaxListLength{-1};
        size_t mItemIndex{ITEM_NONE};
        bool mModeDrop{false};
        bool mDropMouse{false};
        bool mShowSmooth{false};
 
        FlowDirection mFlowDirection{FlowDirection::TopToBottom};
    };
 
} // namespace MyGUI
 
#endif // MYGUI_COMBO_BOX_H_