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
{

    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;

        virtual void setPosition(const IntPoint& _value);
        virtual void setSize(const IntSize& _value);
        virtual void setCoord(const IntCoord& _value);

        void setPosition(int _left, int _top);
        void setSize(int _width, int _height);
        void setCoord(int _left, int _top, int _width, int _height);

        /*events:*/
        EventHandle_ScrollBarPtrSizeT eventScrollChangePosition;

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

        void updateTrack();
        void TrackMove(int _left, int _top);

        virtual void onMouseWheel(int _rel);

        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);

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

        int getTrackPlaceLength() const;

    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

        int mMinTrackSize;
        bool mMoveToClick;

        bool mVerticalAlignment;
    };

} // namespace MyGUI

#endif // __MYGUI_SCROLL_BAR_H__