Crazy Eddie's GUI System 0.8.7
PropertyInitialiser.h
1/***********************************************************************
2 created: Mon Jun 13 2005
3 author: Paul D Turner <paul@cegui.org.uk>
4*************************************************************************/
5/***************************************************************************
6 * Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining
9 * a copy of this software and associated documentation files (the
10 * "Software"), to deal in the Software without restriction, including
11 * without limitation the rights to use, copy, modify, merge, publish,
12 * distribute, sublicense, and/or sell copies of the Software, and to
13 * permit persons to whom the Software is furnished to do so, subject to
14 * the following conditions:
15 *
16 * The above copyright notice and this permission notice shall be
17 * included in all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
20 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
22 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
23 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
24 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25 * OTHER DEALINGS IN THE SOFTWARE.
26 ***************************************************************************/
27#ifndef _CEGUIFalPropertyInitialiser_h_
28#define _CEGUIFalPropertyInitialiser_h_
29
30#include "../PropertySet.h"
31
32
33// Start of CEGUI namespace section
34namespace CEGUI
35{
40 class CEGUIEXPORT PropertyInitialiser :
41 public AllocatedObject<PropertyInitialiser>
42 {
43 public:
55 PropertyInitialiser(const String& property, const String& value);
56
67 void apply(PropertySet& target) const;
78 void setTargetPropertyName(const String& name);
79
88
99 void setInitialiserValue(const String& value);
100
109
121 void writeXMLToStream(XMLSerializer& xml_stream) const;
122
123 private:
124 CEGUI::String d_propertyName;
125 CEGUI::String d_propertyValue;
126 };
127
128} // End of CEGUI namespace section
129
130
131#endif // end of guard _CEGUIFalPropertyInitialiser_h_
Definition: MemoryAllocatedObject.h:110
Class that holds information about a property and it's required initial value.
Definition: PropertyInitialiser.h:42
void setInitialiserValue(const String &value)
Sets the value string to be set on the property targetted by this PropertyInitialiser.
void writeXMLToStream(XMLSerializer &xml_stream) const
Writes an xml representation of this PropertyInitialiser to out_stream.
const String & getInitialiserValue() const
Return the value string to be set on the property targetted by this PropertyInitialiser.
PropertyInitialiser(const String &property, const String &value)
Constructor.
void apply(PropertySet &target) const
Apply this property initialiser to the specified target CEGUI::PropertySet object.
void setTargetPropertyName(const String &name)
Sets the name of the property targetted by this PropertyInitialiser.
const String & getTargetPropertyName() const
Return the name of the property targetted by this PropertyInitialiser.
Interface providing introspection capabilities.
Definition: PropertySet.h:108
String class used within the GUI system.
Definition: String.h:64
Class used to create XML Document.
Definition: XMLSerializer.h:87
Main namespace for Crazy Eddie's GUI Library.
Definition: arch_overview.dox:1