/usr/include/CEGUI/elements/CEGUIScrollablePaneProperties.h is in libcegui-mk2-dev 0.7.6-2ubuntu4.
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 | /***********************************************************************
filename: CEGUIScrollablePaneProperties.h
created: 3/3/2005
author: Paul D Turner
*************************************************************************/
/***************************************************************************
* 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 _CEGUIScrollablePaneProperties_h_
#define _CEGUIScrollablePaneProperties_h_
#include "../CEGUIProperty.h"
// Start of CEGUI namespace section
namespace CEGUI
{
// Start of ScrollablePaneProperties namespace section
/*!
\brief
Namespace containing all classes that make up the properties interface for the ScrollablePane class
*/
namespace ScrollablePaneProperties
{
/*!
\brief
Property to access the setting which controls whether the content pane is automatically
resized according to the size and position of attached content.
\par Usage:
- Name: ContentPaneAutoSized
- Format: "[text]"
\par Where [Text] is:
- "True" to indicate the pane should automatically resize itself.
- "False" to indicate the pane should not automatically resize itself.
*/
class ContentPaneAutoSized : public Property
{
public:
ContentPaneAutoSized() : Property(
"ContentPaneAutoSized",
"Property to get/set the setting which controls whether the content pane will auto-size itself. 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 current content pane area rectangle (as window relative pixels).
\par Usage:
- Name: ContentArea
- Format: "l:[float] t:[float] r:[float] b:[float]".
\par Where:
- l:[float] specifies the position of the left edge of the area as a floating point number.
- t:[float] specifies the position of the top edge of the area as a floating point number.
- r:[float] specifies the position of the right edge of the area as a floating point number.
- b:[float] specifies the position of the bottom edge of the area as a floating point number.
*/
class ContentArea : public Property
{
public:
ContentArea() : Property(
"ContentArea",
"Property to get/set the current content area rectangle of the content pane. Value is \"l:[float] t:[float] r:[float] b:[float]\" (where l is left, t is top, r is right, and b is bottom).",
"l:0.000000 t:0.000000 r:0.000000 b:0.000000")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the setting which controls whether the vertical scroll bar will
always be displayed, or only displayed when it is required.
\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 setting which controls whether the vertical scroll bar is aways shown. 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 setting which controls whether the horizontal scroll bar will
always be displayed, or only displayed when it is required.
\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 setting which controls whether the horizontal scroll bar is aways shown. 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 step size for the horizontal Scrollbar.
\par Usage:
- Name: HorzStepSize
- Format: "[float]".
\par Where:
- [float] specifies the size of the increase/decrease button step for the horizontal scrollbar (as a fraction of 1 page).
*/
class HorzStepSize : public Property
{
public:
HorzStepSize() : Property(
"HorzStepSize",
"Property to get/set the step size for the horizontal Scrollbar. Value is a float.",
"0.100000")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the overlap size for the horizontal Scrollbar.
\par Usage:
- Name: HorzOverlapSize
- Format: "[float]".
\par Where:
- [float] specifies the size of the per-page overlap (as a fraction of one page).
*/
class HorzOverlapSize : public Property
{
public:
HorzOverlapSize() : Property(
"HorzOverlapSize",
"Property to get/set the overlap size for the horizontal Scrollbar. Value is a float.",
"0.010000")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the scroll position of the horizontal Scrollbar.
\par Usage:
- Name: HorzScrollPosition
- Format: "[float]".
\par Where:
- [float] specifies the current scroll position / value of the horizontal Scrollbar (as a fraction of the whole).
*/
class HorzScrollPosition : public Property
{
public:
HorzScrollPosition() : Property(
"HorzScrollPosition",
"Property to get/set the scroll position of the horizontal Scrollbar as a fraction. Value is a float.",
"0.000000")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the step size for the vertical Scrollbar.
\par Usage:
- Name: VertStepSize
- Format: "[float]".
\par Where:
- [float] specifies the size of the increase/decrease button step for the vertical scrollbar (as a fraction of 1 page).
*/
class VertStepSize : public Property
{
public:
VertStepSize() : Property(
"VertStepSize",
"Property to get/set the step size for the vertical Scrollbar. Value is a float.",
"0.100000")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the overlap size for the vertical Scrollbar.
\par Usage:
- Name: VertOverlapSize
- Format: "[float]".
\par Where:
- [float] specifies the size of the per-page overlap (as a fraction of one page).
*/
class VertOverlapSize : public Property
{
public:
VertOverlapSize() : Property(
"VertOverlapSize",
"Property to get/set the overlap size for the vertical Scrollbar. Value is a float.",
"0.010000")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
/*!
\brief
Property to access the scroll position of the vertical Scrollbar.
\par Usage:
- Name: VertScrollPosition
- Format: "[float]".
\par Where:
- [float] specifies the current scroll position / value of the vertical Scrollbar (as a fraction of the whole).
*/
class VertScrollPosition : public Property
{
public:
VertScrollPosition() : Property(
"VertScrollPosition",
"Property to get/set the scroll position of the vertical Scrollbar as a fraction. Value is a float.",
"0.000000")
{}
String get(const PropertyReceiver* receiver) const;
void set(PropertyReceiver* receiver, const String& value);
};
} // End of ScrollablePaneProperties namespace section
} // End of CEGUI namespace section
#endif // end of guard _CEGUIScrollablePaneProperties_h_
|