Unknown XML node. More...
#include <XmlUnknown.h>
Inheritance diagram for PLCore::XmlUnknown:
Public Member Functions | |
| PLCORE_API | XmlUnknown () |
| Default constructor. | |
| PLCORE_API | XmlUnknown (const XmlUnknown &cSource) |
| Copy constructor. | |
| virtual PLCORE_API | ~XmlUnknown () |
| Destructor. | |
| XmlUnknown & | operator= (const XmlUnknown &cSource) |
| Copy operator. | |
| virtual PLCORE_API bool | Save (File &cFile, uint32 nDepth=0) override |
| Save function. | |
| virtual PLCORE_API String | ToString (uint32 nDepth=0) const override |
| Output as string function. | |
| virtual PLCORE_API const char * | Parse (const char *pszData, XmlParsingData *pData=nullptr, EEncoding nEncoding=EncodingUnknown) override |
| Parse the given null terminated block of XML data. | |
| virtual PLCORE_API XmlNode * | Clone () const override |
| Create an exact duplicate of this node and return it. | |
Detailed Description
Unknown XML node.
- Remarks:
- Any tag that the XML parser doesn't recognize is saved as an unknown. It is a tag of text, but should not be modified. It will be written back to the XML, unchanged, when the file is saved. DTD tags get thrown into XmlUnknown.
Constructor & Destructor Documentation
| PLCORE_API PLCore::XmlUnknown::XmlUnknown | ( | ) |
Default constructor.
| PLCORE_API PLCore::XmlUnknown::XmlUnknown | ( | const XmlUnknown & | cSource | ) |
Copy constructor.
- Parameters:
-
[in] cSource Source to copy from
| virtual PLCORE_API PLCore::XmlUnknown::~XmlUnknown | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| XmlUnknown & PLCore::XmlUnknown::operator= | ( | const XmlUnknown & | cSource | ) | [inline] |
Copy operator.
- Parameters:
-
[in] cSource Source to copy from
- Returns:
- Reference to this instance
| virtual PLCORE_API bool PLCore::XmlUnknown::Save | ( | File & | cFile, |
| uint32 | nDepth = 0 |
||
| ) | [override, virtual] |
Save function.
- Parameters:
-
[out] cFile File to write in, must be opened and writable [in] nDepth Current depth
- Returns:
- 'true' if all went fine, else 'false'
Implements PLCore::XmlBase.
| virtual PLCORE_API String PLCore::XmlUnknown::ToString | ( | uint32 | nDepth = 0 | ) | const [override, virtual] |
Output as string function.
- Parameters:
-
[in] nDepth Current depth
- Returns:
- String containing the XML
Implements PLCore::XmlBase.
| virtual PLCORE_API const char* PLCore::XmlUnknown::Parse | ( | const char * | pszData, |
| XmlParsingData * | pData = nullptr, |
||
| EEncoding | nEncoding = EncodingUnknown |
||
| ) | [override, virtual] |
Parse the given null terminated block of XML data.
- Parameters:
-
[in] pszData Parsing data, if a null pointer, an error will be returned [in] pData Parsing data, can be a null pointer [in] nEncoding Encoding
- Returns:
- The pointer to the parameter 'pszData' if all went fine, else a null pointer
- Remarks:
- Passing in an encoding to this method (either 'EncodingLegacy' or 'EncodingUTF8' will force the parser to use that encoding, regardless of what the parser might otherwise try to detect.
Implements PLCore::XmlBase.
| virtual PLCORE_API XmlNode* PLCore::XmlUnknown::Clone | ( | ) | const [override, virtual] |
Create an exact duplicate of this node and return it.
- Returns:
- The clone, a null pointer on error
- Note:
- The memory must be deleted by the caller
Implements PLCore::XmlNode.
The documentation for this class was generated from the following files:
