[1812] | 1 | /************************************************************************
|
---|
| 2 | filename: CEGUIScrolledContainerProperties.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 _CEGUIScrolledContainerProperties_h_
|
---|
| 25 | #define _CEGUIScrolledContainerProperties_h_
|
---|
| 26 |
|
---|
| 27 | #include "CEGUIProperty.h"
|
---|
| 28 |
|
---|
| 29 | // Start of CEGUI namespace section
|
---|
| 30 | namespace CEGUI
|
---|
| 31 | {
|
---|
| 32 | // Start of ScrolledContainerProperties namespace section
|
---|
| 33 | /*!
|
---|
| 34 | \brief
|
---|
| 35 | Namespace containing all classes that make up the properties interface for the ScrolledContainer class
|
---|
| 36 | */
|
---|
| 37 | namespace ScrolledContainerProperties
|
---|
| 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 offering read-only access to the current content extents rectangle (as window relative pixels).
|
---|
| 95 |
|
---|
| 96 | \par Usage:
|
---|
| 97 | - Name: ChildExtentsArea
|
---|
| 98 | - Format: "l:[float] t:[float] r:[float] b:[float]".
|
---|
| 99 |
|
---|
| 100 | \par Where:
|
---|
| 101 | - l:[float] specifies the position of the left edge of the area as a floating point number.
|
---|
| 102 | - t:[float] specifies the position of the top edge of the area as a floating point number.
|
---|
| 103 | - r:[float] specifies the position of the right edge of the area as a floating point number.
|
---|
| 104 | - b:[float] specifies the position of the bottom edge of the area as a floating point number.
|
---|
| 105 | */
|
---|
| 106 | class ChildExtentsArea : public Property
|
---|
| 107 | {
|
---|
| 108 | public:
|
---|
| 109 | ChildExtentsArea() : Property(
|
---|
| 110 | "ChildExtentsArea",
|
---|
| 111 | "Property to get the current content extents rectangle. Value is \"l:[float] t:[float] r:[float] b:[float]\" (where l is left, t is top, r is right, and b is bottom).",
|
---|
| 112 | "l:0.000000 t:0.000000 r:0.000000 b:0.000000")
|
---|
| 113 | {}
|
---|
| 114 |
|
---|
| 115 | String get(const PropertyReceiver* receiver) const;
|
---|
| 116 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 117 | };
|
---|
| 118 |
|
---|
| 119 | } // End of ScrolledContainerProperties namespace section
|
---|
| 120 | } // End of CEGUI namespace section
|
---|
| 121 |
|
---|
| 122 |
|
---|
| 123 | #endif // end of guard _CEGUIScrolledContainerProperties_h_
|
---|