home *** CD-ROM | disk | FTP | other *** search
/ Game Programming in C++ - Start to Finish / GameProgrammingS.iso / developer_install / CEGUISDK-0.4.1-VC6-Native.exe / {app} / include / elements / CEGUIButtonBaseProperties.h < prev    next >
Encoding:
C/C++ Source or Header  |  2005-07-10  |  4.6 KB  |  157 lines
  1. /************************************************************************
  2.     filename:     CEGUIButtonBaseProperties.h
  3.     created:    9/7/2004
  4.     author:        Paul D Turner
  5.     
  6.     purpose:    Interface to properties for button base class
  7. *************************************************************************/
  8. /*************************************************************************
  9.     Crazy Eddie's GUI System (http://www.cegui.org.uk)
  10.     Copyright (C)2004 - 2005 Paul D Turner (paul@cegui.org.uk)
  11.  
  12.     This library is free software; you can redistribute it and/or
  13.     modify it under the terms of the GNU Lesser General Public
  14.     License as published by the Free Software Foundation; either
  15.     version 2.1 of the License, or (at your option) any later version.
  16.  
  17.     This library is distributed in the hope that it will be useful,
  18.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  19.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20.     Lesser General Public License for more details.
  21.  
  22.     You should have received a copy of the GNU Lesser General Public
  23.     License along with this library; if not, write to the Free Software
  24.     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  25. *************************************************************************/
  26. #ifndef _CEGUIButtonBaseProperties_h_
  27. #define _CEGUIButtonBaseProperties_h_
  28.  
  29. #include "CEGUIProperty.h"
  30.  
  31.  
  32. // Start of CEGUI namespace section
  33. namespace CEGUI
  34. {
  35. // Start of ButtonBaseProperties namespace section
  36. /*!
  37. \brief
  38.     Namespace containing all classes that make up the properties interface for the ButtonBase class
  39. */
  40. namespace ButtonBaseProperties
  41. {
  42. /*!
  43. \brief
  44.     Property to access the normal text colour.
  45.  
  46.     This property offers access to the colour value to be used for rendering the button caption text for the normal state.
  47.  
  48.     \par Usage:
  49.         - Name: NormalTextColour
  50.         - Format: "aarrggbb".
  51.  
  52.     \par Where:
  53.         - aarrggbb is the ARGB colour value to be used.
  54. */
  55. class NormalTextColour : public Property
  56. {
  57. public:
  58.     NormalTextColour() : Property(
  59.         "NormalTextColour",
  60.         "Property to get/set the colour to use when rendering label text for normal state.  Value is \"aarrggbb\" (hex).",
  61.         "FFFFFFFF")
  62.     {}
  63.  
  64.     String    get(const PropertyReceiver* receiver) const;
  65.     void    set(PropertyReceiver* receiver, const String& value);
  66. };
  67.  
  68.  
  69. /*!
  70. \brief
  71.     Property to access the hover / highlight text colour.
  72.  
  73.     This property offers access to the colour value to be used for rendering the button caption text for the hover or highlight state.
  74.  
  75.     \par Usage:
  76.         - Name: HoverTextColour
  77.         - Format: "aarrggbb".
  78.  
  79.     \par Where:
  80.         - aarrggbb is the ARGB colour value to be used.
  81. */
  82. class HoverTextColour : public Property
  83. {
  84. public:
  85.     HoverTextColour() : Property(
  86.         "HoverTextColour",
  87.         "Property to get/set the colour to use when rendering label text for hover/highlight state.  Value is \"aarrggbb\" (hex).",
  88.         "FFFFFFFF")
  89.     {}
  90.  
  91.     String    get(const PropertyReceiver* receiver) const;
  92.     void    set(PropertyReceiver* receiver, const String& value);
  93. };
  94.  
  95.  
  96. /*!
  97. \brief
  98.     Property to access the pushed text colour.
  99.  
  100.     This property offers access to the colour value to be used for rendering the button caption text for the pushed state.
  101.  
  102.     \par Usage:
  103.         - Name: PushedTextColour
  104.         - Format: "aarrggbb".
  105.  
  106.     \par Where:
  107.         - aarrggbb is the ARGB colour value to be used.
  108. */
  109. class PushedTextColour : public Property
  110. {
  111. public:
  112.     PushedTextColour() : Property(
  113.         "PushedTextColour", 
  114.         "Property to get/set the colour to use when rendering label text for pushed state.  Value is \"aarrggbb\" (hex).",
  115.         "FFFFFFFF")
  116.     {}
  117.  
  118.     String    get(const PropertyReceiver* receiver) const;
  119.     void    set(PropertyReceiver* receiver, const String& value);
  120. };
  121.  
  122.  
  123. /*!
  124. \brief
  125.     Property to access the disabled text colour.
  126.  
  127.     This property offers access to the colour value to be used for rendering the button caption text for the disabled state.
  128.  
  129.     \par Usage:
  130.         - Name: DisabledTextColour
  131.         - Format: "aarrggbb".
  132.  
  133.     \par Where:
  134.         - aarrggbb is the ARGB colour value to be used.
  135. */
  136. class DisabledTextColour : public Property
  137. {
  138. public:
  139.     DisabledTextColour() : Property(
  140.         "DisabledTextColour",
  141.         "Property to get/set the colour to use when rendering label text for disabled state.  Value is \"aarrggbb\" (hex).",
  142.         "FF7F7F7F")
  143.     {}
  144.  
  145.     String    get(const PropertyReceiver* receiver) const;
  146.     void    set(PropertyReceiver* receiver, const String& value);
  147. };
  148.  
  149.  
  150. } // End of  ButtonBaseProperties namespace section
  151.  
  152.  
  153. } // End of  CEGUI namespace section
  154.  
  155.  
  156. #endif    // end of guard _CEGUIButtonBaseProperties_h_
  157.