#include <tdme/gui/GUIParser.h>

Collaboration diagram for GUIParser:

Static Public Member Functions
static GUIScreenNode *	parse (const string &pathName, const string &fileName, const unordered_map< string, string > &parameters=unordered_map< string, string >())
	Parses a GUI XML file. More...

static GUIScreenNode *	parse (const string &xml, const unordered_map< string, string > &parameters=unordered_map< string, string >(), const string &pathName=string(), const string &fileName=string())
	Parses a GUI XML content. More...

static void	parse (GUIParentNode *parentNode, const string &pathName, const string &fileName)
	Parses a GUI XML file into parent node. More...

static void	parse (GUIParentNode *parentNode, const string &xml)
	Parses a GUI XML content into parent node. More...

static const string	unescapeQuotes (const string &str)
	Unescape quotes. More...

static const string	escapeQuotes (const string &str)
	Escape quotes. More...

static void	addElement (GUIElement *guiElement)
	Add GUI element. More...

static void	initialize ()
	Initialize GUI elements. More...

static void	dispose ()
	Dispose GUI elements. More...

static void	loadProjectThemeProperties (const string &pathName)
	Load project theme properties. More...

Static Private Member Functions
static void	parseEffect (GUINode guiNode, const string &effectPrefix, bool requiresCondition, TiXmlElement node)
	Parse GUI effect. More...

static void	parseEffects (GUINode guiNode, TiXmlElement xmlParentNode)
	Parse GUI effect. More...

static void	parseGUINode (GUIParentNode guiParentNode, const string &parentElementId, TiXmlElement xmlParentNode, GUIElement *guiElement)
	Parse GUI node. More...

static const vector< TiXmlElement * >	getChildrenByTagName (TiXmlElement parent, const char name)
	Returns immediate children tags. More...

static const string	getInnerXml (TiXmlElement *node)
	Get inner XML. More...

static void	parseTemplate (GUIParentNode guiParentNode, const string &parentElementId, TiXmlElement node, const string &_template, const unordered_map< string, string > &attributes, GUIElement *guiElement)
	Parse template. More...

static void	parseInnerXML (GUIParentNode guiParentNode, const string &parentElementId, TiXmlElement node, const string &_template, const unordered_map< string, string > &attributes, GUIElement *guiElement)
	Parse inner XML. More...

static int	parseFactor (GUIParentNode *guiParentNode, const string &factor)
	Parse factor. More...

Static Private Attributes
static STATIC_DLL_IMPEXT map< string, GUIElement * > *	elements = new map<string, GUIElement*>()

static STATIC_DLL_IMPEXT Properties *	engineThemeProperties = new Properties()

static STATIC_DLL_IMPEXT Properties *	projectThemeProperties = new Properties()

Detailed Description

GUI parser.

Author: Andreas Drewke

Version: $Id$

Definition at line 38 of file GUIParser.h.

Member Function Documentation

◆ addElement()

void addElement ( GUIElement * guiElement )

static

Add GUI element.

Parameters

guiElement guiElement

Exceptions

tdme::gui::GUIParserException
tdme::os::filesystem::FileSystemException

Definition at line 1751 of file GUIParser.cpp.

◆ dispose()

void dispose ( )

static

Dispose GUI elements.

Definition at line 1975 of file GUIParser.cpp.

◆ escapeQuotes()

const string escapeQuotes ( const string & str )

static

Escape quotes.

Parameters

str string

Returns: string with escaped quotes

Definition at line 1743 of file GUIParser.cpp.

◆ getChildrenByTagName()

const vector< TiXmlElement * > getChildrenByTagName	(	TiXmlElement *	parent,
		const char *	name
	)

staticprivate

Returns immediate children tags.

Parameters

parent	parent
name	name

Returns: children of parent node with given name

Definition at line 1717 of file GUIParser.cpp.

◆ getInnerXml()

const string getInnerXml ( TiXmlElement * node )

staticprivate

Get inner XML.

Parameters

node node

Returns: string

Definition at line 1726 of file GUIParser.cpp.

◆ initialize()

void initialize ( )

static

Initialize GUI elements.

Definition at line 1763 of file GUIParser.cpp.

◆ loadProjectThemeProperties()

void loadProjectThemeProperties ( const string & pathName )

static

Load project theme properties.

Parameters

pathName path name

Definition at line 1983 of file GUIParser.cpp.

◆ parse() [1/4]

GUIScreenNode * parse	(	const string &	pathName,
		const string &	fileName,
		const unordered_map< string, string > &	parameters = `unordered_map<string, string>()`
	)

static

Parses a GUI XML file.

Parameters

pathName	path name
fileName	file name
parameters	parameters aka key value paris for substitution

Returns: GUI screen node

Exceptions

tdme::gui::GUIParserException
tdme::os::filesystem::FileSystemException

Definition at line 160 of file GUIParser.cpp.

◆ parse() [2/4]

GUIScreenNode * parse	(	const string &	xml,
		const unordered_map< string, string > &	parameters = `unordered_map<string, string>()`,
		const string &	pathName = `string()`,
		const string &	fileName = `string()`
	)

static

Parses a GUI XML content.

Parameters

xml	xml
parameters	parameters aka key value paris for substitution
pathName	path name
fileName	file name

Returns: GUI screen node

Exceptions

tdme::gui::GUIParserException
tdme::os::filesystem::FileSystemException

Definition at line 165 of file GUIParser.cpp.

◆ parse() [3/4]

void parse	(	GUIParentNode *	parentNode,
		const string &	pathName,
		const string &	fileName
	)

static

Parses a GUI XML file into parent node.

Parameters

parentNode	parent node
pathName	path name
fileName	file name

Exceptions

tdme::gui::GUIParserException
tdme::os::filesystem::FileSystemException

Definition at line 273 of file GUIParser.cpp.

◆ parse() [4/4]

void parse	(	GUIParentNode *	parentNode,
		const string &	xml
	)

static

Parses a GUI XML content into parent node.

Parameters

parentNode	parent node
xml	xml

Exceptions

tdme::gui::GUIParserException
tdme::os::filesystem::FileSystemException

Definition at line 279 of file GUIParser.cpp.

◆ parseEffect()

void parseEffect	(	GUINode *	guiNode,
		const string &	effectPrefix,
		bool	requiresCondition,
		TiXmlElement *	node
	)

staticprivate

Parse GUI effect.

Parameters

guiNode	GUI node
effectPrefix	effect prefix
requiresCondition	requires condition
node	node

Definition at line 301 of file GUIParser.cpp.

◆ parseEffects()

void parseEffects	(	GUINode *	guiNode,
		TiXmlElement *	xmlParentNode
	)

staticprivate

Parse GUI effect.

Parameters

guiNode	GUI node
xmlParentNode	xml parent node

Definition at line 352 of file GUIParser.cpp.

◆ parseFactor()

int parseFactor	(	GUIParentNode *	guiParentNode,
		const string &	factor
	)

staticprivate

Parse factor.

Parameters

guiParentNode	gui parent node
factor	factor

Returns: factor

Definition at line 1692 of file GUIParser.cpp.

◆ parseGUINode()

void parseGUINode	(	GUIParentNode *	guiParentNode,
		const string &	parentElementId,
		TiXmlElement *	xmlParentNode,
		GUIElement *	guiElement
	)

staticprivate

Parse GUI node.

Parameters

guiParentNode	gui parent node
parentElementId	parent element id
xmlParentNode	xml parent node
guiElement	gui element

Exceptions

tdme::gui::GUIParserException
tdme::os::filesystem::FileSystemException

Definition at line 367 of file GUIParser.cpp.

◆ parseInnerXML()

void parseInnerXML	(	GUIParentNode *	guiParentNode,
		const string &	parentElementId,
		TiXmlElement *	node,
		const string &	_template,
		const unordered_map< string, string > &	attributes,
		GUIElement *	guiElement
	)

staticprivate

Parse inner XML.

Parameters

guiParentNode	GUI parent node
parentElementId	parent element id
node	template xml node
_template	template
attributes	attributes
guiElement	GUI element

Definition at line 1646 of file GUIParser.cpp.

◆ parseTemplate()

void parseTemplate	(	GUIParentNode *	guiParentNode,
		const string &	parentElementId,
		TiXmlElement *	node,
		const string &	_template,
		const unordered_map< string, string > &	attributes,
		GUIElement *	guiElement
	)

staticprivate

Parse template.

Parameters

guiParentNode	GUI parent node
parentElementId	parent element id
node	template xml node
_template	template
attributes	attributes
guiElement	GUI element

Definition at line 1598 of file GUIParser.cpp.

◆ unescapeQuotes()

const string unescapeQuotes ( const string & str )

static

Unescape quotes.

Parameters

str string

Returns: string with unescaped quotes

Definition at line 1735 of file GUIParser.cpp.

Member Data Documentation

◆ elements

map< string, GUIElement * > * elements = new map<string, GUIElement*>()

staticprivate

Definition at line 42 of file GUIParser.h.

◆ engineThemeProperties

Properties * engineThemeProperties = new Properties()

staticprivate

Definition at line 43 of file GUIParser.h.

◆ projectThemeProperties

Properties * projectThemeProperties = new Properties()

staticprivate

Definition at line 44 of file GUIParser.h.

The documentation for this class was generated from the following files:

/home/andreas/Development/drewke.net/tdme2/src/tdme/gui/GUIParser.h
/home/andreas/Development/drewke.net/tdme2/src/tdme/gui/GUIParser.cpp

Static Public Member Functions

Static Private Member Functions

Static Private Attributes

Detailed Description

Member Function Documentation

◆ addElement()

◆ dispose()

◆ escapeQuotes()

◆ getChildrenByTagName()

◆ getInnerXml()

◆ initialize()

◆ loadProjectThemeProperties()

◆ parse() [1/4]

◆ parse() [2/4]

◆ parse() [3/4]

◆ parse() [4/4]

◆ parseEffect()

◆ parseEffects()

◆ parseFactor()

◆ parseGUINode()

◆ parseInnerXML()

◆ parseTemplate()

◆ unescapeQuotes()

Member Data Documentation

◆ elements

◆ engineThemeProperties

◆ projectThemeProperties