MyGUI_ScrollBar.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_SCROLL_BAR_H_
#define MYGUI_SCROLL_BAR_H_
 
#include "MyGUI_Prerequest.h"
#include "MyGUI_Widget.h"
 
namespace MyGUI
{
 
    class ControllerItem;
 
    typedef delegates::CMultiDelegate2<ScrollBar*, size_t> EventHandle_ScrollBarPtrSizeT;
 
    class MYGUI_EXPORT ScrollBar :
        public Widget,
        public MemberObsolete<ScrollBar>
    {
        MYGUI_RTTI_DERIVED( ScrollBar )
 
    public:
        ScrollBar();
 
        void setVerticalAlignment(bool _value);
        bool getVerticalAlignment() const;
 
        void setScrollRange(size_t _value);
        size_t getScrollRange() const;
 
        void setScrollPosition(size_t _value);
        size_t getScrollPosition() const;
 
        void setScrollPage(size_t _value);
        size_t getScrollPage() const;
 
        void setScrollViewPage(size_t _value);
        size_t getScrollViewPage() const;
 
        void setScrollWheelPage(size_t _value);
        size_t getScrollWheelPage() const;
 
        int getLineSize() const;
 
        void setTrackSize(int _value);
        int getTrackSize() const;
 
        void setMinTrackSize(int _value);
        int getMinTrackSize() const;
 
        void setMoveToClick(bool _value);
        bool getMoveToClick() const;
 
        void setRepeatEnabled(bool enabled);
        bool getRepeatEnabled() const;
 
        void setRepeatTriggerTime(float time);
        float getRepeatTriggerTime(float time) const;
 
        void setRepeatStepTime(float time);
        float getRepeatStepTime(float time) const;
 
        void setPosition(const IntPoint& _value) override;
        void setSize(const IntSize& _value) override;
        void setCoord(const IntCoord& _value) override;
 
        using Widget::setPosition;
        using Widget::setSize;
        using Widget::setCoord;
 
        /*events:*/
        EventHandle_ScrollBarPtrSizeT eventScrollChangePosition;
 
    protected:
        void initialiseOverride() override;
        void shutdownOverride() override;
 
        void updateTrack();
        void TrackMove(int _left, int _top);
 
        void onMouseWheel(int _rel) override;
 
        void notifyMousePressed(Widget* _sender, int _left, int _top, MouseButton _id);
        void notifyMouseReleased(Widget* _sender, int _left, int _top, MouseButton _id);
        void notifyMouseDrag(Widget* _sender, int _left, int _top, MouseButton _id);
        void notifyMouseWheel(Widget* _sender, int _rel);
 
        void setPropertyOverride(const std::string& _key, const std::string& _value) override;
 
        int getTrackPlaceLength() const;
 
    private:
        void repeatClick(MyGUI::Widget* _widget, MyGUI::ControllerItem* _controller);
        void widgetStartPressed();
        void widgetEndPressed();
        void widgetFirstPartPressed();
        void widgetSecondPartPressed();
 
    protected:
        // наши кнопки
        Button* mWidgetStart;
        Button* mWidgetEnd;
        Button* mWidgetTrack;
        // куски между кнопками
        Widget* mWidgetFirstPart;
        Widget* mWidgetSecondPart;
 
        // смещение внутри окна
        IntPoint mPreActionOffset;
 
        // диапазон на который трек может двигаться
        size_t mSkinRangeStart;
        size_t mSkinRangeEnd;
 
        size_t mScrollRange;
        size_t mScrollPosition;
        size_t mScrollPage; // track step, when clicking buttons
        size_t mScrollViewPage; // track step, when clicking scroll line
        size_t mScrollWheelPage; // track step, when scrolling with mouse wheel
 
        bool mEnableRepeat; // Repeat clicks on the scrollbar buttons when the mouse button remains pressed down
        float mRepeatTriggerTime; // Time the mouse button needs to be held for repeating to start
        float mRepeatStepTime; // Time between repeats
 
        int mMinTrackSize;
        bool mMoveToClick;
 
        bool mVerticalAlignment;
    };
 
} // namespace MyGUI
 
#endif // MYGUI_SCROLL_BAR_H_