Crazy Eddie's GUI System
0.8.4
Main Page
Related Pages
Namespaces
Classes
Files
File List
All
Classes
Namespaces
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Pages
Property.h
1
/***********************************************************************
2
created: 21/2/2004
3
author: Paul D Turner
4
5
purpose: Defines the Property class which forms part of a
6
PropertySet
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 _CEGUIProperty_h_
31
#define _CEGUIProperty_h_
32
33
#include "CEGUI/Base.h"
34
#include "CEGUI/String.h"
35
#include "CEGUI/XMLSerializer.h"
36
37
// Start of CEGUI namespace section
38
namespace
CEGUI
39
{
40
45
class
CEGUIEXPORT
PropertyReceiver
46
{
47
public
:
48
PropertyReceiver
() {}
49
virtual
~
PropertyReceiver
() {}
50
};
51
52
60
class
CEGUIEXPORT
Property
:
61
public
AllocatedObject
<Property>
62
{
63
public
:
64
static
const
String
XMLElementName;
65
static
const
String
NameXMLAttributeName;
66
static
const
String
ValueXMLAttributeName;
67
91
Property
(
const
String
& name,
const
String
& help,
const
String
& defaultValue =
""
,
bool
writesXML =
true
,
const
String
& dataType =
"Unknown"
,
const
String
& origin =
"Unknown"
) :
92
d_name(name),
93
d_help(help),
94
d_default(defaultValue),
95
d_writeXML(writesXML),
96
d_dataType(dataType),
97
d_origin(origin)
98
{}
99
104
virtual
~Property
(
void
) {}
105
106
114
const
String
&
getHelp
(
void
)
const
{
return
d_help;}
115
116
124
const
String
&
getName
(
void
)
const
{
return
d_name;}
125
133
const
String
&
getDataType
(
void
)
const
{
return
d_dataType;}
134
142
const
String
&
getOrigin
(
void
)
const
{
return
d_origin;}
143
154
virtual
String
get
(
const
PropertyReceiver
* receiver)
const
= 0;
155
156
172
virtual
void
set
(
PropertyReceiver
* receiver,
const
String
& value) = 0;
173
174
186
virtual
bool
isDefault(
const
PropertyReceiver
* receiver)
const
;
187
188
199
virtual
String
getDefault(
const
PropertyReceiver
* receiver)
const
;
200
201
210
virtual
void
writeXMLToStream(
const
PropertyReceiver
* receiver,
XMLSerializer
& xml_stream)
const
;
211
220
virtual
bool
isReadable()
const
;
221
230
virtual
bool
isWritable()
const
;
231
236
virtual
bool
doesWriteXML()
const
;
237
239
virtual
void
initialisePropertyReceiver
(
PropertyReceiver
*
/*receiver*/
)
const
{}
240
241
virtual
Property
* clone()
const
= 0;
242
243
protected
:
244
String
d_name
;
245
String
d_help
;
246
String
d_default
;
247
bool
d_writeXML
;
248
// TODO: This is really ugly but PropertyDefinition forced me to do this to support operator=
249
String
d_dataType
;
250
// TODO: This is really ugly but PropertyDefinition forced me to do this to support operator=
251
String
d_origin
;
252
};
253
254
}
// End of CEGUI namespace section
255
256
#endif // end of guard _CEGUIProperty_h_
cegui
include
CEGUI
Property.h
Generated by
1.8.3.1