guiCheckBoxCtrl.h

Engine/source/gui/buttons/guiCheckBoxCtrl.h

More...

Classes:

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 _GUICHECKBOXCTRL_H_
25#define _GUICHECKBOXCTRL_H_
26
27#ifndef _GUIBUTTONBASECTRL_H_
28   #include "gui/buttons/guiButtonBaseCtrl.h"
29#endif
30
31
32/// A checkbox button.
33class GuiCheckBoxCtrl : public GuiButtonBaseCtrl
34{
35   public:
36   
37      typedef GuiButtonBaseCtrl Parent;
38
39   protected:
40
41      S32 mIndent;
42       
43   public:
44   
45      GuiCheckBoxCtrl();
46      
47      S32 getIndent() const { return mIndent; }
48      void setIndent( S32 value ) { mIndent = value; }
49
50      void onRender( Point2I offset, const RectI &updateRect );
51      bool onWake();
52
53      void autoSize();
54
55      DECLARE_CONOBJECT( GuiCheckBoxCtrl );
56      DECLARE_DESCRIPTION( "A toggle button that displays a text label and an on/off checkbox." );
57};
58
59#endif //_GUI_CHECKBOX_CTRL_H
60