diff options
Diffstat (limited to 'src/xmlstringwriter.h')
| -rw-r--r-- | src/xmlstringwriter.h | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/src/xmlstringwriter.h b/src/xmlstringwriter.h new file mode 100644 index 0000000..530db3e --- /dev/null +++ b/src/xmlstringwriter.h | |||
| @@ -0,0 +1,50 @@ | |||
| 1 | #ifndef XML_STRING_WRITER | ||
| 2 | #define XML_STRING_WRITER | ||
| 3 | |||
| 4 | #include "xmlnode.h" | ||
| 5 | #include "xmlwriter.h" | ||
| 6 | |||
| 7 | /** | ||
| 8 | * Implements xml writing in the XML standard format. Also allows you to | ||
| 9 | * break that format and auto-indent your exported xml data for ease of | ||
| 10 | * reading. The auto-indenting will only be applied to sections that | ||
| 11 | * have no content of their own already. This means that except for | ||
| 12 | * whitespace all of your data will be preserved perfectly. | ||
| 13 | * You can create an XmlWriter object around a file, or access the static | ||
| 14 | * write function directly and just hand it a filename and a root XmlNode. | ||
| 15 | * When using an XmlWriter object the interface is identicle to that of | ||
| 16 | * the XmlDocument class, so reference that class for API info. However | ||
| 17 | * when the initial (or root) node is closed, and the document is finished | ||
| 18 | * the file will be created and written to automatically. The user can | ||
| 19 | * check to see if this is actually true by calling the isFinished | ||
| 20 | * function in the XmlDocument class. | ||
| 21 | *@author Mike Buland | ||
| 22 | */ | ||
| 23 | class XmlStringWriter : public XmlWriter | ||
| 24 | { | ||
| 25 | public: | ||
| 26 | /** | ||
| 27 | * Construct a string writer using an internal string buffer. | ||
| 28 | *@param sIndent Optional indent to add to each line. | ||
| 29 | */ | ||
| 30 | XmlStringWriter( const char *sIndent=NULL ); | ||
| 31 | |||
| 32 | /** | ||
| 33 | * Destroy the string writer and the internal string. | ||
| 34 | */ | ||
| 35 | ~XmlStringWriter(); | ||
| 36 | |||
| 37 | /** | ||
| 38 | * Get the string that was built. This is only valid after the document has | ||
| 39 | * been completed, so check isCompleted or be sure your addNode and | ||
| 40 | * closeNode calls match up. | ||
| 41 | *@returns A reference to the internal string object. | ||
| 42 | */ | ||
| 43 | std::string &getString(); | ||
| 44 | |||
| 45 | private: | ||
| 46 | void writeString( const char *sString ); | ||
| 47 | std::string sXml; /**< The string object we "write" to. */ | ||
| 48 | }; | ||
| 49 | |||
| 50 | #endif | ||
