CEGUIStaticTextProperties.h

00001 /************************************************************************
00002         filename:       CEGUIStaticTextProperties.h
00003         created:        10/7/2004
00004         author:         Paul D Turner
00005         
00006         purpose:        Interface for properties for the StaticText class.
00007 *************************************************************************/
00008 /*************************************************************************
00009     Crazy Eddie's GUI System (http://www.cegui.org.uk)
00010     Copyright (C)2004 - 2005 Paul D Turner (paul@cegui.org.uk)
00011 
00012     This library is free software; you can redistribute it and/or
00013     modify it under the terms of the GNU Lesser General Public
00014     License as published by the Free Software Foundation; either
00015     version 2.1 of the License, or (at your option) any later version.
00016 
00017     This library is distributed in the hope that it will be useful,
00018     but WITHOUT ANY WARRANTY; without even the implied warranty of
00019     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00020     Lesser General Public License for more details.
00021 
00022     You should have received a copy of the GNU Lesser General Public
00023     License along with this library; if not, write to the Free Software
00024     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00025 *************************************************************************/
00026 #ifndef _CEGUIStaticTextProperties_h_
00027 #define _CEGUIStaticTextProperties_h_
00028 
00029 #include "CEGUIProperty.h"
00030 
00031 
00032 // Start of CEGUI namespace section
00033 namespace CEGUI
00034 {
00035 
00036 // Start of StaticTextProperties namespace section
00041 namespace StaticTextProperties
00042 {
00057 class TextColours : public Property
00058 {
00059 public:
00060         TextColours() : Property(
00061                 "TextColours",
00062                 "Property to get/set the text colours for the StaticText widget.  Value is \"tl:[aarrggbb] tr:[aarrggbb] bl:[aarrggbb] br:[aarrggbb]\".",
00063                 "tl:FFFFFFFF tr:FFFFFFFF bl:FFFFFFFF br:FFFFFFFF")
00064         {}
00065 
00066         String  get(const PropertyReceiver* receiver) const;
00067         void    set(PropertyReceiver* receiver, const String& value);
00068 };
00069 
00070 
00089 class HorzFormatting : public Property
00090 {
00091 public:
00092         HorzFormatting() : Property(
00093                 "HorzFormatting",
00094                 "Property to get/set the horizontal formatting mode.  Value is one of the HorzFormatting strings.",
00095                 "LeftAligned")
00096         {}
00097 
00098         String  get(const PropertyReceiver* receiver) const;
00099         void    set(PropertyReceiver* receiver, const String& value);
00100 };
00101 
00102 
00116 class VertFormatting : public Property
00117 {
00118 public:
00119         VertFormatting() : Property(
00120                 "VertFormatting",
00121                 "Property to get/set the vertical formatting mode.  Value is one of the VertFormatting strings.",
00122                 "VertCentred")
00123         {}
00124 
00125         String  get(const PropertyReceiver* receiver) const;
00126         void    set(PropertyReceiver* receiver, const String& value);
00127 };
00128 
00129 
00142 class VertScrollbar : public Property
00143 {
00144 public:
00145         VertScrollbar() : Property(
00146                 "VertScrollbar",
00147                 "Property to get/set the setting for the vertical scroll bar.  Value is either \"True\" or \"False\".",
00148                 "False")
00149         {}
00150 
00151         String  get(const PropertyReceiver* receiver) const;
00152         void    set(PropertyReceiver* receiver, const String& value);
00153 };
00154 
00155 
00168 class HorzScrollbar : public Property
00169 {
00170 public:
00171         HorzScrollbar() : Property(
00172                 "HorzScrollbar",
00173                 "Property to get/set the setting for the horizontal scroll bar.  Value is either \"True\" or \"False\".",
00174                 "False")
00175         {}
00176 
00177         String  get(const PropertyReceiver* receiver) const;
00178         void    set(PropertyReceiver* receiver, const String& value);
00179 };
00180 
00181 } // End of  StaticTextProperties namespace section
00182 
00183 } // End of  CEGUI namespace section
00184 
00185 
00186 #endif  // end of guard _CEGUIStaticTextProperties_h_

Generated on Sat Nov 26 10:09:55 2005 for Crazy Eddies GUI System by  doxygen 1.4.5