[1812] | 1 | /************************************************************************
|
---|
| 2 | filename: CEGUIScrollablePaneProperties.h
|
---|
| 3 | created: 3/3/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 _CEGUIScrollablePaneProperties_h_
|
---|
| 25 | #define _CEGUIScrollablePaneProperties_h_
|
---|
| 26 |
|
---|
| 27 | #include "CEGUIProperty.h"
|
---|
| 28 |
|
---|
| 29 | // Start of CEGUI namespace section
|
---|
| 30 | namespace CEGUI
|
---|
| 31 | {
|
---|
| 32 | // Start of ScrollablePaneProperties namespace section
|
---|
| 33 | /*!
|
---|
| 34 | \brief
|
---|
| 35 | Namespace containing all classes that make up the properties interface for the ScrollablePane class
|
---|
| 36 | */
|
---|
| 37 | namespace ScrollablePaneProperties
|
---|
| 38 | {
|
---|
| 39 | /*!
|
---|
| 40 | \brief
|
---|
| 41 | Property to access the setting which controls whether the content pane is automatically
|
---|
| 42 | resized according to the size and position of attached content.
|
---|
| 43 |
|
---|
| 44 | \par Usage:
|
---|
| 45 | - Name: ContentPaneAutoSized
|
---|
| 46 | - Format: "[text]"
|
---|
| 47 |
|
---|
| 48 | \par Where [Text] is:
|
---|
| 49 | - "True" to indicate the pane should automatically resize itself.
|
---|
| 50 | - "False" to indicate the pane should not automatically resize itself.
|
---|
| 51 | */
|
---|
| 52 | class ContentPaneAutoSized : public Property
|
---|
| 53 | {
|
---|
| 54 | public:
|
---|
| 55 | ContentPaneAutoSized() : Property(
|
---|
| 56 | "ContentPaneAutoSized",
|
---|
| 57 | "Property to get/set the setting which controls whether the content pane will auto-size itself. Value is either \"True\" or \"False\".",
|
---|
| 58 | "True")
|
---|
| 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 current content pane area rectangle (as window relative pixels).
|
---|
| 68 |
|
---|
| 69 | \par Usage:
|
---|
| 70 | - Name: ContentArea
|
---|
| 71 | - Format: "l:[float] t:[float] r:[float] b:[float]".
|
---|
| 72 |
|
---|
| 73 | \par Where:
|
---|
| 74 | - l:[float] specifies the position of the left edge of the area as a floating point number.
|
---|
| 75 | - t:[float] specifies the position of the top edge of the area as a floating point number.
|
---|
| 76 | - r:[float] specifies the position of the right edge of the area as a floating point number.
|
---|
| 77 | - b:[float] specifies the position of the bottom edge of the area as a floating point number.
|
---|
| 78 | */
|
---|
| 79 | class ContentArea : public Property
|
---|
| 80 | {
|
---|
| 81 | public:
|
---|
| 82 | ContentArea() : Property(
|
---|
| 83 | "ContentArea",
|
---|
| 84 | "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).",
|
---|
| 85 | "l:0.000000 t:0.000000 r:0.000000 b:0.000000")
|
---|
| 86 | {}
|
---|
| 87 |
|
---|
| 88 | String get(const PropertyReceiver* receiver) const;
|
---|
| 89 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 90 | };
|
---|
| 91 |
|
---|
| 92 | /*!
|
---|
| 93 | \brief
|
---|
| 94 | Property to access the setting which controls whether the vertical scroll bar will
|
---|
| 95 | always be displayed, or only displayed when it is required.
|
---|
| 96 |
|
---|
| 97 | \par Usage:
|
---|
| 98 | - Name: ForceVertScrollbar
|
---|
| 99 | - Format: "[text]"
|
---|
| 100 |
|
---|
| 101 | \par Where [Text] is:
|
---|
| 102 | - "True" to indicate that the vertical scroll bar will always be shown.
|
---|
| 103 | - "False" to indicate that the vertical scroll bar will only be shown when it is needed.
|
---|
| 104 | */
|
---|
| 105 | class ForceVertScrollbar : public Property
|
---|
| 106 | {
|
---|
| 107 | public:
|
---|
| 108 | ForceVertScrollbar() : Property(
|
---|
| 109 | "ForceVertScrollbar",
|
---|
| 110 | "Property to get/set the setting which controls whether the vertical scroll bar is aways shown. Value is either \"True\" or \"False\".",
|
---|
| 111 | "False")
|
---|
| 112 | {}
|
---|
| 113 |
|
---|
| 114 | String get(const PropertyReceiver* receiver) const;
|
---|
| 115 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 116 | };
|
---|
| 117 |
|
---|
| 118 |
|
---|
| 119 | /*!
|
---|
| 120 | \brief
|
---|
| 121 | Property to access the setting which controls whether the horizontal scroll bar will
|
---|
| 122 | always be displayed, or only displayed when it is required.
|
---|
| 123 |
|
---|
| 124 | \par Usage:
|
---|
| 125 | - Name: ForceHorzScrollbar
|
---|
| 126 | - Format: "[text]"
|
---|
| 127 |
|
---|
| 128 | \par Where [Text] is:
|
---|
| 129 | - "True" to indicate that the horizontal scroll bar will always be shown.
|
---|
| 130 | - "False" to indicate that the horizontal scroll bar will only be shown when it is needed.
|
---|
| 131 | */
|
---|
| 132 | class ForceHorzScrollbar : public Property
|
---|
| 133 | {
|
---|
| 134 | public:
|
---|
| 135 | ForceHorzScrollbar() : Property(
|
---|
| 136 | "ForceHorzScrollbar",
|
---|
| 137 | "Property to get/set the setting which controls whether the horizontal scroll bar is aways shown. Value is either \"True\" or \"False\".",
|
---|
| 138 | "False")
|
---|
| 139 | {}
|
---|
| 140 |
|
---|
| 141 | String get(const PropertyReceiver* receiver) const;
|
---|
| 142 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 143 | };
|
---|
| 144 |
|
---|
| 145 | /*!
|
---|
| 146 | \brief
|
---|
| 147 | Property to access the step size for the horizontal Scrollbar.
|
---|
| 148 |
|
---|
| 149 | \par Usage:
|
---|
| 150 | - Name: HorzStepSize
|
---|
| 151 | - Format: "[float]".
|
---|
| 152 |
|
---|
| 153 | \par Where:
|
---|
| 154 | - [float] specifies the size of the increase/decrease button step for the horizontal scrollbar (as a fraction of 1 page).
|
---|
| 155 | */
|
---|
| 156 | class HorzStepSize : public Property
|
---|
| 157 | {
|
---|
| 158 | public:
|
---|
| 159 | HorzStepSize() : Property(
|
---|
| 160 | "HorzStepSize",
|
---|
| 161 | "Property to get/set the step size for the horizontal Scrollbar. Value is a float.",
|
---|
| 162 | "0.100000")
|
---|
| 163 | {}
|
---|
| 164 |
|
---|
| 165 | String get(const PropertyReceiver* receiver) const;
|
---|
| 166 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 167 | };
|
---|
| 168 |
|
---|
| 169 | /*!
|
---|
| 170 | \brief
|
---|
| 171 | Property to access the overlap size for the horizontal Scrollbar.
|
---|
| 172 |
|
---|
| 173 | \par Usage:
|
---|
| 174 | - Name: HorzOverlapSize
|
---|
| 175 | - Format: "[float]".
|
---|
| 176 |
|
---|
| 177 | \par Where:
|
---|
| 178 | - [float] specifies the size of the per-page overlap (as a fraction of one page).
|
---|
| 179 | */
|
---|
| 180 | class HorzOverlapSize : public Property
|
---|
| 181 | {
|
---|
| 182 | public:
|
---|
| 183 | HorzOverlapSize() : Property(
|
---|
| 184 | "HorzOverlapSize",
|
---|
| 185 | "Property to get/set the overlap size for the horizontal Scrollbar. Value is a float.",
|
---|
| 186 | "0.010000")
|
---|
| 187 | {}
|
---|
| 188 |
|
---|
| 189 | String get(const PropertyReceiver* receiver) const;
|
---|
| 190 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 191 | };
|
---|
| 192 |
|
---|
| 193 | /*!
|
---|
| 194 | \brief
|
---|
| 195 | Property to access the scroll position of the horizontal Scrollbar.
|
---|
| 196 |
|
---|
| 197 | \par Usage:
|
---|
| 198 | - Name: HorzScrollPosition
|
---|
| 199 | - Format: "[float]".
|
---|
| 200 |
|
---|
| 201 | \par Where:
|
---|
| 202 | - [float] specifies the current scroll position / value of the horizontal Scrollbar (as a fraction of the whole).
|
---|
| 203 | */
|
---|
| 204 | class HorzScrollPosition : public Property
|
---|
| 205 | {
|
---|
| 206 | public:
|
---|
| 207 | HorzScrollPosition() : Property(
|
---|
| 208 | "HorzScrollPosition",
|
---|
| 209 | "Property to get/set the scroll position of the horizontal Scrollbar as a fraction. Value is a float.",
|
---|
| 210 | "0.000000")
|
---|
| 211 | {}
|
---|
| 212 |
|
---|
| 213 | String get(const PropertyReceiver* receiver) const;
|
---|
| 214 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 215 | };
|
---|
| 216 |
|
---|
| 217 | /*!
|
---|
| 218 | \brief
|
---|
| 219 | Property to access the step size for the vertical Scrollbar.
|
---|
| 220 |
|
---|
| 221 | \par Usage:
|
---|
| 222 | - Name: VertStepSize
|
---|
| 223 | - Format: "[float]".
|
---|
| 224 |
|
---|
| 225 | \par Where:
|
---|
| 226 | - [float] specifies the size of the increase/decrease button step for the vertical scrollbar (as a fraction of 1 page).
|
---|
| 227 | */
|
---|
| 228 | class VertStepSize : public Property
|
---|
| 229 | {
|
---|
| 230 | public:
|
---|
| 231 | VertStepSize() : Property(
|
---|
| 232 | "VertStepSize",
|
---|
| 233 | "Property to get/set the step size for the vertical Scrollbar. Value is a float.",
|
---|
| 234 | "0.100000")
|
---|
| 235 | {}
|
---|
| 236 |
|
---|
| 237 | String get(const PropertyReceiver* receiver) const;
|
---|
| 238 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 239 | };
|
---|
| 240 |
|
---|
| 241 | /*!
|
---|
| 242 | \brief
|
---|
| 243 | Property to access the overlap size for the vertical Scrollbar.
|
---|
| 244 |
|
---|
| 245 | \par Usage:
|
---|
| 246 | - Name: VertOverlapSize
|
---|
| 247 | - Format: "[float]".
|
---|
| 248 |
|
---|
| 249 | \par Where:
|
---|
| 250 | - [float] specifies the size of the per-page overlap (as a fraction of one page).
|
---|
| 251 | */
|
---|
| 252 | class VertOverlapSize : public Property
|
---|
| 253 | {
|
---|
| 254 | public:
|
---|
| 255 | VertOverlapSize() : Property(
|
---|
| 256 | "VertOverlapSize",
|
---|
| 257 | "Property to get/set the overlap size for the vertical Scrollbar. Value is a float.",
|
---|
| 258 | "0.010000")
|
---|
| 259 | {}
|
---|
| 260 |
|
---|
| 261 | String get(const PropertyReceiver* receiver) const;
|
---|
| 262 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 263 | };
|
---|
| 264 |
|
---|
| 265 | /*!
|
---|
| 266 | \brief
|
---|
| 267 | Property to access the scroll position of the vertical Scrollbar.
|
---|
| 268 |
|
---|
| 269 | \par Usage:
|
---|
| 270 | - Name: VertScrollPosition
|
---|
| 271 | - Format: "[float]".
|
---|
| 272 |
|
---|
| 273 | \par Where:
|
---|
| 274 | - [float] specifies the current scroll position / value of the vertical Scrollbar (as a fraction of the whole).
|
---|
| 275 | */
|
---|
| 276 | class VertScrollPosition : public Property
|
---|
| 277 | {
|
---|
| 278 | public:
|
---|
| 279 | VertScrollPosition() : Property(
|
---|
| 280 | "VertScrollPosition",
|
---|
| 281 | "Property to get/set the scroll position of the vertical Scrollbar as a fraction. Value is a float.",
|
---|
| 282 | "0.000000")
|
---|
| 283 | {}
|
---|
| 284 |
|
---|
| 285 | String get(const PropertyReceiver* receiver) const;
|
---|
| 286 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 287 | };
|
---|
| 288 |
|
---|
| 289 | } // End of ScrollablePaneProperties namespace section
|
---|
| 290 | } // End of CEGUI namespace section
|
---|
| 291 |
|
---|
| 292 |
|
---|
| 293 | #endif // end of guard _CEGUIScrollablePaneProperties_h_
|
---|