CEGUIScrollbarProperties.h

00001 /***********************************************************************
00002         filename:       CEGUIScrollbarProperties.h
00003         created:        10/7/2004
00004         author:         Paul D Turner
00005         
00006         purpose:        Interface for Scrollbar properties
00007 *************************************************************************/
00008 /***************************************************************************
00009  *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
00010  *
00011  *   Permission is hereby granted, free of charge, to any person obtaining
00012  *   a copy of this software and associated documentation files (the
00013  *   "Software"), to deal in the Software without restriction, including
00014  *   without limitation the rights to use, copy, modify, merge, publish,
00015  *   distribute, sublicense, and/or sell copies of the Software, and to
00016  *   permit persons to whom the Software is furnished to do so, subject to
00017  *   the following conditions:
00018  *
00019  *   The above copyright notice and this permission notice shall be
00020  *   included in all copies or substantial portions of the Software.
00021  *
00022  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00023  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00024  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00025  *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
00026  *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00027  *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00028  *   OTHER DEALINGS IN THE SOFTWARE.
00029  ***************************************************************************/
00030 #ifndef _CEGUIScrollbarProperties_h_
00031 #define _CEGUIScrollbarProperties_h_
00032 
00033 #include "CEGUIProperty.h"
00034 
00035 
00036 // Start of CEGUI namespace section
00037 namespace CEGUI
00038 {
00039 
00040 // Start of ScrollbarProperties namespace section
00045 namespace ScrollbarProperties
00046 {
00058 class DocumentSize : public Property
00059 {
00060 public:
00061         DocumentSize() : Property(
00062                 "DocumentSize",
00063                 "Property to get/set the document size for the Scrollbar.  Value is a float.",
00064                 "1.000000")
00065         {}
00066 
00067         String  get(const PropertyReceiver* receiver) const;
00068         void    set(PropertyReceiver* receiver, const String& value);
00069 };
00070 
00071 
00083 class PageSize : public Property
00084 {
00085 public:
00086         PageSize() : Property(
00087                 "PageSize",
00088                 "Property to get/set the page size for the Scrollbar.  Value is a float.",
00089                 "0.000000")
00090         {}
00091 
00092         String  get(const PropertyReceiver* receiver) const;
00093         void    set(PropertyReceiver* receiver, const String& value);
00094 };
00095 
00096 
00108 class StepSize : public Property
00109 {
00110 public:
00111         StepSize() : Property(
00112                 "StepSize",
00113                 "Property to get/set the step size for the Scrollbar.  Value is a float.",
00114                 "1.000000")
00115         {}
00116 
00117         String  get(const PropertyReceiver* receiver) const;
00118         void    set(PropertyReceiver* receiver, const String& value);
00119 };
00120 
00121 
00133 class OverlapSize : public Property
00134 {
00135 public:
00136         OverlapSize() : Property(
00137                 "OverlapSize",
00138                 "Property to get/set the overlap size for the Scrollbar.  Value is a float.",
00139                 "0.000000")
00140         {}
00141 
00142         String  get(const PropertyReceiver* receiver) const;
00143         void    set(PropertyReceiver* receiver, const String& value);
00144 };
00145 
00157 class ScrollPosition : public Property
00158 {
00159 public:
00160         ScrollPosition() : Property(
00161                 "ScrollPosition",
00162                 "Property to get/set the scroll position of the Scrollbar.  Value is a float.",
00163                 "0.000000")
00164         {}
00165 
00166         String  get(const PropertyReceiver* receiver) const;
00167         void    set(PropertyReceiver* receiver, const String& value);
00168 };
00169 
00170 } // End of  ScrollbarProperties namespace section
00171 
00172 } // End of  CEGUI namespace section
00173 
00174 
00175 #endif  // end of guard _CEGUIScrollbarProperties_h_

Generated on Sat Jun 28 14:35:44 2008 for Crazy Eddies GUI System by  doxygen 1.5.4