include/IGUICheckBox.h

   1 // Copyright (C) 2002-2012 Nikolaus Gebhardt\r
   2 // This file is part of the "Irrlicht Engine".\r
   3 // For conditions of distribution and use, see copyright notice in irrlicht.h\r
   4 \r
   5 #ifndef __I_GUI_CHECKBOX_H_INCLUDED__\r
   6 #define __I_GUI_CHECKBOX_H_INCLUDED__\r
   7 \r
   8 #include "IGUIElement.h"\r
   9 \r
  10 namespace irr\r
  11 {\r
  12 namespace gui\r
  13 {\r
  14 \r
  15         //! GUI Check box interface.\r
  16         /** \par This element can create the following events of type EGUI_EVENT_TYPE:\r
  17         \li EGET_CHECKBOX_CHANGED\r
  18         */\r
  19         class IGUICheckBox : public IGUIElement\r
  20         {\r
  21         public:\r
  22 \r
  23                 //! constructor\r
  24                 IGUICheckBox(IGUIEnvironment* environment, IGUIElement* parent, s32 id, core::rect<s32> rectangle)\r
  25                         : IGUIElement(EGUIET_CHECK_BOX, environment, parent, id, rectangle) {}\r
  26 \r
  27                 //! Set if box is checked.\r
  28                 virtual void setChecked(bool checked) = 0;\r
  29 \r
  30                 //! Returns true if box is checked.\r
  31                 virtual bool isChecked() const = 0;\r
  32 \r
  33                 //! Sets whether to draw the background\r
  34                 virtual void setDrawBackground(bool draw) = 0;\r
  35 \r
  36                 //! Checks if background drawing is enabled\r
  37                 /** \return true if background drawing is enabled, false otherwise */\r
  38                 virtual bool isDrawBackgroundEnabled() const = 0;\r
  39 \r
  40                 //! Sets whether to draw the border\r
  41                 virtual void setDrawBorder(bool draw) = 0;\r
  42 \r
  43                 //! Checks if border drawing is enabled\r
  44                 /** \return true if border drawing is enabled, false otherwise */\r
  45                 virtual bool isDrawBorderEnabled() const = 0;\r
  46 \r
  47         };\r
  48 \r
  49 } // end namespace gui\r
  50 } // end namespace irr\r
  51 \r
  52 #endif\r
  53 \r