[1812] | 1 | /************************************************************************
|
---|
| 2 | filename: CEGUIPushButtonProperties.h
|
---|
| 3 | created: 22/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 _CEGUIPushButtonProperties_h_
|
---|
| 25 | #define _CEGUIPushButtonProperties_h_
|
---|
| 26 |
|
---|
| 27 | #include "CEGUIProperty.h"
|
---|
| 28 |
|
---|
| 29 |
|
---|
| 30 | // Start of CEGUI namespace section
|
---|
| 31 | namespace CEGUI
|
---|
| 32 | {
|
---|
| 33 |
|
---|
| 34 | // Start of PushButtonProperties namespace section
|
---|
| 35 | /*!
|
---|
| 36 | \brief
|
---|
| 37 | Namespace containing all classes that make up the properties
|
---|
| 38 | interface for the PushButton class
|
---|
| 39 | */
|
---|
| 40 | namespace PushButtonProperties
|
---|
| 41 | {
|
---|
| 42 |
|
---|
| 43 | /*!
|
---|
| 44 | \brief
|
---|
| 45 | Property to access the normal image of the button
|
---|
| 46 |
|
---|
| 47 | \par Usage:
|
---|
| 48 | - Name: NormalImage
|
---|
| 49 | - Format: "set:<imageset> image:<imagename>".
|
---|
| 50 |
|
---|
| 51 | */
|
---|
| 52 | class NormalImage : public Property
|
---|
| 53 | {
|
---|
| 54 | public:
|
---|
| 55 | NormalImage() : Property(
|
---|
| 56 | "NormalImage",
|
---|
| 57 | "Property to get/set the normal image for the PushButton widget. Value should be \"set:[imageset name] image:[image name]\".",
|
---|
| 58 | "")
|
---|
| 59 | {}
|
---|
| 60 |
|
---|
| 61 | String get(const PropertyReceiver* receiver) const;
|
---|
| 62 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 63 | };
|
---|
| 64 |
|
---|
| 65 | /*!
|
---|
| 66 | \brief
|
---|
| 67 | Property to access the pushed image of the button
|
---|
| 68 |
|
---|
| 69 | \par Usage:
|
---|
| 70 | - Name: PushedImage
|
---|
| 71 | - Format: "set:<imageset> image:<imagename>".
|
---|
| 72 |
|
---|
| 73 | */
|
---|
| 74 | class PushedImage : public Property
|
---|
| 75 | {
|
---|
| 76 | public:
|
---|
| 77 | PushedImage() : Property(
|
---|
| 78 | "PushedImage",
|
---|
| 79 | "Property to get/set the pushed image for the PushButton widget. Value should be \"set:[imageset name] image:[image name]\".",
|
---|
| 80 | "")
|
---|
| 81 | {}
|
---|
| 82 |
|
---|
| 83 | String get(const PropertyReceiver* receiver) const;
|
---|
| 84 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 85 | };
|
---|
| 86 |
|
---|
| 87 | /*!
|
---|
| 88 | \brief
|
---|
| 89 | Property to access the hover image of the button
|
---|
| 90 |
|
---|
| 91 | \par Usage:
|
---|
| 92 | - Name: HoverImage
|
---|
| 93 | - Format: "set:<imageset> image:<imagename>".
|
---|
| 94 |
|
---|
| 95 | */
|
---|
| 96 | class HoverImage : public Property
|
---|
| 97 | {
|
---|
| 98 | public:
|
---|
| 99 | HoverImage() : Property(
|
---|
| 100 | "HoverImage",
|
---|
| 101 | "Property to get/set the hover image for the PushButton widget. Value should be \"set:[imageset name] image:[image name]\".",
|
---|
| 102 | "")
|
---|
| 103 | {}
|
---|
| 104 |
|
---|
| 105 | String get(const PropertyReceiver* receiver) const;
|
---|
| 106 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 107 | };
|
---|
| 108 |
|
---|
| 109 | /*!
|
---|
| 110 | \brief
|
---|
| 111 | Property to access the disabled image of the button
|
---|
| 112 |
|
---|
| 113 | \par Usage:
|
---|
| 114 | - Name: DisabledImage
|
---|
| 115 | - Format: "set:<imageset> image:<imagename>".
|
---|
| 116 |
|
---|
| 117 | */
|
---|
| 118 | class DisabledImage : public Property
|
---|
| 119 | {
|
---|
| 120 | public:
|
---|
| 121 | DisabledImage() : Property(
|
---|
| 122 | "DisabledImage",
|
---|
| 123 | "Property to get/set the disabled image for the PushButton widget. Value should be \"set:[imageset name] image:[image name]\".",
|
---|
| 124 | "")
|
---|
| 125 | {}
|
---|
| 126 |
|
---|
| 127 | String get(const PropertyReceiver* receiver) const;
|
---|
| 128 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 129 | };
|
---|
| 130 |
|
---|
| 131 | /*!
|
---|
| 132 | \brief
|
---|
| 133 | Property to access whether to use the standard images or the supplied custom ones
|
---|
| 134 |
|
---|
| 135 | \par Usage:
|
---|
| 136 | - Name: UseStandardImagery
|
---|
| 137 | - Format: "True|False".
|
---|
| 138 |
|
---|
| 139 | */
|
---|
| 140 | class UseStandardImagery : public Property
|
---|
| 141 | {
|
---|
| 142 | public:
|
---|
| 143 | UseStandardImagery() : Property(
|
---|
| 144 | "UseStandardImagery",
|
---|
| 145 | "Property to get/set whether to use the standard imagery for the PushButton widget. Value should be \"True\" or \"False\".",
|
---|
| 146 | "True")
|
---|
| 147 | {}
|
---|
| 148 |
|
---|
| 149 | String get(const PropertyReceiver* receiver) const;
|
---|
| 150 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 151 | };
|
---|
| 152 |
|
---|
| 153 | /*!
|
---|
| 154 | \brief
|
---|
| 155 | Property to access an offset that is used to shift the text in the x-direction.
|
---|
| 156 |
|
---|
| 157 | \par Usage:
|
---|
| 158 | - Name: UseStandardImagery
|
---|
| 159 | - Format: "<xoffset>".
|
---|
| 160 |
|
---|
| 161 | \par
|
---|
| 162 | where <xoffset> is a float value specifying the offset relative to the button-size
|
---|
| 163 |
|
---|
| 164 | */
|
---|
| 165 | class TextXOffset : public Property
|
---|
| 166 | {
|
---|
| 167 | public:
|
---|
| 168 | TextXOffset() : Property(
|
---|
| 169 | "TextXOffset",
|
---|
| 170 | "Property to get/set a relative x offset for the button's text",
|
---|
| 171 | "0.000000")
|
---|
| 172 | {}
|
---|
| 173 |
|
---|
| 174 | String get(const PropertyReceiver* receiver) const;
|
---|
| 175 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 176 | };
|
---|
| 177 |
|
---|
| 178 | }
|
---|
| 179 |
|
---|
| 180 | }
|
---|
| 181 | #endif
|
---|