CEGUIMultiLineEditboxProperties.h

00001 /***********************************************************************
00002         filename:       CEGUIMultiLineEditboxProperties.h
00003         created:        10/7/2004
00004         author:         Paul D Turner
00005         
00006         purpose:        Interface to properties for the MultiLineEditbox 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 _CEGUIMultiLineEditboxProperties_h_
00031 #define _CEGUIMultiLineEditboxProperties_h_
00032 
00033 #include "CEGUIProperty.h"
00034 
00035 
00036 // Start of CEGUI namespace section
00037 namespace CEGUI
00038 {
00039 
00040 // Start of MultiLineEditboxProperties namespace section
00045 namespace MultiLineEditboxProperties
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 edit box.  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 
00085 class WordWrap : public Property
00086 {
00087 public:
00088         WordWrap() : Property(
00089                 "WordWrap",
00090                 "Property to get/set the word-wrap setting of the edit box.  Value is either \"True\" or \"False\".",
00091                 "True")
00092         {}
00093 
00094         String  get(const PropertyReceiver* receiver) const;
00095         void    set(PropertyReceiver* receiver, const String& value);
00096 };
00097 
00098 
00110 class CaratIndex : public Property
00111 {
00112 public:
00113         CaratIndex() : Property(
00114                 "CaratIndex",
00115                 "Property to get/set the current carat index.  Value is \"[uint]\".",
00116                 "0")
00117         {}
00118 
00119         String  get(const PropertyReceiver* receiver) const;
00120         void    set(PropertyReceiver* receiver, const String& value);
00121 };
00122 
00123 
00135 class SelectionStart : public Property
00136 {
00137 public:
00138         SelectionStart() : Property(
00139                 "SelectionStart",
00140                 "Property to get/set the zero based index of the selection start position within the text.  Value is \"[uint]\".",
00141                 "0")
00142         {}
00143 
00144         String  get(const PropertyReceiver* receiver) const;
00145         void    set(PropertyReceiver* receiver, const String& value);
00146 };
00147 
00148 
00160 class SelectionLength : public Property
00161 {
00162 public:
00163         SelectionLength() : Property(
00164                 "SelectionLength",
00165                 "Property to get/set the length of the selection (as a count of the number of code points selected).  Value is \"[uint]\".",
00166                 "0")
00167         {}
00168 
00169         String  get(const PropertyReceiver* receiver) const;
00170         void    set(PropertyReceiver* receiver, const String& value);
00171 };
00172 
00173 
00185 class MaxTextLength : public Property
00186 {
00187 public:
00188         MaxTextLength() : Property(
00189                 "MaxTextLength",
00190                 "Property to get/set the the maximum allowed text length (as a count of code points).  Value is \"[uint]\".",
00191                 "1073741824")
00192         {}
00193 
00194         String  get(const PropertyReceiver* receiver) const;
00195         void    set(PropertyReceiver* receiver, const String& value);
00196 };
00197 
00198 
00208 class SelectionBrushImage : public Property
00209 {
00210 public:
00211     SelectionBrushImage() : Property(
00212         "SelectionBrushImage",
00213         "Property to get/set the selection brush image for the editbox.  Value should be \"set:[imageset name] image:[image name]\".",
00214         "")
00215     {}
00216 
00217     String   get(const PropertyReceiver* receiver) const;
00218     void   set(PropertyReceiver* receiver, const String& value);
00219 };
00220 
00221 
00222 } // End of  MultiLineEditboxProperties namespace section
00223 
00224 } // End of  CEGUI namespace section
00225 
00226 
00227 #endif  // end of guard _CEGUIMultiLineEditboxProperties_h_

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