MyGUI_WidgetInput.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_WIDGET_INPUT_H__
#define __MYGUI_WIDGET_INPUT_H__

#include "MyGUI_Prerequest.h"
#include "MyGUI_Macros.h"
#include "MyGUI_WidgetDefines.h"
#include "MyGUI_WidgetToolTip.h"
#include "MyGUI_MouseButton.h"
#include "MyGUI_KeyCode.h"
#include "MyGUI_MaskPickInfo.h"
#include "MyGUI_Delegate.h"
#include "MyGUI_EventPair.h"

namespace MyGUI
{

    // делегаты для событий виджета
    typedef delegates::CMultiDelegate1<Widget*> EventHandle_WidgetVoid;
    typedef delegates::CMultiDelegate2<Widget*, Widget*> EventHandle_WidgetWidget;
    typedef delegates::CMultiDelegate2<Widget*, bool> EventHandle_WidgetBool;
    typedef delegates::CMultiDelegate2<Widget*, int> EventHandle_WidgetInt;
    typedef delegates::CMultiDelegate2<Widget*, size_t> EventHandle_WidgetSizeT;
    typedef delegates::CMultiDelegate3<Widget*, int, int> EventHandle_WidgetIntInt;
    typedef delegates::CMultiDelegate4<Widget*, int, int, MouseButton> EventHandle_WidgetIntIntButton;
    typedef delegates::CMultiDelegate2<Widget*, KeyCode> EventHandle_WidgetKeyCode;
    typedef delegates::CMultiDelegate3<Widget*, KeyCode, Char> EventHandle_WidgetKeyCodeChar;
    typedef delegates::CMultiDelegate2<Widget*, const ToolTipInfo& > EventHandle_WidgetToolTip;

    class MYGUI_EXPORT WidgetInput
    {
    public:
        WidgetInput();
        virtual ~WidgetInput();

        void setNeedToolTip(bool _value);
        bool getNeedToolTip() const;

        void setPointer(const std::string& _value);
        const std::string& getPointer() const;

        void setNeedKeyFocus(bool _value);
        bool getNeedKeyFocus() const;

        void setNeedMouseFocus(bool _value);
        bool getNeedMouseFocus() const;

        void setInheritsPick(bool _value);
        bool getInheritsPick() const;

        void setMaskPick(const std::string& _filename);
        void setMaskPick(const MaskPickInfo& _info);

        bool isMaskPickInside(const IntPoint& _point, const IntCoord& _coord) const;

        bool getRootMouseFocus() const;
        bool getRootKeyFocus() const;

        EventHandle_WidgetWidget eventMouseLostFocus;

        EventHandle_WidgetWidget eventMouseSetFocus;

        EventPairAddParameter<EventHandle_WidgetIntInt, EventHandle_WidgetIntIntButton> eventMouseDrag;

        EventHandle_WidgetIntInt eventMouseMove;

        EventHandle_WidgetInt eventMouseWheel;

        EventHandle_WidgetIntIntButton eventMouseButtonPressed;

        EventHandle_WidgetIntIntButton eventMouseButtonReleased;

        EventHandle_WidgetVoid eventMouseButtonClick;

        EventHandle_WidgetVoid eventMouseButtonDoubleClick;

        EventHandle_WidgetWidget eventKeyLostFocus;

        EventHandle_WidgetWidget eventKeySetFocus;

        EventHandle_WidgetKeyCodeChar eventKeyButtonPressed;

        EventHandle_WidgetKeyCode eventKeyButtonReleased;

        EventHandle_WidgetBool eventRootMouseChangeFocus;

        EventHandle_WidgetBool eventRootKeyChangeFocus;

        EventHandle_WidgetToolTip eventToolTip;

        /*internal:*/
        void _riseMouseLostFocus(Widget* _new);
        void _riseMouseSetFocus(Widget* _old);
        void _riseMouseDrag(int _left, int _top, MouseButton _id);
        void _riseMouseMove(int _left, int _top);
        void _riseMouseWheel(int _rel);
        void _riseMouseButtonPressed(int _left, int _top, MouseButton _id);
        void _riseMouseButtonReleased(int _left, int _top, MouseButton _id);
        void _riseMouseButtonClick();
        void _riseMouseButtonDoubleClick();
        void _riseKeyLostFocus(Widget* _new);
        void _riseKeySetFocus(Widget* _old);
        void _riseKeyButtonPressed(KeyCode _key, Char _char);
        void _riseKeyButtonReleased(KeyCode _key);
        void _riseMouseChangeRootFocus(bool _focus);
        void _riseKeyChangeRootFocus(bool _focus);

        void _setRootMouseFocus(bool _value);
        void _setRootKeyFocus(bool _value);

    protected:
        virtual void onMouseLostFocus(Widget* _new);
        virtual void onMouseSetFocus(Widget* _old);
        virtual void onMouseDrag(int _left, int _top, MouseButton _id);
        virtual void onMouseMove(int _left, int _top);
        virtual void onMouseWheel(int _rel);
        virtual void onMouseButtonPressed(int _left, int _top, MouseButton _id);
        virtual void onMouseButtonReleased(int _left, int _top, MouseButton _id);
        virtual void onMouseButtonClick();
        virtual void onMouseButtonDoubleClick();
        virtual void onKeyLostFocus(Widget* _new);
        virtual void onKeySetFocus(Widget* _old);
        virtual void onKeyButtonPressed(KeyCode _key, Char _char);
        virtual void onKeyButtonReleased(KeyCode _key);
        virtual void onMouseChangeRootFocus(bool _focus);
        virtual void onKeyChangeRootFocus(bool _focus);

    private:
        std::string mPointer;
        MaskPickInfo mOwnMaskPickInfo;

        bool mNeedToolTip;
        bool mInheritsPick;
        bool mNeedKeyFocus;
        bool mNeedMouseFocus;

        bool mRootMouseFocus;
        bool mRootKeyFocus;
    };

} // namespace MyGUI

#endif // __MYGUI_WIDGET_INPUT_H__