XML text node - contained in an XML element. More...
#include <XmlText.h>
Inheritance diagram for PLCore::XmlText:
Public Member Functions | |
| XmlText () | |
| Default constructor. | |
| PLCORE_API | XmlText (const String &sValue) |
| Constructor. | |
| PLCORE_API | XmlText (const XmlText &cSource) |
| Copy constructor. | |
| virtual PLCORE_API | ~XmlText () |
| Destructor. | |
| PLCORE_API XmlText & | operator= (const XmlText &cSource) |
| Copy operator. | |
| bool | IsCDATA () const |
| Queries whether this represents text using a CDATA section. | |
| void | SetCDATA (bool bCDATA) |
| Turns on or off a CDATA representation of text. | |
| 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
XML text node - contained in an XML element.
Constructor & Destructor Documentation
Default constructor.
| PLCORE_API PLCore::XmlText::XmlText | ( | const String & | sValue | ) |
- Parameters:
-
[in] sValue Value of this text node
| PLCORE_API PLCore::XmlText::XmlText | ( | const XmlText & | cSource | ) |
Copy constructor.
- Parameters:
-
[in] cSource Source to copy from
| virtual PLCORE_API PLCore::XmlText::~XmlText | ( | ) | [virtual] |
Destructor.
Member Function Documentation
Copy operator.
- Parameters:
-
[in] cSource Source to copy from
- Returns:
- Reference to this instance
| bool PLCore::XmlText::IsCDATA | ( | ) | const [inline] |
Queries whether this represents text using a CDATA section.
- Returns:
- 'true' if this is input and output as a CDATA style text element, else 'false'
| void PLCore::XmlText::SetCDATA | ( | bool | bCDATA | ) | [inline] |
Turns on or off a CDATA representation of text.
- Parameters:
-
[in] bCDATA 'true' if this should be input and output as a CDATA style text element, else 'false'
| virtual PLCORE_API bool PLCore::XmlText::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::XmlText::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::XmlText::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::XmlText::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:
