Crazy Eddie's GUI System  0.8.7
ChainedXMLHandler.h
1 /***********************************************************************
2  created: Wed Aug 11 2010
3  author: Paul D Turner <paul@cegui.org.uk>
4 *************************************************************************/
5 /***************************************************************************
6  * Copyright (C) 2004 - 2010 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 _CEGUIChainedXMLHandler_h_
28 #define _CEGUIChainedXMLHandler_h_
29 
30 #include "CEGUI/XMLHandler.h"
31 
32 // Start of CEGUI namespace section
33 namespace CEGUI
34 {
36 class CEGUIEXPORT ChainedXMLHandler : public XMLHandler
37 {
38 public:
40  virtual ~ChainedXMLHandler();
41 
42  // XMLHandler overrides
43  const String& getSchemaName() const;
45  void elementStart(const String& element, const XMLAttributes& attributes);
46  void elementEnd(const String& element);
47 
49  bool completed() const;
50 
51 protected:
53  virtual void elementStartLocal(const String& element,
54  const XMLAttributes& attributes) = 0;
56  virtual void elementEndLocal(const String& element) = 0;
57 
60 
67 };
68 
69 
70 } // End of CEGUI namespace section
71 
72 #endif // end of guard _CEGUIChainedXMLHandler_h_
73 
Abstract XMLHandler based class.
Definition: ChainedXMLHandler.h:37
virtual void elementEndLocal(const String &element)=0
Function that handles elements locally (used at end of handler chain)
ChainedXMLHandler * d_chainedHandler
chained xml handler object.
Definition: ChainedXMLHandler.h:62
const String & getDefaultResourceGroup() const
Retrieves the default resource group to be used when handling files.
const String & getSchemaName() const
Retrieves the schema file name to use with resources handled by this handler.
bool d_completed
is the chained handler completed.
Definition: ChainedXMLHandler.h:64
void cleanupChainedHandler()
clean up any chained handler.
virtual void elementStartLocal(const String &element, const XMLAttributes &attributes)=0
Function that handles elements locally (used at end of handler chain)
void elementStart(const String &element, const XMLAttributes &attributes)
Method called to notify the handler at the start of each XML element encountered.
void elementEnd(const String &element)
Method called to notify the handler at the end of each XML element encountered.
bool d_deleteChaniedHandler
should the chained handler be deleted by us?
Definition: ChainedXMLHandler.h:66
bool completed() const
returns whether this chained handler has completed.
String class used within the GUI system.
Definition: String.h:64
Class representing a block of attributes associated with an XML element.
Definition: XMLAttributes.h:48
Definition: XMLHandler.h:37
Main namespace for Crazy Eddie's GUI Library.
Definition: arch_overview.dox:1