From 767bb3951c65e38627cb0bbad9a3756e1cda2520 Mon Sep 17 00:00:00 2001 From: Daniel Wilhelm Date: Fri, 18 Apr 2014 17:30:42 +0200 Subject: 6.1 --- zenxml/doc/namespacezen.html | 239 +++++++++++++++++++------------------------ 1 file changed, 107 insertions(+), 132 deletions(-) (limited to 'zenxml/doc/namespacezen.html') diff --git a/zenxml/doc/namespacezen.html b/zenxml/doc/namespacezen.html index c05f255c..1d961e87 100644 --- a/zenxml/doc/namespacezen.html +++ b/zenxml/doc/namespacezen.html @@ -3,46 +3,36 @@ + zen::Xml: zen Namespace Reference - - - - + + - + -
- - +
- - - - - -
zen::Xml -
Simple C++ XML Processing
- - + + @@ -51,7 +41,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • Main Page
  • Namespaces
  • Classes
    • -
  • Files
  • @@ -81,7 +70,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> - All Classes Namespaces Functions Variables
    + All Classes Namespaces Functions Variables Pages
    • @@ -90,7 +79,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
    -
    +
    Classes | @@ -103,102 +92,109 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');

    The zen::Xml namespace. More...

    - + + + + + + - +

    +

    Classes

    class  XmlOut
     Proxy class to conveniently convert user data into XML structure. More...
     
    class  XmlIn
     Proxy class to conveniently convert XML structure to user data. More...
     
    class  XmlElement
     An XML element. More...
     
    class  XmlDoc
     The complete XML document. More...
     
    struct  XmlError
     Exception base class for zen::Xml. More...
     
    struct  XmlFileError
     Exception thrown due to failed file I/O. More...
     
    struct  XmlParsingError
     Exception thrown due to an XML parsing error. More...

    +

     
    + - - - + + + + - + + - + + - + + - + + - + + - + + - + + - - - + + + + +

    Functions

    template<class String >
    void load (const String &filename, XmlDoc &doc)
     Load XML document from a file.
    template<class String >
    XmlDoc load (const String &filename)
     Load XML document from a file. More...
     
    template<class String >
    void save (const XmlDoc &doc, const String &filename, const std::string &lineBreak="\r\n", const std::string &indent=" ")
     Save XML document to a file.
     Save XML document to a file. More...
     
    template<class T >
    bool readStruc (const XmlElement &input, T &value)
     Convert XML element to structured user data.
     Convert XML element to structured user data. More...
     
    template<class T >
    void writeStruc (const T &value, XmlElement &output)
     Convert structured user data into an XML element.
     Convert structured user data into an XML element. More...
     
    template<class T >
    bool readText (const std::string &input, T &value)
     Convert text to user data - used by XML elements and attributes.
     Convert text to user data - used by XML elements and attributes. More...
     
    template<class T >
    void writeText (const T &value, std::string &output)
     Convert user data into text - used by XML elements and attributes.
     Convert user data into text - used by XML elements and attributes. More...
     
    template<class String >
    void saveStream (const std::string &stream, const String &filename)
     Save byte stream to a file.
     Save byte stream to a file. More...
     
    template<class String >
    std::string loadStream (const String &filename)
     Load byte stream from a file.
     Load byte stream from a file. More...
     
    std::string serialize (const XmlDoc &doc, const std::string &lineBreak="\r\n", const std::string &indent=" ")
     Save XML document as a byte stream.
    void parse (const std::string &stream, XmlDoc &doc)
     Load XML document from a byte stream.
     Save XML document as a byte stream. More...
     
    XmlDoc parse (const std::string &stream)
     Load XML document from a byte stream. More...
     
    -

    Detailed Description

    +

    Detailed Description

    The zen::Xml namespace.

    -

    Function Documentation

    - +

    Function Documentation

    +
    template<class String >
    - + - - - - - - - - - + - -
    void zen::load XmlDoc zen::load ( const String & filename,
    XmlDoc & doc 
    filename) )
    -
    -
    +

    Load XML document from a file.

    -

    Convenience function that does nothing more than calling loadStream() and parse().

    -
    Template Parameters:
    - +

    Convenience function that does nothing more than calling loadStream() and parse().

    +
    Template Parameters
    +
    StringArbitrary string-like type: e.g. std::string, wchar_t*, char[], wchar_t, wxString, MyStringClass, ...
    -
    Parameters:
    +
    Parameters
    -
    filenameInput file name
    docThe XML document to load
    -
    Exceptions:
    +
    Returns
    The loaded XML document
    +
    Exceptions
    - - + +
    XmlFileError
    XmlParsingError
    XmlFileError
    XmlParsingError
    @@ -212,75 +208,63 @@ template<class String >
    template<class String >
    - +
    std::string zen::loadStream std::string zen::loadStream ( const String &  filename)
    -
    -
    +

    Load byte stream from a file.

    -
    Template Parameters:
    - +
    Template Parameters
    +
    StringArbitrary string-like type: e.g. std::string, wchar_t*, char[], wchar_t, wxString, MyStringClass, ...
    -
    Parameters:
    +
    Parameters
    filenameInput file name
    -
    Returns:
    Output byte stream
    -
    Exceptions:
    +
    Returns
    Output byte stream
    +
    Exceptions
    - +
    XmlFileError
    XmlFileError
    - +
    - + - - - - + - - - - - - -
    void zen::parse XmlDoc zen::parse ( const std::string & stream,
    stream) XmlDoc & doc 
    )
    -
    -
    +

    Load XML document from a byte stream.

    -
    Parameters:
    +
    Parameters
    -
    streamInput byte stream
    docOutput XML document
    -
    Exceptions:
    +
    Returns
    Output XML document
    +
    Exceptions
    - +
    XmlParsingError
    XmlParsingError
    @@ -294,7 +278,7 @@ template<class String >
    template<class T >
    - + @@ -311,18 +295,17 @@ template<class T >
    bool zen::readStruc bool zen::readStruc ( const XmlElement &  input,
    - -
    +

    Convert XML element to structured user data.

    -
    Parameters:
    +
    Parameters
    inputThe input XML element.
    valueConversion target value.
    -
    Returns:
    "true" if value was read successfully.
    +
    Returns
    "true" if value was read successfully.
    @@ -333,7 +316,7 @@ template<class T > template<class T > - + @@ -350,18 +333,17 @@ template<class T >
    bool zen::readText bool zen::readText ( const std::string &  input,
    - -
    +

    Convert text to user data - used by XML elements and attributes.

    -
    Parameters:
    +
    Parameters
    inputInput text.
    valueConversion target value.
    -
    Returns:
    "true" if value was read successfully.
    +
    Returns
    "true" if value was read successfully.
    @@ -372,7 +354,7 @@ template<class T > template<class String > - + @@ -401,18 +383,17 @@ template<class String >
    void zen::save void zen::save ( const XmlDoc &  doc,
    - -
    +

    Save XML document to a file.

    -

    Convenience function that does nothing more than calling serialize() and saveStream().

    -
    Template Parameters:
    - +

    Convenience function that does nothing more than calling serialize() and saveStream().

    +
    Template Parameters
    +
    StringArbitrary string-like type: e.g. std::string, wchar_t*, char[], wchar_t, wxString, MyStringClass, ...
    -
    Parameters:
    +
    Parameters
    @@ -421,9 +402,9 @@ template<class String >
    docThe XML document to save
    filenameOutput file name
    -
    Exceptions:
    +
    Exceptions
    - +
    XmlFileError
    XmlFileError
    @@ -437,7 +418,7 @@ template<class String >
    template<class String > - + @@ -454,26 +435,25 @@ template<class String >
    void zen::saveStream void zen::saveStream ( const std::string &  stream,
    - -
    +

    Save byte stream to a file.

    -
    Template Parameters:
    - +
    Template Parameters
    +
    StringArbitrary string-like type: e.g. std::string, wchar_t*, char[], wchar_t, wxString, MyStringClass, ...
    -
    Parameters:
    +
    Parameters
    streamInput byte stream
    filenameOutput file name
    -
    Exceptions:
    +
    Exceptions
    - +
    XmlFileError
    XmlFileError
    @@ -485,7 +465,7 @@ template<class String >
    - + @@ -508,11 +488,10 @@ template<class String >
    std::string zen::serialize std::string zen::serialize ( const XmlDoc &  doc,
    -
    -
    +

    Save XML document as a byte stream.

    -
    Parameters:
    +
    Parameters
    @@ -520,7 +499,7 @@ template<class String >
    docInput XML document
    lineBreakLine break, default: carriage return + new line
    -
    Returns:
    Output byte stream
    +
    Returns
    Output byte stream
    @@ -531,7 +510,7 @@ template<class String > template<class T > - + @@ -548,11 +527,10 @@ template<class T >
    void zen::writeStruc void zen::writeStruc ( const T &  value,
    - -
    +

    Convert structured user data into an XML element.

    -
    Parameters:
    +
    Parameters
    @@ -569,7 +547,7 @@ template<class T > template<class T >
    valueThe value to be converted.
    outputThe output XML element.
    - + @@ -586,11 +564,10 @@ template<class T >
    void zen::writeText void zen::writeText ( const T &  value,
    -
    -
    +

    Convert user data into text - used by XML elements and attributes.

    -
    Parameters:
    +
    Parameters
    @@ -601,13 +578,11 @@ template<class T > - - +
    Generated by   doxygen - 1.8.0 + 1.8.6
    - -- cgit
    valueThe value to be converted.
    outputOutput text.