[657] | 1 | /************************************************************************
|
---|
| 2 | filename: CEGUIWindowProperties.h
|
---|
| 3 | created: 5/7/2004
|
---|
| 4 | author: Paul D Turner
|
---|
| 5 |
|
---|
| 6 | purpose: Interface to available window base class properties
|
---|
| 7 | *************************************************************************/
|
---|
| 8 | /*************************************************************************
|
---|
| 9 | Crazy Eddie's GUI System (http://www.cegui.org.uk)
|
---|
| 10 | Copyright (C)2004 - 2005 Paul D Turner (paul@cegui.org.uk)
|
---|
| 11 |
|
---|
| 12 | This library is free software; you can redistribute it and/or
|
---|
| 13 | modify it under the terms of the GNU Lesser General Public
|
---|
| 14 | License as published by the Free Software Foundation; either
|
---|
| 15 | version 2.1 of the License, or (at your option) any later version.
|
---|
| 16 |
|
---|
| 17 | This library is distributed in the hope that it will be useful,
|
---|
| 18 | but WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
| 19 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
---|
| 20 | Lesser General Public License for more details.
|
---|
| 21 |
|
---|
| 22 | You should have received a copy of the GNU Lesser General Public
|
---|
| 23 | License along with this library; if not, write to the Free Software
|
---|
| 24 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
---|
| 25 | *************************************************************************/
|
---|
| 26 | #ifndef _CEGUIWindowProperties_h_
|
---|
| 27 | #define _CEGUIWindowProperties_h_
|
---|
| 28 |
|
---|
| 29 | #include "CEGUIProperty.h"
|
---|
| 30 |
|
---|
| 31 |
|
---|
| 32 | // Start of CEGUI namespace section
|
---|
| 33 | namespace CEGUI
|
---|
| 34 | {
|
---|
| 35 |
|
---|
| 36 | // Start of WindowProperties namespace section
|
---|
| 37 | /*!
|
---|
| 38 | \brief
|
---|
| 39 | Namespace containing all classes that make up the properties interface for the Window base class
|
---|
| 40 | */
|
---|
| 41 | namespace WindowProperties
|
---|
| 42 | {
|
---|
| 43 | /*!
|
---|
| 44 | \brief
|
---|
| 45 | Property to access minimum window size.
|
---|
| 46 |
|
---|
| 47 | This property offers access to the minimum size setting for the window, using screen relative metrics.
|
---|
| 48 |
|
---|
| 49 | \par Usage:
|
---|
| 50 | - Name: RelativeMinSize
|
---|
| 51 | - Format: "w:[float] h:[float]".
|
---|
| 52 |
|
---|
| 53 | \par Where:
|
---|
| 54 | - w:[float] specifies the minimum width as a floating point number.
|
---|
| 55 | - h:[float] specifies the minimum height as a floating point number.
|
---|
| 56 | */
|
---|
| 57 | class RelativeMinSize : public Property
|
---|
| 58 | {
|
---|
| 59 | public:
|
---|
| 60 | RelativeMinSize() : Property(
|
---|
| 61 | "RelativeMinSize",
|
---|
| 62 | "Property to get/set the minimum size for the Window. Value is \"w:[float] h:[float]\" using relative metrics (this setting is relative to the display size).",
|
---|
| 63 | "w:0.000000 h:0.000000")
|
---|
| 64 | {}
|
---|
| 65 |
|
---|
| 66 | String get(const PropertyReceiver* receiver) const;
|
---|
| 67 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 68 | };
|
---|
| 69 |
|
---|
| 70 |
|
---|
| 71 | /*!
|
---|
| 72 | \brief
|
---|
| 73 | Property to access maximum window size.
|
---|
| 74 |
|
---|
| 75 | This property offers access to the maximum size setting for the window, using screen relative metrics.
|
---|
| 76 |
|
---|
| 77 | \par Usage:
|
---|
| 78 | - Name: RelativeMaxSize
|
---|
| 79 | - Format: "w:[float] h:[float]".
|
---|
| 80 |
|
---|
| 81 | \par Where:
|
---|
| 82 | - w:[float] specifies the maximum width as a floating point number.
|
---|
| 83 | - h:[float] specifies the maximum height as a floating point number.
|
---|
| 84 | */
|
---|
| 85 | class RelativeMaxSize : public Property
|
---|
| 86 | {
|
---|
| 87 | public:
|
---|
| 88 | RelativeMaxSize() : Property(
|
---|
| 89 | "RelativeMaxSize",
|
---|
| 90 | "Property to get/set the maximum size for the Window. Value is \"w:[float] h:[float]\" using relative metrics (this setting is relative to the display size).",
|
---|
| 91 | "w:1.000000 h:1.000000")
|
---|
| 92 | {}
|
---|
| 93 |
|
---|
| 94 | String get(const PropertyReceiver* receiver) const;
|
---|
| 95 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 96 | };
|
---|
| 97 |
|
---|
| 98 |
|
---|
| 99 | /*!
|
---|
| 100 | \brief
|
---|
| 101 | Property to access minimum window size.
|
---|
| 102 |
|
---|
| 103 | This property offers access to the minimum size setting for the window, using absolute screen pixel metrics.
|
---|
| 104 |
|
---|
| 105 | \par Usage:
|
---|
| 106 | - Name: AbsoluteMinSize
|
---|
| 107 | - Format: "w:[float] h:[float]".
|
---|
| 108 |
|
---|
| 109 | \par Where:
|
---|
| 110 | - w:[float] specifies the minimum width as a floating point number.
|
---|
| 111 | - h:[float] specifies the minimum height as a floating point number.
|
---|
| 112 | */
|
---|
| 113 | class AbsoluteMinSize : public Property
|
---|
| 114 | {
|
---|
| 115 | public:
|
---|
| 116 | AbsoluteMinSize() : Property(
|
---|
| 117 | "AbsoluteMinSize",
|
---|
| 118 | "Property to get/set the minimum size for the Window. Value is \"w:[float] h:[float]\" using absolute (pixel) metrics.",
|
---|
| 119 | "w:0.000000 h:0.000000")
|
---|
| 120 | {}
|
---|
| 121 |
|
---|
| 122 | String get(const PropertyReceiver* receiver) const;
|
---|
| 123 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 124 | };
|
---|
| 125 |
|
---|
| 126 |
|
---|
| 127 | /*!
|
---|
| 128 | \brief
|
---|
| 129 | Property to access maximum window size.
|
---|
| 130 |
|
---|
| 131 | This property offers access to the maximum size setting for the window, using absolute screen pixel metrics.
|
---|
| 132 |
|
---|
| 133 | \par Usage:
|
---|
| 134 | - Name: AbsoluteMaxSize
|
---|
| 135 | - Format: "w:[float] h:[float]".
|
---|
| 136 |
|
---|
| 137 | \par Where:
|
---|
| 138 | - w:[float] specifies the maximum width as a floating point number.
|
---|
| 139 | - h:[float] specifies the maximum height as a floating point number.
|
---|
| 140 | */
|
---|
| 141 | class AbsoluteMaxSize : public Property
|
---|
| 142 | {
|
---|
| 143 | public:
|
---|
| 144 | AbsoluteMaxSize() : Property(
|
---|
| 145 | "AbsoluteMaxSize",
|
---|
| 146 | "Property to get/set the maximum size for the Window. Value is \"w:[float] h:[float]\" using absolute (pixel) metrics.",
|
---|
| 147 | "")
|
---|
| 148 | {}
|
---|
| 149 |
|
---|
| 150 | String get(const PropertyReceiver* receiver) const;
|
---|
| 151 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 152 |
|
---|
| 153 | // default depends upon current size of display.
|
---|
| 154 | bool isDefault(const PropertyReceiver* receiver) const;
|
---|
| 155 | String getDefault(const PropertyReceiver* receiver) const;
|
---|
| 156 | };
|
---|
| 157 |
|
---|
| 158 |
|
---|
| 159 | /*!
|
---|
| 160 | \brief
|
---|
| 161 | Property to access the metrics mode setting.
|
---|
| 162 |
|
---|
| 163 | This property offers access to the metrics mode setting for the window.
|
---|
| 164 |
|
---|
| 165 | \par Usage:
|
---|
| 166 | - Name: MetricsMode
|
---|
| 167 | - Format: "[text]".
|
---|
| 168 |
|
---|
| 169 | \par Where [text] is:
|
---|
| 170 | - "Relative" for the relative metrics mode.
|
---|
| 171 | - "Absolute" for the absolute metrics mode.
|
---|
| 172 | - "Inherited" if metrics should be inherited from the parent (only used with set method).
|
---|
| 173 | */
|
---|
| 174 | class MetricsMode : public Property
|
---|
| 175 | {
|
---|
| 176 | public:
|
---|
| 177 | MetricsMode() : Property(
|
---|
| 178 | "MetricsMode",
|
---|
| 179 | "Property to get/set the metrics mode for the Window. Value is \"Relative\", \"Absolute\", or \"Inherited\".",
|
---|
| 180 | "Relative")
|
---|
| 181 | {}
|
---|
| 182 |
|
---|
| 183 | String get(const PropertyReceiver* receiver) const;
|
---|
| 184 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 185 | };
|
---|
| 186 |
|
---|
| 187 |
|
---|
| 188 | /*!
|
---|
| 189 | \brief
|
---|
| 190 | Property to access window ID field.
|
---|
| 191 |
|
---|
| 192 | This property offers access to the client specified ID for the window.
|
---|
| 193 |
|
---|
| 194 | \par Usage:
|
---|
| 195 | - Name: ID
|
---|
| 196 | - Format: "[uint]".
|
---|
| 197 |
|
---|
| 198 | \par Where:
|
---|
| 199 | - [uint] is any unsigned integer value.
|
---|
| 200 | */
|
---|
| 201 | class ID : public Property
|
---|
| 202 | {
|
---|
| 203 | public:
|
---|
| 204 | ID() : Property(
|
---|
| 205 | "ID",
|
---|
| 206 | "Property to get/set the ID value of the Window. Value is an unsigned integer number.",
|
---|
| 207 | "0")
|
---|
| 208 | {}
|
---|
| 209 |
|
---|
| 210 | String get(const PropertyReceiver* receiver) const;
|
---|
| 211 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 212 | };
|
---|
| 213 |
|
---|
| 214 |
|
---|
| 215 | /*!
|
---|
| 216 | \brief
|
---|
| 217 | Property to access window alpha setting.
|
---|
| 218 |
|
---|
| 219 | This property offers access to the alpha-blend setting for the window.
|
---|
| 220 |
|
---|
| 221 | \par Usage:
|
---|
| 222 | - Name: Alpha
|
---|
| 223 | - Format: "[float]".
|
---|
| 224 |
|
---|
| 225 | \par Where:
|
---|
| 226 | - [float] is a floating point number between 0.0 and 1.0.
|
---|
| 227 | */
|
---|
| 228 | class Alpha : public Property
|
---|
| 229 | {
|
---|
| 230 | public:
|
---|
| 231 | Alpha() : Property(
|
---|
| 232 | "Alpha",
|
---|
| 233 | "Property to get/set the alpha value of the Window. Value is floating point number.",
|
---|
| 234 | "1.000000")
|
---|
| 235 | {}
|
---|
| 236 |
|
---|
| 237 | String get(const PropertyReceiver* receiver) const;
|
---|
| 238 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 239 | };
|
---|
| 240 |
|
---|
| 241 |
|
---|
| 242 | /*!
|
---|
| 243 | \brief
|
---|
| 244 | Property to access window Font setting.
|
---|
| 245 |
|
---|
| 246 | This property offers access to the current Font setting for the window.
|
---|
| 247 |
|
---|
| 248 | \par Usage:
|
---|
| 249 | - Name: Font
|
---|
| 250 | - Format: "[text]".
|
---|
| 251 |
|
---|
| 252 | \par Where:
|
---|
| 253 | - [text] is the name of the Font to assign for this window. The Font specified must already be loaded.
|
---|
| 254 | */
|
---|
| 255 | class Font : public Property
|
---|
| 256 | {
|
---|
| 257 | public:
|
---|
| 258 | Font() : Property(
|
---|
| 259 | "Font",
|
---|
| 260 | "Property to get/set the font for the Window. Value is the name of the font to use (must be loaded already).",
|
---|
| 261 | "")
|
---|
| 262 | {}
|
---|
| 263 |
|
---|
| 264 | String get(const PropertyReceiver* receiver) const;
|
---|
| 265 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 266 | };
|
---|
| 267 |
|
---|
| 268 |
|
---|
| 269 | /*!
|
---|
| 270 | \brief
|
---|
| 271 | Property to access window text setting.
|
---|
| 272 |
|
---|
| 273 | This property offers access to the current text for the window.
|
---|
| 274 |
|
---|
| 275 | \par Usage:
|
---|
| 276 | - Name: Text
|
---|
| 277 | - Format: "[text]".
|
---|
| 278 |
|
---|
| 279 | \par Where:
|
---|
| 280 | - [text] is the name of the Font to assign for this window. The Font specified must already be loaded.
|
---|
| 281 | */
|
---|
| 282 | class Text : public Property
|
---|
| 283 | {
|
---|
| 284 | public:
|
---|
| 285 | Text() : Property(
|
---|
| 286 | "Text",
|
---|
| 287 | "Property to get/set the text / caption for the Window. Value is the text string to use.",
|
---|
| 288 | "")
|
---|
| 289 | {}
|
---|
| 290 |
|
---|
| 291 | String get(const PropertyReceiver* receiver) const;
|
---|
| 292 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 293 | };
|
---|
| 294 |
|
---|
| 295 |
|
---|
| 296 | /*!
|
---|
| 297 | \brief
|
---|
| 298 | Property to access window mouse cursor setting.
|
---|
| 299 |
|
---|
| 300 | This property offers access to the current mouse cursor image for the window.
|
---|
| 301 |
|
---|
| 302 | \par Usage:
|
---|
| 303 | - Name: MouseCursorImage
|
---|
| 304 | - Format: "set:[text] image:[text]".
|
---|
| 305 |
|
---|
| 306 | \par Where:
|
---|
| 307 | - set:[text] is the name of the Imageset containing the image. The Imageset name should not contain spaces. The Imageset specified must already be loaded.
|
---|
| 308 | - image:[text] is the name of the Image on the specified Imageset. The Image name should not contain spaces.
|
---|
| 309 | */
|
---|
| 310 | class MouseCursorImage : public Property
|
---|
| 311 | {
|
---|
| 312 | public:
|
---|
| 313 | MouseCursorImage() : Property(
|
---|
| 314 | "MouseCursorImage",
|
---|
| 315 | "Property to get/set the mouse cursor image for the Window. Value should be \"set:<imageset name> image:<image name>\".",
|
---|
| 316 | "")
|
---|
| 317 | {}
|
---|
| 318 |
|
---|
| 319 | String get(const PropertyReceiver* receiver) const;
|
---|
| 320 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 321 | };
|
---|
| 322 |
|
---|
| 323 |
|
---|
| 324 | /*!
|
---|
| 325 | \brief
|
---|
| 326 | Property to access window "clipped by parent" setting.
|
---|
| 327 |
|
---|
| 328 | This property offers access to the clipped by parent setting for the window.
|
---|
| 329 |
|
---|
| 330 | \par Usage:
|
---|
| 331 | - Name: ClippedByParent
|
---|
| 332 | - Format: "[text]".
|
---|
| 333 |
|
---|
| 334 | \par Where [Text] is:
|
---|
| 335 | - "True" to indicate the Window is clipped by it's parent.
|
---|
| 336 | - "False" to indicate the Window is not clipped by it's parent.
|
---|
| 337 | */
|
---|
| 338 | class ClippedByParent : public Property
|
---|
| 339 | {
|
---|
| 340 | public:
|
---|
| 341 | ClippedByParent() : Property(
|
---|
| 342 | "ClippedByParent",
|
---|
| 343 | "Property to get/set the 'clipped by parent' setting for the Window. Value is either \"True\" or \"False\".",
|
---|
| 344 | "True")
|
---|
| 345 | {}
|
---|
| 346 |
|
---|
| 347 | String get(const PropertyReceiver* receiver) const;
|
---|
| 348 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 349 | };
|
---|
| 350 |
|
---|
| 351 |
|
---|
| 352 | /*!
|
---|
| 353 | \brief
|
---|
| 354 | Property to access window "Inherits Alpha" setting.
|
---|
| 355 |
|
---|
| 356 | This property offers access to the inherits alpha setting for the window.
|
---|
| 357 |
|
---|
| 358 | \par Usage:
|
---|
| 359 | - Name: InheritsAlpha
|
---|
| 360 | - Format: "[text]".
|
---|
| 361 |
|
---|
| 362 | \par Where [Text] is:
|
---|
| 363 | - "True" to indicate the Window inherits alpha blend values from it's ancestors.
|
---|
| 364 | - "False" to indicate the Window does not inherit alpha blend values from it's ancestors.
|
---|
| 365 | */
|
---|
| 366 | class InheritsAlpha : public Property
|
---|
| 367 | {
|
---|
| 368 | public:
|
---|
| 369 | InheritsAlpha() : Property(
|
---|
| 370 | "InheritsAlpha",
|
---|
| 371 | "Property to get/set the 'inherits alpha' setting for the Window. Value is either \"True\" or \"False\".",
|
---|
| 372 | "True")
|
---|
| 373 | {}
|
---|
| 374 |
|
---|
| 375 | String get(const PropertyReceiver* receiver) const;
|
---|
| 376 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 377 | };
|
---|
| 378 |
|
---|
| 379 |
|
---|
| 380 | /*!
|
---|
| 381 | \brief
|
---|
| 382 | Property to access window "Always-On-Top" setting.
|
---|
| 383 |
|
---|
| 384 | This property offers access to the always on top / topmost setting for the window.
|
---|
| 385 |
|
---|
| 386 | \par Usage:
|
---|
| 387 | - Name: AlwaysOnTop
|
---|
| 388 | - Format: "[text]".
|
---|
| 389 |
|
---|
| 390 | \par Where [Text] is:
|
---|
| 391 | - "True" to indicate the Window is always on top, and appears above all other non-always on top Windows.
|
---|
| 392 | - "False" to indicate the Window is not always on top, and will appear below all other always on top Windows.
|
---|
| 393 | */
|
---|
| 394 | class AlwaysOnTop : public Property
|
---|
| 395 | {
|
---|
| 396 | public:
|
---|
| 397 | AlwaysOnTop() : Property(
|
---|
| 398 | "AlwaysOnTop",
|
---|
| 399 | "Property to get/set the 'always on top' setting for the Window. Value is either \"True\" or \"False\".",
|
---|
| 400 | "False")
|
---|
| 401 | {}
|
---|
| 402 |
|
---|
| 403 | String get(const PropertyReceiver* receiver) const;
|
---|
| 404 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 405 | };
|
---|
| 406 |
|
---|
| 407 |
|
---|
| 408 | /*!
|
---|
| 409 | \brief
|
---|
| 410 | Property to access window Disabled setting.
|
---|
| 411 |
|
---|
| 412 | This property offers access to the enabled / disabled setting for the window.
|
---|
| 413 |
|
---|
| 414 | \par Usage:
|
---|
| 415 | - Name: Disabled
|
---|
| 416 | - Format: "[text]".
|
---|
| 417 |
|
---|
| 418 | \par Where [Text] is:
|
---|
| 419 | - "True" to indicate the Window is disabled, and will normally receive no inputs from the user.
|
---|
| 420 | - "False" to indicate the Window is not disabled and will receive inputs from the user as normal.
|
---|
| 421 | */
|
---|
| 422 | class Disabled : public Property
|
---|
| 423 | {
|
---|
| 424 | public:
|
---|
| 425 | Disabled() : Property(
|
---|
| 426 | "Disabled",
|
---|
| 427 | "Property to get/set the 'disabled state' setting for the Window. Value is either \"True\" or \"False\".",
|
---|
| 428 | "False")
|
---|
| 429 | {}
|
---|
| 430 |
|
---|
| 431 | String get(const PropertyReceiver* receiver) const;
|
---|
| 432 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 433 | };
|
---|
| 434 |
|
---|
| 435 |
|
---|
| 436 | /*!
|
---|
| 437 | \brief
|
---|
| 438 | Property to access window Visible setting.
|
---|
| 439 |
|
---|
| 440 | This property offers access to the visible setting for the window.
|
---|
| 441 |
|
---|
| 442 | \par Usage:
|
---|
| 443 | - Name: Visible
|
---|
| 444 | - Format: "[text]".
|
---|
| 445 |
|
---|
| 446 | \par Where [Text] is:
|
---|
| 447 | - "True" to indicate the Window is visible.
|
---|
| 448 | - "False" to indicate the Window is not visible.
|
---|
| 449 | */
|
---|
| 450 | class Visible : public Property
|
---|
| 451 | {
|
---|
| 452 | public:
|
---|
| 453 | Visible() : Property(
|
---|
| 454 | "Visible",
|
---|
| 455 | "Property to get/set the 'visible state' setting for the Window. Value is either \"True\" or \"False\".",
|
---|
| 456 | "True")
|
---|
| 457 | {}
|
---|
| 458 |
|
---|
| 459 | String get(const PropertyReceiver* receiver) const;
|
---|
| 460 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 461 | };
|
---|
| 462 |
|
---|
| 463 |
|
---|
| 464 | /*!
|
---|
| 465 | \brief
|
---|
| 466 | Property to access window Restore Old Capture setting.
|
---|
| 467 |
|
---|
| 468 | This property offers access to the restore old capture setting for the window. This setting is of generally limited use, it
|
---|
| 469 | is primary purpose is for certain operations required for compound widgets.
|
---|
| 470 |
|
---|
| 471 | \par Usage:
|
---|
| 472 | - Name: RestoreOldCapture
|
---|
| 473 | - Format: "[text]".
|
---|
| 474 |
|
---|
| 475 | \par Where [Text] is:
|
---|
| 476 | - "True" to indicate the Window should restore any previous capture Window when it loses input capture.
|
---|
| 477 | - "False" to indicate the Window should not restore the old capture Window. This is the default behaviour.
|
---|
| 478 | */
|
---|
| 479 | class RestoreOldCapture : public Property
|
---|
| 480 | {
|
---|
| 481 | public:
|
---|
| 482 | RestoreOldCapture() : Property(
|
---|
| 483 | "RestoreOldCapture",
|
---|
| 484 | "Property to get/set the 'restore old capture' setting for the Window. Value is either \"True\" or \"False\".",
|
---|
| 485 | "False")
|
---|
| 486 | {}
|
---|
| 487 |
|
---|
| 488 | String get(const PropertyReceiver* receiver) const;
|
---|
| 489 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 490 | };
|
---|
| 491 |
|
---|
| 492 |
|
---|
| 493 | /*!
|
---|
| 494 | \brief
|
---|
| 495 | Property to access window Destroyed by Parent setting.
|
---|
| 496 |
|
---|
| 497 | This property offers access to the destryed by parent setting for the window.
|
---|
| 498 |
|
---|
| 499 | \par Usage:
|
---|
| 500 | - Name: DestroyedByParent
|
---|
| 501 | - Format: "[text]".
|
---|
| 502 |
|
---|
| 503 | \par Where [Text] is:
|
---|
| 504 | - "True" to indicate the Window should be automatically destroyed when it's parent Window is destroyed.
|
---|
| 505 | - "False" to indicate the Window should not be destroyed when it's parent Window is destroyed.
|
---|
| 506 | */
|
---|
| 507 | class DestroyedByParent : public Property
|
---|
| 508 | {
|
---|
| 509 | public:
|
---|
| 510 | DestroyedByParent() : Property(
|
---|
| 511 | "DestroyedByParent",
|
---|
| 512 | "Property to get/set the 'destroyed by parent' setting for the Window. Value is either \"True\" or \"False\".",
|
---|
| 513 | "True")
|
---|
| 514 | {}
|
---|
| 515 |
|
---|
| 516 | String get(const PropertyReceiver* receiver) const;
|
---|
| 517 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 518 | };
|
---|
| 519 |
|
---|
| 520 |
|
---|
| 521 | /*!
|
---|
| 522 | \brief
|
---|
| 523 | Property to access window width.
|
---|
| 524 |
|
---|
| 525 | This property offers access to the Width setting for the window, using the Windows active metrics mode.
|
---|
| 526 |
|
---|
| 527 | \par Usage:
|
---|
| 528 | - Name: Width
|
---|
| 529 | - Format: "[float]".
|
---|
| 530 |
|
---|
| 531 | \par Where:
|
---|
| 532 | - [float] specifies the width as a floating point number, using the active metrics system for the Window.
|
---|
| 533 | */
|
---|
| 534 | class Width : public Property
|
---|
| 535 | {
|
---|
| 536 | public:
|
---|
| 537 | Width() : Property(
|
---|
| 538 | "Width",
|
---|
| 539 | "Property to get/set the width of the Window. Value is floating point using the active metrics mode.",
|
---|
| 540 | "0.000000") {}
|
---|
| 541 |
|
---|
| 542 | String get(const PropertyReceiver* receiver) const;
|
---|
| 543 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 544 | };
|
---|
| 545 |
|
---|
| 546 |
|
---|
| 547 | /*!
|
---|
| 548 | \brief
|
---|
| 549 | Property to access window width.
|
---|
| 550 |
|
---|
| 551 | This property offers access to the Width setting for the window, using the relative metrics mode.
|
---|
| 552 |
|
---|
| 553 | \par Usage:
|
---|
| 554 | - Name: RelativeWidth
|
---|
| 555 | - Format: "[float]".
|
---|
| 556 |
|
---|
| 557 | \par Where:
|
---|
| 558 | - [float] specifies the width as a floating point number, using the relative metrics system.
|
---|
| 559 | */
|
---|
| 560 | class RelativeWidth : public Property
|
---|
| 561 | {
|
---|
| 562 | public:
|
---|
| 563 | RelativeWidth() : Property(
|
---|
| 564 | "RelativeWidth",
|
---|
| 565 | "Property to get/set the width of the Window. Value is floating point using relative metrics.",
|
---|
| 566 | "0.000000")
|
---|
| 567 | {}
|
---|
| 568 |
|
---|
| 569 | String get(const PropertyReceiver* receiver) const;
|
---|
| 570 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 571 | };
|
---|
| 572 |
|
---|
| 573 |
|
---|
| 574 | /*!
|
---|
| 575 | \brief
|
---|
| 576 | Property to access window width.
|
---|
| 577 |
|
---|
| 578 | This property offers access to the Width setting for the window, using the absolute metrics mode.
|
---|
| 579 |
|
---|
| 580 | \par Usage:
|
---|
| 581 | - Name: AbsoluteWidth
|
---|
| 582 | - Format: "[float]".
|
---|
| 583 |
|
---|
| 584 | \par Where:
|
---|
| 585 | - [float] specifies the width as a floating point number, using the absolute metrics system.
|
---|
| 586 | */
|
---|
| 587 | class AbsoluteWidth: public Property
|
---|
| 588 | {
|
---|
| 589 | public:
|
---|
| 590 | AbsoluteWidth() : Property(
|
---|
| 591 | "AbsoluteWidth",
|
---|
| 592 | "Property to get/set the width of the Window. Value is floating point using absolute metrics.",
|
---|
| 593 | "0.000000")
|
---|
| 594 | {}
|
---|
| 595 |
|
---|
| 596 | String get(const PropertyReceiver* receiver) const;
|
---|
| 597 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 598 | };
|
---|
| 599 |
|
---|
| 600 |
|
---|
| 601 | /*!
|
---|
| 602 | \brief
|
---|
| 603 | Property to access window height.
|
---|
| 604 |
|
---|
| 605 | This property offers access to the Height setting for the window, using the Windows active metrics mode.
|
---|
| 606 |
|
---|
| 607 | \par Usage:
|
---|
| 608 | - Name: Height
|
---|
| 609 | - Format: "[float]".
|
---|
| 610 |
|
---|
| 611 | \par Where:
|
---|
| 612 | - [float] specifies the height as a floating point number, using the active metrics system for the Window.
|
---|
| 613 | */
|
---|
| 614 | class Height : public Property
|
---|
| 615 | {
|
---|
| 616 | public:
|
---|
| 617 | Height() : Property(
|
---|
| 618 | "Height",
|
---|
| 619 | "Property to get/set the height of the Window. Value is floating point using the active metrics mode.",
|
---|
| 620 | "0.000000")
|
---|
| 621 | {}
|
---|
| 622 |
|
---|
| 623 | String get(const PropertyReceiver* receiver) const;
|
---|
| 624 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 625 | };
|
---|
| 626 |
|
---|
| 627 |
|
---|
| 628 | /*!
|
---|
| 629 | \brief
|
---|
| 630 | Property to access window height.
|
---|
| 631 |
|
---|
| 632 | This property offers access to the Height setting for the window, using the relative metrics mode.
|
---|
| 633 |
|
---|
| 634 | \par Usage:
|
---|
| 635 | - Name: RelativeHeight
|
---|
| 636 | - Format: "[float]".
|
---|
| 637 |
|
---|
| 638 | \par Where:
|
---|
| 639 | - [float] specifies the height as a floating point number, using the relative metrics system.
|
---|
| 640 | */
|
---|
| 641 | class RelativeHeight : public Property
|
---|
| 642 | {
|
---|
| 643 | public:
|
---|
| 644 | RelativeHeight() : Property(
|
---|
| 645 | "RelativeHeight",
|
---|
| 646 | "Property to get/set the height of the Window. Value is floating point using relative metrics.",
|
---|
| 647 | "0.000000")
|
---|
| 648 | {}
|
---|
| 649 |
|
---|
| 650 | String get(const PropertyReceiver* receiver) const;
|
---|
| 651 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 652 | };
|
---|
| 653 |
|
---|
| 654 |
|
---|
| 655 | /*!
|
---|
| 656 | \brief
|
---|
| 657 | Property to access window height.
|
---|
| 658 |
|
---|
| 659 | This property offers access to the Height setting for the window, using the absolute metrics mode.
|
---|
| 660 |
|
---|
| 661 | \par Usage:
|
---|
| 662 | - Name: AbsoluteHeight
|
---|
| 663 | - Format: "[float]".
|
---|
| 664 |
|
---|
| 665 | \par Where:
|
---|
| 666 | - [float] specifies the height as a floating point number, using the absolute metrics system.
|
---|
| 667 | */
|
---|
| 668 | class AbsoluteHeight : public Property
|
---|
| 669 | {
|
---|
| 670 | public:
|
---|
| 671 | AbsoluteHeight() : Property(
|
---|
| 672 | "AbsoluteHeight",
|
---|
| 673 | "Property to get/set the height of the Window. Value is floating point using absolute metrics.",
|
---|
| 674 | "0.000000")
|
---|
| 675 | {}
|
---|
| 676 |
|
---|
| 677 | String get(const PropertyReceiver* receiver) const;
|
---|
| 678 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 679 | };
|
---|
| 680 |
|
---|
| 681 |
|
---|
| 682 | /*!
|
---|
| 683 | \brief
|
---|
| 684 | Property to access the window size.
|
---|
| 685 |
|
---|
| 686 | This property offers access to the size setting for the window, using the Windows active metrics mode.
|
---|
| 687 |
|
---|
| 688 | \par Usage:
|
---|
| 689 | - Name: Size
|
---|
| 690 | - Format: "w:[float] h:[float]".
|
---|
| 691 |
|
---|
| 692 | \par Where:
|
---|
| 693 | - w:[float] specifies the minimum width as a floating point number, using the active metrics system for the Window.
|
---|
| 694 | - h:[float] specifies the minimum height as a floating point number, using the active metrics system for the Window.
|
---|
| 695 | */
|
---|
| 696 | class Size : public Property
|
---|
| 697 | {
|
---|
| 698 | public:
|
---|
| 699 | Size() : Property(
|
---|
| 700 | "Size",
|
---|
| 701 | "Property to get/set the size of the Window. Value is \"w:[float] h:[float]\" using the active metrics mode.",
|
---|
| 702 | "w:0.000000 h:0.000000")
|
---|
| 703 | {}
|
---|
| 704 |
|
---|
| 705 | String get(const PropertyReceiver* receiver) const;
|
---|
| 706 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 707 | };
|
---|
| 708 |
|
---|
| 709 |
|
---|
| 710 | /*!
|
---|
| 711 | \brief
|
---|
| 712 | Property to access the window size.
|
---|
| 713 |
|
---|
| 714 | This property offers access to the size setting for the window, using the relative metrics system.
|
---|
| 715 |
|
---|
| 716 | \par Usage:
|
---|
| 717 | - Name: RelativeSize
|
---|
| 718 | - Format: "w:[float] h:[float]".
|
---|
| 719 |
|
---|
| 720 | \par Where:
|
---|
| 721 | - w:[float] specifies the minimum width as a floating point number, using the relative metrics system.
|
---|
| 722 | - h:[float] specifies the minimum height as a floating point number, using the relative metrics system.
|
---|
| 723 | */
|
---|
| 724 | class RelativeSize : public Property
|
---|
| 725 | {
|
---|
| 726 | public:
|
---|
| 727 | RelativeSize() : Property(
|
---|
| 728 | "RelativeSize",
|
---|
| 729 | "Property to get/set the size of the Window. Value is \"w:[float] h:[float]\" using relative metrics.",
|
---|
| 730 | "w:0.000000 h:0.000000")
|
---|
| 731 | {}
|
---|
| 732 |
|
---|
| 733 | String get(const PropertyReceiver* receiver) const;
|
---|
| 734 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 735 | };
|
---|
| 736 |
|
---|
| 737 |
|
---|
| 738 | /*!
|
---|
| 739 | \brief
|
---|
| 740 | Property to access the window size.
|
---|
| 741 |
|
---|
| 742 | This property offers access to the size setting for the window, using the absolute metrics system.
|
---|
| 743 |
|
---|
| 744 | \par Usage:
|
---|
| 745 | - Name: AbsoluteSize
|
---|
| 746 | - Format: "w:[float] h:[float]".
|
---|
| 747 |
|
---|
| 748 | \par Where:
|
---|
| 749 | - w:[float] specifies the minimum width as a floating point number, using the absolute metrics system.
|
---|
| 750 | - h:[float] specifies the minimum height as a floating point number, using the absolute metrics system.
|
---|
| 751 | */
|
---|
| 752 | class AbsoluteSize : public Property
|
---|
| 753 | {
|
---|
| 754 | public:
|
---|
| 755 | AbsoluteSize() : Property(
|
---|
| 756 | "AbsoluteSize",
|
---|
| 757 | "Property to get/set the size of the Window. Value is \"w:[float] h:[float]\" using absolute metrics.",
|
---|
| 758 | "w:0.000000 h:0.000000")
|
---|
| 759 | {}
|
---|
| 760 |
|
---|
| 761 | String get(const PropertyReceiver* receiver) const;
|
---|
| 762 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 763 | };
|
---|
| 764 |
|
---|
| 765 |
|
---|
| 766 | /*!
|
---|
| 767 | \brief
|
---|
| 768 | Property to access window X position.
|
---|
| 769 |
|
---|
| 770 | This property offers access to the X position for the window, using the Windows active metrics mode.
|
---|
| 771 |
|
---|
| 772 | \par Usage:
|
---|
| 773 | - Name: XPosition
|
---|
| 774 | - Format: "[float]".
|
---|
| 775 |
|
---|
| 776 | \par Where:
|
---|
| 777 | - [float] specifies the x position co-ordinate as a floating point number, using the active metrics system for the Window.
|
---|
| 778 | */
|
---|
| 779 | class XPosition : public Property
|
---|
| 780 | {
|
---|
| 781 | public:
|
---|
| 782 | XPosition() : Property(
|
---|
| 783 | "XPosition",
|
---|
| 784 | "Property to get/set the x co-ordinate position of the Window. Value is a floating point number using the active metrics mode.",
|
---|
| 785 | "0.000000")
|
---|
| 786 | {}
|
---|
| 787 |
|
---|
| 788 | String get(const PropertyReceiver* receiver) const;
|
---|
| 789 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 790 | };
|
---|
| 791 |
|
---|
| 792 |
|
---|
| 793 | /*!
|
---|
| 794 | \brief
|
---|
| 795 | Property to access window X position.
|
---|
| 796 |
|
---|
| 797 | This property offers access to the X position for the window, using the relative metrics system.
|
---|
| 798 |
|
---|
| 799 | \par Usage:
|
---|
| 800 | - Name: RelativeXPosition
|
---|
| 801 | - Format: "[float]".
|
---|
| 802 |
|
---|
| 803 | \par Where:
|
---|
| 804 | - [float] specifies the x position co-ordinate as a floating point number, using the relative metrics system.
|
---|
| 805 | */
|
---|
| 806 | class RelativeXPosition : public Property
|
---|
| 807 | {
|
---|
| 808 | public:
|
---|
| 809 | RelativeXPosition() : Property(
|
---|
| 810 | "RelativeXPosition",
|
---|
| 811 | "Property to get/set the x co-ordinate position of the Window. Value is a floating point number using relative metrics.",
|
---|
| 812 | "0.000000")
|
---|
| 813 | {}
|
---|
| 814 |
|
---|
| 815 | String get(const PropertyReceiver* receiver) const;
|
---|
| 816 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 817 | };
|
---|
| 818 |
|
---|
| 819 |
|
---|
| 820 | /*!
|
---|
| 821 | \brief
|
---|
| 822 | Property to access window X position.
|
---|
| 823 |
|
---|
| 824 | This property offers access to the X position for the window, using the absolute metrics system.
|
---|
| 825 |
|
---|
| 826 | \par Usage:
|
---|
| 827 | - Name: AbsoluteXPosition
|
---|
| 828 | - Format: "[float]".
|
---|
| 829 |
|
---|
| 830 | \par Where:
|
---|
| 831 | - [float] specifies the x position co-ordinate as a floating point number, using the absolute metrics system.
|
---|
| 832 | */
|
---|
| 833 | class AbsoluteXPosition : public Property
|
---|
| 834 | {
|
---|
| 835 | public:
|
---|
| 836 | AbsoluteXPosition() : Property(
|
---|
| 837 | "AbsoluteXPosition",
|
---|
| 838 | "Property to get/set the x co-ordinate position of the Window. Value is a floating point number using absolute metrics.",
|
---|
| 839 | "0.000000")
|
---|
| 840 | {}
|
---|
| 841 |
|
---|
| 842 | String get(const PropertyReceiver* receiver) const;
|
---|
| 843 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 844 | };
|
---|
| 845 |
|
---|
| 846 |
|
---|
| 847 | /*!
|
---|
| 848 | \brief
|
---|
| 849 | Property to access window Y position.
|
---|
| 850 |
|
---|
| 851 | This property offers access to the Y position for the window, using the Windows active metrics mode.
|
---|
| 852 |
|
---|
| 853 | \par Usage:
|
---|
| 854 | - Name: YPosition
|
---|
| 855 | - Format: "[float]".
|
---|
| 856 |
|
---|
| 857 | \par Where:
|
---|
| 858 | - [float] specifies the y position co-ordinate as a floating point number, using the active metrics system for the Window.
|
---|
| 859 | */
|
---|
| 860 | class YPosition : public Property
|
---|
| 861 | {
|
---|
| 862 | public:
|
---|
| 863 | YPosition() : Property(
|
---|
| 864 | "YPosition",
|
---|
| 865 | "Property to get/set the y co-ordinate position of the Window. Value is a floating point number using the active metrics mode.",
|
---|
| 866 | "0.000000")
|
---|
| 867 | {}
|
---|
| 868 |
|
---|
| 869 | String get(const PropertyReceiver* receiver) const;
|
---|
| 870 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 871 | };
|
---|
| 872 |
|
---|
| 873 |
|
---|
| 874 | /*!
|
---|
| 875 | \brief
|
---|
| 876 | Property to access window Y position.
|
---|
| 877 |
|
---|
| 878 | This property offers access to the Y position for the window, using the relative metrics system.
|
---|
| 879 |
|
---|
| 880 | \par Usage:
|
---|
| 881 | - Name: RelativeYPosition
|
---|
| 882 | - Format: "[float]".
|
---|
| 883 |
|
---|
| 884 | \par Where:
|
---|
| 885 | - [float] specifies the y position co-ordinate as a floating point number, using the relative metrics system.
|
---|
| 886 | */
|
---|
| 887 | class RelativeYPosition : public Property
|
---|
| 888 | {
|
---|
| 889 | public:
|
---|
| 890 | RelativeYPosition() : Property(
|
---|
| 891 | "RelativeYPosition",
|
---|
| 892 | "Property to get/set the y co-ordinate position of the Window. Value is a floating point number using relative metrics.",
|
---|
| 893 | "0.000000")
|
---|
| 894 | {}
|
---|
| 895 |
|
---|
| 896 | String get(const PropertyReceiver* receiver) const;
|
---|
| 897 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 898 | };
|
---|
| 899 |
|
---|
| 900 |
|
---|
| 901 | /*!
|
---|
| 902 | \brief
|
---|
| 903 | Property to access window Y position.
|
---|
| 904 |
|
---|
| 905 | This property offers access to the Y position for the window, using the absolute metrics system.
|
---|
| 906 |
|
---|
| 907 | \par Usage:
|
---|
| 908 | - Name: AbsoluteYPosition
|
---|
| 909 | - Format: "[float]".
|
---|
| 910 |
|
---|
| 911 | \par Where:
|
---|
| 912 | - [float] specifies the y position co-ordinate as a floating point number, using the absolute metrics system.
|
---|
| 913 | */
|
---|
| 914 | class AbsoluteYPosition : public Property
|
---|
| 915 | {
|
---|
| 916 | public:
|
---|
| 917 | AbsoluteYPosition() : Property(
|
---|
| 918 | "AbsoluteYPosition",
|
---|
| 919 | "Property to get/set the y co-ordinate position of the Window. Value is a floating point number using absolute metrics.",
|
---|
| 920 | "0.000000")
|
---|
| 921 | {}
|
---|
| 922 |
|
---|
| 923 | String get(const PropertyReceiver* receiver) const;
|
---|
| 924 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 925 | };
|
---|
| 926 |
|
---|
| 927 |
|
---|
| 928 | /*!
|
---|
| 929 | \brief
|
---|
| 930 | Property to access window position.
|
---|
| 931 |
|
---|
| 932 | This property offers access to the position for the window, using the Windows active metrics mode.
|
---|
| 933 |
|
---|
| 934 | \par Usage:
|
---|
| 935 | - Name: Position
|
---|
| 936 | - Format: "x:[float] y:[float]".
|
---|
| 937 |
|
---|
| 938 | \par Where:
|
---|
| 939 | - x:[float] specifies the x position co-ordinate as a floating point number, using the active metrics system for the Window.
|
---|
| 940 | - y:[float] specifies the y position co-ordinate as a floating point number, using the active metrics system for the Window.
|
---|
| 941 | */
|
---|
| 942 | class Position : public Property
|
---|
| 943 | {
|
---|
| 944 | public:
|
---|
| 945 | Position() : Property(
|
---|
| 946 | "Position",
|
---|
| 947 | "Property to get/set the position of the Window. Value is \"x:[float] y:[float]\" using the active metrics mode.",
|
---|
| 948 | "x:0.000000 y:0.000000")
|
---|
| 949 | {}
|
---|
| 950 |
|
---|
| 951 | String get(const PropertyReceiver* receiver) const;
|
---|
| 952 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 953 | };
|
---|
| 954 |
|
---|
| 955 |
|
---|
| 956 | /*!
|
---|
| 957 | \brief
|
---|
| 958 | Property to access window position.
|
---|
| 959 |
|
---|
| 960 | This property offers access to the position for the window, using the relative metrics system.
|
---|
| 961 |
|
---|
| 962 | \par Usage:
|
---|
| 963 | - Name: RelativePosition
|
---|
| 964 | - Format: "x:[float] y:[float]".
|
---|
| 965 |
|
---|
| 966 | \par Where:
|
---|
| 967 | - x:[float] specifies the x position co-ordinate as a floating point number, using the relative metrics system.
|
---|
| 968 | - y:[float] specifies the y position co-ordinate as a floating point number, using the relative metrics system.
|
---|
| 969 | */
|
---|
| 970 | class RelativePosition : public Property
|
---|
| 971 | {
|
---|
| 972 | public:
|
---|
| 973 | RelativePosition() : Property(
|
---|
| 974 | "RelativePosition",
|
---|
| 975 | "Property to get/set the position of the Window. Value is \"x:[float] y:[float]\" using relative metrics.",
|
---|
| 976 | "x:0.000000 y:0.000000")
|
---|
| 977 | {}
|
---|
| 978 |
|
---|
| 979 | String get(const PropertyReceiver* receiver) const;
|
---|
| 980 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 981 | };
|
---|
| 982 |
|
---|
| 983 |
|
---|
| 984 | /*!
|
---|
| 985 | \brief
|
---|
| 986 | Property to access window position.
|
---|
| 987 |
|
---|
| 988 | This property offers access to the position for the window, using the absolute metrics system.
|
---|
| 989 |
|
---|
| 990 | \par Usage:
|
---|
| 991 | - Name: AbsolutePosition
|
---|
| 992 | - Format: "x:[float] y:[float]".
|
---|
| 993 |
|
---|
| 994 | \par Where:
|
---|
| 995 | - x:[float] specifies the x position co-ordinate as a floating point number, using the absolute metrics system.
|
---|
| 996 | - y:[float] specifies the y position co-ordinate as a floating point number, using the absolute metrics system.
|
---|
| 997 | */
|
---|
| 998 | class AbsolutePosition : public Property
|
---|
| 999 | {
|
---|
| 1000 | public:
|
---|
| 1001 | AbsolutePosition() : Property(
|
---|
| 1002 | "AbsolutePosition",
|
---|
| 1003 | "Property to get/set the position of the Window. Value is \"x:[float] y:[float]\" using absolute metrics.",
|
---|
| 1004 | "x:0.000000 y:0.000000")
|
---|
| 1005 | {}
|
---|
| 1006 |
|
---|
| 1007 | String get(const PropertyReceiver* receiver) const;
|
---|
| 1008 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 1009 | };
|
---|
| 1010 |
|
---|
| 1011 |
|
---|
| 1012 | /*!
|
---|
| 1013 | \brief
|
---|
| 1014 | Property to access window area rectangle.
|
---|
| 1015 |
|
---|
| 1016 | This property offers access to the area rectangle (Rect) for the window, using the Windows active metrics mode.
|
---|
| 1017 |
|
---|
| 1018 | \par Usage:
|
---|
| 1019 | - Name: Rect
|
---|
| 1020 | - Format: "l:[float] t:[float] r:[float] b:[float]".
|
---|
| 1021 |
|
---|
| 1022 | \par Where:
|
---|
| 1023 | - l:[float] specifies the position of the left edge of the area as a floating point number, using the active metrics system for the Window.
|
---|
| 1024 | - t:[float] specifies the position of the top edge of the area as a floating point number, using the active metrics system for the Window.
|
---|
| 1025 | - r:[float] specifies the position of the right edge of the area as a floating point number, using the active metrics system for the Window.
|
---|
| 1026 | - b:[float] specifies the position of the bottom edge of the area as a floating point number, using the active metrics system for the Window.
|
---|
| 1027 | */
|
---|
| 1028 | class Rect : public Property
|
---|
| 1029 | {
|
---|
| 1030 | public:
|
---|
| 1031 | Rect() : Property(
|
---|
| 1032 | "Rect",
|
---|
| 1033 | "Property to get/set the area rectangle of the Window. Value is \"l:[float] t:[float] r:[float] b:[float]\" (where l is left, t is top, r is right, and b is bottom) using the active metrics system.",
|
---|
| 1034 | "l:0.000000 t:0.000000 r:0.000000 b:0.000000")
|
---|
| 1035 | {}
|
---|
| 1036 |
|
---|
| 1037 | String get(const PropertyReceiver* receiver) const;
|
---|
| 1038 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 1039 | };
|
---|
| 1040 |
|
---|
| 1041 |
|
---|
| 1042 | /*!
|
---|
| 1043 | \brief
|
---|
| 1044 | Property to access window area rectangle.
|
---|
| 1045 |
|
---|
| 1046 | This property offers access to the area rectangle (Rect) for the window, using the relative metrics system.
|
---|
| 1047 |
|
---|
| 1048 | \par Usage:
|
---|
| 1049 | - Name: RelativeRect
|
---|
| 1050 | - Format: "l:[float] t:[float] r:[float] b:[float]".
|
---|
| 1051 |
|
---|
| 1052 | \par Where:
|
---|
| 1053 | - l:[float] specifies the position of the left edge of the area as a floating point number, using the relative metrics system.
|
---|
| 1054 | - t:[float] specifies the position of the top edge of the area as a floating point number, using the relative metrics system.
|
---|
| 1055 | - r:[float] specifies the position of the right edge of the area as a floating point number, using the relative metrics system.
|
---|
| 1056 | - b:[float] specifies the position of the bottom edge of the area as a floating point number, using the relative metrics system.
|
---|
| 1057 | */
|
---|
| 1058 | class RelativeRect : public Property
|
---|
| 1059 | {
|
---|
| 1060 | public:
|
---|
| 1061 | RelativeRect() : Property(
|
---|
| 1062 | "RelativeRect",
|
---|
| 1063 | "Property to get/set the area rectangle of the Window. Value is \"l:[float] t:[float] r:[float] b:[float]\" (where l is left, t is top, r is right, and b is bottom) using relative metrics.",
|
---|
| 1064 | "l:0.000000 t:0.000000 r:0.000000 b:0.000000")
|
---|
| 1065 | {}
|
---|
| 1066 |
|
---|
| 1067 | String get(const PropertyReceiver* receiver) const;
|
---|
| 1068 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 1069 | };
|
---|
| 1070 |
|
---|
| 1071 |
|
---|
| 1072 | /*!
|
---|
| 1073 | \brief
|
---|
| 1074 | Property to access window area rectangle.
|
---|
| 1075 |
|
---|
| 1076 | This property offers access to the area rectangle (Rect) for the window, using the absolute metrics system.
|
---|
| 1077 |
|
---|
| 1078 | \par Usage:
|
---|
| 1079 | - Name: AbsoluteRect
|
---|
| 1080 | - Format: "l:[float] t:[float] r:[float] b:[float]".
|
---|
| 1081 |
|
---|
| 1082 | \par Where:
|
---|
| 1083 | - l:[float] specifies the position of the left edge of the area as a floating point number, using the absolute metrics system.
|
---|
| 1084 | - t:[float] specifies the position of the top edge of the area as a floating point number, using the absolute metrics system.
|
---|
| 1085 | - r:[float] specifies the position of the right edge of the area as a floating point number, using the absolute metrics system.
|
---|
| 1086 | - b:[float] specifies the position of the bottom edge of the area as a floating point number, using the absolute metrics system.
|
---|
| 1087 | */
|
---|
| 1088 | class AbsoluteRect : public Property
|
---|
| 1089 | {
|
---|
| 1090 | public:
|
---|
| 1091 | AbsoluteRect() : Property(
|
---|
| 1092 | "AbsoluteRect",
|
---|
| 1093 | "Property to get/set the area rectangle of the Window. Value is \"l:[float] t:[float] r:[float] b:[float]\" (where l is left, t is top, r is right, and b is bottom) using absolute metrics.",
|
---|
| 1094 | "l:0.000000 t:0.000000 r:0.000000 b:0.000000")
|
---|
| 1095 | {}
|
---|
| 1096 |
|
---|
| 1097 | String get(const PropertyReceiver* receiver) const;
|
---|
| 1098 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 1099 | };
|
---|
| 1100 |
|
---|
| 1101 |
|
---|
| 1102 | /*!
|
---|
| 1103 | \brief
|
---|
| 1104 | Property to access window Z-Order changing enabled setting.
|
---|
| 1105 |
|
---|
| 1106 | This property offers access to the setting that controls whether z-order changes are enabled for the window.
|
---|
| 1107 |
|
---|
| 1108 | \par Usage:
|
---|
| 1109 | - Name: ZOrderChangeEnabled
|
---|
| 1110 | - Format: "[text]".
|
---|
| 1111 |
|
---|
| 1112 | \par Where [Text] is:
|
---|
| 1113 | - "True" to indicate the Window should respect requests to change z-order.
|
---|
| 1114 | - "False" to indicate the Window should not change it's z-order.
|
---|
| 1115 | */
|
---|
| 1116 | class ZOrderChangeEnabled : public Property
|
---|
| 1117 | {
|
---|
| 1118 | public:
|
---|
| 1119 | ZOrderChangeEnabled() : Property(
|
---|
| 1120 | "ZOrderChangeEnabled",
|
---|
| 1121 | "Property to get/set the 'z-order changing enabled' setting for the Window. Value is either \"True\" or \"False\".",
|
---|
| 1122 | "True")
|
---|
| 1123 | {}
|
---|
| 1124 |
|
---|
| 1125 | String get(const PropertyReceiver* receiver) const;
|
---|
| 1126 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 1127 | };
|
---|
| 1128 |
|
---|
| 1129 |
|
---|
| 1130 | /*!
|
---|
| 1131 | \brief
|
---|
| 1132 | Property to control whether the window will receive double/triple-click events.
|
---|
| 1133 |
|
---|
| 1134 | This property offers access to the setting that controls whether a window will receive double-click and
|
---|
| 1135 | triple-click events, or whether the window will receive multiple single mouse button down events instead.
|
---|
| 1136 |
|
---|
| 1137 | \par Usage:
|
---|
| 1138 | - Name: WantsMultiClickEvents
|
---|
| 1139 | - Format: "[text]".
|
---|
| 1140 |
|
---|
| 1141 | \par Where [Text] is:
|
---|
| 1142 | - "True" to indicate the Window wants double-click and triple-click events.
|
---|
| 1143 | - "False" to indicate the Window wants multiple single mouse button down events.
|
---|
| 1144 | */
|
---|
| 1145 | class WantsMultiClickEvents : public Property
|
---|
| 1146 | {
|
---|
| 1147 | public:
|
---|
| 1148 | WantsMultiClickEvents() : Property(
|
---|
| 1149 | "WantsMultiClickEvents",
|
---|
| 1150 | "Property to get/set whether the window will receive double-click and triple-click events. Value is either \"True\" or \"False\".",
|
---|
| 1151 | "True")
|
---|
| 1152 | {}
|
---|
| 1153 |
|
---|
| 1154 | String get(const PropertyReceiver* receiver) const;
|
---|
| 1155 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 1156 | };
|
---|
| 1157 |
|
---|
| 1158 |
|
---|
| 1159 | /*!
|
---|
| 1160 | \brief
|
---|
| 1161 | Property to control whether the window will receive autorepeat mouse button down events.
|
---|
| 1162 |
|
---|
| 1163 | This property offers access to the setting that controls whether a window will receive autorepeat
|
---|
| 1164 | mouse button down events.
|
---|
| 1165 |
|
---|
| 1166 | \par Usage:
|
---|
| 1167 | - Name: MouseButtonDownAutoRepeat
|
---|
| 1168 | - Format: "[text]".
|
---|
| 1169 |
|
---|
| 1170 | \par Where [Text] is:
|
---|
| 1171 | - "True" to indicate the Window will receive autorepeat mouse button down events.
|
---|
| 1172 | - "False" to indicate the Window will not receive autorepeat mouse button down events.
|
---|
| 1173 | */
|
---|
| 1174 | class MouseButtonDownAutoRepeat : public Property
|
---|
| 1175 | {
|
---|
| 1176 | public:
|
---|
| 1177 | MouseButtonDownAutoRepeat() : Property(
|
---|
| 1178 | "MouseButtonDownAutoRepeat",
|
---|
| 1179 | "Property to get/set whether the window will receive autorepeat mouse button down events. Value is either \"True\" or \"False\".",
|
---|
| 1180 | "False")
|
---|
| 1181 | {}
|
---|
| 1182 |
|
---|
| 1183 | String get(const PropertyReceiver* receiver) const;
|
---|
| 1184 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 1185 | };
|
---|
| 1186 |
|
---|
| 1187 |
|
---|
| 1188 | /*!
|
---|
| 1189 | \brief
|
---|
| 1190 | Property to access window autorepeat delay value.
|
---|
| 1191 |
|
---|
| 1192 | This property offers access to the value that controls the initial delay for autorepeat mouse button down events.
|
---|
| 1193 |
|
---|
| 1194 | \par Usage:
|
---|
| 1195 | - Name: AutoRepeatDelay
|
---|
| 1196 | - Format: "[float]".
|
---|
| 1197 |
|
---|
| 1198 | \par Where:
|
---|
| 1199 | - [float] specifies the delay in seconds.
|
---|
| 1200 | */
|
---|
| 1201 | class AutoRepeatDelay : public Property
|
---|
| 1202 | {
|
---|
| 1203 | public:
|
---|
| 1204 | AutoRepeatDelay() : Property(
|
---|
| 1205 | "AutoRepeatDelay",
|
---|
| 1206 | "Property to get/set the autorepeat delay. Value is a floating point number indicating the delay required in seconds.",
|
---|
| 1207 | "0.3")
|
---|
| 1208 | {}
|
---|
| 1209 |
|
---|
| 1210 | String get(const PropertyReceiver* receiver) const;
|
---|
| 1211 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 1212 | };
|
---|
| 1213 |
|
---|
| 1214 |
|
---|
| 1215 | /*!
|
---|
| 1216 | \brief
|
---|
| 1217 | Property to access window autorepeat rate value.
|
---|
| 1218 |
|
---|
| 1219 | This property offers access to the value that controls the generation rate for autorepeat mouse button down events.
|
---|
| 1220 |
|
---|
| 1221 | \par Usage:
|
---|
| 1222 | - Name: AutoRepeatRate
|
---|
| 1223 | - Format: "[float]".
|
---|
| 1224 |
|
---|
| 1225 | \par Where:
|
---|
| 1226 | - [float] specifies the rate at which autorepeat events will be generated in seconds.
|
---|
| 1227 | */
|
---|
| 1228 | class AutoRepeatRate : public Property
|
---|
| 1229 | {
|
---|
| 1230 | public:
|
---|
| 1231 | AutoRepeatRate() : Property(
|
---|
| 1232 | "AutoRepeatRate",
|
---|
| 1233 | "Property to get/set the autorepeat rate. Value is a floating point number indicating the rate required in seconds.",
|
---|
| 1234 | "0.06")
|
---|
| 1235 | {}
|
---|
| 1236 |
|
---|
| 1237 | String get(const PropertyReceiver* receiver) const;
|
---|
| 1238 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 1239 | };
|
---|
| 1240 |
|
---|
| 1241 | /*!
|
---|
| 1242 | \brief
|
---|
| 1243 | Property to access whether inputs are passed to child windows when
|
---|
| 1244 | input is captured to this window.
|
---|
| 1245 |
|
---|
| 1246 | \par Usage:
|
---|
| 1247 | - Name: DistributeCapturedInputs
|
---|
| 1248 | - Format: "[text]".
|
---|
| 1249 |
|
---|
| 1250 | \par Where [Text] is:
|
---|
| 1251 | - "True" to indicate 'captured' inputs should be passed to attached child windows.
|
---|
| 1252 | - "False" to indicate 'captured' inputs should be passed to this window only.
|
---|
| 1253 | */
|
---|
| 1254 | class DistributeCapturedInputs : public Property
|
---|
| 1255 | {
|
---|
| 1256 | public:
|
---|
| 1257 | DistributeCapturedInputs() : Property(
|
---|
| 1258 | "DistributeCapturedInputs",
|
---|
| 1259 | "Property to get/set whether captured inputs are passed to child windows. Value is either \"True\" or \"False\".",
|
---|
| 1260 | "False")
|
---|
| 1261 | {}
|
---|
| 1262 |
|
---|
| 1263 | String get(const PropertyReceiver* receiver) const;
|
---|
| 1264 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 1265 | };
|
---|
| 1266 |
|
---|
| 1267 | /*!
|
---|
| 1268 | \brief
|
---|
| 1269 | Property to access the custom tooltip for this Window.
|
---|
| 1270 |
|
---|
| 1271 | \par Usage:
|
---|
| 1272 | - Name: CustomTooltipType
|
---|
| 1273 | - Format: "[text]".
|
---|
| 1274 |
|
---|
| 1275 | \par Where:
|
---|
| 1276 | - [Text] is the typename of the custom tooltip for the Window.
|
---|
| 1277 | */
|
---|
| 1278 | class CustomTooltipType : public Property
|
---|
| 1279 | {
|
---|
| 1280 | public:
|
---|
| 1281 | CustomTooltipType() : Property(
|
---|
| 1282 | "CustomTooltipType",
|
---|
| 1283 | "Property to get/set the custom tooltip for the window. Value is the type name of the custom tooltip.",
|
---|
| 1284 | "")
|
---|
| 1285 | {}
|
---|
| 1286 |
|
---|
| 1287 | String get(const PropertyReceiver* receiver) const;
|
---|
| 1288 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 1289 | };
|
---|
| 1290 |
|
---|
| 1291 | /*!
|
---|
| 1292 | \brief
|
---|
| 1293 | Property to access the tooltip text for this Window.
|
---|
| 1294 |
|
---|
| 1295 | \par Usage:
|
---|
| 1296 | - Name: Tooltip
|
---|
| 1297 | - Format: "[text]".
|
---|
| 1298 |
|
---|
| 1299 | \par Where:
|
---|
| 1300 | - [Text] is the tooltip text for this window.
|
---|
| 1301 | */
|
---|
| 1302 | class Tooltip : public Property
|
---|
| 1303 | {
|
---|
| 1304 | public:
|
---|
| 1305 | Tooltip() : Property(
|
---|
| 1306 | "Tooltip",
|
---|
| 1307 | "Property to get/set the tooltip text for the window. Value is the tooltip text for the window.",
|
---|
| 1308 | "")
|
---|
| 1309 | {}
|
---|
| 1310 |
|
---|
| 1311 | String get(const PropertyReceiver* receiver) const;
|
---|
| 1312 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 1313 | };
|
---|
| 1314 |
|
---|
| 1315 | /*!
|
---|
| 1316 | \brief
|
---|
| 1317 | Property to access whether the window inherits its tooltip text from its parent whn it has no tooltip text of its own.
|
---|
| 1318 |
|
---|
| 1319 | \par Usage:
|
---|
| 1320 | - Name: InheritsTooltipText
|
---|
| 1321 | - Format: "[text]".
|
---|
| 1322 |
|
---|
| 1323 | \par Where [Text] is:
|
---|
| 1324 | - "True" to indicate the Window inherits its tooltip text from its parent.
|
---|
| 1325 | - "False" to indicate the Window does not inherit its tooltip text.
|
---|
| 1326 | */
|
---|
| 1327 | class InheritsTooltipText : public Property
|
---|
| 1328 | {
|
---|
| 1329 | public:
|
---|
| 1330 | InheritsTooltipText() : Property(
|
---|
| 1331 | "InheritsTooltipText",
|
---|
| 1332 | "Property to get/set whether the window inherits its parents tooltip text when it has none of its own. Value is either \"True\" or \"False\".",
|
---|
| 1333 | "False")
|
---|
| 1334 | {}
|
---|
| 1335 |
|
---|
| 1336 | String get(const PropertyReceiver* receiver) const;
|
---|
| 1337 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 1338 | };
|
---|
| 1339 |
|
---|
| 1340 |
|
---|
| 1341 | /*!
|
---|
| 1342 | \brief
|
---|
| 1343 | Property to access whether the window rises to the top of the z order when clicked.
|
---|
| 1344 |
|
---|
| 1345 | \par Usage:
|
---|
| 1346 | - Name: RiseOnClick
|
---|
| 1347 | - Format: "[text]".
|
---|
| 1348 |
|
---|
| 1349 | \par Where [Text] is:
|
---|
| 1350 | - "True" to indicate the Window will rise to the surface when clicked.
|
---|
| 1351 | - "False" to indicate the Window will not change z position when clicked.
|
---|
| 1352 | */
|
---|
| 1353 | class RiseOnClick : public Property
|
---|
| 1354 | {
|
---|
| 1355 | public:
|
---|
| 1356 | RiseOnClick() : Property(
|
---|
| 1357 | "RiseOnClick",
|
---|
| 1358 | "Property to get/set whether the window will come tot he top of the z order hwn clicked. Value is either \"True\" or \"False\".",
|
---|
| 1359 | "True")
|
---|
| 1360 | {}
|
---|
| 1361 |
|
---|
| 1362 | String get(const PropertyReceiver* receiver) const;
|
---|
| 1363 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 1364 | };
|
---|
| 1365 |
|
---|
| 1366 |
|
---|
| 1367 | } // End of WindowProperties namespace section
|
---|
| 1368 |
|
---|
| 1369 |
|
---|
| 1370 | } // End of CEGUI namespace section
|
---|
| 1371 |
|
---|
| 1372 | #endif // end of guard _CEGUIWindowProperties_h_
|
---|