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
{
 
    // делегаты для событий виджета
    using EventHandle_WidgetVoid = delegates::MultiDelegate<Widget*>;
    using EventHandle_WidgetWidget = delegates::MultiDelegate<Widget*, Widget*>;
    using EventHandle_WidgetBool = delegates::MultiDelegate<Widget*, bool>;
    using EventHandle_WidgetInt = delegates::MultiDelegate<Widget*, int>;
    using EventHandle_WidgetSizeT = delegates::MultiDelegate<Widget*, size_t>;
    using EventHandle_WidgetIntInt = delegates::MultiDelegate<Widget*, int, int>;
    using EventHandle_WidgetIntIntButton = delegates::MultiDelegate<Widget*, int, int, MouseButton>;
    using EventHandle_WidgetKeyCode = delegates::MultiDelegate<Widget*, KeyCode>;
    using EventHandle_WidgetKeyCodeChar = delegates::MultiDelegate<Widget*, KeyCode, Char>;
    using EventHandle_WidgetToolTip = delegates::MultiDelegate<Widget*, const ToolTipInfo&>;
 
    class MYGUI_EXPORT WidgetInput
    {
    public:
        virtual ~WidgetInput() = default;
 
        void setNeedToolTip(bool _value);
        bool getNeedToolTip() const;
 
        void setPointer(std::string_view _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{false};
        bool mInheritsPick{false};
        bool mNeedKeyFocus{false};
        bool mNeedMouseFocus{true};
 
        bool mRootMouseFocus{false};
        bool mRootKeyFocus{false};
    };
 
} // namespace MyGUI
 
#endif // MYGUI_WIDGET_INPUT_H_