widgets/ProgressBar.h

/***********************************************************************
        filename:       CEGUIProgressBar.h
        created:        13/4/2004
        author:         Paul D Turner
        
        purpose:        Interface to base class for ProgressBar widget
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
 *
 *   Permission is hereby granted, free of charge, to any person obtaining
 *   a copy of this software and associated documentation files (the
 *   "Software"), to deal in the Software without restriction, including
 *   without limitation the rights to use, copy, modify, merge, publish,
 *   distribute, sublicense, and/or sell copies of the Software, and to
 *   permit persons to whom the Software is furnished to do so, subject to
 *   the following conditions:
 *
 *   The above copyright notice and this permission notice shall be
 *   included in all copies or substantial portions of the Software.
 *
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 *   OTHER DEALINGS IN THE SOFTWARE.
 ***************************************************************************/
#ifndef _CEGUIProgressBar_h_
#define _CEGUIProgressBar_h_

#include "../Base.h"
#include "../Window.h"


#if defined(_MSC_VER)
#       pragma warning(push)
#       pragma warning(disable : 4251)
#endif


// Start of CEGUI namespace section
namespace CEGUI
{
class CEGUIEXPORT ProgressBar : public Window
{
public:
        static const String EventNamespace;                             
    static const String WidgetTypeName;             

        /*************************************************************************
                Event name constants
        *************************************************************************/
        static const String EventProgressChanged;
        static const String EventProgressDone;


        /************************************************************************
                Accessor Functions
        ************************************************************************/
        float   getProgress(void) const         {return d_progress;}

        float   getStepSize(void) const                 {return d_step;}


        /*************************************************************************
                Manipulator Functions
        *************************************************************************/
        void    setProgress(float progress);


        void    setStepSize(float step_val)             {d_step = step_val;}


        void    step(void)                      {setProgress(d_progress + d_step);}


        void    adjustProgress(float delta)             {setProgress(d_progress + delta);}


        /*************************************************************************
                Construction / Destruction
        *************************************************************************/
        ProgressBar(const String& type, const String& name);


        virtual ~ProgressBar(void);


protected:
        /*************************************************************************
                Event handlers for progress bar specific events
        *************************************************************************/
        virtual void    onProgressChanged(WindowEventArgs& e);


        virtual void    onProgressDone(WindowEventArgs& e);


        /*************************************************************************
                Implementation Data
        *************************************************************************/
        float   d_progress;             
        float   d_step;                 


private:
        /*************************************************************************
                Private methods
        *************************************************************************/
        void    addProgressBarProperties(void);
};

} // End of  CEGUI namespace section

#if defined(_MSC_VER)
#       pragma warning(pop)
#endif

#endif  // end of guard _CEGUIProgressBar_h_