CEGUIThumbProperties.h

00001 /***********************************************************************
00002         filename:       CEGUIThumbProperties.h
00003         created:        10/7/2004
00004         author:         Paul D Turner
00005         
00006         purpose:        Interface for Thumb 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 _CEGUIThumbProperties_h_
00031 #define _CEGUIThumbProperties_h_
00032 
00033 #include "CEGUIProperty.h"
00034 
00035 
00036 // Start of CEGUI namespace section
00037 namespace CEGUI
00038 {
00039 
00040 // Start of ThumbProperties namespace section
00045 namespace ThumbProperties
00046 {
00059 class HotTracked : public Property
00060 {
00061 public:
00062         HotTracked() : Property(
00063                 "HotTracked",
00064                 "Property to get/set the state of the state of the 'hot-tracked' setting for the thumb.  Value is either \"True\" or \"False\".",
00065                 "True")
00066         {}
00067 
00068         String  get(const PropertyReceiver* receiver) const;
00069         void    set(PropertyReceiver* receiver, const String& value);
00070 };
00071 
00072 
00085 class VertFree : public Property
00086 {
00087 public:
00088         VertFree() : Property(
00089                 "VertFree",
00090                 "Property to get/set the state the setting to free the thumb vertically.  Value is either \"True\" or \"False\".",
00091                 "False")
00092         {}
00093 
00094         String  get(const PropertyReceiver* receiver) const;
00095         void    set(PropertyReceiver* receiver, const String& value);
00096 };
00097 
00098 
00111 class HorzFree : public Property
00112 {
00113 public:
00114         HorzFree() : Property(
00115                 "HorzFree", 
00116                 "Property to get/set the state the setting to free the thumb horizontally.  Value is either \"True\" or \"False\".",
00117                 "False")
00118         {}
00119 
00120         String  get(const PropertyReceiver* receiver) const;
00121         void    set(PropertyReceiver* receiver, const String& value);
00122 };
00123 
00124 
00137 class VertRange : public Property
00138 {
00139 public:
00140         VertRange() : Property(
00141                 "VertRange",
00142                 "Property to get/set the vertical movement range for the thumb.  Value is \"min:[float] max:[float]\".",
00143                 "min:0.000000 max:1.000000")
00144         {}
00145 
00146         String  get(const PropertyReceiver* receiver) const;
00147         void    set(PropertyReceiver* receiver, const String& value);
00148 };
00149 
00150 
00163 class HorzRange : public Property
00164 {
00165 public:
00166         HorzRange() : Property(
00167                 "HorzRange",
00168                 "Property to get/set the horizontal movement range for the thumb.  Value is \"min:[float] max:[float]\".",
00169                 "min:0.000000 max:1.000000")
00170         {}
00171 
00172         String  get(const PropertyReceiver* receiver) const;
00173         void    set(PropertyReceiver* receiver, const String& value);
00174 };
00175 
00176 
00177 } // End of  ThumbProperties namespace section
00178 
00179 } // End of  CEGUI namespace section
00180 
00181 
00182 #endif  // end of guard _CEGUIThumbProperties_h_

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