Crazy Eddies GUI System 0.7.6
CEGUIScrollablePaneProperties.h
00001 /***********************************************************************
00002         filename:       CEGUIScrollablePaneProperties.h
00003         created:        3/3/2005
00004         author:         Paul D Turner
00005 *************************************************************************/
00006 /***************************************************************************
00007  *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
00008  *
00009  *   Permission is hereby granted, free of charge, to any person obtaining
00010  *   a copy of this software and associated documentation files (the
00011  *   "Software"), to deal in the Software without restriction, including
00012  *   without limitation the rights to use, copy, modify, merge, publish,
00013  *   distribute, sublicense, and/or sell copies of the Software, and to
00014  *   permit persons to whom the Software is furnished to do so, subject to
00015  *   the following conditions:
00016  *
00017  *   The above copyright notice and this permission notice shall be
00018  *   included in all copies or substantial portions of the Software.
00019  *
00020  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00021  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00022  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00023  *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
00024  *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00025  *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00026  *   OTHER DEALINGS IN THE SOFTWARE.
00027  ***************************************************************************/
00028 #ifndef _CEGUIScrollablePaneProperties_h_
00029 #define _CEGUIScrollablePaneProperties_h_
00030 
00031 #include "../CEGUIProperty.h"
00032 
00033 // Start of CEGUI namespace section
00034 namespace CEGUI
00035 {
00036 // Start of ScrollablePaneProperties namespace section
00041 namespace ScrollablePaneProperties
00042 {
00056     class ContentPaneAutoSized : public Property
00057     {
00058     public:
00059         ContentPaneAutoSized() : Property(
00060             "ContentPaneAutoSized",
00061             "Property to get/set the setting which controls whether the content pane will auto-size itself.  Value is either \"True\" or \"False\".",
00062             "True")
00063         {}
00064 
00065         String  get(const PropertyReceiver* receiver) const;
00066         void    set(PropertyReceiver* receiver, const String& value);
00067     };
00068 
00083     class ContentArea : public Property
00084     {
00085     public:
00086         ContentArea() : Property(
00087             "ContentArea",
00088             "Property to get/set the current content area rectangle of the content pane.  Value is \"l:[float] t:[float] r:[float] b:[float]\" (where l is left, t is top, r is right, and b is bottom).",
00089             "l:0.000000 t:0.000000 r:0.000000 b:0.000000")
00090         {}
00091 
00092         String  get(const PropertyReceiver* receiver) const;
00093         void    set(PropertyReceiver* receiver, const String& value);
00094     };
00095 
00109     class ForceVertScrollbar : public Property
00110     {
00111     public:
00112         ForceVertScrollbar() : Property(
00113             "ForceVertScrollbar",
00114             "Property to get/set the setting which controls whether the vertical scroll bar is aways shown.  Value is either \"True\" or \"False\".",
00115             "False")
00116         {}
00117 
00118         String  get(const PropertyReceiver* receiver) const;
00119         void    set(PropertyReceiver* receiver, const String& value);
00120     };
00121 
00122 
00136     class ForceHorzScrollbar : public Property
00137     {
00138     public:
00139         ForceHorzScrollbar() : Property(
00140             "ForceHorzScrollbar",
00141             "Property to get/set the setting which controls whether the horizontal scroll bar is aways shown.  Value is either \"True\" or \"False\".",
00142             "False")
00143         {}
00144 
00145         String  get(const PropertyReceiver* receiver) const;
00146         void    set(PropertyReceiver* receiver, const String& value);
00147     };
00148 
00160     class HorzStepSize : public Property
00161     {
00162     public:
00163         HorzStepSize() : Property(
00164             "HorzStepSize",
00165             "Property to get/set the step size for the horizontal Scrollbar.  Value is a float.",
00166             "0.100000")
00167         {}
00168 
00169         String  get(const PropertyReceiver* receiver) const;
00170         void    set(PropertyReceiver* receiver, const String& value);
00171     };
00172 
00184     class HorzOverlapSize : public Property
00185     {
00186     public:
00187         HorzOverlapSize() : Property(
00188             "HorzOverlapSize",
00189             "Property to get/set the overlap size for the horizontal Scrollbar.  Value is a float.",
00190             "0.010000")
00191         {}
00192 
00193         String  get(const PropertyReceiver* receiver) const;
00194         void    set(PropertyReceiver* receiver, const String& value);
00195     };
00196 
00208     class HorzScrollPosition : public Property
00209     {
00210     public:
00211         HorzScrollPosition() : Property(
00212             "HorzScrollPosition",
00213             "Property to get/set the scroll position of the horizontal Scrollbar as a fraction.  Value is a float.",
00214             "0.000000")
00215         {}
00216 
00217         String  get(const PropertyReceiver* receiver) const;
00218         void    set(PropertyReceiver* receiver, const String& value);
00219     };
00220 
00232     class VertStepSize : public Property
00233     {
00234     public:
00235         VertStepSize() : Property(
00236             "VertStepSize",
00237             "Property to get/set the step size for the vertical Scrollbar.  Value is a float.",
00238             "0.100000")
00239         {}
00240 
00241         String  get(const PropertyReceiver* receiver) const;
00242         void    set(PropertyReceiver* receiver, const String& value);
00243     };
00244 
00256     class VertOverlapSize : public Property
00257     {
00258     public:
00259         VertOverlapSize() : Property(
00260             "VertOverlapSize",
00261             "Property to get/set the overlap size for the vertical Scrollbar.  Value is a float.",
00262             "0.010000")
00263         {}
00264 
00265         String  get(const PropertyReceiver* receiver) const;
00266         void    set(PropertyReceiver* receiver, const String& value);
00267     };
00268 
00280     class VertScrollPosition : public Property
00281     {
00282     public:
00283         VertScrollPosition() : Property(
00284             "VertScrollPosition",
00285             "Property to get/set the scroll position of the vertical Scrollbar as a fraction.  Value is a float.",
00286             "0.000000")
00287         {}
00288 
00289         String  get(const PropertyReceiver* receiver) const;
00290         void    set(PropertyReceiver* receiver, const String& value);
00291     };
00292 
00293 } // End of  ScrollablePaneProperties namespace section
00294 } // End of  CEGUI namespace section
00295 
00296 
00297 #endif  // end of guard _CEGUIScrollablePaneProperties_h_