Crazy Eddies GUI System 0.7.5

FalStaticTextProperties.h

00001 /***********************************************************************
00002         filename:       FalagardStaticTextProperties.h
00003         created:        17/9/2005
00004         author:         Tomas L Olsen (based on code by Paul D Turner)
00005         
00006         purpose:        Interface for properties for the FalagardStaticText class.
00007 *************************************************************************/
00008 /***************************************************************************
00009  *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
00010  *
00011  *   Permission is hereby granted, free of charge, to any person obtaining
00012  *   a copy of this software and associated documentation files (the
00013  *   "Software"), to deal in the Software without restriction, including
00014  *   without limitation the rights to use, copy, modify, merge, publish,
00015  *   distribute, sublicense, and/or sell copies of the Software, and to
00016  *   permit persons to whom the Software is furnished to do so, subject to
00017  *   the following conditions:
00018  *
00019  *   The above copyright notice and this permission notice shall be
00020  *   included in all copies or substantial portions of the Software.
00021  *
00022  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00023  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00024  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00025  *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
00026  *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00027  *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00028  *   OTHER DEALINGS IN THE SOFTWARE.
00029  ***************************************************************************/
00030 #ifndef _FalagardStaticTextProperties_h_
00031 #define _FalagardStaticTextProperties_h_
00032 
00033 #include "../../CEGUIProperty.h"
00034 
00035 
00036 // Start of CEGUI namespace section
00037 namespace CEGUI
00038 {
00039 
00040 // Start of FalagardStaticTextProperties namespace section
00045 namespace FalagardStaticTextProperties
00046 {
00047 
00062 class TextColours : public Property
00063 {
00064 public:
00065         TextColours() : Property(
00066                 "TextColours",
00067                 "Property to get/set the text colours for the FalagardStaticText widget.  Value is \"tl:[aarrggbb] tr:[aarrggbb] bl:[aarrggbb] br:[aarrggbb]\".",
00068                 "tl:FFFFFFFF tr:FFFFFFFF bl:FFFFFFFF br:FFFFFFFF")
00069         {}
00070 
00071         String  get(const PropertyReceiver* receiver) const;
00072         void    set(PropertyReceiver* receiver, const String& value);
00073 };
00074 
00075 
00094 class HorzFormatting : public Property
00095 {
00096 public:
00097         HorzFormatting() : Property(
00098                 "HorzFormatting",
00099                 "Property to get/set the horizontal formatting mode.  Value is one of the HorzFormatting strings.",
00100                 "LeftAligned")
00101         {}
00102 
00103         String  get(const PropertyReceiver* receiver) const;
00104         void    set(PropertyReceiver* receiver, const String& value);
00105 };
00106 
00107 
00121 class VertFormatting : public Property
00122 {
00123 public:
00124         VertFormatting() : Property(
00125                 "VertFormatting",
00126                 "Property to get/set the vertical formatting mode.  Value is one of the VertFormatting strings.",
00127                 "VertCentred")
00128         {}
00129 
00130         String  get(const PropertyReceiver* receiver) const;
00131         void    set(PropertyReceiver* receiver, const String& value);
00132 };
00133 
00134 
00147 class VertScrollbar : public Property
00148 {
00149 public:
00150         VertScrollbar() : Property(
00151                 "VertScrollbar",
00152                 "Property to get/set the setting for the vertical scroll bar.  Value is either \"True\" or \"False\".",
00153                 "False")
00154         {}
00155 
00156         String  get(const PropertyReceiver* receiver) const;
00157         void    set(PropertyReceiver* receiver, const String& value);
00158 };
00159 
00160 
00173 class HorzScrollbar : public Property
00174 {
00175 public:
00176         HorzScrollbar() : Property(
00177                 "HorzScrollbar",
00178                 "Property to get/set the setting for the horizontal scroll bar.  Value is either \"True\" or \"False\".",
00179                 "False")
00180         {}
00181 
00182         String  get(const PropertyReceiver* receiver) const;
00183         void    set(PropertyReceiver* receiver, const String& value);
00184 };
00185 
00195 class HorzExtent : public Property
00196 {
00197 public:
00198     HorzExtent() : Property(
00199         "HorzExtent",
00200         "Property to get the current horizontal extent of the formatted text "
00201         "string.  Value is a float indicating the pixel extent.",
00202         "0")
00203     {}
00204 
00205     String get(const PropertyReceiver* receiver) const;
00206     void set(PropertyReceiver* receiver, const String& value);
00207 };
00208 
00218 class VertExtent : public Property
00219 {
00220 public:
00221     VertExtent() : Property(
00222         "VertExtent",
00223         "Property to get the current vertical extent of the formatted text "
00224         "string.  Value is a float indicating the pixel extent.",
00225         "0")
00226     {}
00227 
00228     String get(const PropertyReceiver* receiver) const;
00229     void set(PropertyReceiver* receiver, const String& value);
00230 };
00231 
00232 } // End of  FalagardStaticTextProperties namespace section
00233 
00234 } // End of  CEGUI namespace section
00235 
00236 
00237 #endif  // end of guard _FalagardStaticTextProperties_h_