/usr/include/CEGUI/elements/CEGUIMultiColumnListProperties.h is in libcegui-mk2-dev 0.7.5-8.
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 360 361 362 363 364 365 366 | /***********************************************************************
filename: CEGUIMultiColumnListProperties.h
created: 11/7/2004
author: Paul D Turner
purpose: Interface to multi-column list properties.
*************************************************************************/
/***************************************************************************
* 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 _CEGUIMultiColumnListProperties_h_
#define _CEGUIMultiColumnListProperties_h_
#include "../CEGUIProperty.h"
// Start of CEGUI namespace section
namespace CEGUI
{
// Start of MultiColumnListProperties namespace section
/*!
\brief
Namespace containing all classes that make up the properties interface for the MultiColumnList class
*/
namespace MultiColumnListProperties
{
/*!
\brief
Property to access the setting for user sizing of the column headers.
\par Usage:
- Name: ColumnsSizable
- Format: "[text]"
\par Where [Text] is:
- "True" to indicate the column headers can be sized by the user.
- "False" to indicate the column headers can not be sized by the user.
*/
class ColumnsSizable : public Property
{
public:
ColumnsSizable() : Property(
"ColumnsSizable",
"Property to get/set the setting for user sizing of the column headers. Value is either \"True\" or \"False\".",
"True")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the setting for user moving of the column headers.
\par Usage:
- Name: ColumnsMovable
- Format: "[text]"
\par Where [Text] is:
- "True" to indicate the column headers can be moved by the user.
- "False" to indicate the column headers can not be moved by the user.
*/
class ColumnsMovable : public Property
{
public:
ColumnsMovable() : Property(
"ColumnsMovable",
"Property to get/set the setting for user moving of the column headers. Value is either \"True\" or \"False\".",
"True")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the setting for user modification of the sort column & direction.
\par Usage:
- Name: SortSettingEnabled
- Format: "[text]"
\par Where [Text] is:
- "True" to indicate the user may modify the sort column and direction by clicking the header segments.
- "False" to indicate the user may not modify the sort column or direction.
*/
class SortSettingEnabled : public Property
{
public:
SortSettingEnabled() : Property(
"SortSettingEnabled",
"Property to get/set the setting for for user modification of the sort column & direction. Value is either \"True\" or \"False\".",
"True")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the sort direction setting of the list.
\par Usage:
- Name: SortDirection
- Format: "[text]"
\par Where [Text] is one of:
- "Ascending"
- "Descending"
- "None"
*/
class SortDirection : public Property
{
public:
SortDirection() : Property(
"SortDirection",
"Property to get/set the sort direction setting of the list. Value is the text of one of the SortDirection enumerated value names.",
"None")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the current sort column (via ID code).
\par Usage:
- Name: SortColumnID
- Format: "[uint]".
\par Where:
- [uint] is any unsigned integer value.
*/
class SortColumnID : public Property
{
public:
SortColumnID() : Property(
"SortColumnID",
"Property to get/set the current sort column (via ID code). Value is an unsigned integer number.",
"0", false)
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the nominated selection column (via ID).
\par Usage:
- Name: NominatedSelectionColumnID
- Format: "[uint]".
\par Where:
- [uint] is any unsigned integer value representing the ID code of the column to be used.
*/
class NominatedSelectionColumnID : public Property
{
public:
NominatedSelectionColumnID() : Property(
"NominatedSelectionColumnID",
"Property to get/set the nominated selection column (via ID). Value is an unsigned integer number.",
"0")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the nominated selection row.
\par Usage:
- Name: NominatedSelectionRow
- Format: "[uint]".
\par Where:
- [uint] is any unsigned integer value representing the index of the row to be used.
*/
class NominatedSelectionRow : public Property
{
public:
NominatedSelectionRow() : Property(
"NominatedSelectionRow",
"Property to get/set the nominated selection row. Value is an unsigned integer number.",
"0")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the 'always show' setting for the vertical scroll bar of the list box.
\par Usage:
- Name: ForceVertScrollbar
- Format: "[text]"
\par Where [Text] is:
- "True" to indicate that the vertical scroll bar will always be shown.
- "False" to indicate that the vertical scroll bar will only be shown when it is needed.
*/
class ForceVertScrollbar : public Property
{
public:
ForceVertScrollbar() : Property(
"ForceVertScrollbar",
"Property to get/set the 'always show' setting for the vertical scroll bar of the list box. 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 'always show' setting for the horizontal scroll bar of the list box.
\par Usage:
- Name: ForceHorzScrollbar
- Format: "[text]"
\par Where [Text] is:
- "True" to indicate that the horizontal scroll bar will always be shown.
- "False" to indicate that the horizontal scroll bar will only be shown when it is needed.
*/
class ForceHorzScrollbar : public Property
{
public:
ForceHorzScrollbar() : Property(
"ForceHorzScrollbar",
"Property to get/set the 'always show' setting for the horizontal scroll bar of the list box. 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 selection mode setting of the list.
\par Usage:
- Name: SelectionMode
- Format: "[text]"
\par Where [Text] is one of:
- "RowSingle"
- "RowMultiple"
- "CellSingle"
- "CellMultiple"
- "NominatedColumnSingle"
- "NominatedColumnMultiple"
- "ColumnSingle"
- "ColumnMultiple"
- "NominatedRowSingle"
- "NominatedRowMultiple"
*/
class SelectionMode : public Property
{
public:
SelectionMode() : Property(
"SelectionMode",
"Property to get/set the selection mode setting of the list. Value is the text of one of the SelectionMode enumerated value names.",
"RowSingle")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access a column.
\par Usage:
- Name: ColumnHeader
- Format: "text:[caption] width:{s,o} id:[uint]"
\par where:
- [caption] is the column header caption text.
- [{s,o}] is a UDim specification.
- [uint] is the unique ID for the column.
*/
class ColumnHeader : public Property
{
public:
ColumnHeader() : Property(
"ColumnHeader",
"Property to set up a column (there is no getter for this property)",
"", false)
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the number of rows in the list (read-only)
\par Usage:
- Name: RowCount
- Format: "" (property is read-only).
*/
class RowCount : public Property
{
public:
RowCount() : Property(
"RowCount",
"Property to access the number of rows in the list (read only)",
"", false)
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
} // End of MultiColumnListProperties namespace section
} // End of CEGUI namespace section
#endif // end of guard _CEGUIMultiColumnListProperties_h_
|