← Back to branch summary

~thomir-deactivatedaccount/cegui/fix-build

« back to all changes in this revision

Viewing changes to cegui/include/elements/CEGUIListHeaderSegmentProperties.h

  • Committer: Thomi Richards
  • Date: 2013-02-06 22:13:36 UTC
  • Revision ID: thomi.richards@canonical.com-20130206221336-rsmud4k50g6nzv50
Initial code import.

Show diffs side-by-side

added added

removed removed

Lines of Context:
cegui/include/elements/CEGUIListHeaderSegmentProperties.h
 
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
 *   Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
 
10
 *
 
11
 *   Permission is hereby granted, free of charge, to any person obtaining
 
12
 *   a copy of this software and associated documentation files (the
 
13
 *   "Software"), to deal in the Software without restriction, including
 
14
 *   without limitation the rights to use, copy, modify, merge, publish,
 
15
 *   distribute, sublicense, and/or sell copies of the Software, and to
 
16
 *   permit persons to whom the Software is furnished to do so, subject to
 
17
 *   the following conditions:
 
18
 *
 
19
 *   The above copyright notice and this permission notice shall be
 
20
 *   included in all copies or substantial portions of the Software.
 
21
 *
 
22
 *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 
23
 *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 
24
 *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 
25
 *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 
26
 *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 
27
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 
28
 *   OTHER DEALINGS IN THE SOFTWARE.
 
29
 ***************************************************************************/
 
30
#ifndef _CEGUIListHeaderSegmentProperties_h_
 
31
#define _CEGUIListHeaderSegmentProperties_h_
 
32
 
 
33
#include "../CEGUIProperty.h"
 
34
 
 
35
 
 
36
// Start of CEGUI namespace section
 
37
namespace CEGUI
 
38
{
 
39
 
 
40
// Start of ListHeaderSegmentProperties namespace section
 
41
/*!
 
42
\brief
 
43
        Namespace containing all classes that make up the properties interface for the ListHeaderSegment class
 
44
*/
 
45
namespace ListHeaderSegmentProperties
 
46
{
 
47
/*!
 
48
\brief
 
49
        Property to access the sizable setting of the header segment.
 
50
 
 
51
        \par Usage:
 
52
                - Name: Sizable
 
53
                - Format: "[text]"
 
54
 
 
55
        \par Where [Text] is:
 
56
                - "True" to indicate the segment can be sized by the user.
 
57
                - "False" to indicate the segment can not be sized by the user.
 
58
*/
 
59
class Sizable : public Property
 
60
{
 
61
public:
 
62
        Sizable() : Property(
 
63
                "Sizable",
 
64
                "Property to get/set the sizable setting of the header segment.  Value is either \"True\" or \"False\".",
 
65
                "True")
 
66
        {}
 
67
 
 
68
        String  get(const PropertyReceiver* receiver) const;
 
69
        void    set(PropertyReceiver* receiver, const String& value);
 
70
};
 
71
 
 
72
 
 
73
/*!
 
74
\brief
 
75
        Property to access the click-able setting of the header segment.
 
76
 
 
77
        \par Usage:
 
78
                - Name: Clickable
 
79
                - Format: "[text]"
 
80
 
 
81
        \par Where [Text] is:
 
82
                - "True" to indicate the segment can be clicked by the user.
 
83
                - "False" to indicate the segment can not be clicked by the user.
 
84
*/
 
85
class Clickable : public Property
 
86
{
 
87
public:
 
88
        Clickable() : Property(
 
89
                "Clickable",
 
90
                "Property to get/set the click-able setting of the header segment.  Value is either \"True\" or \"False\".",
 
91
                "True")
 
92
        {}
 
93
 
 
94
        String  get(const PropertyReceiver* receiver) const;
 
95
        void    set(PropertyReceiver* receiver, const String& value);
 
96
};
 
97
 
 
98
 
 
99
/*!
 
100
\brief
 
101
        Property to access the drag-able setting of the header segment.
 
102
 
 
103
        \par Usage:
 
104
                - Name: Dragable
 
105
                - Format: "[text]"
 
106
 
 
107
        \par Where [Text] is:
 
108
                - "True" to indicate the segment can be dragged by the user.
 
109
                - "False" to indicate the segment can not be dragged by the user.
 
110
*/
 
111
class Dragable : public Property
 
112
{
 
113
public:
 
114
        Dragable() : Property(
 
115
                "Dragable",
 
116
                "Property to get/set the drag-able setting of the header segment.  Value is either \"True\" or \"False\".",
 
117
                "True")
 
118
        {}
 
119
 
 
120
        String  get(const PropertyReceiver* receiver) const;
 
121
        void    set(PropertyReceiver* receiver, const String& value);
 
122
};
 
123
 
 
124
 
 
125
/*!
 
126
\brief
 
127
        Property to access the sort direction setting of the header segment.
 
128
 
 
129
        \par Usage:
 
130
                - Name: SortDirection
 
131
                - Format: "[text]"
 
132
 
 
133
        \par Where [Text] is one of:
 
134
                - "Ascending"
 
135
                - "Descending"
 
136
                - "None"
 
137
*/
 
138
class SortDirection : public Property
 
139
{
 
140
public:
 
141
        SortDirection() : Property(
 
142
                "SortDirection",
 
143
                "Property to get/set the sort direction setting of the header segment.  Value is the text of one of the SortDirection enumerated value names.",
 
144
                "None")
 
145
        {}
 
146
 
 
147
        String  get(const PropertyReceiver* receiver) const;
 
148
        void    set(PropertyReceiver* receiver, const String& value);
 
149
};
 
150
 
 
151
 
 
152
/*!
 
153
\brief
 
154
   Property to access the segment sizing cursor image
 
155
 
 
156
   \par Usage:
 
157
      - Name: SizingCursorImage
 
158
      - Format: "set:<imageset> image:<imagename>".
 
159
 
 
160
*/
 
161
class SizingCursorImage : public Property
 
162
{
 
163
public:
 
164
   SizingCursorImage() : Property(
 
165
       "SizingCursorImage",
 
166
       "Property to get/set the sizing cursor image for the List Header Segment.  Value should be \"set:[imageset name] image:[image name]\".",
 
167
       "")
 
168
   {}
 
169
 
 
170
   String   get(const PropertyReceiver* receiver) const;
 
171
   void   set(PropertyReceiver* receiver, const String& value);
 
172
};
 
173
 
 
174
 
 
175
/*!
 
176
\brief
 
177
   Property to access the segment moving cursor image
 
178
 
 
179
   \par Usage:
 
180
      - Name: MovingCursorImage
 
181
      - Format: "set:<imageset> image:<imagename>".
 
182
 
 
183
*/
 
184
class MovingCursorImage : public Property
 
185
{
 
186
public:
 
187
   MovingCursorImage() : Property(
 
188
       "MovingCursorImage",
 
189
       "Property to get/set the moving cursor image for the List Header Segment.  Value should be \"set:[imageset name] image:[image name]\".",
 
190
       "")
 
191
   {}
 
192
 
 
193
   String   get(const PropertyReceiver* receiver) const;
 
194
   void   set(PropertyReceiver* receiver, const String& value);
 
195
};
 
196
 
 
197
} // End of  ListHeaderSegmentProperties namespace section
 
198
 
 
199
} // End of  CEGUI namespace section
 
200
 
 
201
 
 
202
#endif  // end of guard _CEGUIListHeaderSegmentProperties_h_