MyGUI_ProgressBar.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_PROGRESS_BAR_H__
#define __MYGUI_PROGRESS_BAR_H__

#include "MyGUI_Prerequest.h"
#include "MyGUI_Align.h"
#include "MyGUI_FlowDirection.h"
#include "MyGUI_Widget.h"

namespace MyGUI
{

    class MYGUI_EXPORT ProgressBar :
        public Widget,
        public MemberObsolete<ProgressBar>
    {
        MYGUI_RTTI_DERIVED( ProgressBar )

    public:
        ProgressBar();

        void setProgressRange(size_t _value);
        size_t getProgressRange() const;

        void setProgressPosition(size_t _value);
        size_t getProgressPosition() const;

        void setProgressAutoTrack(bool _value);
        bool getProgressAutoTrack() const;

        void setFlowDirection(FlowDirection _value);
        FlowDirection getFlowDirection() 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);

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

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

    private:
        void frameEntered(float _time);
        void updateTrack();

        int getClientWidth();
        int getClientHeight();

        void setTrackPosition(Widget* _widget, int _left, int _top, int _width, int _height);

    private:
        std::string mTrackSkin;
        int mTrackWidth;
        int mTrackStep;
        int mTrackMin;

        VectorWidgetPtr mVectorTrack;
        size_t mRange;
        size_t mStartPosition, mEndPosition;
        float mAutoPosition;
        bool mAutoTrack;
        bool mFillTrack;

        FlowDirection mFlowDirection;

        Widget* mClient;
    };

} // namespace MyGUI

#endif // __MYGUI_PROGRESS_BAR_H__