# CEGUIWindowProperties.h

    00001 /************************************************************************
    00002         filename:       CEGUIWindowProperties.h
    00003         created:        5/7/2004
    00004         author:         Paul D Turner
    00005
    00006         purpose:        Interface to available window base class properties
    00007 *************************************************************************/
    00008 /*************************************************************************
    00009     Crazy Eddie's GUI System (http://www.cegui.org.uk)
    00010     Copyright (C)2004 - 2005 Paul D Turner (paul@cegui.org.uk)
    00011
    00012     This library is free software; you can redistribute it and/or
    00013     modify it under the terms of the GNU Lesser General Public
    00014     License as published by the Free Software Foundation; either
    00015     version 2.1 of the License, or (at your option) any later version.
    00016
    00017     This library is distributed in the hope that it will be useful,
    00018     but WITHOUT ANY WARRANTY; without even the implied warranty of
    00019     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    00020     Lesser General Public License for more details.
    00021
    00022     You should have received a copy of the GNU Lesser General Public
    00023     License along with this library; if not, write to the Free Software
    00024     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
    00025 *************************************************************************/
    00026 #ifndef _CEGUIWindowProperties_h_
    00027 #define _CEGUIWindowProperties_h_
    00028
    00029 #include "CEGUIProperty.h"
    00030
    00031
    00032 // Start of CEGUI namespace section
    00033 namespace CEGUI
    00034 {
    00035
    00036 // Start of WindowProperties namespace section
    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", false)
    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", false)
    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", false)
    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                 "", false)
    00148                 {}
    00149
    00150         String  get(const PropertyReceiver* receiver) const;
    00151         void    set(PropertyReceiver* receiver, const String& value);
    00152
    00153         // default depends upon current size of display.
    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         bool    isDefault(const PropertyReceiver* receiver) const;
    00267 };
    00268
    00269
    00283 class Text : public Property
    00284 {
    00285 public:
    00286         Text() : Property(
    00287                 "Text",
    00288                 "Property to get/set the text / caption for the Window.  Value is the text string to use.",
    00289                 "")
    00290         {}
    00291
    00292         String  get(const PropertyReceiver* receiver) const;
    00293         void    set(PropertyReceiver* receiver, const String& value);
    00294 };
    00295
    00296
    00311 class MouseCursorImage : public Property
    00312 {
    00313 public:
    00314         MouseCursorImage() : Property(
    00315                 "MouseCursorImage",
    00316                 "Property to get/set the mouse cursor image for the Window.  Value should be \"set:<imageset name> image:<image name>\".",
    00317                 "")
    00318         {}
    00319
    00320         String  get(const PropertyReceiver* receiver) const;
    00321         void    set(PropertyReceiver* receiver, const String& value);
    00322         bool    isDefault(const PropertyReceiver* receiver) const;
    00323 };
    00324
    00325
    00340 class ClippedByParent : public Property
    00341 {
    00342 public:
    00343         ClippedByParent() : Property(
    00344                 "ClippedByParent",
    00345                 "Property to get/set the 'clipped by parent' setting for the Window.  Value is either \"True\" or \"False\".",
    00346                 "True")
    00347         {}
    00348
    00349         String  get(const PropertyReceiver* receiver) const;
    00350         void    set(PropertyReceiver* receiver, const String& value);
    00351 };
    00352
    00353
    00368 class InheritsAlpha : public Property
    00369 {
    00370 public:
    00371         InheritsAlpha() : Property(
    00372                 "InheritsAlpha",
    00373                 "Property to get/set the 'inherits alpha' setting for the Window.  Value is either \"True\" or \"False\".",
    00374                 "True")
    00375         {}
    00376
    00377         String  get(const PropertyReceiver* receiver) const;
    00378         void    set(PropertyReceiver* receiver, const String& value);
    00379 };
    00380
    00381
    00396 class AlwaysOnTop : public Property
    00397 {
    00398 public:
    00399         AlwaysOnTop() : Property(
    00400                 "AlwaysOnTop",
    00401                 "Property to get/set the 'always on top' setting for the Window.  Value is either \"True\" or \"False\".",
    00402                 "False")
    00403         {}
    00404
    00405         String  get(const PropertyReceiver* receiver) const;
    00406         void    set(PropertyReceiver* receiver, const String& value);
    00407 };
    00408
    00409
    00424 class Disabled : public Property
    00425 {
    00426 public:
    00427         Disabled() : Property(
    00428                 "Disabled",
    00429                 "Property to get/set the 'disabled state' setting for the Window.  Value is either \"True\" or \"False\".",
    00430                 "False")
    00431         {}
    00432
    00433         String  get(const PropertyReceiver* receiver) const;
    00434         void    set(PropertyReceiver* receiver, const String& value);
    00435         bool    isDefault(const PropertyReceiver* receiver) const;
    00436 };
    00437
    00438
    00453 class Visible : public Property
    00454 {
    00455 public:
    00456         Visible() : Property(
    00457                 "Visible",
    00458                 "Property to get/set the 'visible state' setting for the Window.  Value is either \"True\" or \"False\".",
    00459                 "True")
    00460         {}
    00461
    00462         String  get(const PropertyReceiver* receiver) const;
    00463         void    set(PropertyReceiver* receiver, const String& value);
    00464         bool    isDefault(const PropertyReceiver* receiver) const;
    00465 };
    00466
    00467
    00483 class RestoreOldCapture : public Property
    00484 {
    00485 public:
    00486         RestoreOldCapture() : Property(
    00487                 "RestoreOldCapture",
    00488                 "Property to get/set the 'restore old capture' setting for the Window.  Value is either \"True\" or \"False\".",
    00489                 "False")
    00490         {}
    00491
    00492         String  get(const PropertyReceiver* receiver) const;
    00493         void    set(PropertyReceiver* receiver, const String& value);
    00494 };
    00495
    00496
    00511 class DestroyedByParent : public Property
    00512 {
    00513 public:
    00514         DestroyedByParent() : Property(
    00515                 "DestroyedByParent",
    00516                 "Property to get/set the 'destroyed by parent' setting for the Window.  Value is either \"True\" or \"False\".",
    00517                 "True")
    00518         {}
    00519
    00520         String  get(const PropertyReceiver* receiver) const;
    00521         void    set(PropertyReceiver* receiver, const String& value);
    00522 };
    00523
    00524
    00538 class Width : public Property
    00539 {
    00540 public:
    00541         Width() : Property(
    00542                 "Width",
    00543                 "Property to get/set the width of the Window.  Value is floating point using the active metrics mode.",
    00544                 "0.000000", false) {}
    00545
    00546         String  get(const PropertyReceiver* receiver) const;
    00547         void    set(PropertyReceiver* receiver, const String& value);
    00548 };
    00549
    00550
    00564 class RelativeWidth : public Property
    00565 {
    00566 public:
    00567         RelativeWidth() : Property(
    00568                 "RelativeWidth",
    00569                 "Property to get/set the width of the Window.  Value is floating point using relative metrics.",
    00570                 "0.000000", false)
    00571         {}
    00572
    00573         String  get(const PropertyReceiver* receiver) const;
    00574         void    set(PropertyReceiver* receiver, const String& value);
    00575 };
    00576
    00577
    00591 class AbsoluteWidth: public Property
    00592 {
    00593 public:
    00594         AbsoluteWidth() : Property(
    00595                 "AbsoluteWidth",
    00596                 "Property to get/set the width of the Window.  Value is floating point using absolute metrics.",
    00597                 "0.000000", false)
    00598         {}
    00599
    00600         String  get(const PropertyReceiver* receiver) const;
    00601         void    set(PropertyReceiver* receiver, const String& value);
    00602 };
    00603
    00604
    00618 class Height : public Property
    00619 {
    00620 public:
    00621         Height() : Property(
    00622                 "Height",
    00623                 "Property to get/set the height of the Window.  Value is floating point using the active metrics mode.",
    00624                 "0.000000", false)
    00625         {}
    00626
    00627         String  get(const PropertyReceiver* receiver) const;
    00628         void    set(PropertyReceiver* receiver, const String& value);
    00629 };
    00630
    00631
    00645 class RelativeHeight : public Property
    00646 {
    00647 public:
    00648         RelativeHeight() : Property(
    00649                 "RelativeHeight",
    00650                 "Property to get/set the height of the Window.  Value is floating point using relative metrics.",
    00651                 "0.000000", false)
    00652         {}
    00653
    00654         String  get(const PropertyReceiver* receiver) const;
    00655         void    set(PropertyReceiver* receiver, const String& value);
    00656 };
    00657
    00658
    00672 class AbsoluteHeight : public Property
    00673 {
    00674 public:
    00675         AbsoluteHeight() : Property(
    00676                 "AbsoluteHeight",
    00677                 "Property to get/set the height of the Window.  Value is floating point using absolute metrics.",
    00678                 "0.000000", false)
    00679         {}
    00680
    00681         String  get(const PropertyReceiver* receiver) const;
    00682         void    set(PropertyReceiver* receiver, const String& value);
    00683 };
    00684
    00685
    00700 class Size : public Property
    00701 {
    00702 public:
    00703         Size() : Property(
    00704                 "Size",
    00705                 "Property to get/set the size of the Window.  Value is \"w:[float] h:[float]\" using the active metrics mode.",
    00706                 "w:0.000000 h:0.000000", false)
    00707         {}
    00708
    00709         String  get(const PropertyReceiver* receiver) const;
    00710         void    set(PropertyReceiver* receiver, const String& value);
    00711 };
    00712
    00713
    00728 class RelativeSize : public Property
    00729 {
    00730 public:
    00731         RelativeSize() : Property(
    00732                 "RelativeSize",
    00733                 "Property to get/set the size of the Window.  Value is \"w:[float] h:[float]\" using relative metrics.",
    00734                 "w:0.000000 h:0.000000", false)
    00735         {}
    00736
    00737         String  get(const PropertyReceiver* receiver) const;
    00738         void    set(PropertyReceiver* receiver, const String& value);
    00739 };
    00740
    00741
    00756 class AbsoluteSize : public Property
    00757 {
    00758 public:
    00759         AbsoluteSize() : Property(
    00760                 "AbsoluteSize",
    00761                 "Property to get/set the size of the Window.  Value is \"w:[float] h:[float]\" using absolute metrics.",
    00762                 "w:0.000000 h:0.000000", false)
    00763         {}
    00764
    00765         String  get(const PropertyReceiver* receiver) const;
    00766         void    set(PropertyReceiver* receiver, const String& value);
    00767 };
    00768
    00769
    00783 class XPosition : public Property
    00784 {
    00785 public:
    00786         XPosition() : Property(
    00787                 "XPosition",
    00788                 "Property to get/set the x co-ordinate position of the Window.  Value is a floating point number using the active metrics mode.",
    00789                 "0.000000", false)
    00790         {}
    00791
    00792         String  get(const PropertyReceiver* receiver) const;
    00793         void    set(PropertyReceiver* receiver, const String& value);
    00794 };
    00795
    00796
    00810 class RelativeXPosition : public Property
    00811 {
    00812 public:
    00813         RelativeXPosition() : Property(
    00814                 "RelativeXPosition",
    00815                 "Property to get/set the x co-ordinate position of the Window.  Value is a floating point number using relative metrics.",
    00816                 "0.000000", false)
    00817         {}
    00818
    00819         String  get(const PropertyReceiver* receiver) const;
    00820         void    set(PropertyReceiver* receiver, const String& value);
    00821 };
    00822
    00823
    00837 class AbsoluteXPosition : public Property
    00838 {
    00839 public:
    00840         AbsoluteXPosition() : Property(
    00841                 "AbsoluteXPosition",
    00842                 "Property to get/set the x co-ordinate position of the Window.  Value is a floating point number using absolute metrics.",
    00843                 "0.000000", false)
    00844         {}
    00845
    00846         String  get(const PropertyReceiver* receiver) const;
    00847         void    set(PropertyReceiver* receiver, const String& value);
    00848 };
    00849
    00850
    00864 class YPosition : public Property
    00865 {
    00866 public:
    00867         YPosition() : Property(
    00868                 "YPosition",
    00869                 "Property to get/set the y co-ordinate position of the Window.  Value is a floating point number using the active metrics mode.",
    00870                 "0.000000", false)
    00871         {}
    00872
    00873         String  get(const PropertyReceiver* receiver) const;
    00874         void    set(PropertyReceiver* receiver, const String& value);
    00875 };
    00876
    00877
    00891 class RelativeYPosition : public Property
    00892 {
    00893 public:
    00894         RelativeYPosition() : Property(
    00895                 "RelativeYPosition",
    00896                 "Property to get/set the y co-ordinate position of the Window.  Value is a floating point number using relative metrics.",
    00897                 "0.000000", false)
    00898         {}
    00899
    00900         String  get(const PropertyReceiver* receiver) const;
    00901         void    set(PropertyReceiver* receiver, const String& value);
    00902 };
    00903
    00904
    00918 class AbsoluteYPosition : public Property
    00919 {
    00920 public:
    00921         AbsoluteYPosition() : Property(
    00922                 "AbsoluteYPosition",
    00923                 "Property to get/set the y co-ordinate position of the Window.  Value is a floating point number using absolute metrics.",
    00924                 "0.000000", false)
    00925         {}
    00926
    00927         String  get(const PropertyReceiver* receiver) const;
    00928         void    set(PropertyReceiver* receiver, const String& value);
    00929 };
    00930
    00931
    00946 class Position : public Property
    00947 {
    00948 public:
    00949         Position() : Property(
    00950                 "Position",
    00951                 "Property to get/set the position of the Window.  Value is \"x:[float] y:[float]\" using the active metrics mode.",
    00952                 "x:0.000000 y:0.000000", false)
    00953         {}
    00954
    00955         String  get(const PropertyReceiver* receiver) const;
    00956         void    set(PropertyReceiver* receiver, const String& value);
    00957 };
    00958
    00959
    00974 class RelativePosition : public Property
    00975 {
    00976 public:
    00977         RelativePosition() : Property(
    00978                 "RelativePosition",
    00979                 "Property to get/set the position of the Window.  Value is \"x:[float] y:[float]\" using relative metrics.",
    00980                 "x:0.000000 y:0.000000", false)
    00981         {}
    00982
    00983         String  get(const PropertyReceiver* receiver) const;
    00984         void    set(PropertyReceiver* receiver, const String& value);
    00985 };
    00986
    00987
    01002 class AbsolutePosition : public Property
    01003 {
    01004 public:
    01005         AbsolutePosition() : Property(
    01006                 "AbsolutePosition",
    01007                 "Property to get/set the position of the Window.  Value is \"x:[float] y:[float]\" using absolute metrics.",
    01008                 "x:0.000000 y:0.000000", false)
    01009         {}
    01010
    01011         String  get(const PropertyReceiver* receiver) const;
    01012         void    set(PropertyReceiver* receiver, const String& value);
    01013 };
    01014
    01015
    01032 class Rect : public Property
    01033 {
    01034 public:
    01035         Rect() : Property(
    01036                 "Rect",
    01037                 "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.",
    01038                 "l:0.000000 t:0.000000 r:0.000000 b:0.000000", false)
    01039         {}
    01040
    01041         String  get(const PropertyReceiver* receiver) const;
    01042         void    set(PropertyReceiver* receiver, const String& value);
    01043 };
    01044
    01045
    01062 class RelativeRect : public Property
    01063 {
    01064 public:
    01065         RelativeRect() : Property(
    01066                 "RelativeRect",
    01067                 "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.",
    01068                 "l:0.000000 t:0.000000 r:0.000000 b:0.000000", false)
    01069         {}
    01070
    01071         String  get(const PropertyReceiver* receiver) const;
    01072         void    set(PropertyReceiver* receiver, const String& value);
    01073 };
    01074
    01075
    01092 class AbsoluteRect : public Property
    01093 {
    01094 public:
    01095         AbsoluteRect() : Property(
    01096                 "AbsoluteRect",
    01097                 "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.",
    01098                 "l:0.000000 t:0.000000 r:0.000000 b:0.000000", false)
    01099         {}
    01100
    01101         String  get(const PropertyReceiver* receiver) const;
    01102         void    set(PropertyReceiver* receiver, const String& value);
    01103 };
    01104
    01105
    01120 class ZOrderChangeEnabled : public Property
    01121 {
    01122 public:
    01123         ZOrderChangeEnabled() : Property(
    01124                 "ZOrderChangeEnabled",
    01125                 "Property to get/set the 'z-order changing enabled' setting for the Window.  Value is either \"True\" or \"False\".",
    01126                 "True")
    01127         {}
    01128
    01129         String  get(const PropertyReceiver* receiver) const;
    01130         void    set(PropertyReceiver* receiver, const String& value);
    01131 };
    01132
    01133
    01149 class WantsMultiClickEvents : public Property
    01150 {
    01151 public:
    01152     WantsMultiClickEvents() : Property(
    01153         "WantsMultiClickEvents",
    01154         "Property to get/set whether the window will receive double-click and triple-click events.  Value is either \"True\" or \"False\".",
    01155         "True")
    01156     {}
    01157
    01158     String      get(const PropertyReceiver* receiver) const;
    01159     void        set(PropertyReceiver* receiver, const String& value);
    01160 };
    01161
    01162
    01178 class MouseButtonDownAutoRepeat : public Property
    01179 {
    01180 public:
    01181     MouseButtonDownAutoRepeat() : Property(
    01182         "MouseButtonDownAutoRepeat",
    01183         "Property to get/set whether the window will receive autorepeat mouse button down events.  Value is either \"True\" or \"False\".",
    01184         "False")
    01185     {}
    01186
    01187     String  get(const PropertyReceiver* receiver) const;
    01188     void    set(PropertyReceiver* receiver, const String& value);
    01189 };
    01190
    01191
    01205 class AutoRepeatDelay : public Property
    01206 {
    01207 public:
    01208     AutoRepeatDelay() : Property(
    01209         "AutoRepeatDelay",
    01210         "Property to get/set the autorepeat delay.  Value is a floating point number indicating the delay required in seconds.",
    01211         "0.300000")
    01212     {}
    01213
    01214     String  get(const PropertyReceiver* receiver) const;
    01215     void    set(PropertyReceiver* receiver, const String& value);
    01216 };
    01217
    01218
    01232 class AutoRepeatRate : public Property
    01233 {
    01234 public:
    01235     AutoRepeatRate() : Property(
    01236         "AutoRepeatRate",
    01237         "Property to get/set the autorepeat rate.  Value is a floating point number indicating the rate required in seconds.",
    01238         "0.060000")
    01239     {}
    01240
    01241     String  get(const PropertyReceiver* receiver) const;
    01242     void    set(PropertyReceiver* receiver, const String& value);
    01243 };
    01244
    01258 class DistributeCapturedInputs : public Property
    01259 {
    01260 public:
    01261         DistributeCapturedInputs() : Property(
    01262                 "DistributeCapturedInputs",
    01263                 "Property to get/set whether captured inputs are passed to child windows.  Value is either \"True\" or \"False\".",
    01264                 "False")
    01265         {}
    01266
    01267         String  get(const PropertyReceiver* receiver) const;
    01268         void    set(PropertyReceiver* receiver, const String& value);
    01269 };
    01270
    01282 class CustomTooltipType : public Property
    01283 {
    01284 public:
    01285     CustomTooltipType() : Property(
    01286     "CustomTooltipType",
    01287     "Property to get/set the custom tooltip for the window.  Value is the type name of the custom tooltip.",
    01288     "")
    01289     {}
    01290
    01291     String  get(const PropertyReceiver* receiver) const;
    01292     void    set(PropertyReceiver* receiver, const String& value);
    01293 };
    01294
    01306 class Tooltip : public Property
    01307 {
    01308 public:
    01309     Tooltip() : Property(
    01310     "Tooltip",
    01311     "Property to get/set the tooltip text for the window.  Value is the tooltip text for the window.",
    01312     "")
    01313     {}
    01314
    01315     String  get(const PropertyReceiver* receiver) const;
    01316     void    set(PropertyReceiver* receiver, const String& value);
    01317 };
    01318
    01331 class InheritsTooltipText : public Property
    01332 {
    01333 public:
    01334     InheritsTooltipText() : Property(
    01335         "InheritsTooltipText",
    01336         "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\".",
    01337         "False")
    01338     {}
    01339
    01340     String  get(const PropertyReceiver* receiver) const;
    01341     void    set(PropertyReceiver* receiver, const String& value);
    01342 };
    01343
    01344
    01357 class RiseOnClick : public Property
    01358 {
    01359 public:
    01360     RiseOnClick() : Property(
    01361                 "RiseOnClick",
    01362                 "Property to get/set whether the window will come tot he top of the z order hwn clicked.  Value is either \"True\" or \"False\".",
    01363                 "True")
    01364         {}
    01365
    01366         String  get(const PropertyReceiver* receiver) const;
    01367         void    set(PropertyReceiver* receiver, const String& value);
    01368 };
    01369
    01370
    01384 class VerticalAlignment : public Property
    01385 {
    01386     public:
    01387         VerticalAlignment() : Property(
    01388         "VerticalAlignment",
    01389         "Property to get/set the windows vertical alignment.  Value is one of \"Top\", \"Centre\" or \"Bottom\".",
    01390         "Top")
    01391         {}
    01392
    01393         String  get(const PropertyReceiver* receiver) const;
    01394         void    set(PropertyReceiver* receiver, const String& value);
    01395 };
    01396
    01397
    01411 class HorizontalAlignment : public Property
    01412 {
    01413     public:
    01414         HorizontalAlignment() : Property(
    01415         "HorizontalAlignment",
    01416         "Property to get/set the windows horizontal alignment.  Value is one of \"Left\", \"Centre\" or \"Right\".",
    01417         "Left")
    01418         {}
    01419
    01420         String  get(const PropertyReceiver* receiver) const;
    01421         void    set(PropertyReceiver* receiver, const String& value);
    01422 };
    01423
    01424
    01425 /*
    01426 \brief
    01427         Property to access the unified area rectangle of the window.
    01428
    01429         \par Usage:
    01430                 - Name: UnifiedAreaRect
    01431                 - Format: "{{[ls],[lo]},{[ts],[to]},{[rs],[ro]},{[bs],[bo]}}"
    01432
    01433         \par Where:
    01434                 - [ls] is a floating point value describing the relative scale value for the left edge.
    01435                 - [lo] is a floating point value describing the absolute offset value for the left edge.
    01436                 - [ts] is a floating point value describing the relative scale value for the top edge.
    01437                 - [to] is a floating point value describing the absolute offset value for the top edge.
    01438                 - [rs] is a floating point value describing the relative scale value for the right edge.
    01439                 - [ro] is a floating point value describing the absolute offset value for the right edge.
    01440                 - [bs] is a floating point value describing the relative scale value for the bottom edge.
    01441                 - [bo] is a floating point value describing the absolute offset value for the bottom edge.
    01442 */
    01443 class UnifiedAreaRect : public Property
    01444 {
    01445         public:
    01446                 UnifiedAreaRect() : Property(
    01447                 "UnifiedAreaRect",
    01448                 "Property to get/set the windows unified area rectangle.  Value is a \"URect\".",
    01449                 "{{0.000000,0.000000},{0.000000,0.000000},{0.000000,0.000000},{0.000000,0.000000}}")
    01450                 {}
    01451
    01452                 String  get(const PropertyReceiver* receiver) const;
    01453                 void    set(PropertyReceiver* receiver, const String& value);
    01454 };
    01455
    01456
    01457 /*
    01458 \brief
    01459         Property to access the unified position of the window.
    01460
    01461         \par Usage:
    01462                 - Name: UnifiedPosition
    01463                 - Format: "{{[xs],[xo]},{[ys],[yo]}}"
    01464
    01465         \par Where:
    01466                 - [xs] is a floating point value describing the relative scale value for the position x-coordinate.
    01467                 - [xo] is a floating point value describing the absolute offset value for the position x-coordinate.
    01468                 - [ys] is a floating point value describing the relative scale value for the position y-coordinate.
    01469                 - [yo] is a floating point value describing the absolute offset value for the position y-coordinate.
    01470 */
    01471 class UnifiedPosition : public Property
    01472 {
    01473         public:
    01474                 UnifiedPosition() : Property(
    01475                 "UnifiedPosition",
    01476                 "Property to get/set the windows unified position.  Value is a \"UVector2\".",
    01477                 "{{0.000000,0.000000},{0.000000,0.000000}}", false)
    01478                 {}
    01479
    01480                 String  get(const PropertyReceiver* receiver) const;
    01481                 void    set(PropertyReceiver* receiver, const String& value);
    01482 };
    01483
    01484
    01485 /*
    01486 \brief
    01487         Property to access the unified position x-coordinate of the window.
    01488
    01489         \par Usage:
    01490                 - Name: UnifiedXPosition
    01491                 - Format: "{[s],[o]}"
    01492
    01493         \par Where:
    01494                 - [s] is a floating point value describing the relative scale value for the position x-coordinate.
    01495                 - [o] is a floating point value describing the absolute offset value for the position x-coordinate.
    01496 */
    01497 class UnifiedXPosition : public Property
    01498 {
    01499         public:
    01500                 UnifiedXPosition() : Property(
    01501                 "UnifiedXPosition",
    01502                 "Property to get/set the windows unified position x-coordinate.  Value is a \"UDim\".",
    01503                 "{0.000000,0.000000}", false)
    01504                 {}
    01505
    01506                 String  get(const PropertyReceiver* receiver) const;
    01507                 void    set(PropertyReceiver* receiver, const String& value);
    01508 };
    01509
    01510
    01511 /*
    01512 \brief
    01513         Property to access the unified position y-coordinate of the window.
    01514
    01515         \par Usage:
    01516                 - Name: UnifiedYPosition
    01517                 - Format: "{[s],[o]}"
    01518
    01519         \par Where:
    01520                 - [s] is a floating point value describing the relative scale value for the position y-coordinate.
    01521                 - [o] is a floating point value describing the absolute offset value for the position y-coordinate.
    01522 */
    01523 class UnifiedYPosition : public Property
    01524 {
    01525         public:
    01526                 UnifiedYPosition() : Property(
    01527                 "UnifiedYPosition",
    01528                 "Property to get/set the windows unified position y-coordinate.  Value is a \"UDim\".",
    01529                 "{0.000000,0.000000}", false)
    01530                 {}
    01531
    01532                 String  get(const PropertyReceiver* receiver) const;
    01533                 void    set(PropertyReceiver* receiver, const String& value);
    01534 };
    01535
    01536
    01537 /*
    01538 \brief
    01539         Property to access the unified position of the window.
    01540
    01541         \par Usage:
    01542                 - Name: UnifiedSize
    01543                 - Format: "{{[ws],[wo]},{[hs],[ho]}}"
    01544
    01545         \par Where:
    01546                 - [ws] is a floating point value describing the relative scale value for the width.
    01547                 - [wo] is a floating point value describing the absolute offset value for the width.
    01548                 - [hs] is a floating point value describing the relative scale value for the height.
    01549                 - [ho] is a floating point value describing the absolute offset value for the height.
    01550 */
    01551 class UnifiedSize : public Property
    01552 {
    01553         public:
    01554                 UnifiedSize() : Property(
    01555                 "UnifiedSize",
    01556                 "Property to get/set the windows unified size.  Value is a \"UVector2\".",
    01557                 "{{0.000000,0.000000},{0.000000,0.000000}}", false)
    01558                 {}
    01559
    01560                 String  get(const PropertyReceiver* receiver) const;
    01561                 void    set(PropertyReceiver* receiver, const String& value);
    01562 };
    01563
    01564
    01565 /*
    01566 \brief
    01567         Property to access the unified width of the window.
    01568
    01569         \par Usage:
    01570                 - Name: UnifiedWidth
    01571                 - Format: "{[s],[o]}"
    01572
    01573         \par Where:
    01574                 - [s] is a floating point value describing the relative scale value for the width.
    01575                 - [o] is a floating point value describing the absolute offset value for the width.
    01576 */
    01577 class UnifiedWidth : public Property
    01578 {
    01579         public:
    01580                 UnifiedWidth() : Property(
    01581                 "UnifiedWidth",
    01582                 "Property to get/set the windows unified width.  Value is a \"UDim\".",
    01583                 "{0.000000,0.000000}", false)
    01584                 {}
    01585
    01586                 String  get(const PropertyReceiver* receiver) const;
    01587                 void    set(PropertyReceiver* receiver, const String& value);
    01588 };
    01589
    01590
    01591 /*
    01592 \brief
    01593         Property to access the unified height of the window.
    01594
    01595         \par Usage:
    01596                 - Name: UnifiedHeight
    01597                 - Format: "{[s],[o]}"
    01598
    01599         \par Where:
    01600                 - [s] is a floating point value describing the relative scale value for the height.
    01601                 - [o] is a floating point value describing the absolute offset value for the height.
    01602 */
    01603 class UnifiedHeight : public Property
    01604 {
    01605         public:
    01606                 UnifiedHeight() : Property(
    01607                 "UnifiedHeight",
    01608                 "Property to get/set the windows unified height.  Value is a \"UDim\".",
    01609                 "{0.000000,0.000000}", false)
    01610                 {}
    01611
    01612                 String  get(const PropertyReceiver* receiver) const;
    01613                 void    set(PropertyReceiver* receiver, const String& value);
    01614 };
    01615
    01616
    01617 /*
    01618 \brief
    01619         Property to access the unified minimum size of the window.
    01620
    01621         \par Usage:
    01622                 - Name: UnifiedMinSize
    01623                 - Format: "{{[ws],[wo]},{[hs],[ho]}}"
    01624
    01625         \par Where:
    01626                 - [ws] is a floating point value describing the relative scale value for the minimum width.
    01627                 - [wo] is a floating point value describing the absolute offset value for the minimum width.
    01628                 - [hs] is a floating point value describing the relative scale value for the minimum height.
    01629                 - [ho] is a floating point value describing the absolute offset value for the minimum height.
    01630 */
    01631 class UnifiedMinSize : public Property
    01632 {
    01633         public:
    01634                 UnifiedMinSize() : Property(
    01635                 "UnifiedMinSize",
    01636                 "Property to get/set the windows unified minimum size.  Value is a \"UVector2\".",
    01637                 "{{0.000000,0.000000},{0.000000,0.000000}}")
    01638                 {}
    01639
    01640                 String  get(const PropertyReceiver* receiver) const;
    01641                 void    set(PropertyReceiver* receiver, const String& value);
    01642 };
    01643
    01644
    01645 /*
    01646 \brief
    01647         Property to access the unified maximum size of the window.
    01648
    01649         \par Usage:
    01650                 - Name: UnifiedMaxSize
    01651                 - Format: "{{[ws],[wo]},{[hs],[ho]}}"
    01652
    01653         \par Where:
    01654                 - [ws] is a floating point value describing the relative scale value for the maximum width.
    01655                 - [wo] is a floating point value describing the absolute offset value for the maximum width.
    01656                 - [hs] is a floating point value describing the relative scale value for the maximum height.
    01657                 - [ho] is a floating point value describing the absolute offset value for the maximum height.
    01658 */
    01659 class UnifiedMaxSize : public Property
    01660 {
    01661         public:
    01662                 UnifiedMaxSize() : Property(
    01663                 "UnifiedMaxSize",
    01664                 "Property to get/set the windows unified maximum size.  Value is a \"UVector2\".",
    01665                 "{{0.000000,0.000000},{0.000000,0.000000}}")
    01666                 {}
    01667
    01668                 String  get(const PropertyReceiver* receiver) const;
    01669                 void    set(PropertyReceiver* receiver, const String& value);
    01670 };
    01671
    01672
    01673 } // End of  WindowProperties namespace section
    01674
    01675
    01676 } // End of  CEGUI namespace section
    01677
    01678 #endif  // end of guard _CEGUIWindowProperties_h_