[1812] | 1 | /************************************************************************
|
---|
| 2 | filename: CEGUIListHeaderSegmentProperties.h
|
---|
| 3 | created: 11/7/2004
|
---|
| 4 | author: Paul D Turner
|
---|
| 5 |
|
---|
| 6 | purpose: Interface to properties for ListHeaderSegment class
|
---|
| 7 | *************************************************************************/
|
---|
| 8 | /*************************************************************************
|
---|
| 9 | Crazy Eddie's GUI System (http://www.cegui.org.uk)
|
---|
| 10 | Copyright (C)2004 - 2005 Paul D Turner (paul@cegui.org.uk)
|
---|
| 11 |
|
---|
| 12 | This library is free software; you can redistribute it and/or
|
---|
| 13 | modify it under the terms of the GNU Lesser General Public
|
---|
| 14 | License as published by the Free Software Foundation; either
|
---|
| 15 | version 2.1 of the License, or (at your option) any later version.
|
---|
| 16 |
|
---|
| 17 | This library is distributed in the hope that it will be useful,
|
---|
| 18 | but WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
| 19 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
---|
| 20 | Lesser General Public License for more details.
|
---|
| 21 |
|
---|
| 22 | You should have received a copy of the GNU Lesser General Public
|
---|
| 23 | License along with this library; if not, write to the Free Software
|
---|
| 24 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
---|
| 25 | *************************************************************************/
|
---|
| 26 | #ifndef _CEGUIListHeaderSegmentProperties_h_
|
---|
| 27 | #define _CEGUIListHeaderSegmentProperties_h_
|
---|
| 28 |
|
---|
| 29 | #include "CEGUIProperty.h"
|
---|
| 30 |
|
---|
| 31 |
|
---|
| 32 | // Start of CEGUI namespace section
|
---|
| 33 | namespace CEGUI
|
---|
| 34 | {
|
---|
| 35 |
|
---|
| 36 | // Start of ListHeaderSegmentProperties namespace section
|
---|
| 37 | /*!
|
---|
| 38 | \brief
|
---|
| 39 | Namespace containing all classes that make up the properties interface for the ListHeaderSegment class
|
---|
| 40 | */
|
---|
| 41 | namespace ListHeaderSegmentProperties
|
---|
| 42 | {
|
---|
| 43 | /*!
|
---|
| 44 | \brief
|
---|
| 45 | Property to access the sizable setting of the header segment.
|
---|
| 46 |
|
---|
| 47 | \par Usage:
|
---|
| 48 | - Name: Sizable
|
---|
| 49 | - Format: "[text]"
|
---|
| 50 |
|
---|
| 51 | \par Where [Text] is:
|
---|
| 52 | - "True" to indicate the segment can be sized by the user.
|
---|
| 53 | - "False" to indicate the segment can not be sized by the user.
|
---|
| 54 | */
|
---|
| 55 | class Sizable : public Property
|
---|
| 56 | {
|
---|
| 57 | public:
|
---|
| 58 | Sizable() : Property(
|
---|
| 59 | "Sizable",
|
---|
| 60 | "Property to get/set the sizable setting of the header segment. Value is either \"True\" or \"False\".",
|
---|
| 61 | "True")
|
---|
| 62 | {}
|
---|
| 63 |
|
---|
| 64 | String get(const PropertyReceiver* receiver) const;
|
---|
| 65 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 66 | };
|
---|
| 67 |
|
---|
| 68 |
|
---|
| 69 | /*!
|
---|
| 70 | \brief
|
---|
| 71 | Property to access the click-able setting of the header segment.
|
---|
| 72 |
|
---|
| 73 | \par Usage:
|
---|
| 74 | - Name: Clickable
|
---|
| 75 | - Format: "[text]"
|
---|
| 76 |
|
---|
| 77 | \par Where [Text] is:
|
---|
| 78 | - "True" to indicate the segment can be clicked by the user.
|
---|
| 79 | - "False" to indicate the segment can not be clicked by the user.
|
---|
| 80 | */
|
---|
| 81 | class Clickable : public Property
|
---|
| 82 | {
|
---|
| 83 | public:
|
---|
| 84 | Clickable() : Property(
|
---|
| 85 | "Clickable",
|
---|
| 86 | "Property to get/set the click-able setting of the header segment. Value is either \"True\" or \"False\".",
|
---|
| 87 | "True")
|
---|
| 88 | {}
|
---|
| 89 |
|
---|
| 90 | String get(const PropertyReceiver* receiver) const;
|
---|
| 91 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 92 | };
|
---|
| 93 |
|
---|
| 94 |
|
---|
| 95 | /*!
|
---|
| 96 | \brief
|
---|
| 97 | Property to access the drag-able setting of the header segment.
|
---|
| 98 |
|
---|
| 99 | \par Usage:
|
---|
| 100 | - Name: Dragable
|
---|
| 101 | - Format: "[text]"
|
---|
| 102 |
|
---|
| 103 | \par Where [Text] is:
|
---|
| 104 | - "True" to indicate the segment can be dragged by the user.
|
---|
| 105 | - "False" to indicate the segment can not be dragged by the user.
|
---|
| 106 | */
|
---|
| 107 | class Dragable : public Property
|
---|
| 108 | {
|
---|
| 109 | public:
|
---|
| 110 | Dragable() : Property(
|
---|
| 111 | "Dragable",
|
---|
| 112 | "Property to get/set the drag-able setting of the header segment. Value is either \"True\" or \"False\".",
|
---|
| 113 | "True")
|
---|
| 114 | {}
|
---|
| 115 |
|
---|
| 116 | String get(const PropertyReceiver* receiver) const;
|
---|
| 117 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 118 | };
|
---|
| 119 |
|
---|
| 120 |
|
---|
| 121 | /*!
|
---|
| 122 | \brief
|
---|
| 123 | Property to access the sort direction setting of the header segment.
|
---|
| 124 |
|
---|
| 125 | \par Usage:
|
---|
| 126 | - Name: SortDirection
|
---|
| 127 | - Format: "[text]"
|
---|
| 128 |
|
---|
| 129 | \par Where [Text] is one of:
|
---|
| 130 | - "Ascending"
|
---|
| 131 | - "Descending"
|
---|
| 132 | - "None"
|
---|
| 133 | */
|
---|
| 134 | class SortDirection : public Property
|
---|
| 135 | {
|
---|
| 136 | public:
|
---|
| 137 | SortDirection() : Property(
|
---|
| 138 | "SortDirection",
|
---|
| 139 | "Property to get/set the sort direction setting of the header segment. Value is the text of one of the SortDirection enumerated value names.",
|
---|
| 140 | "None")
|
---|
| 141 | {}
|
---|
| 142 |
|
---|
| 143 | String get(const PropertyReceiver* receiver) const;
|
---|
| 144 | void set(PropertyReceiver* receiver, const String& value);
|
---|
| 145 | };
|
---|
| 146 |
|
---|
| 147 | } // End of ListHeaderSegmentProperties namespace section
|
---|
| 148 |
|
---|
| 149 | } // End of CEGUI namespace section
|
---|
| 150 |
|
---|
| 151 |
|
---|
| 152 | #endif // end of guard _CEGUIListHeaderSegmentProperties_h_
|
---|