Crazy Eddie's GUI System  0.8.7
XMLAttributes.h
1 /***********************************************************************
2  created: Sat Mar 12 2005
3  author: Paul D Turner
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 _CEGUIXMLAttributes_h_
28 #define _CEGUIXMLAttributes_h_
29 
30 #include "CEGUI/Base.h"
31 #include "CEGUI/String.h"
32 #include <map>
33 
34 #if defined(_MSC_VER)
35 # pragma warning(push)
36 # pragma warning(disable : 4251)
37 #endif
38 
39 // Start of CEGUI namespace section
40 namespace CEGUI
41 {
46  class CEGUIEXPORT XMLAttributes :
47  public AllocatedObject<XMLAttributes>
48  {
49  public:
55 
60  virtual ~XMLAttributes(void);
61 
76  void add(const String& attrName, const String& attrValue);
77 
88  void remove(const String& attrName);
89 
101  bool exists(const String& attrName) const;
102 
110  size_t getCount(void) const;
111 
128  const String& getName(size_t index) const;
129 
146  const String& getValue(size_t index) const;
147 
160  const String& getValue(const String& attrName) const;
161 
177  const String& getValueAsString(const String& attrName, const String& def = "") const;
178 
196  bool getValueAsBool(const String& attrName, bool def = false) const;
197 
215  int getValueAsInteger(const String& attrName, int def = 0) const;
216 
234  float getValueAsFloat(const String& attrName, float def = 0.0f) const;
235 
236  protected:
237  typedef std::map<String, String, StringFastLessCompare> AttributeMap;
238  AttributeMap d_attrs;
239  };
240 
241 } // End of CEGUI namespace section
242 
243 
244 #if defined(_MSC_VER)
245 # pragma warning(pop)
246 #endif
247 
248 #endif // end of guard _CEGUIXMLAttributes_h_
CEGUI::XMLAttributes::~XMLAttributes
virtual ~XMLAttributes(void)
XMLAttributes Destructor.
CEGUI::XMLAttributes::add
void add(const String &attrName, const String &attrValue)
Adds an attribute to the attribute block. If the attribute value already exists, it is replaced with ...
CEGUI::XMLAttributes::getCount
size_t getCount(void) const
Return the number of attributes in the attribute block.
CEGUI::XMLAttributes::getName
const String & getName(size_t index) const
Return the name of an attribute based upon its index within the attribute block.
CEGUI
Main namespace for Crazy Eddie's GUI Library.
Definition: arch_overview.dox:1
CEGUI::AllocatedObject
Definition: MemoryAllocatedObject.h:110
CEGUI::XMLAttributes::getValueAsBool
bool getValueAsBool(const String &attrName, bool def=false) const
Return the value of attribute attrName as a boolean value.
CEGUI::XMLAttributes::remove
void remove(const String &attrName)
Removes an attribute from the attribute block.
CEGUI::XMLAttributes::XMLAttributes
XMLAttributes(void)
XMLAttributes constructor.
CEGUI::XMLAttributes
Class representing a block of attributes associated with an XML element.
Definition: XMLAttributes.h:48
CEGUI::XMLAttributes::exists
bool exists(const String &attrName) const
Return whether the named attribute exists within the attribute block.
CEGUI::XMLAttributes::getValueAsInteger
int getValueAsInteger(const String &attrName, int def=0) const
Return the value of attribute attrName as a integer value.
CEGUI::XMLAttributes::getValue
const String & getValue(size_t index) const
Return the value string of an attribute based upon its index within the attribute block.
CEGUI::XMLAttributes::getValueAsFloat
float getValueAsFloat(const String &attrName, float def=0.0f) const
Return the value of attribute attrName as a floating point value.
CEGUI::XMLAttributes::getValueAsString
const String & getValueAsString(const String &attrName, const String &def="") const
Return the value of attribute attrName as a string.
CEGUI::String
String class used within the GUI system.
Definition: String.h:64
CEGUI::XMLAttributes::getValue
const String & getValue(const String &attrName) const
Return the value string for attribute attrName.