/usr/include/CEGUI/elements/CEGUIEditboxProperties.h is in libcegui-mk2-dev 0.7.6-3.3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 | /***********************************************************************
filename: CEGUIEditboxProperties.h
created: 9/7/2004
author: Paul D Turner
purpose: Interface to Properties for Editbox class
*************************************************************************/
/***************************************************************************
* Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
***************************************************************************/
#ifndef _CEGUIEditboxProperties_h_
#define _CEGUIEditboxProperties_h_
#include "../CEGUIProperty.h"
// Start of CEGUI namespace section
namespace CEGUI
{
// Start of EditboxProperties namespace section
/*!
\brief
Namespace containing all classes that make up the properties interface for the Editbox class
*/
namespace EditboxProperties
{
/*!
\brief
Property to access the read-only setting of the edit box.
This property offers access to the read-only setting for the Editbox object.
\par Usage:
- Name: ReadOnly
- Format: "[text]"
\par Where [Text] is:
- "True" to indicate the edit box is read-only.
- "False" to indicate the edit box is not read-only (text may be edited by user).
*/
class ReadOnly : public Property
{
public:
ReadOnly() : Property(
"ReadOnly",
"Property to get/set the read-only setting for the Editbox. Value is either \"True\" or \"False\".",
"False")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the mask text setting of the edit box.
This property offers access to the mask text setting for the Editbox object.
\par Usage:
- Name: MaskText
- Format: "[text]"
\par Where [Text] is:
- "True" to indicate the text should be masked.
- "False" to indicate the text should not be masked.
*/
class MaskText : public Property
{
public:
MaskText() : Property(
"MaskText",
"Property to get/set the mask text setting for the Editbox. Value is either \"True\" or \"False\".",
"False")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the mask text setting of the edit box.
This property offers access to the mask text setting for the Editbox object.
\par Usage:
- Name: MaskCodepoint
- Format: "[uint]"
\par Where:
- [uint] is the Unicode utf32 value of the codepoint used for masking text.
*/
class MaskCodepoint : public Property
{
public:
MaskCodepoint() : Property(
"MaskCodepoint",
"Property to get/set the utf32 codepoint value used for masking text. Value is \"[uint]\".",
"42")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the string used for regular expression validation of the edit box text.
\par Usage:
- Name: ValidationString
- Format: "[text]"
\par Where:
- [Text] is the string used for validating text entry.
*/
class ValidationString : public Property
{
public:
ValidationString() : Property(
"ValidationString",
"Property to get/set the validation string Editbox. Value is a text string.",
".*")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the current carat index.
\par Usage:
- Name: CaratIndex
- Format: "[uint]"
\par Where:
- [uint] is the zero based index of the carat position within the text.
*/
class CaratIndex : public Property
{
public:
CaratIndex() : Property(
"CaratIndex",
"Property to get/set the current carat index. Value is \"[uint]\".",
"0")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the current selection start index.
\par Usage:
- Name: SelectionStart
- Format: "[uint]"
\par Where:
- [uint] is the zero based index of the selection start position within the text.
*/
class SelectionStart : public Property
{
public:
SelectionStart() : Property(
"SelectionStart",
"Property to get/set the zero based index of the selection start position within the text. Value is \"[uint]\".",
"0")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the current selection length.
\par Usage:
- Name: SelectionLength
- Format: "[uint]"
\par Where:
- [uint] is the length of the selection (as a count of the number of code points selected).
*/
class SelectionLength : public Property
{
public:
SelectionLength() : Property(
"SelectionLength",
"Property to get/set the length of the selection (as a count of the number of code points selected). Value is \"[uint]\".",
"0")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the maximum text length for the edit box.
\par Usage:
- Name: MaxTextLength
- Format: "[uint]"
\par Where:
- [uint] is the maximum allowed text length (as a count of code points).
*/
class MaxTextLength : public Property
{
public:
MaxTextLength() : Property(
"MaxTextLength",
"Property to get/set the the maximum allowed text length (as a count of code points). Value is \"[uint]\".",
"1073741824")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the normal, unselected, text colour used for rendering text.
\par Usage:
- Name: NormalTextColour
- Format: "aarrggbb".
\par Where:
- aarrggbb is the ARGB colour value to be used.
*/
class NormalTextColour : public Property
{
public:
NormalTextColour() : Property(
"NormalTextColour",
"Property to get/set the normal, unselected, text colour used for rendering text. Value is \"aarrggbb\" (hex).",
"FFFFFFFF")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the colour used for rendering text within the selection area.
\par Usage:
- Name: SelectedTextColour
- Format: "aarrggbb".
\par Where:
- aarrggbb is the ARGB colour value to be used.
*/
class SelectedTextColour : public Property
{
public:
SelectedTextColour() : Property(
"SelectedTextColour",
"Property to get/set the colour used for rendering text within the selection area. Value is \"aarrggbb\" (hex).",
"FF000000")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the colour used for rendering the selection highlight when the edit box is active.
\par Usage:
- Name: ActiveSelectionColour
- Format: "aarrggbb".
\par Where:
- aarrggbb is the ARGB colour value to be used.
*/
class ActiveSelectionColour : public Property
{
public:
ActiveSelectionColour() : Property(
"ActiveSelectionColour",
"Property to get/set the colour used for rendering the selection highlight when the edit box is active. Value is \"aarrggbb\" (hex).",
"FF6060FF")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the colour used for rendering the selection highlight when the edit box is inactive.
\par Usage:
- Name: InactiveSelectionColour
- Format: "aarrggbb".
\par Where:
- aarrggbb is the ARGB colour value to be used.
*/
class InactiveSelectionColour : public Property
{
public:
InactiveSelectionColour() : Property(
"InactiveSelectionColour",
"Property to get/set the colour used for rendering the selection highlight when the edit box is inactive. Value is \"aarrggbb\" (hex).",
"FF808080")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
} // End of EditboxProperties namespace section
} // End of CEGUI namespace section
#endif // end of guard _CEGUIEditboxProperties_h_
|