Class used to create XML Document.
More...
List of all members.
Detailed Description
Class used to create XML Document.
This class hides the complexity of formatting valid XML files. The class provides automatic substitution of entities, XML indenting in respect of the spaces. It does not contains any codes specific to CEGUI taking appart the CEGUI::String class. The following example show the code needed to exports parts of an XML document similar to what can be found in a layout.
#include <iostream>
#include <CEGUI/XMLSerializer.h>
int main()
{
Create an encoder that outputs its result on standard output
XMLSerializer xml(std::cout, 4);
xml.openTag("Window")
.attribute("Type", "TaharezLook/StaticText")
.attribute("Name", "Test")
.openTag("Property")
.attribute("Name", "Text")
.text("This is the static text to be displayed")
.closeTag()
.openTag("Window")
.attribute("Name", "Button")
.attribute("Type", "Vanilla/Button")
.openTag("Property")
.attribute("Name", "Text")
.attribute("Value", "Push me")
.closeTag()
.closeTag()
.closeTag();
if (xml)
{
std::cout << "XML Exported successfully" << std::endl;
}
return 0;
}
Constructor & Destructor Documentation
CEGUI::XMLSerializer::XMLSerializer |
( |
OutStream & |
out, |
|
|
size_t |
indentSpace = 4 |
|
) |
| |
XMLSerializer constructor.
- Parameters:
-
out | The stream to use to export the result |
indentSpace | The indentation level (0 to disable indentation) |
Member Function Documentation
After an opening tag you can populate attribute list with this function.
- Parameters:
-
name | The name of the attribute |
value | The value of the attribute |
- Returns:
- A reference to the current object for chaining operation
Close the current tag.
- Returns:
- A reference to the current object for chaining operation
unsigned int CEGUI::XMLSerializer::getTagCount |
( |
) |
const |
report the nimber of tags created in the document
- Returns:
- return the number of tag created in the document
Start a new tag in the xml document.
- Parameters:
-
- Returns:
- A reference to the current object for chaining operation
CEGUI::XMLSerializer::operator bool |
( |
) |
const [inline] |
Check wether the XML Serializer status is valid.
- Returns:
- True if all previous operations where successfull
bool CEGUI::XMLSerializer::operator! |
( |
) |
const [inline] |
Check wether the XML Serializer status is invalid.
- Returns:
- True if one operations failed
Create a text node.
- Parameters:
-
text | the content of the node |
- Returns:
- A reference to the current object for chaining operation