source/gui/CCheckBox.h

   1 /* Copyright (C) 2009 Wildfire Games.
   2  * This file is part of 0 A.D.
   3  *
   4  * 0 A.D. is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * 0 A.D. is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 /*
  19 GUI Object - Check box
  20
  21 --Overview--
  22
  23         GUI Object representing a check box
  24
  25 --More info--
  26
  27         Check GUI.h
  28
  29 */
  30
  31 #ifndef INCLUDED_CCHECKBOX
  32 #define INCLUDED_CCHECKBOX
  33
  34 //--------------------------------------------------------
  35 //  Includes / Compiler directives
  36 //--------------------------------------------------------
  37 #include "GUI.h"
  38
  39 //--------------------------------------------------------
  40 //  Macros
  41 //--------------------------------------------------------
  42
  43 //--------------------------------------------------------
  44 //  Types
  45 //--------------------------------------------------------
  46
  47 //--------------------------------------------------------
  48 //  Declarations
  49 //--------------------------------------------------------
  50
  51 /**
  52  * CheckBox
  53  *
  54  * @see IGUIObject
  55  * @see IGUISettingsObject
  56  * @see IGUIButtonBehavior
  57  */
  58 class CCheckBox : public IGUIButtonBehavior, public IGUITextOwner
  59 {
  60         GUI_OBJECT(CCheckBox)
  61
  62 public:
  63         CCheckBox();
  64         virtual ~CCheckBox();
  65
  66         /**
  67          * @see IGUIObject#ResetStates()
  68          */
  69         virtual void ResetStates() { IGUIButtonBehavior::ResetStates(); }
  70
  71         /**
  72          * @see IGUIObject#HandleMessage()
  73          */
  74         virtual void HandleMessage(SGUIMessage &Message);
  75
  76         /**
  77          * Draws the control
  78          */
  79         virtual void Draw();
  80
  81 protected:
  82         /**
  83          * Sets up text, should be called every time changes has been
  84          * made that can change the visual.
  85          */
  86         void SetupText();
  87 };
  88
  89 #endif