Crazy Eddie's GUI System  0.8.4
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
FormattingSetting.h
1 /***********************************************************************
2  created: Fri Jun 15 2012
3  author: Paul D Turner <paul@cegui.org.uk>
4 *************************************************************************/
5 /***************************************************************************
6  * Copyright (C) 2004 - 2012 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 _CEGUIFormattingSetting_h_
28 #define _CEGUIFormattingSetting_h_
29 
30 #include "CEGUI/Window.h"
31 #include "CEGUI/falagard/XMLEnumHelper.h"
32 
33 namespace CEGUI
34 {
35 
36 template<typename T>
37 class FormattingSetting
38 {
39 public:
40  //------------------------------------------------------------------------//
41  FormattingSetting() :
42  d_value(FalagardXMLHelper<T>::fromString(""))
43  {}
44 
45  //------------------------------------------------------------------------//
46  FormattingSetting(const String& property_name) :
47  d_value(FalagardXMLHelper<T>::fromString("")),
48  d_propertySource(property_name)
49  {}
50 
51  //------------------------------------------------------------------------//
52  FormattingSetting(T val) :
53  d_value(val)
54  {}
55 
56  //------------------------------------------------------------------------//
57  T get(const Window& wnd) const
58  {
59  if (d_propertySource.empty())
60  return d_value;
61 
62  return FalagardXMLHelper<T>::fromString(
63  wnd.getProperty(d_propertySource));
64  }
65 
66  //------------------------------------------------------------------------//
67  void set(T val)
68  {
69  d_value = val;
70  d_propertySource.clear();
71  }
72 
73  //------------------------------------------------------------------------//
74  T getValue() const
75  {
76  return d_value;
77  }
78 
79  //------------------------------------------------------------------------//
80  void setPropertySource(const String& property_name)
81  {
82  d_propertySource = property_name;
83  }
84 
85  //------------------------------------------------------------------------//
86  bool isFetchedFromProperty() const
87  {
88  return !d_propertySource.empty();
89  }
90 
91  //------------------------------------------------------------------------//
92  void writeXMLToStream(XMLSerializer& xml_stream) const
93  {
94  writeXMLTagToStream(xml_stream);
95  writeXMLAttributesToStream(xml_stream);
96  xml_stream.closeTag();
97  }
98 
99  //------------------------------------------------------------------------//
100  virtual void writeXMLTagToStream(XMLSerializer& xml_stream) const
101  {
102  // This does nothing and needs to be specialised or overridden
103  }
104 
105  //------------------------------------------------------------------------//
106  virtual void writeXMLAttributesToStream(XMLSerializer& xml_stream) const
107  {
108  // This does nothing and needs to be specialised or overridden
109  }
110 
111  //------------------------------------------------------------------------//
112  bool operator==(const FormattingSetting<T>& rhs) const
113  {
114  return d_value == rhs.d_value &&
115  d_propertySource == rhs.d_propertySource;
116  }
117 
118  //------------------------------------------------------------------------//
119  bool operator!=(const FormattingSetting<T>& rhs) const
120  {
121  return !operator==(rhs);
122  }
123 
124 protected:
125  T d_value;
126  String d_propertySource;
127 };
128 
129 template<> void CEGUIEXPORT FormattingSetting<VerticalFormatting>::writeXMLTagToStream(
130  XMLSerializer& xml_stream) const;
131 template<> void CEGUIEXPORT FormattingSetting<VerticalFormatting>::writeXMLAttributesToStream(
132  XMLSerializer& xml_stream) const;
133 template<> void CEGUIEXPORT FormattingSetting<HorizontalFormatting>::writeXMLTagToStream(
134  XMLSerializer& xml_stream) const;
135 template<> void CEGUIEXPORT FormattingSetting<HorizontalFormatting>::writeXMLAttributesToStream(
136  XMLSerializer& xml_stream) const;
137 template<> void CEGUIEXPORT FormattingSetting<VerticalTextFormatting>::writeXMLTagToStream(
138  XMLSerializer& xml_stream) const;
139 template<> void CEGUIEXPORT FormattingSetting<VerticalTextFormatting>::writeXMLAttributesToStream(
140  XMLSerializer& xml_stream) const;
141 template<> void CEGUIEXPORT FormattingSetting<HorizontalTextFormatting>::writeXMLTagToStream(
142  XMLSerializer& xml_stream) const;
143 template<> void CEGUIEXPORT FormattingSetting<HorizontalTextFormatting>::writeXMLAttributesToStream(
144  XMLSerializer& xml_stream) const;
145 }
146 
147 #endif
148