home *** CD-ROM | disk | FTP | other *** search
/ Game Programming in C++ - Start to Finish / GameProgrammingS.iso / developer_install / CEGUISDK-0.4.1-VC6-Native.exe / {app} / include / elements / CEGUIDragContainerProperties.h < prev    next >
Encoding:
C/C++ Source or Header  |  2005-02-15  |  4.6 KB  |  139 lines
  1. /************************************************************************
  2.     filename:     CEGUIDragContainerProperties.h
  3.     created:    15/2/2005
  4.     author:        Paul D Turner
  5. *************************************************************************/
  6. /*************************************************************************
  7.     Crazy Eddie's GUI System (http://www.cegui.org.uk)
  8.     Copyright (C)2004 - 2005 Paul D Turner (paul@cegui.org.uk)
  9.  
  10.     This library is free software; you can redistribute it and/or
  11.     modify it under the terms of the GNU Lesser General Public
  12.     License as published by the Free Software Foundation; either
  13.     version 2.1 of the License, or (at your option) any later version.
  14.  
  15.     This library is distributed in the hope that it will be useful,
  16.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  17.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18.     Lesser General Public License for more details.
  19.  
  20.     You should have received a copy of the GNU Lesser General Public
  21.     License along with this library; if not, write to the Free Software
  22.     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23. *************************************************************************/
  24. #ifndef _CEGUIDragContainerProperties_h_
  25. #define _CEGUIDragContainerProperties_h_
  26.  
  27. #include "CEGUIProperty.h"
  28.  
  29. // Start of CEGUI namespace section
  30. namespace CEGUI
  31. {
  32. // Start of DragContainerProperties namespace section
  33. namespace DragContainerProperties
  34. {
  35.     /*!
  36.     \brief
  37.         Property to access the state of the dragging enabled setting.
  38.  
  39.         \par Usage:
  40.             - Name: DraggingEnabled
  41.             - Format: "[text]".
  42.  
  43.         \par Where [Text] is:
  44.             - "True" to indicate that dragging is enabled.
  45.             - "False" to indicate that dragging is disabled.
  46.     */
  47.     class DraggingEnabled : public Property
  48.     {
  49.     public:
  50.         DraggingEnabled() : Property(
  51.             "DraggingEnabled",
  52.             "Property to get/set the state of the dragging enabled setting for the DragContainer.  Value is either \"True\" or \"False\".",
  53.             "True")
  54.         {}
  55.  
  56.         String    get(const PropertyReceiver* receiver) const;
  57.         void    set(PropertyReceiver* receiver, const String& value);
  58.     };
  59.  
  60.     /*!
  61.     \brief
  62.         Property to access the dragging alpha value.
  63.  
  64.         \par Usage:
  65.             - Name: DragAlpha
  66.             - Format: "[float]".
  67.  
  68.         \par Where:
  69.             - [float] represents the alpha value to set when dragging.
  70.     */
  71.     class DragAlpha : public Property
  72.     {
  73.     public:
  74.         DragAlpha() : Property(
  75.             "DragAlpha",
  76.             "Property to get/set the dragging alpha value.  Value is a float.",
  77.             "0.500000")
  78.         {}
  79.  
  80.         String get(const PropertyReceiver* receiver) const;
  81.         void set(PropertyReceiver* receiver, const String& value);
  82.     };
  83.  
  84.     /*!
  85.     \brief
  86.         Property to access the dragging threshold value.
  87.  
  88.         \par Usage:
  89.             - Name: DragThreshold
  90.             - Format: "[float]".
  91.  
  92.         \par Where:
  93.             - [float] represents the movement threshold (in pixels) which must be exceeded to commence dragging.
  94.     */
  95.     class DragThreshold : public Property
  96.     {
  97.     public:
  98.         DragThreshold() : Property(
  99.             "DragThreshold",
  100.             "Property to get/set the dragging threshold value.  Value is a float.",
  101.             "8.000000")
  102.         {}
  103.  
  104.         String get(const PropertyReceiver* receiver) const;
  105.         void set(PropertyReceiver* receiver, const String& value);
  106.     };
  107.  
  108.     /*!
  109.     \brief
  110.         Property to access the dragging mouse cursor setting.
  111.  
  112.         This property offers access to the mouse cursor image used when dragging the DragContainer.
  113.  
  114.         \par Usage:
  115.             - Name: DragCursorImage
  116.             - Format: "set:[text] image:[text]".
  117.  
  118.         \par Where:
  119.             - set:[text] is the name of the Imageset containing the image.  The Imageset name should not contain spaces.  The Imageset specified must already be loaded.
  120.             - image:[text] is the name of the Image on the specified Imageset.  The Image name should not contain spaces.
  121.     */
  122.     class DragCursorImage : public Property
  123.     {
  124.     public:
  125.         DragCursorImage() : Property(
  126.             "DragCursorImage",
  127.             "Property to get/set the mouse cursor image used when dragging.  Value should be \"set:<imageset name> image:<image name>\".",
  128.             "")
  129.         {}
  130.  
  131.         String    get(const PropertyReceiver* receiver) const;
  132.         void    set(PropertyReceiver* receiver, const String& value);
  133.     };
  134.  
  135. } // End of  DragContainerProperties namespace section
  136. } // End of  CEGUI namespace section
  137.  
  138. #endif    // end of guard _CEGUIDragContainerProperties_h_
  139.