CEGUIComboboxProperties.h

00001 /************************************************************************
00002         filename:       CEGUIComboboxProperties.h
00003         created:        11/7/2004
00004         author:         Paul D Turner
00005         
00006         purpose:        Interface to Combobox property classes
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 _CEGUIComboboxProperties_h_
00027 #define _CEGUIComboboxProperties_h_
00028 
00029 #include "CEGUIProperty.h"
00030 
00031 
00032 // Start of CEGUI namespace section
00033 namespace CEGUI
00034 {
00035 
00036 // Start of ComboboxProperties namespace section
00041 namespace ComboboxProperties
00042 {
00055 class ReadOnly : public Property
00056 {
00057 public:
00058         ReadOnly() : Property(
00059                 "ReadOnly",
00060                 "Property to get/set the read-only setting for the Editbox.  Value is either \"True\" or \"False\".",
00061                 "False")
00062         {}
00063 
00064         String  get(const PropertyReceiver* receiver) const;
00065         void    set(PropertyReceiver* receiver, const String& value);
00066 };
00067 
00068 
00080 class ValidationString : public Property
00081 {
00082 public:
00083         ValidationString() : Property(
00084                 "ValidationString",
00085                 "Property to get/set the validation string Editbox.  Value is a text string.",
00086                 ".*")
00087         {}
00088 
00089         String  get(const PropertyReceiver* receiver) const;
00090         void    set(PropertyReceiver* receiver, const String& value);
00091 };
00092 
00093 
00105 class CaratIndex : public Property
00106 {
00107 public:
00108         CaratIndex() : Property(
00109                 "CaratIndex",
00110                 "Property to get/set the current carat index.  Value is \"[uint]\".",
00111                 "0")
00112         {}
00113 
00114         String  get(const PropertyReceiver* receiver) const;
00115         void    set(PropertyReceiver* receiver, const String& value);
00116 };
00117 
00118 
00130 class EditSelectionStart : public Property
00131 {
00132 public:
00133         EditSelectionStart() : Property(
00134                 "EditSelectionStart",
00135                 "Property to get/set the zero based index of the selection start position within the text.  Value is \"[uint]\".",
00136                 "0")
00137         {}
00138 
00139         String  get(const PropertyReceiver* receiver) const;
00140         void    set(PropertyReceiver* receiver, const String& value);
00141 };
00142 
00143 
00155 class EditSelectionLength : public Property
00156 {
00157 public:
00158         EditSelectionLength() : Property(
00159                 "EditSelectionLength",
00160                 "Property to get/set the length of the selection (as a count of the number of code points selected).  Value is \"[uint]\".",
00161                 "0")
00162         {}
00163 
00164         String  get(const PropertyReceiver* receiver) const;
00165         void    set(PropertyReceiver* receiver, const String& value);
00166 };
00167 
00168 
00180 class MaxEditTextLength : public Property
00181 {
00182 public:
00183         MaxEditTextLength() : Property(
00184                 "MaxEditTextLength",
00185                 "Property to get/set the the maximum allowed text length (as a count of code points).  Value is \"[uint]\".",
00186                 "1073741824")
00187         {}
00188 
00189         String  get(const PropertyReceiver* receiver) const;
00190         void    set(PropertyReceiver* receiver, const String& value);
00191 };
00192 
00193 
00205 class NormalEditTextColour : public Property
00206 {
00207 public:
00208         NormalEditTextColour() : Property(
00209                 "NormalEditTextColour",
00210                 "Property to get/set the normal, unselected, text colour used for rendering text.  Value is \"aarrggbb\" (hex).",
00211                 "00FFFFFF")
00212         {}
00213 
00214         String  get(const PropertyReceiver* receiver) const;
00215         void    set(PropertyReceiver* receiver, const String& value);
00216 };
00217 
00218 
00230 class SelectedEditTextColour : public Property
00231 {
00232 public:
00233         SelectedEditTextColour() : Property(
00234                 "SelectedEditTextColour",
00235                 "Property to get/set the colour used for rendering text within the selection area.  Value is \"aarrggbb\" (hex).",
00236                 "00000000")
00237         {}
00238 
00239         String  get(const PropertyReceiver* receiver) const;
00240         void    set(PropertyReceiver* receiver, const String& value);
00241 };
00242 
00243 
00255 class ActiveEditSelectionColour : public Property
00256 {
00257 public:
00258         ActiveEditSelectionColour() : Property(
00259                 "ActiveEditSelectionColour",
00260                 "Property to get/set the colour used for rendering the selection highlight when the edit box is active.  Value is \"aarrggbb\" (hex).",
00261                 "006060FF")
00262         {}
00263 
00264         String  get(const PropertyReceiver* receiver) const;
00265         void    set(PropertyReceiver* receiver, const String& value);
00266 };
00267 
00268 
00280 class InactiveEditSelectionColour : public Property
00281 {
00282 public:
00283         InactiveEditSelectionColour() : Property(
00284                 "InactiveEditSelectionColour",
00285                 "Property to get/set the colour used for rendering the selection highlight when the edit box is inactive.  Value is \"aarrggbb\" (hex).",
00286                 "00808080")
00287         {}
00288 
00289         String  get(const PropertyReceiver* receiver) const;
00290         void    set(PropertyReceiver* receiver, const String& value);
00291 };
00292 
00293 
00306 class SortList : public Property
00307 {
00308 public:
00309         SortList() : Property(
00310                 "SortList",
00311                 "Property to get/set the sort setting of the list box.  Value is either \"True\" or \"False\".",
00312                 "False")
00313         {}
00314 
00315         String  get(const PropertyReceiver* receiver) const;
00316         void    set(PropertyReceiver* receiver, const String& value);
00317 };
00318 
00319 
00332 class ForceVertScrollbar : public Property
00333 {
00334 public:
00335         ForceVertScrollbar() : Property(
00336                 "ForceVertScrollbar",
00337                 "Property to get/set the 'always show' setting for the vertical scroll bar of the list box.  Value is either \"True\" or \"False\".",
00338                 "False")
00339         {}
00340 
00341         String  get(const PropertyReceiver* receiver) const;
00342         void    set(PropertyReceiver* receiver, const String& value);
00343 };
00344 
00345 
00358 class ForceHorzScrollbar : public Property
00359 {
00360 public:
00361         ForceHorzScrollbar() : Property(
00362                 "ForceHorzScrollbar",
00363                 "Property to get/set the 'always show' setting for the horizontal scroll bar of the list box.  Value is either \"True\" or \"False\".",
00364                 "False")
00365         {}
00366 
00367         String  get(const PropertyReceiver* receiver) const;
00368         void    set(PropertyReceiver* receiver, const String& value);
00369 };
00370 
00371 
00384 class SingleClickMode : public Property
00385 {
00386 public:
00387         SingleClickMode() : Property(
00388                 "SingleClickMode",
00389                 "Property to get/set the 'single click mode' setting for the combo box.  Value is either \"True\" or \"False\".",
00390                 "False")
00391         {}
00392 
00393         String  get(const PropertyReceiver* receiver) const;
00394         void    set(PropertyReceiver* receiver, const String& value);
00395 };
00396 
00397 
00398 } // End of  ComboboxProperties namespace section
00399 
00400 } // End of  CEGUI namespace section
00401 
00402 
00403 #endif  // end of guard _CEGUIComboboxProperties_h_

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