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
{

    typedef delegates::CMultiDelegate2<ComboBox*, size_t> EventHandle_ComboBoxPtrSizeT;

    class MYGUI_EXPORT ComboBox :
        public EditBox,
        public IItemContainer,
        public MemberObsolete<ComboBox>
    {
        MYGUI_RTTI_DERIVED( ComboBox )

    public:
        ComboBox();

        //------------------------------------------------------------------------------//
        // манипуляции айтемами

        size_t getItemCount() const;

        void insertItemAt(size_t _index, const UString& _name, 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);


        //------------------------------------------------------------------------------//
        // манипуляции выдимостью

        void beginToItemAt(size_t _index);

        void beginToItemFirst();

        void beginToItemLast();

        void beginToItemSelected();


        //------------------------------------------------------------------------------------//
        // методы для управления отображением

        void setComboModeDrop(bool _value);
        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:*/
        EventPair<EventHandle_WidgetVoid, EventHandle_ComboBoxPtrSizeT> eventComboAccept;

        EventPair<EventHandle_WidgetSizeT, EventHandle_ComboBoxPtrSizeT> eventComboChangePosition;

        /*internal:*/
        // IItemContainer impl
        virtual size_t _getItemCount();
        virtual void _addItem(const MyGUI::UString& _name);
        virtual void _removeItemAt(size_t _index);
        virtual void _setItemNameAt(size_t _index, const UString& _name);
        virtual const UString& _getItemNameAt(size_t _index);

        virtual void _resetContainer(bool _update);

    protected:
        virtual void initialiseOverride();
        virtual void shutdownOverride();

        virtual void onKeyButtonPressed(KeyCode _key, Char _char);

        virtual void setPropertyOverride(const std::string& _key, const std::string& _value);

    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;
        ListBox* mList;

        bool mListShow;
        int mMaxListLength;
        size_t mItemIndex;
        bool mModeDrop;
        bool mDropMouse;
        bool mShowSmooth;

        FlowDirection mFlowDirection;
    };

} // namespace MyGUI

#endif // __MYGUI_COMBO_BOX_H__