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  *   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 _CEGUIComboboxProperties_h_
00031 #define _CEGUIComboboxProperties_h_
00032 
00033 #include "CEGUIProperty.h"
00034 
00035 
00036 // Start of CEGUI namespace section
00037 namespace CEGUI
00038 {
00039 
00040 // Start of ComboboxProperties namespace section
00045 namespace ComboboxProperties
00046 {
00059 class ReadOnly : public Property
00060 {
00061 public:
00062         ReadOnly() : Property(
00063                 "ReadOnly",
00064                 "Property to get/set the read-only setting for the Editbox.  Value is either \"True\" or \"False\".",
00065                 "False")
00066         {}
00067 
00068         String  get(const PropertyReceiver* receiver) const;
00069         void    set(PropertyReceiver* receiver, const String& value);
00070 };
00071 
00072 
00084 class ValidationString : public Property
00085 {
00086 public:
00087         ValidationString() : Property(
00088                 "ValidationString",
00089                 "Property to get/set the validation string Editbox.  Value is a text string.",
00090                 ".*")
00091         {}
00092 
00093         String  get(const PropertyReceiver* receiver) const;
00094         void    set(PropertyReceiver* receiver, const String& value);
00095 };
00096 
00097 
00109 class CaratIndex : public Property
00110 {
00111 public:
00112         CaratIndex() : Property(
00113                 "CaratIndex",
00114                 "Property to get/set the current carat index.  Value is \"[uint]\".",
00115                 "0")
00116         {}
00117 
00118         String  get(const PropertyReceiver* receiver) const;
00119         void    set(PropertyReceiver* receiver, const String& value);
00120 };
00121 
00122 
00134 class EditSelectionStart : public Property
00135 {
00136 public:
00137         EditSelectionStart() : Property(
00138                 "EditSelectionStart",
00139                 "Property to get/set the zero based index of the selection start position within the text.  Value is \"[uint]\".",
00140                 "0")
00141         {}
00142 
00143         String  get(const PropertyReceiver* receiver) const;
00144         void    set(PropertyReceiver* receiver, const String& value);
00145 };
00146 
00147 
00159 class EditSelectionLength : public Property
00160 {
00161 public:
00162         EditSelectionLength() : Property(
00163                 "EditSelectionLength",
00164                 "Property to get/set the length of the selection (as a count of the number of code points selected).  Value is \"[uint]\".",
00165                 "0")
00166         {}
00167 
00168         String  get(const PropertyReceiver* receiver) const;
00169         void    set(PropertyReceiver* receiver, const String& value);
00170 };
00171 
00172 
00184 class MaxEditTextLength : public Property
00185 {
00186 public:
00187         MaxEditTextLength() : Property(
00188                 "MaxEditTextLength",
00189                 "Property to get/set the the maximum allowed text length (as a count of code points).  Value is \"[uint]\".",
00190                 "1073741824")
00191         {}
00192 
00193         String  get(const PropertyReceiver* receiver) const;
00194         void    set(PropertyReceiver* receiver, const String& value);
00195 };
00196 
00197 
00210 class SortList : public Property
00211 {
00212 public:
00213         SortList() : Property(
00214                 "SortList",
00215                 "Property to get/set the sort setting of the list box.  Value is either \"True\" or \"False\".",
00216                 "False")
00217         {}
00218 
00219         String  get(const PropertyReceiver* receiver) const;
00220         void    set(PropertyReceiver* receiver, const String& value);
00221 };
00222 
00223 
00236 class ForceVertScrollbar : public Property
00237 {
00238 public:
00239         ForceVertScrollbar() : Property(
00240                 "ForceVertScrollbar",
00241                 "Property to get/set the 'always show' setting for the vertical scroll bar of the list box.  Value is either \"True\" or \"False\".",
00242                 "False")
00243         {}
00244 
00245         String  get(const PropertyReceiver* receiver) const;
00246         void    set(PropertyReceiver* receiver, const String& value);
00247 };
00248 
00249 
00262 class ForceHorzScrollbar : public Property
00263 {
00264 public:
00265         ForceHorzScrollbar() : Property(
00266                 "ForceHorzScrollbar",
00267                 "Property to get/set the 'always show' setting for the horizontal scroll bar of the list box.  Value is either \"True\" or \"False\".",
00268                 "False")
00269         {}
00270 
00271         String  get(const PropertyReceiver* receiver) const;
00272         void    set(PropertyReceiver* receiver, const String& value);
00273 };
00274 
00275 
00288 class SingleClickMode : public Property
00289 {
00290 public:
00291         SingleClickMode() : Property(
00292                 "SingleClickMode",
00293                 "Property to get/set the 'single click mode' setting for the combo box.  Value is either \"True\" or \"False\".",
00294                 "False")
00295         {}
00296 
00297         String  get(const PropertyReceiver* receiver) const;
00298         void    set(PropertyReceiver* receiver, const String& value);
00299 };
00300 
00301 
00302 } // End of  ComboboxProperties namespace section
00303 
00304 } // End of  CEGUI namespace section
00305 
00306 
00307 #endif  // end of guard _CEGUIComboboxProperties_h_

Generated on Sun Nov 5 14:35:28 2006 for Crazy Eddies GUI System by  doxygen 1.4.7