00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026 #ifndef _CEGUIWindowProperties_h_
00027 #define _CEGUIWindowProperties_h_
00028
00029 #include "CEGUIProperty.h"
00030
00031
00032
00033 namespace CEGUI
00034 {
00035
00036
00041 namespace WindowProperties
00042 {
00057 class RelativeMinSize : public Property
00058 {
00059 public:
00060 RelativeMinSize() : Property(
00061 "RelativeMinSize",
00062 "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).",
00063 "w:0.000000 h:0.000000")
00064 {}
00065
00066 String get(const PropertyReceiver* receiver) const;
00067 void set(PropertyReceiver* receiver, const String& value);
00068 };
00069
00070
00085 class RelativeMaxSize : public Property
00086 {
00087 public:
00088 RelativeMaxSize() : Property(
00089 "RelativeMaxSize",
00090 "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).",
00091 "w:1.000000 h:1.000000")
00092 {}
00093
00094 String get(const PropertyReceiver* receiver) const;
00095 void set(PropertyReceiver* receiver, const String& value);
00096 };
00097
00098
00113 class AbsoluteMinSize : public Property
00114 {
00115 public:
00116 AbsoluteMinSize() : Property(
00117 "AbsoluteMinSize",
00118 "Property to get/set the minimum size for the Window. Value is \"w:[float] h:[float]\" using absolute (pixel) metrics.",
00119 "w:0.000000 h:0.000000")
00120 {}
00121
00122 String get(const PropertyReceiver* receiver) const;
00123 void set(PropertyReceiver* receiver, const String& value);
00124 };
00125
00126
00141 class AbsoluteMaxSize : public Property
00142 {
00143 public:
00144 AbsoluteMaxSize() : Property(
00145 "AbsoluteMaxSize",
00146 "Property to get/set the maximum size for the Window. Value is \"w:[float] h:[float]\" using absolute (pixel) metrics.",
00147 "")
00148 {}
00149
00150 String get(const PropertyReceiver* receiver) const;
00151 void set(PropertyReceiver* receiver, const String& value);
00152
00153
00154 bool isDefault(const PropertyReceiver* receiver) const;
00155 String getDefault(const PropertyReceiver* receiver) const;
00156 };
00157
00158
00174 class MetricsMode : public Property
00175 {
00176 public:
00177 MetricsMode() : Property(
00178 "MetricsMode",
00179 "Property to get/set the metrics mode for the Window. Value is \"Relative\", \"Absolute\", or \"Inherited\".",
00180 "Relative")
00181 {}
00182
00183 String get(const PropertyReceiver* receiver) const;
00184 void set(PropertyReceiver* receiver, const String& value);
00185 };
00186
00187
00201 class ID : public Property
00202 {
00203 public:
00204 ID() : Property(
00205 "ID",
00206 "Property to get/set the ID value of the Window. Value is an unsigned integer number.",
00207 "0")
00208 {}
00209
00210 String get(const PropertyReceiver* receiver) const;
00211 void set(PropertyReceiver* receiver, const String& value);
00212 };
00213
00214
00228 class Alpha : public Property
00229 {
00230 public:
00231 Alpha() : Property(
00232 "Alpha",
00233 "Property to get/set the alpha value of the Window. Value is floating point number.",
00234 "1.000000")
00235 {}
00236
00237 String get(const PropertyReceiver* receiver) const;
00238 void set(PropertyReceiver* receiver, const String& value);
00239 };
00240
00241
00255 class Font : public Property
00256 {
00257 public:
00258 Font() : Property(
00259 "Font",
00260 "Property to get/set the font for the Window. Value is the name of the font to use (must be loaded already).",
00261 "")
00262 {}
00263
00264 String get(const PropertyReceiver* receiver) const;
00265 void set(PropertyReceiver* receiver, const String& value);
00266 };
00267
00268
00282 class Text : public Property
00283 {
00284 public:
00285 Text() : Property(
00286 "Text",
00287 "Property to get/set the text / caption for the Window. Value is the text string to use.",
00288 "")
00289 {}
00290
00291 String get(const PropertyReceiver* receiver) const;
00292 void set(PropertyReceiver* receiver, const String& value);
00293 };
00294
00295
00310 class MouseCursorImage : public Property
00311 {
00312 public:
00313 MouseCursorImage() : Property(
00314 "MouseCursorImage",
00315 "Property to get/set the mouse cursor image for the Window. Value should be \"set:<imageset name> image:<image name>\".",
00316 "")
00317 {}
00318
00319 String get(const PropertyReceiver* receiver) const;
00320 void set(PropertyReceiver* receiver, const String& value);
00321 };
00322
00323
00338 class ClippedByParent : public Property
00339 {
00340 public:
00341 ClippedByParent() : Property(
00342 "ClippedByParent",
00343 "Property to get/set the 'clipped by parent' setting for the Window. Value is either \"True\" or \"False\".",
00344 "True")
00345 {}
00346
00347 String get(const PropertyReceiver* receiver) const;
00348 void set(PropertyReceiver* receiver, const String& value);
00349 };
00350
00351
00366 class InheritsAlpha : public Property
00367 {
00368 public:
00369 InheritsAlpha() : Property(
00370 "InheritsAlpha",
00371 "Property to get/set the 'inherits alpha' setting for the Window. Value is either \"True\" or \"False\".",
00372 "True")
00373 {}
00374
00375 String get(const PropertyReceiver* receiver) const;
00376 void set(PropertyReceiver* receiver, const String& value);
00377 };
00378
00379
00394 class AlwaysOnTop : public Property
00395 {
00396 public:
00397 AlwaysOnTop() : Property(
00398 "AlwaysOnTop",
00399 "Property to get/set the 'always on top' setting for the Window. Value is either \"True\" or \"False\".",
00400 "False")
00401 {}
00402
00403 String get(const PropertyReceiver* receiver) const;
00404 void set(PropertyReceiver* receiver, const String& value);
00405 };
00406
00407
00422 class Disabled : public Property
00423 {
00424 public:
00425 Disabled() : Property(
00426 "Disabled",
00427 "Property to get/set the 'disabled state' setting for the Window. Value is either \"True\" or \"False\".",
00428 "False")
00429 {}
00430
00431 String get(const PropertyReceiver* receiver) const;
00432 void set(PropertyReceiver* receiver, const String& value);
00433 };
00434
00435
00450 class Visible : public Property
00451 {
00452 public:
00453 Visible() : Property(
00454 "Visible",
00455 "Property to get/set the 'visible state' setting for the Window. Value is either \"True\" or \"False\".",
00456 "True")
00457 {}
00458
00459 String get(const PropertyReceiver* receiver) const;
00460 void set(PropertyReceiver* receiver, const String& value);
00461 };
00462
00463
00479 class RestoreOldCapture : public Property
00480 {
00481 public:
00482 RestoreOldCapture() : Property(
00483 "RestoreOldCapture",
00484 "Property to get/set the 'restore old capture' setting for the Window. Value is either \"True\" or \"False\".",
00485 "False")
00486 {}
00487
00488 String get(const PropertyReceiver* receiver) const;
00489 void set(PropertyReceiver* receiver, const String& value);
00490 };
00491
00492
00507 class DestroyedByParent : public Property
00508 {
00509 public:
00510 DestroyedByParent() : Property(
00511 "DestroyedByParent",
00512 "Property to get/set the 'destroyed by parent' setting for the Window. Value is either \"True\" or \"False\".",
00513 "True")
00514 {}
00515
00516 String get(const PropertyReceiver* receiver) const;
00517 void set(PropertyReceiver* receiver, const String& value);
00518 };
00519
00520
00534 class Width : public Property
00535 {
00536 public:
00537 Width() : Property(
00538 "Width",
00539 "Property to get/set the width of the Window. Value is floating point using the active metrics mode.",
00540 "0.000000") {}
00541
00542 String get(const PropertyReceiver* receiver) const;
00543 void set(PropertyReceiver* receiver, const String& value);
00544 };
00545
00546
00560 class RelativeWidth : public Property
00561 {
00562 public:
00563 RelativeWidth() : Property(
00564 "RelativeWidth",
00565 "Property to get/set the width of the Window. Value is floating point using relative metrics.",
00566 "0.000000")
00567 {}
00568
00569 String get(const PropertyReceiver* receiver) const;
00570 void set(PropertyReceiver* receiver, const String& value);
00571 };
00572
00573
00587 class AbsoluteWidth: public Property
00588 {
00589 public:
00590 AbsoluteWidth() : Property(
00591 "AbsoluteWidth",
00592 "Property to get/set the width of the Window. Value is floating point using absolute metrics.",
00593 "0.000000")
00594 {}
00595
00596 String get(const PropertyReceiver* receiver) const;
00597 void set(PropertyReceiver* receiver, const String& value);
00598 };
00599
00600
00614 class Height : public Property
00615 {
00616 public:
00617 Height() : Property(
00618 "Height",
00619 "Property to get/set the height of the Window. Value is floating point using the active metrics mode.",
00620 "0.000000")
00621 {}
00622
00623 String get(const PropertyReceiver* receiver) const;
00624 void set(PropertyReceiver* receiver, const String& value);
00625 };
00626
00627
00641 class RelativeHeight : public Property
00642 {
00643 public:
00644 RelativeHeight() : Property(
00645 "RelativeHeight",
00646 "Property to get/set the height of the Window. Value is floating point using relative metrics.",
00647 "0.000000")
00648 {}
00649
00650 String get(const PropertyReceiver* receiver) const;
00651 void set(PropertyReceiver* receiver, const String& value);
00652 };
00653
00654
00668 class AbsoluteHeight : public Property
00669 {
00670 public:
00671 AbsoluteHeight() : Property(
00672 "AbsoluteHeight",
00673 "Property to get/set the height of the Window. Value is floating point using absolute metrics.",
00674 "0.000000")
00675 {}
00676
00677 String get(const PropertyReceiver* receiver) const;
00678 void set(PropertyReceiver* receiver, const String& value);
00679 };
00680
00681
00696 class Size : public Property
00697 {
00698 public:
00699 Size() : Property(
00700 "Size",
00701 "Property to get/set the size of the Window. Value is \"w:[float] h:[float]\" using the active metrics mode.",
00702 "w:0.000000 h:0.000000")
00703 {}
00704
00705 String get(const PropertyReceiver* receiver) const;
00706 void set(PropertyReceiver* receiver, const String& value);
00707 };
00708
00709
00724 class RelativeSize : public Property
00725 {
00726 public:
00727 RelativeSize() : Property(
00728 "RelativeSize",
00729 "Property to get/set the size of the Window. Value is \"w:[float] h:[float]\" using relative metrics.",
00730 "w:0.000000 h:0.000000")
00731 {}
00732
00733 String get(const PropertyReceiver* receiver) const;
00734 void set(PropertyReceiver* receiver, const String& value);
00735 };
00736
00737
00752 class AbsoluteSize : public Property
00753 {
00754 public:
00755 AbsoluteSize() : Property(
00756 "AbsoluteSize",
00757 "Property to get/set the size of the Window. Value is \"w:[float] h:[float]\" using absolute metrics.",
00758 "w:0.000000 h:0.000000")
00759 {}
00760
00761 String get(const PropertyReceiver* receiver) const;
00762 void set(PropertyReceiver* receiver, const String& value);
00763 };
00764
00765
00779 class XPosition : public Property
00780 {
00781 public:
00782 XPosition() : Property(
00783 "XPosition",
00784 "Property to get/set the x co-ordinate position of the Window. Value is a floating point number using the active metrics mode.",
00785 "0.000000")
00786 {}
00787
00788 String get(const PropertyReceiver* receiver) const;
00789 void set(PropertyReceiver* receiver, const String& value);
00790 };
00791
00792
00806 class RelativeXPosition : public Property
00807 {
00808 public:
00809 RelativeXPosition() : Property(
00810 "RelativeXPosition",
00811 "Property to get/set the x co-ordinate position of the Window. Value is a floating point number using relative metrics.",
00812 "0.000000")
00813 {}
00814
00815 String get(const PropertyReceiver* receiver) const;
00816 void set(PropertyReceiver* receiver, const String& value);
00817 };
00818
00819
00833 class AbsoluteXPosition : public Property
00834 {
00835 public:
00836 AbsoluteXPosition() : Property(
00837 "AbsoluteXPosition",
00838 "Property to get/set the x co-ordinate position of the Window. Value is a floating point number using absolute metrics.",
00839 "0.000000")
00840 {}
00841
00842 String get(const PropertyReceiver* receiver) const;
00843 void set(PropertyReceiver* receiver, const String& value);
00844 };
00845
00846
00860 class YPosition : public Property
00861 {
00862 public:
00863 YPosition() : Property(
00864 "YPosition",
00865 "Property to get/set the y co-ordinate position of the Window. Value is a floating point number using the active metrics mode.",
00866 "0.000000")
00867 {}
00868
00869 String get(const PropertyReceiver* receiver) const;
00870 void set(PropertyReceiver* receiver, const String& value);
00871 };
00872
00873
00887 class RelativeYPosition : public Property
00888 {
00889 public:
00890 RelativeYPosition() : Property(
00891 "RelativeYPosition",
00892 "Property to get/set the y co-ordinate position of the Window. Value is a floating point number using relative metrics.",
00893 "0.000000")
00894 {}
00895
00896 String get(const PropertyReceiver* receiver) const;
00897 void set(PropertyReceiver* receiver, const String& value);
00898 };
00899
00900
00914 class AbsoluteYPosition : public Property
00915 {
00916 public:
00917 AbsoluteYPosition() : Property(
00918 "AbsoluteYPosition",
00919 "Property to get/set the y co-ordinate position of the Window. Value is a floating point number using absolute metrics.",
00920 "0.000000")
00921 {}
00922
00923 String get(const PropertyReceiver* receiver) const;
00924 void set(PropertyReceiver* receiver, const String& value);
00925 };
00926
00927
00942 class Position : public Property
00943 {
00944 public:
00945 Position() : Property(
00946 "Position",
00947 "Property to get/set the position of the Window. Value is \"x:[float] y:[float]\" using the active metrics mode.",
00948 "x:0.000000 y:0.000000")
00949 {}
00950
00951 String get(const PropertyReceiver* receiver) const;
00952 void set(PropertyReceiver* receiver, const String& value);
00953 };
00954
00955
00970 class RelativePosition : public Property
00971 {
00972 public:
00973 RelativePosition() : Property(
00974 "RelativePosition",
00975 "Property to get/set the position of the Window. Value is \"x:[float] y:[float]\" using relative metrics.",
00976 "x:0.000000 y:0.000000")
00977 {}
00978
00979 String get(const PropertyReceiver* receiver) const;
00980 void set(PropertyReceiver* receiver, const String& value);
00981 };
00982
00983
00998 class AbsolutePosition : public Property
00999 {
01000 public:
01001 AbsolutePosition() : Property(
01002 "AbsolutePosition",
01003 "Property to get/set the position of the Window. Value is \"x:[float] y:[float]\" using absolute metrics.",
01004 "x:0.000000 y:0.000000")
01005 {}
01006
01007 String get(const PropertyReceiver* receiver) const;
01008 void set(PropertyReceiver* receiver, const String& value);
01009 };
01010
01011
01028 class Rect : public Property
01029 {
01030 public:
01031 Rect() : Property(
01032 "Rect",
01033 "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.",
01034 "l:0.000000 t:0.000000 r:0.000000 b:0.000000")
01035 {}
01036
01037 String get(const PropertyReceiver* receiver) const;
01038 void set(PropertyReceiver* receiver, const String& value);
01039 };
01040
01041
01058 class RelativeRect : public Property
01059 {
01060 public:
01061 RelativeRect() : Property(
01062 "RelativeRect",
01063 "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.",
01064 "l:0.000000 t:0.000000 r:0.000000 b:0.000000")
01065 {}
01066
01067 String get(const PropertyReceiver* receiver) const;
01068 void set(PropertyReceiver* receiver, const String& value);
01069 };
01070
01071
01088 class AbsoluteRect : public Property
01089 {
01090 public:
01091 AbsoluteRect() : Property(
01092 "AbsoluteRect",
01093 "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.",
01094 "l:0.000000 t:0.000000 r:0.000000 b:0.000000")
01095 {}
01096
01097 String get(const PropertyReceiver* receiver) const;
01098 void set(PropertyReceiver* receiver, const String& value);
01099 };
01100
01101
01116 class ZOrderChangeEnabled : public Property
01117 {
01118 public:
01119 ZOrderChangeEnabled() : Property(
01120 "ZOrderChangeEnabled",
01121 "Property to get/set the 'z-order changing enabled' setting for the Window. Value is either \"True\" or \"False\".",
01122 "True")
01123 {}
01124
01125 String get(const PropertyReceiver* receiver) const;
01126 void set(PropertyReceiver* receiver, const String& value);
01127 };
01128
01129
01145 class WantsMultiClickEvents : public Property
01146 {
01147 public:
01148 WantsMultiClickEvents() : Property(
01149 "WantsMultiClickEvents",
01150 "Property to get/set whether the window will receive double-click and triple-click events. Value is either \"True\" or \"False\".",
01151 "True")
01152 {}
01153
01154 String get(const PropertyReceiver* receiver) const;
01155 void set(PropertyReceiver* receiver, const String& value);
01156 };
01157
01158
01174 class MouseButtonDownAutoRepeat : public Property
01175 {
01176 public:
01177 MouseButtonDownAutoRepeat() : Property(
01178 "MouseButtonDownAutoRepeat",
01179 "Property to get/set whether the window will receive autorepeat mouse button down events. Value is either \"True\" or \"False\".",
01180 "False")
01181 {}
01182
01183 String get(const PropertyReceiver* receiver) const;
01184 void set(PropertyReceiver* receiver, const String& value);
01185 };
01186
01187
01201 class AutoRepeatDelay : public Property
01202 {
01203 public:
01204 AutoRepeatDelay() : Property(
01205 "AutoRepeatDelay",
01206 "Property to get/set the autorepeat delay. Value is a floating point number indicating the delay required in seconds.",
01207 "0.3")
01208 {}
01209
01210 String get(const PropertyReceiver* receiver) const;
01211 void set(PropertyReceiver* receiver, const String& value);
01212 };
01213
01214
01228 class AutoRepeatRate : public Property
01229 {
01230 public:
01231 AutoRepeatRate() : Property(
01232 "AutoRepeatRate",
01233 "Property to get/set the autorepeat rate. Value is a floating point number indicating the rate required in seconds.",
01234 "0.06")
01235 {}
01236
01237 String get(const PropertyReceiver* receiver) const;
01238 void set(PropertyReceiver* receiver, const String& value);
01239 };
01240
01241
01242 }
01243
01244
01245 }
01246
01247 #endif // end of guard _CEGUIWindowProperties_h_