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

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

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

        IntCoord getViewCoord() const;

        void setViewOffset(const IntPoint& _value);
        IntPoint getViewOffset() const;

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

        void notifyMousePressed(Widget* _sender, int _left, int _top, MouseButton _id);
        void notifyMouseReleased(Widget* _sender, int _left, int _top, MouseButton _id);

        void notifyScrollChangePosition(ScrollBar* _sender, size_t _position);
        void notifyMouseWheel(Widget* _sender, int _rel);

        void updateView();

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

        ScrollBar* getVScroll();

    private:
        // размер данных
        virtual IntSize getContentSize();
        // смещение данных
        virtual IntPoint getContentPosition();
        // размер окна, через которые видно данные
        virtual IntSize getViewSize();
        virtual void setContentPosition(const IntPoint& _point);
        // размер на который прокручиваются данные при щелчке по скролу
        virtual size_t getVScrollPage();
        virtual size_t getHScrollPage();

        virtual Align getContentAlign();

    protected:
        Align mContentAlign;
        Widget* mRealClient;
    };

} // namespace MyGUI

#endif // __MYGUI_SCROLL_VIEW_H__