MyGUI_ScrollView.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_VIEW_H_
#define MYGUI_SCROLL_VIEW_H_
 
#include "MyGUI_Prerequest.h"
#include "MyGUI_Widget.h"
#include "MyGUI_ScrollViewBase.h"
 
namespace MyGUI
{
 
    class MYGUI_EXPORT ScrollView :
        public Widget,
        protected ScrollViewBase,
        public MemberObsolete<ScrollView>
    {
        MYGUI_RTTI_DERIVED( ScrollView )
 
    public:
        ScrollView();
 
        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;
 
        void setVisibleVScroll(bool _value);
        bool isVisibleVScroll() const;
 
        void setVisibleHScroll(bool _value);
        bool isVisibleHScroll() const;
 
        void setCanvasAlign(Align _value);
        Align getCanvasAlign() const;
 
        void setCanvasSize(const IntSize& _value);
        void setCanvasSize(int _width, int _height);
        IntSize getCanvasSize() const;
 
        IntCoord getViewCoord() const;
 
        void setViewOffset(const IntPoint& _value);
        IntPoint getViewOffset() const;
 
    protected:
        void initialiseOverride() override;
        void shutdownOverride() override;
 
        void notifyScrollChangePosition(ScrollBar* _sender, size_t _position);
        void notifyMouseWheel(Widget* _sender, int _rel);
 
        void updateView();
 
        void setPropertyOverride(const std::string& _key, const std::string& _value) override;
 
        ScrollBar* getVScroll() const;
 
    private:
        // размер данных
        IntSize getContentSize() const override;
        // смещение данных
        IntPoint getContentPosition() const override;
        // размер окна, через которые видно данные
        IntSize getViewSize() const override;
        void setContentPosition(const IntPoint& _point) override;
        // размер на который прокручиваются данные при щелчке по скролу
        size_t getVScrollPage() const override;
        size_t getHScrollPage() const override;
 
        Align getContentAlign() const override;
 
    protected:
        Align mContentAlign;
    };
 
} // namespace MyGUI
 
#endif // MYGUI_SCROLL_VIEW_H_