guiProgressCtrl.h

Engine/source/gui/game/guiProgressCtrl.h
Classes:

class
Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _GUIPROGRESSCTRL_H_
25#define _GUIPROGRESSCTRL_H_
26
27#ifndef _GUICONTROL_H_
28#include "gui/core/guiControl.h"
29#endif
30
31#ifndef _GUITEXTCTRL_H_
32#include "gui/controls/guiTextCtrl.h"
33#endif
34
35
36class GuiProgressCtrl : public GuiTextCtrl
37{
38private:
39   typedef GuiTextCtrl Parent;
40
41   F32 mProgress;
42
43public:
44   //creation methods
45   DECLARE_CONOBJECT(GuiProgressCtrl);
46   DECLARE_CATEGORY( "Gui Values" );
47   DECLARE_DESCRIPTION( "A control that display a horizontal progress bar.  The bar is\n"
48      "rendered using as a filled rectangle (properties determined by profile)." );
49   GuiProgressCtrl();
50
51   //console related methods
52   virtual const char *getScriptValue();
53   virtual void setScriptValue(const char *value);
54
55   void onPreRender();
56   void onRender(Point2I offset, const RectI &updateRect);
57};
58
59#endif
60