diff --git a/CMakeLists.txt b/CMakeLists.txt index 2a45e459..76320221 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,5 +1,5 @@ cmake_minimum_required(VERSION 3.15) -project(tinyxml2 VERSION 9.0.0) +project(tinyxml2 VERSION 10.0.0) include(CTest) option(tinyxml2_BUILD_TESTING "Build tests for tinyxml2" "${BUILD_TESTING}") diff --git a/docs/_example_1.html b/docs/_example_1.html index bac9a0c7..9659fcbd 100644 --- a/docs/_example_1.html +++ b/docs/_example_1.html @@ -1,14 +1,16 @@ - +
- - + +
- TinyXML-2
- 9.0.0
+
+ |
TinyXML-2 10.0.0
|
Basic XML file loading. The basic syntax to load an XML file from disk and check for an error. (ErrorID() will return 0 for no error.)
- TinyXML-2
- 9.0.0
+
+ |
TinyXML-2 10.0.0
|
Basic XML string parsing. The basic syntax to parse an XML for a char* and check for an error. (ErrorID() will return 0 for no error.)
- TinyXML-2
- 9.0.0
+
+ |
TinyXML-2 10.0.0
|
In this example, we navigate a simple XML file, and read some interesting text. Note that this example doesn't use error checking; working code should check for null pointers when walking an XML tree, or use XMLHandle.
@@ -115,7 +123,7 @@
- TinyXML-2
- 9.0.0
+
+ |
TinyXML-2 10.0.0
|
- TinyXML-2
- 9.0.0
+
+ |
TinyXML-2 10.0.0
|
▼Ntinyxml2 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CXMLVisitor | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CXMLNode | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CXMLText | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CXMLComment | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CXMLDeclaration | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CXMLUnknown | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CXMLAttribute | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CXMLElement | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CXMLDocument | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CXMLHandle | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CXMLConstHandle | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CXMLPrinter |
▼Ntinyxml2 | |
CXMLAttribute | |
CXMLComment | |
CXMLConstHandle | |
CXMLDeclaration | |
CXMLDocument | |
CXMLElement | |
CXMLHandle | |
CXMLNode | |
CXMLPrinter | |
CXMLText | |
CXMLUnknown | |
CXMLVisitor |
- TinyXML-2
- 9.0.0
+
+ |
TinyXML-2 10.0.0
|
- TinyXML-2
- 9.0.0
+
+ |
TinyXML-2 10.0.0
|
This is the complete list of members for tinyxml2::XMLAttribute, including all inherited members.
- TinyXML-2
- 9.0.0
+
+ |
TinyXML-2 10.0.0
|
#include <tinyxml2.h>
+Public Member Functions
-const char * | Name () const | | The name of the attribute. | |
-const char * | Value () const | | The value of the attribute. | |
-int | GetLineNum () const |
+const char * | Name () const | | The name of the attribute. | |
+const char * | Value () const | | The value of the attribute. | | |
-const XMLAttribute * | Next () const | | The next attribute in the list. | | int | IntValue () const |
+const XMLAttribute * | Next () const | | The next attribute in the list. | | |
-unsigned | UnsignedValue () const | | Query as an unsigned integer. See IntValue() |
+unsigned | UnsignedValue () const | |
-bool | BoolValue () const | | Query as a boolean. See IntValue() |
+bool | BoolValue () const | |
-double | DoubleValue () const | | Query as a double. See IntValue() |
+double | DoubleValue () const | |
-float | FloatValue () const | | Query as a float. See IntValue() |
+float | FloatValue () const | | XMLError | QueryIntValue (int *value) const | |
-XMLError | QueryUnsignedValue (unsigned int *value) const | |
-XMLError | QueryInt64Value (int64_t *value) const | |
-XMLError | QueryUnsigned64Value (uint64_t *value) const | |
-XMLError | QueryBoolValue (bool *value) const | |
-XMLError | QueryDoubleValue (double *value) const | |
-XMLError | QueryFloatValue (float *value) const | |
-void | SetAttribute (const char *value) | |
-void | SetAttribute (int value) | |
-void | SetAttribute (unsigned value) | |
-void | SetAttribute (int64_t value) | |
-void | SetAttribute (uint64_t value) | |
-void | SetAttribute (bool value) | |
-void | SetAttribute (double value) | |
-void | SetAttribute (float value) | | +int | GetLineNum () const | Gets the line number the attribute is in, if the document was parsed from a file. | int | IntValue () const | Query as an unsigned integer. See IntValue() | Query as a boolean. See IntValue() | Query as a double. See IntValue() | Query as a float. See IntValue() | XMLError | QueryIntValue (int *value) const | +XMLError | QueryUnsignedValue (unsigned int *value) const | See QueryIntValue. | +XMLError | QueryInt64Value (int64_t *value) const | See QueryIntValue. | +XMLError | QueryUnsigned64Value (uint64_t *value) const | See QueryIntValue. | +XMLError | QueryBoolValue (bool *value) const | See QueryIntValue. | +XMLError | QueryDoubleValue (double *value) const | See QueryIntValue. | +XMLError | QueryFloatValue (float *value) const | See QueryIntValue. | +void | SetAttribute (const char *value) | Set the attribute to a string value. | +void | SetAttribute (int value) | Set the attribute to value. | +void | SetAttribute (unsigned value) | Set the attribute to value. | +void | SetAttribute (int64_t value) | Set the attribute to value. | +void | SetAttribute (uint64_t value) | Set the attribute to value. | +void | SetAttribute (bool value) | Set the attribute to value. | +void | SetAttribute (double value) | Set the attribute to value. | +void | SetAttribute (float value) | Set the attribute to value. |
An attribute is a name-value pair. Elements have an arbitrary number of attributes, each with a unique name.
-IntValue interprets the attribute as an integer, and returns the value. If the value isn't an integer, 0 will be returned. There is no error checking; use QueryIntValue() if you need error checking.
+IntValue interprets the attribute as an integer, and returns the value. If the value isn't an integer, 0 will be returned. There is no error checking; use QueryIntValue() if you need error checking.
- TinyXML-2
- 9.0.0
+
+ |
TinyXML-2 10.0.0
|
This is the complete list of members for tinyxml2::XMLComment, including all inherited members.
- TinyXML-2
- 9.0.0
+
+ |
TinyXML-2 10.0.0
|
+Public Member Functions
-virtual XMLComment * | ToComment () | | Safely cast to a Comment, or null. | | virtual bool | Accept (XMLVisitor *visitor) const | | virtual XMLNode * | ShallowClone (XMLDocument *document) const | | virtual bool | ShallowEqual (const XMLNode *compare) const | | Public Member Functions inherited from tinyxml2::XMLNode |
-const XMLDocument * | GetDocument () const | | Get the XMLDocument that owns this XMLNode. | |
-XMLDocument * | GetDocument () | | Get the XMLDocument that owns this XMLNode. | |
-virtual XMLElement * | ToElement () | | Safely cast to an Element, or null. | |
-virtual XMLText * | ToText () | | Safely cast to Text, or null. | |
-virtual XMLDocument * | ToDocument () | | Safely cast to a Document, or null. | |
-virtual XMLDeclaration * | ToDeclaration () | | Safely cast to a Declaration, or null. | |
-virtual XMLUnknown * | ToUnknown () | | Safely cast to an Unknown, or null. | | const char * | Value () const | | void | SetValue (const char *val, bool staticMem=false) |
+virtual XMLComment * | ToComment () override | | Safely cast to a Comment, or null. | | virtual bool | Accept (XMLVisitor *visitor) const override | | virtual XMLNode * | ShallowClone (XMLDocument *document) const override | | virtual bool | ShallowEqual (const XMLNode *compare) const override | | Public Member Functions inherited from tinyxml2::XMLNode |
+const XMLDocument * | GetDocument () const | | Get the XMLDocument that owns this XMLNode. | |
+XMLDocument * | GetDocument () | | Get the XMLDocument that owns this XMLNode. | |
+virtual XMLElement * | ToElement () | | Safely cast to an Element, or null. | |
+virtual XMLText * | ToText () | | Safely cast to Text, or null. | |
+virtual XMLDocument * | ToDocument () | | Safely cast to a Document, or null. | |
+virtual XMLDeclaration * | ToDeclaration () | | Safely cast to a Declaration, or null. | |
+virtual XMLUnknown * | ToUnknown () | | Safely cast to an Unknown, or null. | | const char * | Value () const | | |
-int | GetLineNum () const | |
-const XMLNode * | Parent () const | | Get the parent of this node on the DOM. | |
-bool | NoChildren () const |
+const XMLNode * | Parent () const | | Get the parent of this node on the DOM. | | |
-const XMLNode * | FirstChild () const | | Get the first child node, or null if none exists. | | const XMLElement * | FirstChildElement (const char *name=0) const | |
-const XMLNode * | LastChild () const | | Get the last child node, or null if none exists. | | const XMLElement * | LastChildElement (const char *name=0) const | |
-const XMLNode * | PreviousSibling () const | | Get the previous (left) sibling node of this node. | |
-const XMLElement * | PreviousSiblingElement (const char *name=0) const | | Get the previous (left) sibling element of this node, with an optionally supplied name. | |
-const XMLNode * | NextSibling () const | | Get the next (right) sibling node of this node. | |
-const XMLElement * | NextSiblingElement (const char *name=0) const | | Get the next (right) sibling element of this node, with an optionally supplied name. | | XMLNode * | InsertEndChild (XMLNode *addThis) | | XMLNode * | InsertFirstChild (XMLNode *addThis) | | XMLNode * | InsertAfterChild (XMLNode *afterThis, XMLNode *addThis) | | void | DeleteChildren () |
+const XMLNode * | FirstChild () const | | Get the first child node, or null if none exists. | | const XMLElement * | FirstChildElement (const char *name=0) const | |
+const XMLNode * | LastChild () const | | Get the last child node, or null if none exists. | | const XMLElement * | LastChildElement (const char *name=0) const | |
+const XMLNode * | PreviousSibling () const | | Get the previous (left) sibling node of this node. | |
+const XMLElement * | PreviousSiblingElement (const char *name=0) const | | Get the previous (left) sibling element of this node, with an optionally supplied name. | |
+const XMLNode * | NextSibling () const | | Get the next (right) sibling node of this node. | |
+const XMLElement * | NextSiblingElement (const char *name=0) const | | Get the next (right) sibling element of this node, with an optionally supplied name. | | XMLNode * | InsertEndChild (XMLNode *addThis) | | XMLNode * | InsertFirstChild (XMLNode *addThis) | | XMLNode * | InsertAfterChild (XMLNode *afterThis, XMLNode *addThis) | | | void | DeleteChild (XMLNode *node) | | XMLNode * | DeepClone (XMLDocument *target) const | | void | SetUserData (void *userData) | XMLNode * | DeepClone (XMLDocument *target) const | | | void * | GetUserData () const | | void * | GetUserData () const | | void | SetValue (const char *val, bool staticMem=false) | +int | GetLineNum () const | Gets the line number the node is in, if the document was parsed from a file. | +bool | NoChildren () const | Returns true if this node has no children. | void | DeleteChildren () | void | DeleteChild (XMLNode *node) | void | SetUserData (void *userData) |
An XML Comment.
Which are both good references for "visiting".
-An example of using Accept():
XMLPrinter printer; +An example of using Accept():
XMLPrinter printer; tinyxmlDoc.Accept( &printer ); const char* xmlcstr = printer.CStr();@@ -229,8 +236,8 @@-
◆ ShallowClone()
+ +◆ ShallowClone()
- -@@ -239,28 +246,27 @@
- virtual XMLNode* tinyxml2::XMLComment::ShallowClone +virtual XMLNode * tinyxml2::XMLComment::ShallowClone ( -XMLDocument * -document ) +XMLDocument * document ) const -virtual +overridevirtual-Make a copy of this node, but not its children. You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())
+Make a copy of this node, but not its children. You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())
Note: if called on a XMLDocument, this will return null.
-Implements tinyxml2::XMLNode.
+Implements tinyxml2::XMLNode.
◆ ShallowEqual()
+ +◆ ShallowEqual()
@@ -271,14 +277,13 @@virtual bool tinyxml2::XMLComment::ShallowEqual
( -const XMLNode * -compare ) +const XMLNode * compare ) const -virtual +overridevirtual@@ -295,7 +300,7 @@-Generated on Sat Apr 2 2022 13:12:57 for TinyXML-2 by 1.9.1 +Generated on Sat Dec 30 2023 18:02:35 for TinyXML-2 by 1.10.0 diff --git a/docs/classtinyxml2_1_1_x_m_l_comment.png b/docs/classtinyxml2_1_1_x_m_l_comment.png index 3a076f05..273dd1fc 100644 Binary files a/docs/classtinyxml2_1_1_x_m_l_comment.png and b/docs/classtinyxml2_1_1_x_m_l_comment.png differ diff --git a/docs/classtinyxml2_1_1_x_m_l_const_handle-members.html b/docs/classtinyxml2_1_1_x_m_l_const_handle-members.html index 58e1f4bd..672929bc 100644 --- a/docs/classtinyxml2_1_1_x_m_l_const_handle-members.html +++ b/docs/classtinyxml2_1_1_x_m_l_const_handle-members.html @@ -1,14 +1,16 @@ - + - - + +
TinyXML-2: Member List + + @@ -19,10 +21,9 @@- + +/* @license-end */ +-
- - TinyXML-2 - 9.0.0 ++ @@ -30,21 +31,22 @@+ TinyXML-2 10.0.0- +++++ ++Loading...+Searching...+No Matches+@@ -66,8 +75,7 @@--+tinyxml2::XMLConstHandle Member Listtinyxml2::XMLConstHandle Member List@@ -75,7 +83,7 @@
-Generated on Sat Apr 2 2022 13:12:57 for TinyXML-2 by 1.9.1 +Generated on Sat Dec 30 2023 18:02:35 for TinyXML-2 by 1.10.0 diff --git a/docs/classtinyxml2_1_1_x_m_l_const_handle.html b/docs/classtinyxml2_1_1_x_m_l_const_handle.html index cd0f7e27..94d59f6d 100644 --- a/docs/classtinyxml2_1_1_x_m_l_const_handle.html +++ b/docs/classtinyxml2_1_1_x_m_l_const_handle.html @@ -1,14 +1,16 @@ - + - - + +TinyXML-2: tinyxml2::XMLConstHandle Class Reference + + @@ -19,10 +21,9 @@- + +/* @license-end */ +-
- - TinyXML-2 - 9.0.0 ++ @@ -30,21 +31,22 @@+ TinyXML-2 10.0.0- +++++ ++Loading...+Searching...+No Matches+@@ -68,8 +77,7 @@--+tinyxml2::XMLConstHandle Class Referencetinyxml2::XMLConstHandle Class Reference@@ -82,7 +90,7 @@
-Generated on Sat Apr 2 2022 13:12:57 for TinyXML-2 by 1.9.1 +Generated on Sat Dec 30 2023 18:02:35 for TinyXML-2 by 1.10.0 diff --git a/docs/classtinyxml2_1_1_x_m_l_declaration-members.html b/docs/classtinyxml2_1_1_x_m_l_declaration-members.html index 0e1d5775..77378d31 100644 --- a/docs/classtinyxml2_1_1_x_m_l_declaration-members.html +++ b/docs/classtinyxml2_1_1_x_m_l_declaration-members.html @@ -1,14 +1,16 @@ - + - - + +TinyXML-2: Member List + + @@ -19,10 +21,9 @@- + +/* @license-end */ +-
- - TinyXML-2 - 9.0.0 ++ @@ -30,21 +31,22 @@+ TinyXML-2 10.0.0- +++++ ++Loading...+Searching...+No Matches+@@ -66,49 +75,48 @@--+tinyxml2::XMLDeclaration Member Listtinyxml2::XMLDeclaration Member ListThis is the complete list of members for tinyxml2::XMLDeclaration, including all inherited members.
-Generated on Sat Apr 2 2022 13:12:57 for TinyXML-2 by 1.9.1 +Generated on Sat Dec 30 2023 18:02:35 for TinyXML-2 by 1.10.0 diff --git a/docs/classtinyxml2_1_1_x_m_l_declaration.html b/docs/classtinyxml2_1_1_x_m_l_declaration.html index e0751b0c..03d471f2 100644 --- a/docs/classtinyxml2_1_1_x_m_l_declaration.html +++ b/docs/classtinyxml2_1_1_x_m_l_declaration.html @@ -1,14 +1,16 @@ - + - - + +TinyXML-2: tinyxml2::XMLDeclaration Class Reference + + @@ -19,10 +21,9 @@- + +/* @license-end */ +-
- - TinyXML-2 - 9.0.0 ++ @@ -30,21 +31,22 @@+ TinyXML-2 10.0.0- +++++ ++Loading...+Searching...+No Matches+@@ -69,8 +78,7 @@ --+tinyxml2::XMLDeclaration Class Referencetinyxml2::XMLDeclaration Class Reference@@ -85,115 +93,115 @@-
+
- Public Member Functions
- -virtual XMLDeclaration * ToDeclaration () - Safely cast to a Declaration, or null. - - virtual bool Accept (XMLVisitor *visitor) const - - virtual XMLNode * ShallowClone (XMLDocument *document) const - - virtual bool ShallowEqual (const XMLNode *compare) const - - Public Member Functions inherited from tinyxml2::XMLNode - -const XMLDocument * GetDocument () const - Get the XMLDocument that owns this XMLNode. - - -XMLDocument * GetDocument () - Get the XMLDocument that owns this XMLNode. - - -virtual XMLElement * ToElement () - Safely cast to an Element, or null. - - -virtual XMLText * ToText () - Safely cast to Text, or null. - - -virtual XMLComment * ToComment () - Safely cast to a Comment, or null. - - -virtual XMLDocument * ToDocument () - Safely cast to a Document, or null. - - -virtual XMLUnknown * ToUnknown () - Safely cast to an Unknown, or null. - - const char * Value () const - + void SetValue (const char *val, bool staticMem=false) + +virtual XMLDeclaration * ToDeclaration () override + Safely cast to a Declaration, or null. + + virtual bool Accept (XMLVisitor *visitor) const override + + virtual XMLNode * ShallowClone (XMLDocument *document) const override + + virtual bool ShallowEqual (const XMLNode *compare) const override + + Public Member Functions inherited from tinyxml2::XMLNode + +const XMLDocument * GetDocument () const + Get the XMLDocument that owns this XMLNode. + + +XMLDocument * GetDocument () + Get the XMLDocument that owns this XMLNode. + + +virtual XMLElement * ToElement () + Safely cast to an Element, or null. + + +virtual XMLText * ToText () + Safely cast to Text, or null. + + +virtual XMLComment * ToComment () + Safely cast to a Comment, or null. + + +virtual XMLDocument * ToDocument () + Safely cast to a Document, or null. + + +virtual XMLUnknown * ToUnknown () + Safely cast to an Unknown, or null. + + const char * Value () const + void SetValue (const char *val, bool staticMem=false) - + -int GetLineNum () const +int GetLineNum () const Gets the line number the node is in, if the document was parsed from a file. - - -const XMLNode * Parent () const - Get the parent of this node on the DOM. - + -bool NoChildren () const + +const XMLNode * Parent () const + Get the parent of this node on the DOM. + +bool NoChildren () const Returns true if this node has no children. - - -const XMLNode * FirstChild () const - Get the first child node, or null if none exists. - - const XMLElement * FirstChildElement (const char *name=0) const - - -const XMLNode * LastChild () const - Get the last child node, or null if none exists. - - const XMLElement * LastChildElement (const char *name=0) const - - -const XMLNode * PreviousSibling () const - Get the previous (left) sibling node of this node. - - -const XMLElement * PreviousSiblingElement (const char *name=0) const - Get the previous (left) sibling element of this node, with an optionally supplied name. - - -const XMLNode * NextSibling () const - Get the next (right) sibling node of this node. - - -const XMLElement * NextSiblingElement (const char *name=0) const - Get the next (right) sibling element of this node, with an optionally supplied name. - - XMLNode * InsertEndChild (XMLNode *addThis) - - XMLNode * InsertFirstChild (XMLNode *addThis) - - XMLNode * InsertAfterChild (XMLNode *afterThis, XMLNode *addThis) - + void DeleteChildren () + +const XMLNode * FirstChild () const + Get the first child node, or null if none exists. + + const XMLElement * FirstChildElement (const char *name=0) const + + +const XMLNode * LastChild () const + Get the last child node, or null if none exists. + + const XMLElement * LastChildElement (const char *name=0) const + + +const XMLNode * PreviousSibling () const + Get the previous (left) sibling node of this node. + + +const XMLElement * PreviousSiblingElement (const char *name=0) const + Get the previous (left) sibling element of this node, with an optionally supplied name. + + +const XMLNode * NextSibling () const + Get the next (right) sibling node of this node. + + +const XMLElement * NextSiblingElement (const char *name=0) const + Get the next (right) sibling element of this node, with an optionally supplied name. + + XMLNode * InsertEndChild (XMLNode *addThis) + + XMLNode * InsertFirstChild (XMLNode *addThis) + + XMLNode * InsertAfterChild (XMLNode *afterThis, XMLNode *addThis) + void DeleteChildren () - + void DeleteChild (XMLNode *node) void DeleteChild (XMLNode *node) - - XMLNode * DeepClone (XMLDocument *target) const - + void SetUserData (void *userData) + XMLNode * DeepClone (XMLDocument *target) const + void SetUserData (void *userData) - - void * GetUserData () const + + void * GetUserData () const Detailed Description
In correct XML the declaration is the first entry in the file.
<?xml version="1.0" standalone="yes"?>TinyXML-2 will happily read or write files without a declaration, however.
The text of the declaration isn't interpreted. It is parsed and written as a string.
Member Function Documentation
- -◆ Accept()
+ +◆ Accept()
@@ -204,14 +212,13 @@virtual bool tinyxml2::XMLDeclaration::Accept
( -XMLVisitor * -visitor ) +XMLVisitor * visitor ) const -virtual +overridevirtual@@ -223,7 +230,7 @@http://c2.com/cgi/wiki?HierarchicalVisitorPattern
Which are both good references for "visiting".
-An example of using Accept():
XMLPrinter printer; +An example of using Accept():
XMLPrinter printer; tinyxmlDoc.Accept( &printer ); const char* xmlcstr = printer.CStr();@@ -231,8 +238,8 @@-
◆ ShallowClone()
+ +◆ ShallowClone()
- -@@ -241,28 +248,27 @@
- virtual XMLNode* tinyxml2::XMLDeclaration::ShallowClone +virtual XMLNode * tinyxml2::XMLDeclaration::ShallowClone ( -XMLDocument * -document ) +XMLDocument * document ) const -virtual +overridevirtual-Make a copy of this node, but not its children. You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())
+Make a copy of this node, but not its children. You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())
Note: if called on a XMLDocument, this will return null.
-Implements tinyxml2::XMLNode.
+Implements tinyxml2::XMLNode.
◆ ShallowEqual()
+ +◆ ShallowEqual()
@@ -273,14 +279,13 @@virtual bool tinyxml2::XMLDeclaration::ShallowEqual
( -const XMLNode * -compare ) +const XMLNode * compare ) const -virtual +overridevirtual@@ -297,7 +302,7 @@-Generated on Sat Apr 2 2022 13:12:57 for TinyXML-2 by 1.9.1 +Generated on Sat Dec 30 2023 18:02:35 for TinyXML-2 by 1.10.0 diff --git a/docs/classtinyxml2_1_1_x_m_l_declaration.png b/docs/classtinyxml2_1_1_x_m_l_declaration.png index c7aa6319..39154dc0 100644 Binary files a/docs/classtinyxml2_1_1_x_m_l_declaration.png and b/docs/classtinyxml2_1_1_x_m_l_declaration.png differ diff --git a/docs/classtinyxml2_1_1_x_m_l_document-members.html b/docs/classtinyxml2_1_1_x_m_l_document-members.html index ded1a4fe..258c6eb5 100644 --- a/docs/classtinyxml2_1_1_x_m_l_document-members.html +++ b/docs/classtinyxml2_1_1_x_m_l_document-members.html @@ -1,14 +1,16 @@ - + - - + +
TinyXML-2: Member List + + @@ -19,10 +21,9 @@- + +/* @license-end */ +-
- - TinyXML-2 - 9.0.0 ++ @@ -30,21 +31,22 @@+ TinyXML-2 10.0.0- +++++ ++Loading...+Searching...+No Matches+@@ -66,73 +75,72 @@--+tinyxml2::XMLDocument Member Listtinyxml2::XMLDocument Member ListThis is the complete list of members for tinyxml2::XMLDocument, including all inherited members.
-Generated on Sat Apr 2 2022 13:12:57 for TinyXML-2 by 1.9.1 +Generated on Sat Dec 30 2023 18:02:35 for TinyXML-2 by 1.10.0 diff --git a/docs/classtinyxml2_1_1_x_m_l_document.html b/docs/classtinyxml2_1_1_x_m_l_document.html index db5db28d..d60a6366 100644 --- a/docs/classtinyxml2_1_1_x_m_l_document.html +++ b/docs/classtinyxml2_1_1_x_m_l_document.html @@ -1,14 +1,16 @@ - + - - + +TinyXML-2: tinyxml2::XMLDocument Class Reference + + @@ -19,10 +21,9 @@- + +/* @license-end */ +-
- - TinyXML-2 - 9.0.0 ++ @@ -30,21 +31,22 @@+ TinyXML-2 10.0.0- +++++ ++Loading...+Searching...+No Matches+@@ -69,8 +78,7 @@ --+tinyxml2::XMLDocument Class Referencetinyxml2::XMLDocument Class Reference@@ -85,175 +93,175 @@-
+
- Public Member Functions
+ - XMLDocument (bool processEntities=true, Whitespace whitespaceMode=PRESERVE_WHITESPACE) + XMLDocument (bool processEntities=true, Whitespace whitespaceMode=PRESERVE_WHITESPACE) constructor - - -virtual XMLDocument * ToDocument () - Safely cast to a Document, or null. - + XMLError Parse (const char *xml, size_t nBytes=static_cast< size_t >(-1)) + +virtual XMLDocument * ToDocument () override + Safely cast to a Document, or null. + XMLError Parse (const char *xml, size_t nBytes=static_cast< size_t >(-1)) - + XMLError LoadFile (const char *filename) XMLError LoadFile (const char *filename) - + XMLError LoadFile (FILE *) XMLError LoadFile (FILE *) - + XMLError SaveFile (const char *filename, bool compact=false) XMLError SaveFile (const char *filename, bool compact=false) - + XMLError SaveFile (FILE *fp, bool compact=false) XMLError SaveFile (FILE *fp, bool compact=false) - + bool HasBOM () const bool HasBOM () const - + void SetBOM (bool useBOM) void SetBOM (bool useBOM) - - XMLElement * RootElement () - + void Print (XMLPrinter *streamer=0) const + XMLElement * RootElement () + void Print (XMLPrinter *streamer=0) const - - virtual bool Accept (XMLVisitor *visitor) const - - XMLElement * NewElement (const char *name) - - XMLComment * NewComment (const char *comment) - - XMLText * NewText (const char *text) - - XMLDeclaration * NewDeclaration (const char *text=0) - - XMLUnknown * NewUnknown (const char *text) - + void DeleteNode (XMLNode *node) + virtual bool Accept (XMLVisitor *visitor) const override + + XMLElement * NewElement (const char *name) + + XMLComment * NewComment (const char *comment) + + XMLText * NewText (const char *text) + + XMLDeclaration * NewDeclaration (const char *text=0) + + XMLUnknown * NewUnknown (const char *text) + void DeleteNode (XMLNode *node) - + -void ClearError () +void ClearError () Clears the error flags. - + -bool Error () const +bool Error () const Return true if there was an error parsing the document. - + -XMLError ErrorID () const +XMLError ErrorID () const Return the errorID. - - const char * ErrorStr () const - - -void PrintError () const + A (trivial) utility function that prints the ErrorStr() to stdout. + const char * ErrorStr () const + + +void PrintError () const A (trivial) utility function that prints the ErrorStr() to stdout. - + -int ErrorLineNum () const +int ErrorLineNum () const Return the line where the error occurred, or zero if unknown. - + -void Clear () +void Clear () Clear the document, resetting it to the initial state. - + void DeepCopy (XMLDocument *target) const void DeepCopy (XMLDocument *target) const - - virtual XMLNode * ShallowClone (XMLDocument *) const - - virtual bool ShallowEqual (const XMLNode *) const - - Public Member Functions inherited from tinyxml2::XMLNode - -const XMLDocument * GetDocument () const - Get the XMLDocument that owns this XMLNode. - - -XMLDocument * GetDocument () - Get the XMLDocument that owns this XMLNode. - - -virtual XMLElement * ToElement () - Safely cast to an Element, or null. - - -virtual XMLText * ToText () - Safely cast to Text, or null. - - -virtual XMLComment * ToComment () - Safely cast to a Comment, or null. - - -virtual XMLDeclaration * ToDeclaration () - Safely cast to a Declaration, or null. - - -virtual XMLUnknown * ToUnknown () - Safely cast to an Unknown, or null. - - const char * Value () const - + void SetValue (const char *val, bool staticMem=false) + virtual XMLNode * ShallowClone (XMLDocument *) const override + + virtual bool ShallowEqual (const XMLNode *) const override + + Public Member Functions inherited from tinyxml2::XMLNode + +const XMLDocument * GetDocument () const + Get the XMLDocument that owns this XMLNode. + + +XMLDocument * GetDocument () + Get the XMLDocument that owns this XMLNode. + + +virtual XMLElement * ToElement () + Safely cast to an Element, or null. + + +virtual XMLText * ToText () + Safely cast to Text, or null. + + +virtual XMLComment * ToComment () + Safely cast to a Comment, or null. + + +virtual XMLDeclaration * ToDeclaration () + Safely cast to a Declaration, or null. + + +virtual XMLUnknown * ToUnknown () + Safely cast to an Unknown, or null. + + const char * Value () const + void SetValue (const char *val, bool staticMem=false) - + -int GetLineNum () const +int GetLineNum () const Gets the line number the node is in, if the document was parsed from a file. - - -const XMLNode * Parent () const - Get the parent of this node on the DOM. - + -bool NoChildren () const + +const XMLNode * Parent () const + Get the parent of this node on the DOM. + +bool NoChildren () const Returns true if this node has no children. - - -const XMLNode * FirstChild () const - Get the first child node, or null if none exists. - - const XMLElement * FirstChildElement (const char *name=0) const - - -const XMLNode * LastChild () const - Get the last child node, or null if none exists. - - const XMLElement * LastChildElement (const char *name=0) const - - -const XMLNode * PreviousSibling () const - Get the previous (left) sibling node of this node. - - -const XMLElement * PreviousSiblingElement (const char *name=0) const - Get the previous (left) sibling element of this node, with an optionally supplied name. - - -const XMLNode * NextSibling () const - Get the next (right) sibling node of this node. - - -const XMLElement * NextSiblingElement (const char *name=0) const - Get the next (right) sibling element of this node, with an optionally supplied name. - - XMLNode * InsertEndChild (XMLNode *addThis) - - XMLNode * InsertFirstChild (XMLNode *addThis) - - XMLNode * InsertAfterChild (XMLNode *afterThis, XMLNode *addThis) - + void DeleteChildren () + +const XMLNode * FirstChild () const + Get the first child node, or null if none exists. + + const XMLElement * FirstChildElement (const char *name=0) const + + +const XMLNode * LastChild () const + Get the last child node, or null if none exists. + + const XMLElement * LastChildElement (const char *name=0) const + + +const XMLNode * PreviousSibling () const + Get the previous (left) sibling node of this node. + + +const XMLElement * PreviousSiblingElement (const char *name=0) const + Get the previous (left) sibling element of this node, with an optionally supplied name. + + +const XMLNode * NextSibling () const + Get the next (right) sibling node of this node. + + +const XMLElement * NextSiblingElement (const char *name=0) const + Get the next (right) sibling element of this node, with an optionally supplied name. + + XMLNode * InsertEndChild (XMLNode *addThis) + + XMLNode * InsertFirstChild (XMLNode *addThis) + + XMLNode * InsertAfterChild (XMLNode *afterThis, XMLNode *addThis) + void DeleteChildren () - + void DeleteChild (XMLNode *node) void DeleteChild (XMLNode *node) - - XMLNode * DeepClone (XMLDocument *target) const - + void SetUserData (void *userData) + XMLNode * DeepClone (XMLDocument *target) const + void SetUserData (void *userData) - - void * GetUserData () const + + void * GetUserData () const Detailed Description
A Document binds together all the functionality. It can be saved, loaded, and printed to the screen. All Nodes are connected and allocated to a Document. If the Document is deleted, all its Nodes are also deleted.
Member Function Documentation
- -◆ Accept()
+ +◆ Accept()
@@ -264,14 +272,13 @@virtual bool tinyxml2::XMLDocument::Accept
( -XMLVisitor * -visitor ) +XMLVisitor * visitor ) const -virtual +overridevirtual@@ -283,7 +290,7 @@http://c2.com/cgi/wiki?HierarchicalVisitorPattern
Which are both good references for "visiting".
-An example of using Accept():
XMLPrinter printer; +An example of using Accept():
XMLPrinter printer; tinyxmlDoc.Accept( &printer ); const char* xmlcstr = printer.CStr();@@ -291,8 +298,8 @@-
◆ DeepCopy()
+ +◆ DeepCopy()
- -@@ -300,19 +307,18 @@void tinyxml2::XMLDocument::DeepCopy
( -XMLDocument * -target ) +XMLDocument * target ) const -Copies this document to a target document. The target will be completely cleared before the copy. If you want to copy a sub-tree, see XMLNode::DeepClone().
+Copies this document to a target document. The target will be completely cleared before the copy. If you want to copy a sub-tree, see XMLNode::DeepClone().
NOTE: that the 'target' must be non-null.
◆ DeleteNode()
+ +◆ DeleteNode()
@@ -320,8 +326,7 @@void tinyxml2::XMLDocument::DeleteNode
( -XMLNode * -node ) +XMLNode * node ) @@ -330,16 +335,16 @@ -
◆ ErrorStr()
+ +◆ ErrorStr()
@@ -348,8 +353,8 @@
- const char* tinyxml2::XMLDocument::ErrorStr +const char * tinyxml2::XMLDocument::ErrorStr ( -) +) const -
◆ HasBOM()
+ +◆ HasBOM()
@@ -360,7 +365,7 @@bool tinyxml2::XMLDocument::HasBOM
( -) +) const @@ -374,8 +379,8 @@-
◆ LoadFile() [1/2]
+ +◆ LoadFile() [1/2]
@@ -383,8 +388,7 @@XMLError tinyxml2::XMLDocument::LoadFile
( -const char * -filename ) +const char * filename ) @@ -393,8 +397,8 @@ -
◆ LoadFile() [2/2]
+ +◆ LoadFile() [2/2]
@@ -402,8 +406,7 @@XMLError tinyxml2::XMLDocument::LoadFile
( -FILE * -) +FILE * ) @@ -414,17 +417,16 @@ -
◆ NewComment()
+ +◆ NewComment()
@@ -433,17 +435,16 @@
- XMLComment* tinyxml2::XMLDocument::NewComment +XMLComment * tinyxml2::XMLDocument::NewComment ( -const char * -comment ) +const char * comment ) -
◆ NewDeclaration()
+ +◆ NewDeclaration()
@@ -453,17 +454,16 @@
- XMLDeclaration* tinyxml2::XMLDocument::NewDeclaration +XMLDeclaration * tinyxml2::XMLDocument::NewDeclaration ( -const char * -text = 0
) +const char * text = 0 ) -
◆ NewElement()
+ +◆ NewElement()
@@ -472,17 +472,16 @@
- XMLElement* tinyxml2::XMLDocument::NewElement +XMLElement * tinyxml2::XMLDocument::NewElement ( -const char * -name ) +const char * name ) -
◆ NewText()
+ +◆ NewText()
@@ -491,17 +490,16 @@
- XMLText* tinyxml2::XMLDocument::NewText +XMLText * tinyxml2::XMLDocument::NewText ( -const char * -text ) +const char * text ) -
◆ NewUnknown()
+ +◆ NewUnknown()
@@ -510,8 +508,8 @@
- XMLUnknown* tinyxml2::XMLDocument::NewUnknown +XMLUnknown * tinyxml2::XMLDocument::NewUnknown ( -const char * -text ) +const char * text ) -
◆ Parse()
+ +◆ Parse()
@@ -519,19 +517,12 @@XMLError tinyxml2::XMLDocument::Parse
( -const char * -xml, +const char * xml, - - size_t -nBytes = -static_cast< size_t >(-1)
- - ) -+ size_t nBytes = static_cast< size_t >(-1) ) @@ -540,8 +531,8 @@-
◆ Print()
+ +◆ Print()
@@ -549,8 +540,7 @@void tinyxml2::XMLDocument::Print
( -XMLPrinter * -streamer = 0
) +XMLPrinter * streamer = 0 ) const @@ -563,8 +553,8 @@-
◆ RootElement()
+ +◆ RootElement()
- -@@ -573,9 +563,9 @@
@@ -585,12 +575,12 @@
- XMLElement* tinyxml2::XMLDocument::RootElement +XMLElement * tinyxml2::XMLDocument::RootElement ( -) +) -
Return the root element of DOM. Equivalent to FirstChildElement(). To get the first node, use FirstChild().
+Return the root element of DOM. Equivalent to FirstChildElement(). To get the first node, use FirstChild().
◆ SaveFile() [1/2]
+ +◆ SaveFile() [1/2]
@@ -598,19 +588,12 @@XMLError tinyxml2::XMLDocument::SaveFile
( -const char * -filename, +const char * filename, - - bool -compact = -false
- - ) -+ bool compact = false ) @@ -618,8 +601,8 @@-
◆ SaveFile() [2/2]
+ +◆ SaveFile() [2/2]
@@ -627,19 +610,12 @@XMLError tinyxml2::XMLDocument::SaveFile
( -FILE * -fp, +FILE * fp, - - bool -compact = -false
- - ) -+ bool compact = false ) @@ -648,8 +624,8 @@-
◆ SetBOM()
+ +◆ SetBOM()
@@ -660,8 +636,7 @@void tinyxml2::XMLDocument::SetBOM
( -bool -useBOM ) +bool useBOM ) @@ -675,8 +650,8 @@ -
◆ ShallowClone()
+ +◆ ShallowClone()
- -@@ -685,28 +660,27 @@
- virtual XMLNode* tinyxml2::XMLDocument::ShallowClone +virtual XMLNode * tinyxml2::XMLDocument::ShallowClone ( -XMLDocument * -document ) +XMLDocument * document ) const -inlinevirtual +inlineoverridevirtual-Make a copy of this node, but not its children. You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())
+Make a copy of this node, but not its children. You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())
Note: if called on a XMLDocument, this will return null.
-Implements tinyxml2::XMLNode.
+Implements tinyxml2::XMLNode.
◆ ShallowEqual()
+ +◆ ShallowEqual()
@@ -717,14 +691,13 @@virtual bool tinyxml2::XMLDocument::ShallowEqual
( -const XMLNode * -compare ) +const XMLNode * compare ) const -inlinevirtual +inlineoverridevirtual@@ -741,7 +714,7 @@-Generated on Sat Apr 2 2022 13:12:57 for TinyXML-2 by 1.9.1 +Generated on Sat Dec 30 2023 18:02:35 for TinyXML-2 by 1.10.0 diff --git a/docs/classtinyxml2_1_1_x_m_l_document.png b/docs/classtinyxml2_1_1_x_m_l_document.png index 4fcf9f46..51c28390 100644 Binary files a/docs/classtinyxml2_1_1_x_m_l_document.png and b/docs/classtinyxml2_1_1_x_m_l_document.png differ diff --git a/docs/classtinyxml2_1_1_x_m_l_element-members.html b/docs/classtinyxml2_1_1_x_m_l_element-members.html index 431f15ed..a23343da 100644 --- a/docs/classtinyxml2_1_1_x_m_l_element-members.html +++ b/docs/classtinyxml2_1_1_x_m_l_element-members.html @@ -1,14 +1,16 @@ - + - - + +
TinyXML-2: Member List + + @@ -19,10 +21,9 @@- + +/* @license-end */ +-
- - TinyXML-2 - 9.0.0 ++ @@ -30,21 +31,22 @@+ TinyXML-2 10.0.0- +++++ ++Loading...+Searching...+No Matches+@@ -66,106 +75,105 @@--+tinyxml2::XMLElement Member Listtinyxml2::XMLElement Member ListThis is the complete list of members for tinyxml2::XMLElement, including all inherited members.
-Generated on Sat Apr 2 2022 13:12:57 for TinyXML-2 by 1.9.1 +Generated on Sat Dec 30 2023 18:02:35 for TinyXML-2 by 1.10.0 diff --git a/docs/classtinyxml2_1_1_x_m_l_element.html b/docs/classtinyxml2_1_1_x_m_l_element.html index ee02c91f..80faa881 100644 --- a/docs/classtinyxml2_1_1_x_m_l_element.html +++ b/docs/classtinyxml2_1_1_x_m_l_element.html @@ -1,14 +1,16 @@ - + - - + +TinyXML-2: tinyxml2::XMLElement Class Reference + + @@ -19,10 +21,9 @@- + +/* @license-end */ +-
- - TinyXML-2 - 9.0.0 ++ @@ -30,21 +31,22 @@+ TinyXML-2 10.0.0- +++++ ++Loading...+Searching...+No Matches+@@ -69,8 +78,7 @@ --+tinyxml2::XMLElement Class Referencetinyxml2::XMLElement Class Reference@@ -85,323 +93,323 @@-
+
- Public Member Functions
- -const char * Name () const - Get the name of an element (which is the Value() of the node.) - + -void SetName (const char *str, bool staticMem=false) + +const char * Name () const + Get the name of an element (which is the Value() of the node.) + +void SetName (const char *str, bool staticMem=false) Set the name of the element. - - -virtual XMLElement * ToElement () - Safely cast to an Element, or null. - - virtual bool Accept (XMLVisitor *visitor) const - - const char * Attribute (const char *name, const char *value=0) const - + int IntAttribute (const char *name, int defaultValue=0) const + +virtual XMLElement * ToElement () override + Safely cast to an Element, or null. + + virtual bool Accept (XMLVisitor *visitor) const override + + const char * Attribute (const char *name, const char *value=0) const + int IntAttribute (const char *name, int defaultValue=0) const - - -unsigned UnsignedAttribute (const char *name, unsigned defaultValue=0) const + See IntAttribute() + +unsigned UnsignedAttribute (const char *name, unsigned defaultValue=0) const See IntAttribute() - - -int64_t Int64Attribute (const char *name, int64_t defaultValue=0) const + See IntAttribute() + +int64_t Int64Attribute (const char *name, int64_t defaultValue=0) const See IntAttribute() - - -uint64_t Unsigned64Attribute (const char *name, uint64_t defaultValue=0) const + See IntAttribute() + +uint64_t Unsigned64Attribute (const char *name, uint64_t defaultValue=0) const See IntAttribute() - - -bool BoolAttribute (const char *name, bool defaultValue=false) const + See IntAttribute() + +bool BoolAttribute (const char *name, bool defaultValue=false) const See IntAttribute() - - -double DoubleAttribute (const char *name, double defaultValue=0) const + See IntAttribute() + +double DoubleAttribute (const char *name, double defaultValue=0) const See IntAttribute() - - -float FloatAttribute (const char *name, float defaultValue=0) const + See IntAttribute() + +float FloatAttribute (const char *name, float defaultValue=0) const See IntAttribute() - + XMLError QueryIntAttribute (const char *name, int *value) const XMLError QueryIntAttribute (const char *name, int *value) const - - -XMLError QueryUnsignedAttribute (const char *name, unsigned int *value) const + See QueryIntAttribute() + +XMLError QueryUnsignedAttribute (const char *name, unsigned int *value) const See QueryIntAttribute() - - -XMLError QueryInt64Attribute (const char *name, int64_t *value) const + See QueryIntAttribute() + +XMLError QueryInt64Attribute (const char *name, int64_t *value) const See QueryIntAttribute() - - -XMLError QueryUnsigned64Attribute (const char *name, uint64_t *value) const + See QueryIntAttribute() + +XMLError QueryUnsigned64Attribute (const char *name, uint64_t *value) const See QueryIntAttribute() - - -XMLError QueryBoolAttribute (const char *name, bool *value) const + See QueryIntAttribute() + +XMLError QueryBoolAttribute (const char *name, bool *value) const See QueryIntAttribute() - - -XMLError QueryDoubleAttribute (const char *name, double *value) const + See QueryIntAttribute() + +XMLError QueryDoubleAttribute (const char *name, double *value) const See QueryIntAttribute() - - -XMLError QueryFloatAttribute (const char *name, float *value) const + See QueryIntAttribute() + +XMLError QueryFloatAttribute (const char *name, float *value) const See QueryIntAttribute() - - -XMLError QueryStringAttribute (const char *name, const char **value) const + See QueryIntAttribute() + +XMLError QueryStringAttribute (const char *name, const char **value) const See QueryIntAttribute() - + XMLError QueryAttribute (const char *name, int *value) const XMLError QueryAttribute (const char *name, int *value) const - + -void SetAttribute (const char *name, const char *value) +void SetAttribute (const char *name, const char *value) Sets the named attribute to value. - + -void SetAttribute (const char *name, int value) +void SetAttribute (const char *name, int value) Sets the named attribute to value. - + -void SetAttribute (const char *name, unsigned value) +void SetAttribute (const char *name, unsigned value) Sets the named attribute to value. - + -void SetAttribute (const char *name, int64_t value) +void SetAttribute (const char *name, int64_t value) Sets the named attribute to value. - + -void SetAttribute (const char *name, uint64_t value) +void SetAttribute (const char *name, uint64_t value) Sets the named attribute to value. - + -void SetAttribute (const char *name, bool value) +void SetAttribute (const char *name, bool value) Sets the named attribute to value. - + -void SetAttribute (const char *name, double value) +void SetAttribute (const char *name, double value) Sets the named attribute to value. - + -void SetAttribute (const char *name, float value) +void SetAttribute (const char *name, float value) Sets the named attribute to value. - + void DeleteAttribute (const char *name) void DeleteAttribute (const char *name) - - -const XMLAttribute * FirstAttribute () const - Return the first attribute in the list. - - -const XMLAttribute * FindAttribute (const char *name) const - Query a specific attribute in the list. - - const char * GetText () const - + void SetText (const char *inText) + +const XMLAttribute * FirstAttribute () const + Return the first attribute in the list. + + +const XMLAttribute * FindAttribute (const char *name) const + Query a specific attribute in the list. + + const char * GetText () const + void SetText (const char *inText) - - -void SetText (int value) + Convenience method for setting text inside an element. See SetText() for important limitations. + +void SetText (int value) Convenience method for setting text inside an element. See SetText() for important limitations. - - -void SetText (unsigned value) + Convenience method for setting text inside an element. See SetText() for important limitations. + +void SetText (unsigned value) Convenience method for setting text inside an element. See SetText() for important limitations. - - -void SetText (int64_t value) + Convenience method for setting text inside an element. See SetText() for important limitations. + +void SetText (int64_t value) Convenience method for setting text inside an element. See SetText() for important limitations. - - -void SetText (uint64_t value) + Convenience method for setting text inside an element. See SetText() for important limitations. + +void SetText (uint64_t value) Convenience method for setting text inside an element. See SetText() for important limitations. - - -void SetText (bool value) + Convenience method for setting text inside an element. See SetText() for important limitations. + +void SetText (bool value) Convenience method for setting text inside an element. See SetText() for important limitations. - - -void SetText (double value) + Convenience method for setting text inside an element. See SetText() for important limitations. + +void SetText (double value) Convenience method for setting text inside an element. See SetText() for important limitations. - - -void SetText (float value) + Convenience method for setting text inside an element. See SetText() for important limitations. + +void SetText (float value) Convenience method for setting text inside an element. See SetText() for important limitations. - + XMLError QueryIntText (int *ival) const XMLError QueryIntText (int *ival) const - - -XMLError QueryUnsignedText (unsigned *uval) const + See QueryIntText() + +XMLError QueryUnsignedText (unsigned *uval) const See QueryIntText() - - -XMLError QueryInt64Text (int64_t *uval) const + See QueryIntText() + +XMLError QueryInt64Text (int64_t *uval) const See QueryIntText() - - -XMLError QueryUnsigned64Text (uint64_t *uval) const + See QueryIntText() + +XMLError QueryUnsigned64Text (uint64_t *uval) const See QueryIntText() - - -XMLError QueryBoolText (bool *bval) const + See QueryIntText() + +XMLError QueryBoolText (bool *bval) const See QueryIntText() - - -XMLError QueryDoubleText (double *dval) const + See QueryIntText() + +XMLError QueryDoubleText (double *dval) const See QueryIntText() - - -XMLError QueryFloatText (float *fval) const + See QueryIntText() + +XMLError QueryFloatText (float *fval) const See QueryIntText() - - -unsigned UnsignedText (unsigned defaultValue=0) const + See QueryIntText() + +unsigned UnsignedText (unsigned defaultValue=0) const See QueryIntText() - - -int64_t Int64Text (int64_t defaultValue=0) const + See QueryIntText() + +int64_t Int64Text (int64_t defaultValue=0) const See QueryIntText() - - -uint64_t Unsigned64Text (uint64_t defaultValue=0) const + See QueryIntText() + +uint64_t Unsigned64Text (uint64_t defaultValue=0) const See QueryIntText() - - -bool BoolText (bool defaultValue=false) const + See QueryIntText() + +bool BoolText (bool defaultValue=false) const See QueryIntText() - - -double DoubleText (double defaultValue=0) const + See QueryIntText() + +double DoubleText (double defaultValue=0) const See QueryIntText() - - -float FloatText (float defaultValue=0) const + See QueryIntText() + +float FloatText (float defaultValue=0) const See QueryIntText() - - XMLElement * InsertNewChildElement (const char *name) - - -XMLComment * InsertNewComment (const char *comment) - See InsertNewChildElement() - - -XMLText * InsertNewText (const char *text) - See InsertNewChildElement() - - -XMLDeclaration * InsertNewDeclaration (const char *text) - See InsertNewChildElement() - - -XMLUnknown * InsertNewUnknown (const char *text) - See InsertNewChildElement() - - virtual XMLNode * ShallowClone (XMLDocument *document) const - - virtual bool ShallowEqual (const XMLNode *compare) const - - Public Member Functions inherited from tinyxml2::XMLNode - -const XMLDocument * GetDocument () const - Get the XMLDocument that owns this XMLNode. - - -XMLDocument * GetDocument () - Get the XMLDocument that owns this XMLNode. - - -virtual XMLText * ToText () - Safely cast to Text, or null. - - -virtual XMLComment * ToComment () - Safely cast to a Comment, or null. - - -virtual XMLDocument * ToDocument () - Safely cast to a Document, or null. - - -virtual XMLDeclaration * ToDeclaration () - Safely cast to a Declaration, or null. - - -virtual XMLUnknown * ToUnknown () - Safely cast to an Unknown, or null. - - const char * Value () const - + void SetValue (const char *val, bool staticMem=false) + XMLElement * InsertNewChildElement (const char *name) + + +XMLComment * InsertNewComment (const char *comment) + See InsertNewChildElement() + + +XMLText * InsertNewText (const char *text) + See InsertNewChildElement() + + +XMLDeclaration * InsertNewDeclaration (const char *text) + See InsertNewChildElement() + + +XMLUnknown * InsertNewUnknown (const char *text) + See InsertNewChildElement() + + virtual XMLNode * ShallowClone (XMLDocument *document) const override + + virtual bool ShallowEqual (const XMLNode *compare) const override + + Public Member Functions inherited from tinyxml2::XMLNode + +const XMLDocument * GetDocument () const + Get the XMLDocument that owns this XMLNode. + + +XMLDocument * GetDocument () + Get the XMLDocument that owns this XMLNode. + + +virtual XMLText * ToText () + Safely cast to Text, or null. + + +virtual XMLComment * ToComment () + Safely cast to a Comment, or null. + + +virtual XMLDocument * ToDocument () + Safely cast to a Document, or null. + + +virtual XMLDeclaration * ToDeclaration () + Safely cast to a Declaration, or null. + + +virtual XMLUnknown * ToUnknown () + Safely cast to an Unknown, or null. + + const char * Value () const + void SetValue (const char *val, bool staticMem=false) - + -int GetLineNum () const +int GetLineNum () const Gets the line number the node is in, if the document was parsed from a file. - - -const XMLNode * Parent () const - Get the parent of this node on the DOM. - + -bool NoChildren () const + +const XMLNode * Parent () const + Get the parent of this node on the DOM. + +bool NoChildren () const Returns true if this node has no children. - - -const XMLNode * FirstChild () const - Get the first child node, or null if none exists. - - const XMLElement * FirstChildElement (const char *name=0) const - - -const XMLNode * LastChild () const - Get the last child node, or null if none exists. - - const XMLElement * LastChildElement (const char *name=0) const - - -const XMLNode * PreviousSibling () const - Get the previous (left) sibling node of this node. - - -const XMLElement * PreviousSiblingElement (const char *name=0) const - Get the previous (left) sibling element of this node, with an optionally supplied name. - - -const XMLNode * NextSibling () const - Get the next (right) sibling node of this node. - - -const XMLElement * NextSiblingElement (const char *name=0) const - Get the next (right) sibling element of this node, with an optionally supplied name. - - XMLNode * InsertEndChild (XMLNode *addThis) - - XMLNode * InsertFirstChild (XMLNode *addThis) - - XMLNode * InsertAfterChild (XMLNode *afterThis, XMLNode *addThis) - + void DeleteChildren () + +const XMLNode * FirstChild () const + Get the first child node, or null if none exists. + + const XMLElement * FirstChildElement (const char *name=0) const + + +const XMLNode * LastChild () const + Get the last child node, or null if none exists. + + const XMLElement * LastChildElement (const char *name=0) const + + +const XMLNode * PreviousSibling () const + Get the previous (left) sibling node of this node. + + +const XMLElement * PreviousSiblingElement (const char *name=0) const + Get the previous (left) sibling element of this node, with an optionally supplied name. + + +const XMLNode * NextSibling () const + Get the next (right) sibling node of this node. + + +const XMLElement * NextSiblingElement (const char *name=0) const + Get the next (right) sibling element of this node, with an optionally supplied name. + + XMLNode * InsertEndChild (XMLNode *addThis) + + XMLNode * InsertFirstChild (XMLNode *addThis) + + XMLNode * InsertAfterChild (XMLNode *afterThis, XMLNode *addThis) + void DeleteChildren () - + void DeleteChild (XMLNode *node) void DeleteChild (XMLNode *node) - - XMLNode * DeepClone (XMLDocument *target) const - + void SetUserData (void *userData) + XMLNode * DeepClone (XMLDocument *target) const + void SetUserData (void *userData) - - void * GetUserData () const + + void * GetUserData () const Detailed Description
The element is a container class. It has a value, the element name, and can contain other elements, text, comments, and unknowns. Elements also contain an arbitrary number of attributes.
Member Function Documentation
- -◆ Accept()
+ +◆ Accept()
@@ -412,14 +420,13 @@virtual bool tinyxml2::XMLElement::Accept
( -XMLVisitor * -visitor ) +XMLVisitor * visitor ) const -virtual +overridevirtual@@ -431,7 +438,7 @@http://c2.com/cgi/wiki?HierarchicalVisitorPattern
Which are both good references for "visiting".
-An example of using Accept():
XMLPrinter printer; +An example of using Accept():
XMLPrinter printer; tinyxmlDoc.Accept( &printer ); const char* xmlcstr = printer.CStr();@@ -439,32 +446,25 @@-
◆ Attribute()
+ +◆ Attribute()
- const char* tinyxml2::XMLElement::Attribute +const char * tinyxml2::XMLElement::Attribute ( -const char * -name, +const char * name, - - const char * -value = -0
- - ) -const +const char * value = 0 ) const -Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists. For example:
+Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists. For example:
const char* value = ele->Attribute( "foo" );The 'value' parameter is normally null. However, if specified, the attribute will only be returned if the 'name' and 'value' match. This allow you to write code:
if ( ele->Attribute( "foo", "bar" ) ) callFooIsBar(); @@ -474,8 +474,8 @@-
◆ DeleteAttribute()
+ +◆ DeleteAttribute()
@@ -483,8 +483,7 @@void tinyxml2::XMLElement::DeleteAttribute
( -const char * -name ) +const char * name ) @@ -493,42 +492,41 @@ -
◆ GetText()
+ +◆ GetText()
- -
- const char* tinyxml2::XMLElement::GetText +const char * tinyxml2::XMLElement::GetText ( -) +) const -Convenience function for easy access to the text inside an element. Although easy and concise, GetText() is limited compared to getting the XMLText child and accessing it directly.
-If the first child of 'this' is a XMLText, the GetText() returns the character string of the Text node, else null is returned.
+Convenience function for easy access to the text inside an element. Although easy and concise, GetText() is limited compared to getting the XMLText child and accessing it directly.
+If the first child of 'this' is a XMLText, the GetText() returns the character string of the Text node, else null is returned.
This is a convenient method for getting the text of simple contained text:
<foo>This is text</foo> const char* str = fooElement->GetText();'str' will be a pointer to "This is text".
Note that this function can be misleading. If the element foo was created from this XML:
<foo><b>This is text</b></foo>then the value of str would be null. The first child node isn't a text node, it is another element. From this XML:
<foo>This is <b>text</b></foo> -GetText() will return "This is ".
+GetText() will return "This is ".
◆ InsertNewChildElement()
+ +◆ InsertNewChildElement()
@@ -537,8 +535,8 @@
- XMLElement* tinyxml2::XMLElement::InsertNewChildElement +XMLElement * tinyxml2::XMLElement::InsertNewChildElement ( -const char * -name ) +const char * name ) -
◆ IntAttribute()
+ +◆ IntAttribute()
- -@@ -546,28 +544,21 @@int tinyxml2::XMLElement::IntAttribute
( -const char * -name, +const char * name, - - int -defaultValue = -0
- - ) -const +int defaultValue = 0 ) const -Given an attribute name, IntAttribute() returns the value of the attribute interpreted as an integer. The default value will be returned if the attribute isn't present, or if there is an error. (For a method with error checking, see QueryIntAttribute()).
+Given an attribute name, IntAttribute() returns the value of the attribute interpreted as an integer. The default value will be returned if the attribute isn't present, or if there is an error. (For a method with error checking, see QueryIntAttribute()).
◆ QueryAttribute()
+ +◆ QueryAttribute()
- -@@ -578,19 +569,12 @@XMLError tinyxml2::XMLElement::QueryAttribute
( -const char * -name, +const char * name, - - int * -value -- @@ -599,15 +583,15 @@- ) -const +int * value ) const -
Given an attribute name, QueryAttribute() returns XML_SUCCESS, XML_WRONG_ATTRIBUTE_TYPE if the conversion can't be performed, or XML_NO_ATTRIBUTE if the attribute doesn't exist. It is overloaded for the primitive types, and is a generally more convenient replacement of QueryIntAttribute() and related functions.
+Given an attribute name, QueryAttribute() returns XML_SUCCESS, XML_WRONG_ATTRIBUTE_TYPE if the conversion can't be performed, or XML_NO_ATTRIBUTE if the attribute doesn't exist. It is overloaded for the primitive types, and is a generally more convenient replacement of QueryIntAttribute() and related functions.
If successful, the result of the conversion will be written to 'value'. If not successful, nothing will be written to 'value'. This allows you to provide default value:
int value = 10; QueryAttribute( "foo", &value ); // if "foo" isn't found, value will still be 10◆ QueryIntAttribute()
+ +◆ QueryIntAttribute()
- -@@ -618,19 +602,12 @@XMLError tinyxml2::XMLElement::QueryIntAttribute
( -const char * -name, +const char * name, - - int * -value -- @@ -639,14 +616,14 @@- ) -const +int * value ) const -
Given an attribute name, QueryIntAttribute() returns XML_SUCCESS, XML_WRONG_ATTRIBUTE_TYPE if the conversion can't be performed, or XML_NO_ATTRIBUTE if the attribute doesn't exist. If successful, the result of the conversion will be written to 'value'. If not successful, nothing will be written to 'value'. This allows you to provide default value:
+Given an attribute name, QueryIntAttribute() returns XML_SUCCESS, XML_WRONG_ATTRIBUTE_TYPE if the conversion can't be performed, or XML_NO_ATTRIBUTE if the attribute doesn't exist. If successful, the result of the conversion will be written to 'value'. If not successful, nothing will be written to 'value'. This allows you to provide default value:
int value = 10; QueryIntAttribute( "foo", &value ); // if "foo" isn't found, value will still be 10◆ QueryIntText()
+ +◆ QueryIntText()
@@ -654,8 +631,7 @@XMLError tinyxml2::XMLElement::QueryIntText
( -int * -ival ) +int * ival ) const @@ -664,7 +640,7 @@QueryIntText() and similar functions provide a safe and easier way to get to the "value" of x and y. +
The QueryIntText() and similar functions provide a safe and easier way to get to the "value" of x and y.
int x = 0; float y = 0; // types of x and y are contrived for example const XMLElement* xElement = pointElement->FirstChildElement( "x" ); @@ -675,8 +651,8 @@-
◆ SetText()
+ +◆ SetText()
- -@@ -684,26 +660,25 @@void tinyxml2::XMLElement::SetText
( -const char * -inText ) +const char * inText ) -Convenience function for easy access to the text inside an element. Although easy and concise, SetText() is limited compared to creating an XMLText child and mutating it directly.
-If the first child of 'this' is a XMLText, SetText() sets its value to the given string, otherwise it will create a first child that is an XMLText.
+Convenience function for easy access to the text inside an element. Although easy and concise, SetText() is limited compared to creating an XMLText child and mutating it directly.
+If the first child of 'this' is a XMLText, SetText() sets its value to the given string, otherwise it will create a first child that is an XMLText.
This is a convenient method for setting the text of simple contained text:
<foo>This is text</foo> fooElement->SetText( "Hullaballoo!" ); <foo>Hullaballoo!</foo>Note that this function can be misleading. If the element foo was created from this XML:
<foo><b>This is text</b></foo>then it will not change "This is text", but rather prefix it with a text element:
<foo>Hullaballoo!<b>This is text</b></foo>For this XML:
<foo /> -SetText() will generate
<foo>Hullaballoo!</foo> +SetText() will generate
<foo>Hullaballoo!</foo>◆ ShallowClone()
+ +◆ ShallowClone()
- -@@ -712,28 +687,27 @@
- virtual XMLNode* tinyxml2::XMLElement::ShallowClone +virtual XMLNode * tinyxml2::XMLElement::ShallowClone ( -XMLDocument * -document ) +XMLDocument * document ) const -virtual +overridevirtual-Make a copy of this node, but not its children. You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())
+Make a copy of this node, but not its children. You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())
Note: if called on a XMLDocument, this will return null.
-Implements tinyxml2::XMLNode.
+Implements tinyxml2::XMLNode.
◆ ShallowEqual()
+ +◆ ShallowEqual()
@@ -744,14 +718,13 @@virtual bool tinyxml2::XMLElement::ShallowEqual
( -const XMLNode * -compare ) +const XMLNode * compare ) const -virtual +overridevirtual@@ -768,7 +741,7 @@-Generated on Sat Apr 2 2022 13:12:57 for TinyXML-2 by 1.9.1 +Generated on Sat Dec 30 2023 18:02:35 for TinyXML-2 by 1.10.0 diff --git a/docs/classtinyxml2_1_1_x_m_l_element.png b/docs/classtinyxml2_1_1_x_m_l_element.png index b76dc5b5..1feb99aa 100644 Binary files a/docs/classtinyxml2_1_1_x_m_l_element.png and b/docs/classtinyxml2_1_1_x_m_l_element.png differ diff --git a/docs/classtinyxml2_1_1_x_m_l_handle-members.html b/docs/classtinyxml2_1_1_x_m_l_handle-members.html index fb40c904..761930c7 100644 --- a/docs/classtinyxml2_1_1_x_m_l_handle-members.html +++ b/docs/classtinyxml2_1_1_x_m_l_handle-members.html @@ -1,14 +1,16 @@ - + - - + +
TinyXML-2: Member List + + @@ -19,10 +21,9 @@- + +/* @license-end */ +-
- - TinyXML-2 - 9.0.0 ++ @@ -30,21 +31,22 @@+ TinyXML-2 10.0.0- +++++ ++Loading...+Searching...+No Matches+@@ -66,34 +75,33 @@--+tinyxml2::XMLHandle Member Listtinyxml2::XMLHandle Member ListThis is the complete list of members for tinyxml2::XMLHandle, including all inherited members.
-Generated on Sat Apr 2 2022 13:12:57 for TinyXML-2 by 1.9.1 +Generated on Sat Dec 30 2023 18:02:35 for TinyXML-2 by 1.10.0 diff --git a/docs/classtinyxml2_1_1_x_m_l_handle.html b/docs/classtinyxml2_1_1_x_m_l_handle.html index f50ab042..a5f576cb 100644 --- a/docs/classtinyxml2_1_1_x_m_l_handle.html +++ b/docs/classtinyxml2_1_1_x_m_l_handle.html @@ -1,14 +1,16 @@ - + - - + +TinyXML-2: tinyxml2::XMLHandle Class Reference + + @@ -19,10 +21,9 @@- + +/* @license-end */ +-
- - TinyXML-2 - 9.0.0 ++ @@ -30,21 +31,22 @@+ TinyXML-2 10.0.0- +++++ ++Loading...+Searching...+No Matches+@@ -69,83 +78,82 @@ --+tinyxml2::XMLHandle Class Referencetinyxml2::XMLHandle Class Reference
#include <tinyxml2.h>
-
+
- Public Member Functions
+ - XMLHandle (XMLNode *node) + XMLHandle (XMLNode *node) Create a handle from any node (at any depth of the tree.) This can be a null pointer. - + - XMLHandle (XMLNode &node) + XMLHandle (XMLNode &node) Create a handle from a node. - + - XMLHandle (const XMLHandle &ref) + XMLHandle (const XMLHandle &ref) Copy constructor. - - -XMLHandle & operator= (const XMLHandle &ref) - Assignment. - + -XMLHandle FirstChild () + +XMLHandle & operator= (const XMLHandle &ref) + Assignment. + +XMLHandle FirstChild () Get the first child of this handle. - + -XMLHandle FirstChildElement (const char *name=0) +XMLHandle FirstChildElement (const char *name=0) Get the first child element of this handle. - + -XMLHandle LastChild () +XMLHandle LastChild () Get the last child of this handle. - + -XMLHandle LastChildElement (const char *name=0) +XMLHandle LastChildElement (const char *name=0) Get the last child element of this handle. - + -XMLHandle PreviousSibling () +XMLHandle PreviousSibling () Get the previous sibling of this handle. - + -XMLHandle PreviousSiblingElement (const char *name=0) +XMLHandle PreviousSiblingElement (const char *name=0) Get the previous sibling element of this handle. - + -XMLHandle NextSibling () +XMLHandle NextSibling () Get the next sibling of this handle. - + -XMLHandle NextSiblingElement (const char *name=0) +XMLHandle NextSiblingElement (const char *name=0) Get the next sibling element of this handle. - - -XMLNode * ToNode () - Safe cast to XMLNode. This can return null. - - -XMLElement * ToElement () - Safe cast to XMLElement. This can return null. - - -XMLText * ToText () - Safe cast to XMLText. This can return null. - - -XMLUnknown * ToUnknown () - Safe cast to XMLUnknown. This can return null. - - -XMLDeclaration * ToDeclaration () - Safe cast to XMLDeclaration. This can return null. + + +XMLNode * ToNode () + Safe cast to XMLNode. This can return null. + + +XMLElement * ToElement () + Safe cast to XMLElement. This can return null. + + +XMLText * ToText () + Safe cast to XMLText. This can return null. + + +XMLUnknown * ToUnknown () + Safe cast to XMLUnknown. This can return null. + + +XMLDeclaration * ToDeclaration () + Safe cast to XMLDeclaration. This can return null. Detailed Description
A XMLHandle is a class that wraps a node pointer with null checks; this is an incredibly useful thing. Note that XMLHandle is not part of the TinyXML-2 DOM structure. It is a separate utility class.
@@ -184,7 +192,7 @@
-Generated on Sat Apr 2 2022 13:12:57 for TinyXML-2 by 1.9.1 +Generated on Sat Dec 30 2023 18:02:35 for TinyXML-2 by 1.10.0 diff --git a/docs/classtinyxml2_1_1_x_m_l_node-members.html b/docs/classtinyxml2_1_1_x_m_l_node-members.html index 5dcdcf19..3315a5ae 100644 --- a/docs/classtinyxml2_1_1_x_m_l_node-members.html +++ b/docs/classtinyxml2_1_1_x_m_l_node-members.html @@ -1,14 +1,16 @@ - + - - + +TinyXML-2: Member List + + @@ -19,10 +21,9 @@- + +/* @license-end */ +-
- - TinyXML-2 - 9.0.0 ++ @@ -30,21 +31,22 @@+ TinyXML-2 10.0.0- +++++ ++Loading...+Searching...+No Matches+@@ -66,49 +75,48 @@--+tinyxml2::XMLNode Member Listtinyxml2::XMLNode Member ListThis is the complete list of members for tinyxml2::XMLNode, including all inherited members.
-Generated on Sat Apr 2 2022 13:12:57 for TinyXML-2 by 1.9.1 +Generated on Sat Dec 30 2023 18:02:35 for TinyXML-2 by 1.10.0 diff --git a/docs/classtinyxml2_1_1_x_m_l_node.html b/docs/classtinyxml2_1_1_x_m_l_node.html index 54ff824a..2e0881df 100644 --- a/docs/classtinyxml2_1_1_x_m_l_node.html +++ b/docs/classtinyxml2_1_1_x_m_l_node.html @@ -1,14 +1,16 @@ - + - - + +TinyXML-2: tinyxml2::XMLNode Class Reference + + @@ -19,10 +21,9 @@- + +/* @license-end */ +-
- - TinyXML-2 - 9.0.0 ++ @@ -30,21 +31,22 @@+ TinyXML-2 10.0.0- +++++ ++Loading...+Searching...+No Matches+@@ -69,8 +78,7 @@ --+tinyxml2::XMLNode Class Referenceabstracttinyxml2::XMLNode Class Referenceabstract@@ -90,106 +98,106 @@-
+
- Public Member Functions
- -const XMLDocument * GetDocument () const - Get the XMLDocument that owns this XMLNode. - - -XMLDocument * GetDocument () - Get the XMLDocument that owns this XMLNode. - - -virtual XMLElement * ToElement () - Safely cast to an Element, or null. - - -virtual XMLText * ToText () - Safely cast to Text, or null. - - -virtual XMLComment * ToComment () - Safely cast to a Comment, or null. - - -virtual XMLDocument * ToDocument () - Safely cast to a Document, or null. - - -virtual XMLDeclaration * ToDeclaration () - Safely cast to a Declaration, or null. - - -virtual XMLUnknown * ToUnknown () - Safely cast to an Unknown, or null. - - const char * Value () const - + void SetValue (const char *val, bool staticMem=false) + +const XMLDocument * GetDocument () const + Get the XMLDocument that owns this XMLNode. + + +XMLDocument * GetDocument () + Get the XMLDocument that owns this XMLNode. + + +virtual XMLElement * ToElement () + Safely cast to an Element, or null. + + +virtual XMLText * ToText () + Safely cast to Text, or null. + + +virtual XMLComment * ToComment () + Safely cast to a Comment, or null. + + +virtual XMLDocument * ToDocument () + Safely cast to a Document, or null. + + +virtual XMLDeclaration * ToDeclaration () + Safely cast to a Declaration, or null. + + +virtual XMLUnknown * ToUnknown () + Safely cast to an Unknown, or null. + + const char * Value () const + void SetValue (const char *val, bool staticMem=false) - + -int GetLineNum () const +int GetLineNum () const Gets the line number the node is in, if the document was parsed from a file. - - -const XMLNode * Parent () const - Get the parent of this node on the DOM. - + -bool NoChildren () const + +const XMLNode * Parent () const + Get the parent of this node on the DOM. + +bool NoChildren () const Returns true if this node has no children. - - -const XMLNode * FirstChild () const - Get the first child node, or null if none exists. - - const XMLElement * FirstChildElement (const char *name=0) const - - -const XMLNode * LastChild () const - Get the last child node, or null if none exists. - - const XMLElement * LastChildElement (const char *name=0) const - - -const XMLNode * PreviousSibling () const - Get the previous (left) sibling node of this node. - - -const XMLElement * PreviousSiblingElement (const char *name=0) const - Get the previous (left) sibling element of this node, with an optionally supplied name. - - -const XMLNode * NextSibling () const - Get the next (right) sibling node of this node. - - -const XMLElement * NextSiblingElement (const char *name=0) const - Get the next (right) sibling element of this node, with an optionally supplied name. - - XMLNode * InsertEndChild (XMLNode *addThis) - - XMLNode * InsertFirstChild (XMLNode *addThis) - - XMLNode * InsertAfterChild (XMLNode *afterThis, XMLNode *addThis) - + void DeleteChildren () + +const XMLNode * FirstChild () const + Get the first child node, or null if none exists. + + const XMLElement * FirstChildElement (const char *name=0) const + + +const XMLNode * LastChild () const + Get the last child node, or null if none exists. + + const XMLElement * LastChildElement (const char *name=0) const + + +const XMLNode * PreviousSibling () const + Get the previous (left) sibling node of this node. + + +const XMLElement * PreviousSiblingElement (const char *name=0) const + Get the previous (left) sibling element of this node, with an optionally supplied name. + + +const XMLNode * NextSibling () const + Get the next (right) sibling node of this node. + + +const XMLElement * NextSiblingElement (const char *name=0) const + Get the next (right) sibling element of this node, with an optionally supplied name. + + XMLNode * InsertEndChild (XMLNode *addThis) + + XMLNode * InsertFirstChild (XMLNode *addThis) + + XMLNode * InsertAfterChild (XMLNode *afterThis, XMLNode *addThis) + void DeleteChildren () - + void DeleteChild (XMLNode *node) void DeleteChild (XMLNode *node) - - virtual XMLNode * ShallowClone (XMLDocument *document) const =0 - - XMLNode * DeepClone (XMLDocument *target) const - + virtual bool ShallowEqual (const XMLNode *compare) const =0 + virtual XMLNode * ShallowClone (XMLDocument *document) const =0 + + XMLNode * DeepClone (XMLDocument *target) const + virtual bool ShallowEqual (const XMLNode *compare) const =0 - + virtual bool Accept (XMLVisitor *visitor) const =0 virtual bool Accept (XMLVisitor *visitor) const =0 - + void SetUserData (void *userData) void SetUserData (void *userData) - - void * GetUserData () const + + void * GetUserData () const Detailed Description
XMLNode is a base class for every object that is in the XML Document Object Model (DOM), except XMLAttributes. Nodes have siblings, a parent, and children which can be navigated. A node is always in a XMLDocument. The type of a XMLNode can be queried, and it can be cast to its more defined type.
@@ -204,8 +212,8 @@ Attributes (not on tree) Comment (leaf) Unknown (leaf)Member Function Documentation
- -◆ Accept()
+ +◆ Accept()
- -@@ -216,8 +224,7 @@virtual bool tinyxml2::XMLNode::Accept
( -XMLVisitor * -visitor ) +XMLVisitor * visitor ) const @@ -235,25 +242,24 @@http://c2.com/cgi/wiki?HierarchicalVisitorPattern
Which are both good references for "visiting".
-An example of using Accept():
XMLPrinter printer; +An example of using Accept():
XMLPrinter printer; tinyxmlDoc.Accept( &printer ); const char* xmlcstr = printer.CStr();-Implemented in tinyxml2::XMLDocument, tinyxml2::XMLElement, tinyxml2::XMLUnknown, tinyxml2::XMLDeclaration, tinyxml2::XMLComment, and tinyxml2::XMLText.
+Implemented in tinyxml2::XMLText, tinyxml2::XMLComment, tinyxml2::XMLDeclaration, tinyxml2::XMLUnknown, tinyxml2::XMLElement, and tinyxml2::XMLDocument.
◆ DeepClone()
+ +◆ DeepClone()
@@ -264,8 +270,8 @@
- XMLNode* tinyxml2::XMLNode::DeepClone +XMLNode * tinyxml2::XMLNode::DeepClone ( -XMLDocument * -target ) +XMLDocument * target ) const -
◆ DeleteChild()
+ +◆ DeleteChild()
@@ -273,8 +279,7 @@void tinyxml2::XMLNode::DeleteChild
( -XMLNode * -node ) +XMLNode * node ) @@ -283,8 +288,8 @@ -
◆ DeleteChildren()
+ +◆ DeleteChildren()
@@ -292,7 +297,7 @@void tinyxml2::XMLNode::DeleteChildren
( -) +) @@ -301,17 +306,16 @@ -
◆ FirstChildElement()
+ +◆ FirstChildElement()
@@ -320,8 +324,8 @@
- const XMLElement* tinyxml2::XMLNode::FirstChildElement +const XMLElement * tinyxml2::XMLNode::FirstChildElement ( -const char * -name = 0
) +const char * name = 0 ) const -
◆ GetUserData()
+ +◆ GetUserData()
@@ -330,9 +334,9 @@
@@ -346,28 +350,21 @@
- void* tinyxml2::XMLNode::GetUserData +void * tinyxml2::XMLNode::GetUserData ( -) +) const -
◆ InsertAfterChild()
+ +◆ InsertAfterChild()
- XMLNode* tinyxml2::XMLNode::InsertAfterChild +XMLNode * tinyxml2::XMLNode::InsertAfterChild ( -XMLNode * -afterThis, +XMLNode * afterThis, - - XMLNode * -addThis -- - ) -+ XMLNode * addThis ) @@ -375,17 +372,16 @@-
◆ InsertEndChild()
+ +◆ InsertEndChild()
@@ -394,17 +390,16 @@
- XMLNode* tinyxml2::XMLNode::InsertEndChild +XMLNode * tinyxml2::XMLNode::InsertEndChild ( -XMLNode * -addThis ) +XMLNode * addThis ) -
◆ InsertFirstChild()
+ +◆ InsertFirstChild()
@@ -413,17 +408,16 @@
- XMLNode* tinyxml2::XMLNode::InsertFirstChild +XMLNode * tinyxml2::XMLNode::InsertFirstChild ( -XMLNode * -addThis ) +XMLNode * addThis ) -
◆ LastChildElement()
+ +◆ LastChildElement()
@@ -432,8 +426,8 @@
- const XMLElement* tinyxml2::XMLNode::LastChildElement +const XMLElement * tinyxml2::XMLNode::LastChildElement ( -const char * -name = 0
) +const char * name = 0 ) const -
◆ SetUserData()
+ +◆ SetUserData()
@@ -444,8 +438,7 @@void tinyxml2::XMLNode::SetUserData
( -void * -userData ) +void * userData ) @@ -459,8 +452,8 @@ -
◆ SetValue()
+ +◆ SetValue()
- -@@ -468,28 +461,21 @@void tinyxml2::XMLNode::SetValue
( -const char * -val, +const char * val, - - bool -staticMem = -false
- - ) -+ bool staticMem = false ) ◆ ShallowClone()
+ +◆ ShallowClone()
- -@@ -498,10 +484,9 @@
@@ -511,15 +496,15 @@
- virtual XMLNode* tinyxml2::XMLNode::ShallowClone +virtual XMLNode * tinyxml2::XMLNode::ShallowClone ( -XMLDocument * -document ) +XMLDocument * document ) const -
Make a copy of this node, but not its children. You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())
+Make a copy of this node, but not its children. You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())
Note: if called on a XMLDocument, this will return null.
-Implemented in tinyxml2::XMLElement, tinyxml2::XMLUnknown, tinyxml2::XMLDeclaration, tinyxml2::XMLComment, tinyxml2::XMLText, and tinyxml2::XMLDocument.
+Implemented in tinyxml2::XMLDocument, tinyxml2::XMLText, tinyxml2::XMLComment, tinyxml2::XMLDeclaration, tinyxml2::XMLUnknown, and tinyxml2::XMLElement.
◆ ShallowEqual()
+ +◆ ShallowEqual()
- -@@ -530,8 +515,7 @@virtual bool tinyxml2::XMLNode::ShallowEqual
( -const XMLNode * -compare ) +const XMLNode * compare ) const @@ -544,20 +528,20 @@XMLDocument, this will return false. -
Implemented in tinyxml2::XMLElement, tinyxml2::XMLUnknown, tinyxml2::XMLDeclaration, tinyxml2::XMLComment, tinyxml2::XMLText, and tinyxml2::XMLDocument.
+Implemented in tinyxml2::XMLDocument, tinyxml2::XMLText, tinyxml2::XMLComment, tinyxml2::XMLDeclaration, tinyxml2::XMLUnknown, and tinyxml2::XMLElement.
◆ Value()
+ +◆ Value()
@@ -576,7 +560,7 @@
- const char* tinyxml2::XMLNode::Value +const char * tinyxml2::XMLNode::Value ( -) +) const -Generated on Sat Apr 2 2022 13:12:57 for TinyXML-2 by 1.9.1 +Generated on Sat Dec 30 2023 18:02:35 for TinyXML-2 by 1.10.0 diff --git a/docs/classtinyxml2_1_1_x_m_l_node.png b/docs/classtinyxml2_1_1_x_m_l_node.png index cb1e7ce1..d750dee8 100644 Binary files a/docs/classtinyxml2_1_1_x_m_l_node.png and b/docs/classtinyxml2_1_1_x_m_l_node.png differ diff --git a/docs/classtinyxml2_1_1_x_m_l_printer-members.html b/docs/classtinyxml2_1_1_x_m_l_printer-members.html index ff0ddc91..9f8a08c9 100644 --- a/docs/classtinyxml2_1_1_x_m_l_printer-members.html +++ b/docs/classtinyxml2_1_1_x_m_l_printer-members.html @@ -1,14 +1,16 @@ - + - - + +
TinyXML-2: Member List + + @@ -19,10 +21,9 @@- + +/* @license-end */ +-
- - TinyXML-2 - 9.0.0 ++ @@ -30,21 +31,22 @@+ TinyXML-2 10.0.0- +++++ ++Loading...+Searching...+No Matches+@@ -66,43 +75,42 @@--+tinyxml2::XMLPrinter Member Listtinyxml2::XMLPrinter Member ListThis is the complete list of members for tinyxml2::XMLPrinter, including all inherited members.
- ClearBuffer(bool resetToFirstElement=true) tinyxml2::XMLPrinter inline - CloseElement(bool compactMode=false) tinyxml2::XMLPrinter virtual - CStr() const tinyxml2::XMLPrinter inline + CStrSize() const tinyxml2::XMLPrinter inline + CloseElement(bool compactMode=false) tinyxml2::XMLPrinter virtual + CStr() const tinyxml2::XMLPrinter inline CStrSize() const tinyxml2::XMLPrinter inline - OpenElement(const char *name, bool compactMode=false) tinyxml2::XMLPrinter + PrintSpace(int depth) tinyxml2::XMLPrinter protectedvirtual PrintSpace(int depth) tinyxml2::XMLPrinter protectedvirtual - PushAttribute(const char *name, const char *value) tinyxml2::XMLPrinter + PushComment(const char *comment) tinyxml2::XMLPrinter PushComment(const char *comment) tinyxml2::XMLPrinter - PushHeader(bool writeBOM, bool writeDeclaration) tinyxml2::XMLPrinter + PushText(const char *text, bool cdata=false) tinyxml2::XMLPrinter PushText(const char *text, bool cdata=false) tinyxml2::XMLPrinter - PushText(int value) tinyxml2::XMLPrinter + PushText(unsigned value) tinyxml2::XMLPrinter PushText(unsigned value) tinyxml2::XMLPrinter - PushText(int64_t value) tinyxml2::XMLPrinter + PushText(uint64_t value) tinyxml2::XMLPrinter PushText(uint64_t value) tinyxml2::XMLPrinter - PushText(bool value) tinyxml2::XMLPrinter + PushText(float value) tinyxml2::XMLPrinter PushText(float value) tinyxml2::XMLPrinter - PushText(double value) tinyxml2::XMLPrinter - Visit(const XMLText &text) tinyxml2::XMLPrinter virtual - Visit(const XMLComment &comment) tinyxml2::XMLPrinter virtual - Visit(const XMLDeclaration &declaration) tinyxml2::XMLPrinter virtual - Visit(const XMLUnknown &unknown) tinyxml2::XMLPrinter virtual - VisitEnter(const XMLDocument &) tinyxml2::XMLPrinter virtual - VisitEnter(const XMLElement &element, const XMLAttribute *attribute) tinyxml2::XMLPrinter virtual - VisitExit(const XMLDocument &) tinyxml2::XMLPrinter inlinevirtual - VisitExit(const XMLElement &element) tinyxml2::XMLPrinter virtual + XMLPrinter(FILE *file=0, bool compact=false, int depth=0) tinyxml2::XMLPrinter + Visit(const XMLText &text) override tinyxml2::XMLPrinter virtual + Visit(const XMLComment &comment) override tinyxml2::XMLPrinter virtual + Visit(const XMLDeclaration &declaration) override tinyxml2::XMLPrinter virtual + Visit(const XMLUnknown &unknown) override tinyxml2::XMLPrinter virtual + VisitEnter(const XMLDocument &) override tinyxml2::XMLPrinter virtual + VisitEnter(const XMLElement &element, const XMLAttribute *attribute) override tinyxml2::XMLPrinter virtual + VisitExit(const XMLDocument &) override tinyxml2::XMLPrinter inlinevirtual + VisitExit(const XMLElement &element) override tinyxml2::XMLPrinter virtual XMLPrinter(FILE *file=0, bool compact=false, int depth=0) tinyxml2::XMLPrinter
-Generated on Sat Apr 2 2022 13:12:57 for TinyXML-2 by 1.9.1 +Generated on Sat Dec 30 2023 18:02:35 for TinyXML-2 by 1.10.0 diff --git a/docs/classtinyxml2_1_1_x_m_l_printer.html b/docs/classtinyxml2_1_1_x_m_l_printer.html index 3ddd7284..40b7c6c8 100644 --- a/docs/classtinyxml2_1_1_x_m_l_printer.html +++ b/docs/classtinyxml2_1_1_x_m_l_printer.html @@ -1,14 +1,16 @@ - + - - + +TinyXML-2: tinyxml2::XMLPrinter Class Reference + + @@ -19,10 +21,9 @@- + +/* @license-end */ +-
- - TinyXML-2 - 9.0.0 ++ @@ -30,21 +31,22 @@+ TinyXML-2 10.0.0- +-++++ ++Loading...+Searching...+No Matches+-+tinyxml2::XMLPrinter Class Referencetinyxml2::XMLPrinter Class Reference@@ -86,100 +94,100 @@-
+
- Public Member Functions
+ XMLPrinter (FILE *file=0, bool compact=false, int depth=0) XMLPrinter (FILE *file=0, bool compact=false, int depth=0) - + void PushHeader (bool writeBOM, bool writeDeclaration) void PushHeader (bool writeBOM, bool writeDeclaration) - + void OpenElement (const char *name, bool compactMode=false) void OpenElement (const char *name, bool compactMode=false) - + -void PushAttribute (const char *name, const char *value) +void PushAttribute (const char *name, const char *value) If streaming, add an attribute to an open element. - + -virtual void CloseElement (bool compactMode=false) +virtual void CloseElement (bool compactMode=false) If streaming, close the Element. - + -void PushText (const char *text, bool cdata=false) +void PushText (const char *text, bool cdata=false) Add a text node. - + -void PushText (int value) +void PushText (int value) Add a text node from an integer. - + -void PushText (unsigned value) +void PushText (unsigned value) Add a text node from an unsigned. - + -void PushText (int64_t value) +void PushText (int64_t value) Add a text node from a signed 64bit integer. - + -void PushText (uint64_t value) +void PushText (uint64_t value) Add a text node from an unsigned 64bit integer. - + -void PushText (bool value) +void PushText (bool value) Add a text node from a bool. - + -void PushText (float value) +void PushText (float value) Add a text node from a float. - + -void PushText (double value) +void PushText (double value) Add a text node from a double. - + -void PushComment (const char *comment) +void PushComment (const char *comment) Add a comment. - - -virtual bool VisitEnter (const XMLDocument &) - Visit a document. - - -virtual bool VisitExit (const XMLDocument &) - Visit a document. - - -virtual bool VisitEnter (const XMLElement &element, const XMLAttribute *attribute) - Visit an element. - - -virtual bool VisitExit (const XMLElement &element) - Visit an element. - - -virtual bool Visit (const XMLText &text) - Visit a text node. - - -virtual bool Visit (const XMLComment &comment) - Visit a comment node. - - -virtual bool Visit (const XMLDeclaration &declaration) - Visit a declaration. - - -virtual bool Visit (const XMLUnknown &unknown) - Visit an unknown node. - - const char * CStr () const - + int CStrSize () const + +virtual bool VisitEnter (const XMLDocument &) override + Visit a document. + + +virtual bool VisitExit (const XMLDocument &) override + Visit a document. + + +virtual bool VisitEnter (const XMLElement &element, const XMLAttribute *attribute) override + Visit an element. + + +virtual bool VisitExit (const XMLElement &element) override + Visit an element. + + +virtual bool Visit (const XMLText &text) override + Visit a text node. + + +virtual bool Visit (const XMLComment &comment) override + Visit a comment node. + + +virtual bool Visit (const XMLDeclaration &declaration) override + Visit a declaration. + + +virtual bool Visit (const XMLUnknown &unknown) override + Visit an unknown node. + + const char * CStr () const + int CStrSize () const - + void ClearBuffer (bool resetToFirstElement=true) void ClearBuffer (bool resetToFirstElement=true) -
+
- Protected Member Functions
+ virtual void PrintSpace (int depth) virtual void PrintSpace (int depth) Detailed Description
@@ -204,8 +212,8 @@ printer.PushAttribute( "foo", "bar" ); printer.CloseElement();Constructor & Destructor Documentation
- -◆ XMLPrinter()
+ +◆ XMLPrinter()
@@ -213,35 +221,27 @@tinyxml2::XMLPrinter::XMLPrinter
( -FILE * -file = +0
,FILE * file = 0, - bool -compact = +false
,bool compact = false, - - int -depth = -0
- - ) -+ int depth = 0 ) -Construct the printer. If the FILE* is specified, this will print to the FILE. Else it will print to memory, and the result is available in CStr(). If 'compact' is set to true, then output is created with only required whitespace and newlines.
+Construct the printer. If the FILE* is specified, this will print to the FILE. Else it will print to memory, and the result is available in CStr(). If 'compact' is set to true, then output is created with only required whitespace and newlines.
Member Function Documentation
- -◆ ClearBuffer()
+ +◆ ClearBuffer()
@@ -252,8 +252,7 @@void tinyxml2::XMLPrinter::ClearBuffer
( -bool -resetToFirstElement = true
) +bool resetToFirstElement = true ) @@ -267,8 +266,8 @@ -
◆ CStr()
+ +◆ CStr()
@@ -277,9 +276,9 @@
@@ -293,8 +292,8 @@
- const char* tinyxml2::XMLPrinter::CStr +const char * tinyxml2::XMLPrinter::CStr ( -) +) const -
◆ CStrSize()
+ +◆ CStrSize()
@@ -305,7 +304,7 @@int tinyxml2::XMLPrinter::CStrSize
( -) +) const @@ -319,8 +318,8 @@-
◆ OpenElement()
+ +◆ OpenElement()
- -@@ -328,28 +327,21 @@void tinyxml2::XMLPrinter::OpenElement
( -const char * -name, +const char * name, - - bool -compactMode = -false
- - ) -+ bool compactMode = false ) -If streaming, start writing an element. The element must be closed with CloseElement()
+If streaming, start writing an element. The element must be closed with CloseElement()
◆ PrintSpace()
+ +◆ PrintSpace()
- -@@ -360,8 +352,7 @@virtual void tinyxml2::XMLPrinter::PrintSpace
( -int -depth ) +int depth ) @@ -371,12 +362,12 @@ -
Prints out the space before an element. You may override to change the space and tabs used. A PrintSpace() override should call Print().
+Prints out the space before an element. You may override to change the space and tabs used. A PrintSpace() override should call Print().
◆ PushHeader()
+ +◆ PushHeader()
@@ -384,19 +375,12 @@void tinyxml2::XMLPrinter::PushHeader
( -bool -writeBOM, +bool writeBOM, - - bool -writeDeclaration -- - ) -+ bool writeDeclaration ) @@ -410,7 +394,7 @@-Generated on Sat Apr 2 2022 13:12:57 for TinyXML-2 by 1.9.1 +Generated on Sat Dec 30 2023 18:02:35 for TinyXML-2 by 1.10.0 diff --git a/docs/classtinyxml2_1_1_x_m_l_printer.png b/docs/classtinyxml2_1_1_x_m_l_printer.png index 9bc67485..4fcb981b 100644 Binary files a/docs/classtinyxml2_1_1_x_m_l_printer.png and b/docs/classtinyxml2_1_1_x_m_l_printer.png differ diff --git a/docs/classtinyxml2_1_1_x_m_l_text-members.html b/docs/classtinyxml2_1_1_x_m_l_text-members.html index 710094d3..366571ce 100644 --- a/docs/classtinyxml2_1_1_x_m_l_text-members.html +++ b/docs/classtinyxml2_1_1_x_m_l_text-members.html @@ -1,14 +1,16 @@ - + - - + +
TinyXML-2: Member List + + @@ -19,10 +21,9 @@- + +/* @license-end */ +-
- - TinyXML-2 - 9.0.0 ++ @@ -30,21 +31,22 @@+ TinyXML-2 10.0.0- +++++ ++Loading...+Searching...+No Matches+@@ -66,51 +75,50 @@--+tinyxml2::XMLText Member Listtinyxml2::XMLText Member ListThis is the complete list of members for tinyxml2::XMLText, including all inherited members.
-Generated on Sat Apr 2 2022 13:12:57 for TinyXML-2 by 1.9.1 +Generated on Sat Dec 30 2023 18:02:35 for TinyXML-2 by 1.10.0 diff --git a/docs/classtinyxml2_1_1_x_m_l_text.html b/docs/classtinyxml2_1_1_x_m_l_text.html index 7ea88d3c..56db24c0 100644 --- a/docs/classtinyxml2_1_1_x_m_l_text.html +++ b/docs/classtinyxml2_1_1_x_m_l_text.html @@ -1,14 +1,16 @@ - + - - + +TinyXML-2: tinyxml2::XMLText Class Reference + + @@ -19,10 +21,9 @@- + +/* @license-end */ +-
- - TinyXML-2 - 9.0.0 ++ @@ -30,21 +31,22 @@+ TinyXML-2 10.0.0- +++++ ++Loading...+Searching...+No Matches+@@ -69,8 +78,7 @@ --+tinyxml2::XMLText Class Referencetinyxml2::XMLText Class Reference@@ -85,123 +93,123 @@-
+
- Public Member Functions
- virtual bool Accept (XMLVisitor *visitor) const - - -virtual XMLText * ToText () - Safely cast to Text, or null. - + -void SetCData (bool isCData) + virtual bool Accept (XMLVisitor *visitor) const override + + +virtual XMLText * ToText () override + Safely cast to Text, or null. + +void SetCData (bool isCData) Declare whether this should be CDATA or standard text. - + -bool CData () const +bool CData () const Returns true if this is a CDATA text element. - - virtual XMLNode * ShallowClone (XMLDocument *document) const - - virtual bool ShallowEqual (const XMLNode *compare) const - - Public Member Functions inherited from tinyxml2::XMLNode - -const XMLDocument * GetDocument () const - Get the XMLDocument that owns this XMLNode. - - -XMLDocument * GetDocument () - Get the XMLDocument that owns this XMLNode. - - -virtual XMLElement * ToElement () - Safely cast to an Element, or null. - - -virtual XMLComment * ToComment () - Safely cast to a Comment, or null. - - -virtual XMLDocument * ToDocument () - Safely cast to a Document, or null. - - -virtual XMLDeclaration * ToDeclaration () - Safely cast to a Declaration, or null. - - -virtual XMLUnknown * ToUnknown () - Safely cast to an Unknown, or null. - - const char * Value () const - + void SetValue (const char *val, bool staticMem=false) + virtual XMLNode * ShallowClone (XMLDocument *document) const override + + virtual bool ShallowEqual (const XMLNode *compare) const override + + Public Member Functions inherited from tinyxml2::XMLNode + +const XMLDocument * GetDocument () const + Get the XMLDocument that owns this XMLNode. + + +XMLDocument * GetDocument () + Get the XMLDocument that owns this XMLNode. + + +virtual XMLElement * ToElement () + Safely cast to an Element, or null. + + +virtual XMLComment * ToComment () + Safely cast to a Comment, or null. + + +virtual XMLDocument * ToDocument () + Safely cast to a Document, or null. + + +virtual XMLDeclaration * ToDeclaration () + Safely cast to a Declaration, or null. + + +virtual XMLUnknown * ToUnknown () + Safely cast to an Unknown, or null. + + const char * Value () const + void SetValue (const char *val, bool staticMem=false) - + -int GetLineNum () const +int GetLineNum () const Gets the line number the node is in, if the document was parsed from a file. - - -const XMLNode * Parent () const - Get the parent of this node on the DOM. - + -bool NoChildren () const + +const XMLNode * Parent () const + Get the parent of this node on the DOM. + +bool NoChildren () const Returns true if this node has no children. - - -const XMLNode * FirstChild () const - Get the first child node, or null if none exists. - - const XMLElement * FirstChildElement (const char *name=0) const - - -const XMLNode * LastChild () const - Get the last child node, or null if none exists. - - const XMLElement * LastChildElement (const char *name=0) const - - -const XMLNode * PreviousSibling () const - Get the previous (left) sibling node of this node. - - -const XMLElement * PreviousSiblingElement (const char *name=0) const - Get the previous (left) sibling element of this node, with an optionally supplied name. - - -const XMLNode * NextSibling () const - Get the next (right) sibling node of this node. - - -const XMLElement * NextSiblingElement (const char *name=0) const - Get the next (right) sibling element of this node, with an optionally supplied name. - - XMLNode * InsertEndChild (XMLNode *addThis) - - XMLNode * InsertFirstChild (XMLNode *addThis) - - XMLNode * InsertAfterChild (XMLNode *afterThis, XMLNode *addThis) - + void DeleteChildren () + +const XMLNode * FirstChild () const + Get the first child node, or null if none exists. + + const XMLElement * FirstChildElement (const char *name=0) const + + +const XMLNode * LastChild () const + Get the last child node, or null if none exists. + + const XMLElement * LastChildElement (const char *name=0) const + + +const XMLNode * PreviousSibling () const + Get the previous (left) sibling node of this node. + + +const XMLElement * PreviousSiblingElement (const char *name=0) const + Get the previous (left) sibling element of this node, with an optionally supplied name. + + +const XMLNode * NextSibling () const + Get the next (right) sibling node of this node. + + +const XMLElement * NextSiblingElement (const char *name=0) const + Get the next (right) sibling element of this node, with an optionally supplied name. + + XMLNode * InsertEndChild (XMLNode *addThis) + + XMLNode * InsertFirstChild (XMLNode *addThis) + + XMLNode * InsertAfterChild (XMLNode *afterThis, XMLNode *addThis) + void DeleteChildren () - + void DeleteChild (XMLNode *node) void DeleteChild (XMLNode *node) - - XMLNode * DeepClone (XMLDocument *target) const - + void SetUserData (void *userData) + XMLNode * DeepClone (XMLDocument *target) const + void SetUserData (void *userData) - - void * GetUserData () const + + void * GetUserData () const Detailed Description
XML text.
Note that a text node can have child element nodes, for example:
<root>This is <b>bold</b></root> -A text node can have 2 ways to output the next. "normal" output and CDATA. It will default to the mode it was parsed from the XML file and you generally want to leave it alone, but you can change the output mode with SetCData() and query it with CData().
+A text node can have 2 ways to output the next. "normal" output and CDATA. It will default to the mode it was parsed from the XML file and you generally want to leave it alone, but you can change the output mode with SetCData() and query it with CData().
Member Function Documentation
- -◆ Accept()
+ +◆ Accept()
@@ -212,14 +220,13 @@virtual bool tinyxml2::XMLText::Accept
( -XMLVisitor * -visitor ) +XMLVisitor * visitor ) const -virtual +overridevirtual@@ -231,7 +238,7 @@http://c2.com/cgi/wiki?HierarchicalVisitorPattern
Which are both good references for "visiting".
-An example of using Accept():
XMLPrinter printer; +An example of using Accept():
XMLPrinter printer; tinyxmlDoc.Accept( &printer ); const char* xmlcstr = printer.CStr();@@ -239,8 +246,8 @@-
◆ ShallowClone()
+ +◆ ShallowClone()
- -@@ -249,28 +256,27 @@
- virtual XMLNode* tinyxml2::XMLText::ShallowClone +virtual XMLNode * tinyxml2::XMLText::ShallowClone ( -XMLDocument * -document ) +XMLDocument * document ) const -virtual +overridevirtual-Make a copy of this node, but not its children. You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())
+Make a copy of this node, but not its children. You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())
Note: if called on a XMLDocument, this will return null.
-Implements tinyxml2::XMLNode.
+Implements tinyxml2::XMLNode.
◆ ShallowEqual()
+ +◆ ShallowEqual()
@@ -281,14 +287,13 @@virtual bool tinyxml2::XMLText::ShallowEqual
( -const XMLNode * -compare ) +const XMLNode * compare ) const -virtual +overridevirtual@@ -305,7 +310,7 @@-Generated on Sat Apr 2 2022 13:12:57 for TinyXML-2 by 1.9.1 +Generated on Sat Dec 30 2023 18:02:35 for TinyXML-2 by 1.10.0 diff --git a/docs/classtinyxml2_1_1_x_m_l_text.png b/docs/classtinyxml2_1_1_x_m_l_text.png index 5a9863ac..ec37c93d 100644 Binary files a/docs/classtinyxml2_1_1_x_m_l_text.png and b/docs/classtinyxml2_1_1_x_m_l_text.png differ diff --git a/docs/classtinyxml2_1_1_x_m_l_unknown-members.html b/docs/classtinyxml2_1_1_x_m_l_unknown-members.html index a541dd6f..d2063be8 100644 --- a/docs/classtinyxml2_1_1_x_m_l_unknown-members.html +++ b/docs/classtinyxml2_1_1_x_m_l_unknown-members.html @@ -1,14 +1,16 @@ - + - - + +
TinyXML-2: Member List + + @@ -19,10 +21,9 @@- + +/* @license-end */ +-
- - TinyXML-2 - 9.0.0 ++ @@ -30,21 +31,22 @@+ TinyXML-2 10.0.0- +++++ ++Loading...+Searching...+No Matches+@@ -66,49 +75,48 @@--+tinyxml2::XMLUnknown Member Listtinyxml2::XMLUnknown Member ListThis is the complete list of members for tinyxml2::XMLUnknown, including all inherited members.
-Generated on Sat Apr 2 2022 13:12:57 for TinyXML-2 by 1.9.1 +Generated on Sat Dec 30 2023 18:02:36 for TinyXML-2 by 1.10.0 diff --git a/docs/classtinyxml2_1_1_x_m_l_unknown.html b/docs/classtinyxml2_1_1_x_m_l_unknown.html index b82f1f26..4f503d30 100644 --- a/docs/classtinyxml2_1_1_x_m_l_unknown.html +++ b/docs/classtinyxml2_1_1_x_m_l_unknown.html @@ -1,14 +1,16 @@ - + - - + +TinyXML-2: tinyxml2::XMLUnknown Class Reference + + @@ -19,10 +21,9 @@- + +/* @license-end */ +-
- - TinyXML-2 - 9.0.0 ++ @@ -30,21 +31,22 @@+ TinyXML-2 10.0.0- +++++ ++Loading...+Searching...+No Matches+@@ -69,8 +78,7 @@ --+tinyxml2::XMLUnknown Class Referencetinyxml2::XMLUnknown Class Reference@@ -85,114 +93,114 @@-
+
- Public Member Functions
- -virtual XMLUnknown * ToUnknown () - Safely cast to an Unknown, or null. - - virtual bool Accept (XMLVisitor *visitor) const - - virtual XMLNode * ShallowClone (XMLDocument *document) const - - virtual bool ShallowEqual (const XMLNode *compare) const - - Public Member Functions inherited from tinyxml2::XMLNode - -const XMLDocument * GetDocument () const - Get the XMLDocument that owns this XMLNode. - - -XMLDocument * GetDocument () - Get the XMLDocument that owns this XMLNode. - - -virtual XMLElement * ToElement () - Safely cast to an Element, or null. - - -virtual XMLText * ToText () - Safely cast to Text, or null. - - -virtual XMLComment * ToComment () - Safely cast to a Comment, or null. - - -virtual XMLDocument * ToDocument () - Safely cast to a Document, or null. - - -virtual XMLDeclaration * ToDeclaration () - Safely cast to a Declaration, or null. - - const char * Value () const - + void SetValue (const char *val, bool staticMem=false) + +virtual XMLUnknown * ToUnknown () override + Safely cast to an Unknown, or null. + + virtual bool Accept (XMLVisitor *visitor) const override + + virtual XMLNode * ShallowClone (XMLDocument *document) const override + + virtual bool ShallowEqual (const XMLNode *compare) const override + + Public Member Functions inherited from tinyxml2::XMLNode + +const XMLDocument * GetDocument () const + Get the XMLDocument that owns this XMLNode. + + +XMLDocument * GetDocument () + Get the XMLDocument that owns this XMLNode. + + +virtual XMLElement * ToElement () + Safely cast to an Element, or null. + + +virtual XMLText * ToText () + Safely cast to Text, or null. + + +virtual XMLComment * ToComment () + Safely cast to a Comment, or null. + + +virtual XMLDocument * ToDocument () + Safely cast to a Document, or null. + + +virtual XMLDeclaration * ToDeclaration () + Safely cast to a Declaration, or null. + + const char * Value () const + void SetValue (const char *val, bool staticMem=false) - + -int GetLineNum () const +int GetLineNum () const Gets the line number the node is in, if the document was parsed from a file. - - -const XMLNode * Parent () const - Get the parent of this node on the DOM. - + -bool NoChildren () const + +const XMLNode * Parent () const + Get the parent of this node on the DOM. + +bool NoChildren () const Returns true if this node has no children. - - -const XMLNode * FirstChild () const - Get the first child node, or null if none exists. - - const XMLElement * FirstChildElement (const char *name=0) const - - -const XMLNode * LastChild () const - Get the last child node, or null if none exists. - - const XMLElement * LastChildElement (const char *name=0) const - - -const XMLNode * PreviousSibling () const - Get the previous (left) sibling node of this node. - - -const XMLElement * PreviousSiblingElement (const char *name=0) const - Get the previous (left) sibling element of this node, with an optionally supplied name. - - -const XMLNode * NextSibling () const - Get the next (right) sibling node of this node. - - -const XMLElement * NextSiblingElement (const char *name=0) const - Get the next (right) sibling element of this node, with an optionally supplied name. - - XMLNode * InsertEndChild (XMLNode *addThis) - - XMLNode * InsertFirstChild (XMLNode *addThis) - - XMLNode * InsertAfterChild (XMLNode *afterThis, XMLNode *addThis) - + void DeleteChildren () + +const XMLNode * FirstChild () const + Get the first child node, or null if none exists. + + const XMLElement * FirstChildElement (const char *name=0) const + + +const XMLNode * LastChild () const + Get the last child node, or null if none exists. + + const XMLElement * LastChildElement (const char *name=0) const + + +const XMLNode * PreviousSibling () const + Get the previous (left) sibling node of this node. + + +const XMLElement * PreviousSiblingElement (const char *name=0) const + Get the previous (left) sibling element of this node, with an optionally supplied name. + + +const XMLNode * NextSibling () const + Get the next (right) sibling node of this node. + + +const XMLElement * NextSiblingElement (const char *name=0) const + Get the next (right) sibling element of this node, with an optionally supplied name. + + XMLNode * InsertEndChild (XMLNode *addThis) + + XMLNode * InsertFirstChild (XMLNode *addThis) + + XMLNode * InsertAfterChild (XMLNode *afterThis, XMLNode *addThis) + void DeleteChildren () - + void DeleteChild (XMLNode *node) void DeleteChild (XMLNode *node) - - XMLNode * DeepClone (XMLDocument *target) const - + void SetUserData (void *userData) + XMLNode * DeepClone (XMLDocument *target) const + void SetUserData (void *userData) - - void * GetUserData () const + + void * GetUserData () const Detailed Description
Any tag that TinyXML-2 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 XMLUnknowns.
Member Function Documentation
- -◆ Accept()
+ +◆ Accept()
@@ -203,14 +211,13 @@virtual bool tinyxml2::XMLUnknown::Accept
( -XMLVisitor * -visitor ) +XMLVisitor * visitor ) const -virtual +overridevirtual@@ -222,7 +229,7 @@http://c2.com/cgi/wiki?HierarchicalVisitorPattern
Which are both good references for "visiting".
-An example of using Accept():
XMLPrinter printer; +An example of using Accept():
XMLPrinter printer; tinyxmlDoc.Accept( &printer ); const char* xmlcstr = printer.CStr();@@ -230,8 +237,8 @@-
◆ ShallowClone()
+ +◆ ShallowClone()
- -@@ -240,28 +247,27 @@
- virtual XMLNode* tinyxml2::XMLUnknown::ShallowClone +virtual XMLNode * tinyxml2::XMLUnknown::ShallowClone ( -XMLDocument * -document ) +XMLDocument * document ) const -virtual +overridevirtual-Make a copy of this node, but not its children. You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())
+Make a copy of this node, but not its children. You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())
Note: if called on a XMLDocument, this will return null.
-Implements tinyxml2::XMLNode.
+Implements tinyxml2::XMLNode.
◆ ShallowEqual()
+ +◆ ShallowEqual()
@@ -272,14 +278,13 @@virtual bool tinyxml2::XMLUnknown::ShallowEqual
( -const XMLNode * -compare ) +const XMLNode * compare ) const -virtual +overridevirtual@@ -296,7 +301,7 @@-Generated on Sat Apr 2 2022 13:12:57 for TinyXML-2 by 1.9.1 +Generated on Sat Dec 30 2023 18:02:35 for TinyXML-2 by 1.10.0 diff --git a/docs/classtinyxml2_1_1_x_m_l_unknown.png b/docs/classtinyxml2_1_1_x_m_l_unknown.png index 217b62c5..47897cfb 100644 Binary files a/docs/classtinyxml2_1_1_x_m_l_unknown.png and b/docs/classtinyxml2_1_1_x_m_l_unknown.png differ diff --git a/docs/classtinyxml2_1_1_x_m_l_visitor-members.html b/docs/classtinyxml2_1_1_x_m_l_visitor-members.html index fed72685..b4e3f47c 100644 --- a/docs/classtinyxml2_1_1_x_m_l_visitor-members.html +++ b/docs/classtinyxml2_1_1_x_m_l_visitor-members.html @@ -1,14 +1,16 @@ - + - - + +
TinyXML-2: Member List + + @@ -19,10 +21,9 @@- + +/* @license-end */ +-
- - TinyXML-2 - 9.0.0 ++ @@ -30,21 +31,22 @@+ TinyXML-2 10.0.0- +++++ ++Loading...+Searching...+No Matches+@@ -66,25 +75,24 @@--+tinyxml2::XMLVisitor Member Listtinyxml2::XMLVisitor Member ListThis is the complete list of members for tinyxml2::XMLVisitor, including all inherited members.
- Visit(const XMLDeclaration &) tinyxml2::XMLVisitor inlinevirtual + Visit(const XMLText &) tinyxml2::XMLVisitor inlinevirtual Visit(const XMLText &) tinyxml2::XMLVisitor inlinevirtual - Visit(const XMLComment &) tinyxml2::XMLVisitor inlinevirtual + Visit(const XMLUnknown &) tinyxml2::XMLVisitor inlinevirtual Visit(const XMLUnknown &) tinyxml2::XMLVisitor inlinevirtual - VisitEnter(const XMLDocument &) tinyxml2::XMLVisitor inlinevirtual + VisitEnter(const XMLElement &, const XMLAttribute *) tinyxml2::XMLVisitor inlinevirtual VisitEnter(const XMLElement &, const XMLAttribute *) tinyxml2::XMLVisitor inlinevirtual - VisitExit(const XMLDocument &) tinyxml2::XMLVisitor inlinevirtual + VisitExit(const XMLElement &) tinyxml2::XMLVisitor inlinevirtual VisitExit(const XMLElement &) tinyxml2::XMLVisitor inlinevirtual
-Generated on Sat Apr 2 2022 13:12:57 for TinyXML-2 by 1.9.1 +Generated on Sat Dec 30 2023 18:02:36 for TinyXML-2 by 1.10.0 diff --git a/docs/classtinyxml2_1_1_x_m_l_visitor.html b/docs/classtinyxml2_1_1_x_m_l_visitor.html index 2af5ef54..84c2277b 100644 --- a/docs/classtinyxml2_1_1_x_m_l_visitor.html +++ b/docs/classtinyxml2_1_1_x_m_l_visitor.html @@ -1,14 +1,16 @@ - + - - + +TinyXML-2: tinyxml2::XMLVisitor Class Reference + + @@ -19,10 +21,9 @@- + +/* @license-end */ +-
- - TinyXML-2 - 9.0.0 ++ @@ -30,21 +31,22 @@+ TinyXML-2 10.0.0- +++++ ++Loading...+Searching...+No Matches+@@ -69,8 +78,7 @@ --+tinyxml2::XMLVisitor Class Referencetinyxml2::XMLVisitor Class Reference@@ -85,43 +93,43 @@-
+
- Public Member Functions
+ -virtual bool VisitEnter (const XMLDocument &) +virtual bool VisitEnter (const XMLDocument &) Visit a document. - + -virtual bool VisitExit (const XMLDocument &) +virtual bool VisitExit (const XMLDocument &) Visit a document. - + -virtual bool VisitEnter (const XMLElement &, const XMLAttribute *) +virtual bool VisitEnter (const XMLElement &, const XMLAttribute *) Visit an element. - + -virtual bool VisitExit (const XMLElement &) +virtual bool VisitExit (const XMLElement &) Visit an element. - + -virtual bool Visit (const XMLDeclaration &) +virtual bool Visit (const XMLDeclaration &) Visit a declaration. - + -virtual bool Visit (const XMLText &) +virtual bool Visit (const XMLText &) Visit a text node. - + -virtual bool Visit (const XMLComment &) +virtual bool Visit (const XMLComment &) Visit a comment node. - + -virtual bool Visit (const XMLUnknown &) +virtual bool Visit (const XMLUnknown &) Visit an unknown node. Detailed Description
-Implements the interface to the "Visitor pattern" (see the Accept() method.) If you call the Accept() method, it requires being passed a XMLVisitor class to handle callbacks. For nodes that contain other nodes (Document, Element) you will get called with a VisitEnter/VisitExit pair. Nodes that are always leafs are simply called with Visit().
+Implements the interface to the "Visitor pattern" (see the Accept() method.) If you call the Accept() method, it requires being passed a XMLVisitor class to handle callbacks. For nodes that contain other nodes (Document, Element) you will get called with a VisitEnter/VisitExit pair. Nodes that are always leafs are simply called with Visit().
If you return 'true' from a Visit method, recursive parsing will continue. If you return false, no children of this node or its siblings will be visited.
All flavors of Visit methods have a default implementation that returns 'true' (continue visiting). You need to only override methods that are interesting to you.
Generally Accept() is called on the XMLDocument, although all nodes support visiting.
@@ -133,7 +141,7 @@
-Generated on Sat Apr 2 2022 13:12:57 for TinyXML-2 by 1.9.1 +Generated on Sat Dec 30 2023 18:02:36 for TinyXML-2 by 1.10.0 diff --git a/docs/classtinyxml2_1_1_x_m_l_visitor.png b/docs/classtinyxml2_1_1_x_m_l_visitor.png index 8ae4c23c..022e517e 100644 Binary files a/docs/classtinyxml2_1_1_x_m_l_visitor.png and b/docs/classtinyxml2_1_1_x_m_l_visitor.png differ diff --git a/docs/clipboard.js b/docs/clipboard.js new file mode 100644 index 00000000..42c1fb0e --- /dev/null +++ b/docs/clipboard.js @@ -0,0 +1,61 @@ +/** + +The code below is based on the Doxygen Awesome project, see +https://github.com/jothepro/doxygen-awesome-css + +MIT License + +Copyright (c) 2021 - 2022 jothepro + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +*/ + +let clipboard_title = "Copy to clipboard" +let clipboard_icon = `` +let clipboard_successIcon = `` +let clipboard_successDuration = 1000 + +$(function() { + if(navigator.clipboard) { + const fragments = document.getElementsByClassName("fragment") + for(const fragment of fragments) { + const clipboard_div = document.createElement("div") + clipboard_div.classList.add("clipboard") + clipboard_div.innerHTML = clipboard_icon + clipboard_div.title = clipboard_title + $(clipboard_div).click(function() { + const content = this.parentNode.cloneNode(true) + // filter out line number and folded fragments from file listings + content.querySelectorAll(".lineno, .ttc, .foldclosed").forEach((node) => { node.remove() }) + let text = content.textContent + // remove trailing newlines and trailing spaces from empty lines + text = text.replace(/^\s*\n/gm,'\n').replace(/\n*$/,'') + navigator.clipboard.writeText(text); + this.classList.add("success") + this.innerHTML = clipboard_successIcon + window.setTimeout(() => { // switch back to normal icon after timeout + this.classList.remove("success") + this.innerHTML = clipboard_icon + }, clipboard_successDuration); + }) + fragment.insertBefore(clipboard_div, fragment.firstChild) + } + } +}) diff --git a/docs/cookie.js b/docs/cookie.js new file mode 100644 index 00000000..53ad21d9 --- /dev/null +++ b/docs/cookie.js @@ -0,0 +1,58 @@ +/*! + Cookie helper functions + Copyright (c) 2023 Dimitri van Heesch + Released under MIT license. +*/ +let Cookie = { + cookie_namespace: 'doxygen_', + + readSetting(cookie,defVal) { + if (window.chrome) { + const val = localStorage.getItem(this.cookie_namespace+cookie) || + sessionStorage.getItem(this.cookie_namespace+cookie); + if (val) return val; + } else { + let myCookie = this.cookie_namespace+cookie+"="; + if (document.cookie) { + const index = document.cookie.indexOf(myCookie); + if (index != -1) { + const valStart = index + myCookie.length; + let valEnd = document.cookie.indexOf(";", valStart); + if (valEnd == -1) { + valEnd = document.cookie.length; + } + return document.cookie.substring(valStart, valEnd); + } + } + } + return defVal; + }, + + writeSetting(cookie,val,days=10*365) { // default days='forever', 0=session cookie, -1=delete + if (window.chrome) { + if (days==0) { + sessionStorage.setItem(this.cookie_namespace+cookie,val); + } else { + localStorage.setItem(this.cookie_namespace+cookie,val); + } + } else { + let date = new Date(); + date.setTime(date.getTime()+(days*24*60*60*1000)); + const expiration = days!=0 ? "expires="+date.toGMTString()+";" : ""; + document.cookie = this.cookie_namespace + cookie + "=" + + val + "; SameSite=Lax;" + expiration + "path=/"; + } + }, + + eraseSetting(cookie) { + if (window.chrome) { + if (localStorage.getItem(this.cookie_namespace+cookie)) { + localStorage.removeItem(this.cookie_namespace+cookie); + } else if (sessionStorage.getItem(this.cookie_namespace+cookie)) { + sessionStorage.removeItem(this.cookie_namespace+cookie); + } + } else { + this.writeSetting(cookie,'',-1); + } + }, +} diff --git a/docs/doc.svg b/docs/doc.svg new file mode 100644 index 00000000..0b928a53 --- /dev/null +++ b/docs/doc.svg @@ -0,0 +1,12 @@ + + + diff --git a/docs/docd.svg b/docs/docd.svg new file mode 100644 index 00000000..ac18b275 --- /dev/null +++ b/docs/docd.svg @@ -0,0 +1,12 @@ + + + diff --git a/docs/doxygen.css b/docs/doxygen.css index ffbff022..7b7d851b 100644 --- a/docs/doxygen.css +++ b/docs/doxygen.css @@ -1,29 +1,422 @@ -/* The standard CSS for doxygen 1.9.1 */ - -body, table, div, p, dl { - font: 400 14px/22px Roboto,sans-serif; +/* The standard CSS for doxygen 1.10.0*/ + +html { +/* page base colors */ +--page-background-color: white; +--page-foreground-color: black; +--page-link-color: #3D578C; +--page-visited-link-color: #4665A2; + +/* index */ +--index-odd-item-bg-color: #F8F9FC; +--index-even-item-bg-color: white; +--index-header-color: black; +--index-separator-color: #A0A0A0; + +/* header */ +--header-background-color: #F9FAFC; +--header-separator-color: #C4CFE5; +--header-gradient-image: url('nav_h.png'); +--group-header-separator-color: #879ECB; +--group-header-color: #354C7B; +--inherit-header-color: gray; + +--footer-foreground-color: #2A3D61; +--footer-logo-width: 104px; +--citation-label-color: #334975; +--glow-color: cyan; + +--title-background-color: white; +--title-separator-color: #5373B4; +--directory-separator-color: #9CAFD4; +--separator-color: #4A6AAA; + +--blockquote-background-color: #F7F8FB; +--blockquote-border-color: #9CAFD4; + +--scrollbar-thumb-color: #9CAFD4; +--scrollbar-background-color: #F9FAFC; + +--icon-background-color: #728DC1; +--icon-foreground-color: white; +--icon-doc-image: url('doc.svg'); +--icon-folder-open-image: url('folderopen.svg'); +--icon-folder-closed-image: url('folderclosed.svg'); + +/* brief member declaration list */ +--memdecl-background-color: #F9FAFC; +--memdecl-separator-color: #DEE4F0; +--memdecl-foreground-color: #555; +--memdecl-template-color: #4665A2; + +/* detailed member list */ +--memdef-border-color: #A8B8D9; +--memdef-title-background-color: #E2E8F2; +--memdef-title-gradient-image: url('nav_f.png'); +--memdef-proto-background-color: #DFE5F1; +--memdef-proto-text-color: #253555; +--memdef-proto-text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); +--memdef-doc-background-color: white; +--memdef-param-name-color: #602020; +--memdef-template-color: #4665A2; + +/* tables */ +--table-cell-border-color: #2D4068; +--table-header-background-color: #374F7F; +--table-header-foreground-color: #FFFFFF; + +/* labels */ +--label-background-color: #728DC1; +--label-left-top-border-color: #5373B4; +--label-right-bottom-border-color: #C4CFE5; +--label-foreground-color: white; + +/** navigation bar/tree/menu */ +--nav-background-color: #F9FAFC; +--nav-foreground-color: #364D7C; +--nav-gradient-image: url('tab_b.png'); +--nav-gradient-hover-image: url('tab_h.png'); +--nav-gradient-active-image: url('tab_a.png'); +--nav-gradient-active-image-parent: url("../tab_a.png"); +--nav-separator-image: url('tab_s.png'); +--nav-breadcrumb-image: url('bc_s.png'); +--nav-breadcrumb-border-color: #C2CDE4; +--nav-splitbar-image: url('splitbar.png'); +--nav-font-size-level1: 13px; +--nav-font-size-level2: 10px; +--nav-font-size-level3: 9px; +--nav-text-normal-color: #283A5D; +--nav-text-hover-color: white; +--nav-text-active-color: white; +--nav-text-normal-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); +--nav-text-hover-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); +--nav-text-active-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); +--nav-menu-button-color: #364D7C; +--nav-menu-background-color: white; +--nav-menu-foreground-color: #555555; +--nav-menu-toggle-color: rgba(255, 255, 255, 0.5); +--nav-arrow-color: #9CAFD4; +--nav-arrow-selected-color: #9CAFD4; + +/* table of contents */ +--toc-background-color: #F4F6FA; +--toc-border-color: #D8DFEE; +--toc-header-color: #4665A2; +--toc-down-arrow-image: url("data:image/svg+xml;utf8,"); + +/** search field */ +--search-background-color: white; +--search-foreground-color: #909090; +--search-magnification-image: url('mag.svg'); +--search-magnification-select-image: url('mag_sel.svg'); +--search-active-color: black; +--search-filter-background-color: #F9FAFC; +--search-filter-foreground-color: black; +--search-filter-border-color: #90A5CE; +--search-filter-highlight-text-color: white; +--search-filter-highlight-bg-color: #3D578C; +--search-results-foreground-color: #425E97; +--search-results-background-color: #EEF1F7; +--search-results-border-color: black; +--search-box-shadow: inset 0.5px 0.5px 3px 0px #555; + +/** code fragments */ +--code-keyword-color: #008000; +--code-type-keyword-color: #604020; +--code-flow-keyword-color: #E08000; +--code-comment-color: #800000; +--code-preprocessor-color: #806020; +--code-string-literal-color: #002080; +--code-char-literal-color: #008080; +--code-xml-cdata-color: black; +--code-vhdl-digit-color: #FF00FF; +--code-vhdl-char-color: #000000; +--code-vhdl-keyword-color: #700070; +--code-vhdl-logic-color: #FF0000; +--code-link-color: #4665A2; +--code-external-link-color: #4665A2; +--fragment-foreground-color: black; +--fragment-background-color: #FBFCFD; +--fragment-border-color: #C4CFE5; +--fragment-lineno-border-color: #00FF00; +--fragment-lineno-background-color: #E8E8E8; +--fragment-lineno-foreground-color: black; +--fragment-lineno-link-fg-color: #4665A2; +--fragment-lineno-link-bg-color: #D8D8D8; +--fragment-lineno-link-hover-fg-color: #4665A2; +--fragment-lineno-link-hover-bg-color: #C8C8C8; +--fragment-copy-ok-color: #2EC82E; +--tooltip-foreground-color: black; +--tooltip-background-color: white; +--tooltip-border-color: gray; +--tooltip-doc-color: grey; +--tooltip-declaration-color: #006318; +--tooltip-link-color: #4665A2; +--tooltip-shadow: 1px 1px 7px gray; +--fold-line-color: #808080; +--fold-minus-image: url('minus.svg'); +--fold-plus-image: url('plus.svg'); +--fold-minus-image-relpath: url('../../minus.svg'); +--fold-plus-image-relpath: url('../../plus.svg'); + +/** font-family */ +--font-family-normal: Roboto,sans-serif; +--font-family-monospace: 'JetBrains Mono',Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace,fixed; +--font-family-nav: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; +--font-family-title: Tahoma,Arial,sans-serif; +--font-family-toc: Verdana,'DejaVu Sans',Geneva,sans-serif; +--font-family-search: Arial,Verdana,sans-serif; +--font-family-icon: Arial,Helvetica; +--font-family-tooltip: Roboto,sans-serif; + +/** special sections */ +--warning-color-bg: #f8d1cc; +--warning-color-hl: #b61825; +--warning-color-text: #75070f; +--note-color-bg: #faf3d8; +--note-color-hl: #f3a600; +--note-color-text: #5f4204; +--todo-color-bg: #e4f3ff; +--todo-color-hl: #1879C4; +--todo-color-text: #274a5c; +--test-color-bg: #e8e8ff; +--test-color-hl: #3939C4; +--test-color-text: #1a1a5c; +--deprecated-color-bg: #ecf0f3; +--deprecated-color-hl: #5b6269; +--deprecated-color-text: #43454a; +--bug-color-bg: #e4dafd; +--bug-color-hl: #5b2bdd; +--bug-color-text: #2a0d72; +--invariant-color-bg: #d8f1e3; +--invariant-color-hl: #44b86f; +--invariant-color-text: #265532; +} + +@media (prefers-color-scheme: dark) { + html:not(.dark-mode) { + color-scheme: dark; + +/* page base colors */ +--page-background-color: black; +--page-foreground-color: #C9D1D9; +--page-link-color: #90A5CE; +--page-visited-link-color: #A3B4D7; + +/* index */ +--index-odd-item-bg-color: #0B101A; +--index-even-item-bg-color: black; +--index-header-color: #C4CFE5; +--index-separator-color: #334975; + +/* header */ +--header-background-color: #070B11; +--header-separator-color: #141C2E; +--header-gradient-image: url('nav_hd.png'); +--group-header-separator-color: #283A5D; +--group-header-color: #90A5CE; +--inherit-header-color: #A0A0A0; + +--footer-foreground-color: #5B7AB7; +--footer-logo-width: 60px; +--citation-label-color: #90A5CE; +--glow-color: cyan; + +--title-background-color: #090D16; +--title-separator-color: #354C79; +--directory-separator-color: #283A5D; +--separator-color: #283A5D; + +--blockquote-background-color: #101826; +--blockquote-border-color: #283A5D; + +--scrollbar-thumb-color: #283A5D; +--scrollbar-background-color: #070B11; + +--icon-background-color: #334975; +--icon-foreground-color: #C4CFE5; +--icon-doc-image: url('docd.svg'); +--icon-folder-open-image: url('folderopend.svg'); +--icon-folder-closed-image: url('folderclosedd.svg'); + +/* brief member declaration list */ +--memdecl-background-color: #0B101A; +--memdecl-separator-color: #2C3F65; +--memdecl-foreground-color: #BBB; +--memdecl-template-color: #7C95C6; + +/* detailed member list */ +--memdef-border-color: #233250; +--memdef-title-background-color: #1B2840; +--memdef-title-gradient-image: url('nav_fd.png'); +--memdef-proto-background-color: #19243A; +--memdef-proto-text-color: #9DB0D4; +--memdef-proto-text-shadow: 0px 1px 1px rgba(0, 0, 0, 0.9); +--memdef-doc-background-color: black; +--memdef-param-name-color: #D28757; +--memdef-template-color: #7C95C6; + +/* tables */ +--table-cell-border-color: #283A5D; +--table-header-background-color: #283A5D; +--table-header-foreground-color: #C4CFE5; + +/* labels */ +--label-background-color: #354C7B; +--label-left-top-border-color: #4665A2; +--label-right-bottom-border-color: #283A5D; +--label-foreground-color: #CCCCCC; + +/** navigation bar/tree/menu */ +--nav-background-color: #101826; +--nav-foreground-color: #364D7C; +--nav-gradient-image: url('tab_bd.png'); +--nav-gradient-hover-image: url('tab_hd.png'); +--nav-gradient-active-image: url('tab_ad.png'); +--nav-gradient-active-image-parent: url("../tab_ad.png"); +--nav-separator-image: url('tab_sd.png'); +--nav-breadcrumb-image: url('bc_sd.png'); +--nav-breadcrumb-border-color: #2A3D61; +--nav-splitbar-image: url('splitbard.png'); +--nav-font-size-level1: 13px; +--nav-font-size-level2: 10px; +--nav-font-size-level3: 9px; +--nav-text-normal-color: #B6C4DF; +--nav-text-hover-color: #DCE2EF; +--nav-text-active-color: #DCE2EF; +--nav-text-normal-shadow: 0px 1px 1px black; +--nav-text-hover-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); +--nav-text-active-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); +--nav-menu-button-color: #B6C4DF; +--nav-menu-background-color: #05070C; +--nav-menu-foreground-color: #BBBBBB; +--nav-menu-toggle-color: rgba(255, 255, 255, 0.2); +--nav-arrow-color: #334975; +--nav-arrow-selected-color: #90A5CE; + +/* table of contents */ +--toc-background-color: #151E30; +--toc-border-color: #202E4A; +--toc-header-color: #A3B4D7; +--toc-down-arrow-image: url("data:image/svg+xml;utf8,"); + +/** search field */ +--search-background-color: black; +--search-foreground-color: #C5C5C5; +--search-magnification-image: url('mag_d.svg'); +--search-magnification-select-image: url('mag_seld.svg'); +--search-active-color: #C5C5C5; +--search-filter-background-color: #101826; +--search-filter-foreground-color: #90A5CE; +--search-filter-border-color: #7C95C6; +--search-filter-highlight-text-color: #BCC9E2; +--search-filter-highlight-bg-color: #283A5D; +--search-results-background-color: #101826; +--search-results-foreground-color: #90A5CE; +--search-results-border-color: #7C95C6; +--search-box-shadow: inset 0.5px 0.5px 3px 0px #2F436C; + +/** code fragments */ +--code-keyword-color: #CC99CD; +--code-type-keyword-color: #AB99CD; +--code-flow-keyword-color: #E08000; +--code-comment-color: #717790; +--code-preprocessor-color: #65CABE; +--code-string-literal-color: #7EC699; +--code-char-literal-color: #00E0F0; +--code-xml-cdata-color: #C9D1D9; +--code-vhdl-digit-color: #FF00FF; +--code-vhdl-char-color: #C0C0C0; +--code-vhdl-keyword-color: #CF53C9; +--code-vhdl-logic-color: #FF0000; +--code-link-color: #79C0FF; +--code-external-link-color: #79C0FF; +--fragment-foreground-color: #C9D1D9; +--fragment-background-color: #090D16; +--fragment-border-color: #30363D; +--fragment-lineno-border-color: #30363D; +--fragment-lineno-background-color: black; +--fragment-lineno-foreground-color: #6E7681; +--fragment-lineno-link-fg-color: #6E7681; +--fragment-lineno-link-bg-color: #303030; +--fragment-lineno-link-hover-fg-color: #8E96A1; +--fragment-lineno-link-hover-bg-color: #505050; +--fragment-copy-ok-color: #0EA80E; +--tooltip-foreground-color: #C9D1D9; +--tooltip-background-color: #202020; +--tooltip-border-color: #C9D1D9; +--tooltip-doc-color: #D9E1E9; +--tooltip-declaration-color: #20C348; +--tooltip-link-color: #79C0FF; +--tooltip-shadow: none; +--fold-line-color: #808080; +--fold-minus-image: url('minusd.svg'); +--fold-plus-image: url('plusd.svg'); +--fold-minus-image-relpath: url('../../minusd.svg'); +--fold-plus-image-relpath: url('../../plusd.svg'); + +/** font-family */ +--font-family-normal: Roboto,sans-serif; +--font-family-monospace: 'JetBrains Mono',Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace,fixed; +--font-family-nav: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; +--font-family-title: Tahoma,Arial,sans-serif; +--font-family-toc: Verdana,'DejaVu Sans',Geneva,sans-serif; +--font-family-search: Arial,Verdana,sans-serif; +--font-family-icon: Arial,Helvetica; +--font-family-tooltip: Roboto,sans-serif; + +/** special sections */ +--warning-color-bg: #2e1917; +--warning-color-hl: #ad2617; +--warning-color-text: #f5b1aa; +--note-color-bg: #3b2e04; +--note-color-hl: #f1b602; +--note-color-text: #ceb670; +--todo-color-bg: #163750; +--todo-color-hl: #1982D2; +--todo-color-text: #dcf0fa; +--test-color-bg: #121258; +--test-color-hl: #4242cf; +--test-color-text: #c0c0da; +--deprecated-color-bg: #2e323b; +--deprecated-color-hl: #738396; +--deprecated-color-text: #abb0bd; +--bug-color-bg: #2a2536; +--bug-color-hl: #7661b3; +--bug-color-text: #ae9ed6; +--invariant-color-bg: #303a35; +--invariant-color-hl: #76ce96; +--invariant-color-text: #cceed5; +}} +body { + background-color: var(--page-background-color); + color: var(--page-foreground-color); } -p.reference, p.definition { - font: 400 14px/22px Roboto,sans-serif; +body, table, div, p, dl { + font-weight: 400; + font-size: 14px; + font-family: var(--font-family-normal); + line-height: 22px; } /* @group Heading Levels */ -h1.groupheader { - font-size: 150%; -} - .title { - font: 400 14px/28px Roboto,sans-serif; + font-family: var(--font-family-normal); + line-height: 28px; font-size: 150%; font-weight: bold; margin: 10px 2px; } +h1.groupheader { + font-size: 150%; +} + h2.groupheader { - border-bottom: 1px solid #879ECB; - color: #354C7B; + border-bottom: 1px solid var(--group-header-separator-color); + color: var(--group-header-color); font-size: 150%; font-weight: normal; margin-top: 1.75em; @@ -46,22 +439,13 @@ h1, h2, h3, h4, h5, h6 { } h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow { - text-shadow: 0 0 15px cyan; + text-shadow: 0 0 15px var(--glow-color); } dt { font-weight: bold; } -ul.multicol { - -moz-column-gap: 1em; - -webkit-column-gap: 1em; - column-gap: 1em; - -moz-column-count: 3; - -webkit-column-count: 3; - column-count: 3; -} - p.startli, p.startdd { margin-top: 2px; } @@ -113,7 +497,6 @@ h3.version { } div.navtab { - border-right: 1px solid #A3B4D7; padding-right: 15px; text-align: right; line-height: 110%; @@ -127,16 +510,17 @@ td.navtab { padding-right: 6px; padding-left: 6px; } + td.navtabHL { - background-image: url('tab_a.png'); + background-image: var(--nav-gradient-active-image); background-repeat:repeat-x; padding-right: 6px; padding-left: 6px; } td.navtabHL a, td.navtabHL a:visited { - color: #fff; - text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); + color: var(--nav-text-hover-color); + text-shadow: var(--nav-text-hover-shadow); } a.navtab { @@ -148,7 +532,13 @@ div.qindex{ width: 100%; line-height: 140%; font-size: 130%; - color: #A0A0A0; + color: var(--index-separator-color); +} + +#main-menu a:focus { + outline: auto; + z-index: 10; + position: relative; } dt.alphachar{ @@ -157,7 +547,7 @@ dt.alphachar{ } .alphachar a{ - color: black; + color: var(--index-header-color); } .alphachar a:hover, .alphachar a:visited{ @@ -176,8 +566,12 @@ dt.alphachar{ line-height: 1.15em; } +.classindex dl.even { + background-color: var(--index-even-item-bg-color); +} + .classindex dl.odd { - background-color: #F8F9FC; + background-color: var(--index-odd-item-bg-color); } @media(min-width: 1120px) { @@ -196,21 +590,23 @@ dt.alphachar{ /* @group Link Styling */ a { - color: #3D578C; + color: var(--page-link-color); font-weight: normal; text-decoration: none; } .contents a:visited { - color: #4665A2; + color: var(--page-visited-link-color); } a:hover { - text-decoration: underline; + text-decoration: none; + background: linear-gradient(to bottom, transparent 0,transparent calc(100% - 1px), currentColor 100%); } -.contents a.qindexHL:visited { - color: #FFFFFF; +a:hover > span.arrow { + text-decoration: none; + background : var(--nav-background-color); } a.el { @@ -221,12 +617,39 @@ a.elRef { } a.code, a.code:visited, a.line, a.line:visited { - color: #4665A2; + color: var(--code-link-color); } a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited { - color: #4665A2; -} + color: var(--code-external-link-color); +} + +a.code.hl_class { /* style for links to class names in code snippets */ } +a.code.hl_struct { /* style for links to struct names in code snippets */ } +a.code.hl_union { /* style for links to union names in code snippets */ } +a.code.hl_interface { /* style for links to interface names in code snippets */ } +a.code.hl_protocol { /* style for links to protocol names in code snippets */ } +a.code.hl_category { /* style for links to category names in code snippets */ } +a.code.hl_exception { /* style for links to exception names in code snippets */ } +a.code.hl_service { /* style for links to service names in code snippets */ } +a.code.hl_singleton { /* style for links to singleton names in code snippets */ } +a.code.hl_concept { /* style for links to concept names in code snippets */ } +a.code.hl_namespace { /* style for links to namespace names in code snippets */ } +a.code.hl_package { /* style for links to package names in code snippets */ } +a.code.hl_define { /* style for links to macro names in code snippets */ } +a.code.hl_function { /* style for links to function names in code snippets */ } +a.code.hl_variable { /* style for links to variable names in code snippets */ } +a.code.hl_typedef { /* style for links to typedef names in code snippets */ } +a.code.hl_enumvalue { /* style for links to enum value names in code snippets */ } +a.code.hl_enumeration { /* style for links to enumeration names in code snippets */ } +a.code.hl_signal { /* style for links to Qt signal names in code snippets */ } +a.code.hl_slot { /* style for links to Qt slot names in code snippets */ } +a.code.hl_friend { /* style for links to friend names in code snippets */ } +a.code.hl_dcop { /* style for links to KDE3 DCOP names in code snippets */ } +a.code.hl_property { /* style for links to property names in code snippets */ } +a.code.hl_event { /* style for links to event names in code snippets */ } +a.code.hl_sequence { /* style for links to sequence names in code snippets */ } +a.code.hl_dictionary { /* style for links to dictionary names in code snippets */ } /* @end */ @@ -235,7 +658,17 @@ dl.el { } ul { - overflow: hidden; /*Fixed: list item bullets overlap floating elements*/ + overflow: visible; +} + +ul.multicol { + -moz-column-gap: 1em; + -webkit-column-gap: 1em; + column-gap: 1em; + -moz-column-count: 3; + -webkit-column-count: 3; + column-count: 3; + list-style-type: none; } #side-nav ul { @@ -249,35 +682,70 @@ ul { .fragment { text-align: left; direction: ltr; - overflow-x: auto; /*Fixed: fragment lines overlap floating elements*/ + overflow-x: auto; overflow-y: hidden; + position: relative; + min-height: 12px; + margin: 10px 0px; + padding: 10px 10px; + border: 1px solid var(--fragment-border-color); + border-radius: 4px; + background-color: var(--fragment-background-color); + color: var(--fragment-foreground-color); } pre.fragment { - border: 1px solid #C4CFE5; - background-color: #FBFCFD; - padding: 4px 6px; - margin: 4px 8px 4px 2px; + word-wrap: break-word; + font-size: 10pt; + line-height: 125%; + font-family: var(--font-family-monospace); +} + +.clipboard { + width: 24px; + height: 24px; + right: 5px; + top: 5px; + opacity: 0; + position: absolute; + display: inline; overflow: auto; - word-wrap: break-word; - font-size: 9pt; - line-height: 125%; - font-family: monospace, fixed; - font-size: 105%; + fill: var(--fragment-foreground-color); + justify-content: center; + align-items: center; + cursor: pointer; } -div.fragment { - padding: 0 0 1px 0; /*Fixed: last line underline overlap border*/ - margin: 4px 8px 4px 2px; - background-color: #FBFCFD; - border: 1px solid #C4CFE5; +.clipboard.success { + border: 1px solid var(--fragment-foreground-color); + border-radius: 4px; +} + +.fragment:hover .clipboard, .clipboard.success { + opacity: .28; +} + +.clipboard:hover, .clipboard.success { + opacity: 1 !important; +} + +.clipboard:active:not([class~=success]) svg { + transform: scale(.91); +} + +.clipboard.success svg { + fill: var(--fragment-copy-ok-color); +} + +.clipboard.success { + border-color: var(--fragment-copy-ok-color); } div.line { - font-family: monospace, fixed; + font-family: var(--font-family-monospace); font-size: 13px; min-height: 13px; - line-height: 1.0; + line-height: 1.2; text-wrap: unrestricted; white-space: -moz-pre-wrap; /* Moz */ white-space: -pre-wrap; /* Opera 4-6 */ @@ -306,24 +774,40 @@ div.line:after { } div.line.glow { - background-color: cyan; - box-shadow: 0 0 10px cyan; + background-color: var(--glow-color); + box-shadow: 0 0 10px var(--glow-color); } +span.fold { + margin-left: 5px; + margin-right: 1px; + margin-top: 0px; + margin-bottom: 0px; + padding: 0px; + display: inline-block; + width: 12px; + height: 12px; + background-repeat:no-repeat; + background-position:center; +} span.lineno { padding-right: 4px; + margin-right: 9px; text-align: right; - border-right: 2px solid #0F0; - background-color: #E8E8E8; + border-right: 2px solid var(--fragment-lineno-border-color); + color: var(--fragment-lineno-foreground-color); + background-color: var(--fragment-lineno-background-color); white-space: pre; } -span.lineno a { - background-color: #D8D8D8; +span.lineno a, span.lineno a:visited { + color: var(--fragment-lineno-link-fg-color); + background-color: var(--fragment-lineno-link-bg-color); } span.lineno a:hover { - background-color: #C8C8C8; + color: var(--fragment-lineno-link-hover-fg-color); + background-color: var(--fragment-lineno-link-hover-bg-color); } .lineno { @@ -335,24 +819,6 @@ span.lineno a:hover { user-select: none; } -div.ah, span.ah { - background-color: black; - font-weight: bold; - color: #FFFFFF; - margin-bottom: 3px; - margin-top: 3px; - padding: 0.2em; - border: solid thin #333; - border-radius: 0.5em; - -webkit-border-radius: .5em; - -moz-border-radius: .5em; - box-shadow: 2px 2px 3px #999; - -webkit-box-shadow: 2px 2px 3px #999; - -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; - background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444)); - background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000 110%); -} - div.classindex ul { list-style: none; padding-left: 0; @@ -374,8 +840,7 @@ div.groupText { } body { - background-color: white; - color: black; + color: var(--page-foreground-color); margin: 0; } @@ -385,33 +850,15 @@ div.contents { margin-right: 8px; } -td.indexkey { - background-color: #EBEFF6; - font-weight: bold; - border: 1px solid #C4CFE5; - margin: 2px 0px 2px 0; - padding: 2px 10px; - white-space: nowrap; - vertical-align: top; -} - -td.indexvalue { - background-color: #EBEFF6; - border: 1px solid #C4CFE5; - padding: 2px 10px; - margin: 2px 0px; -} - -tr.memlist { - background-color: #EEF1F7; -} - p.formulaDsp { text-align: center; } -img.formulaDsp { - +img.dark-mode-visible { + display: none; +} +img.light-mode-visible { + display: none; } img.formulaInl, img.inline { @@ -437,89 +884,74 @@ address.footer { img.footer { border: 0px; vertical-align: middle; + width: var(--footer-logo-width); +} + +.compoundTemplParams { + color: var(--memdecl-template-color); + font-size: 80%; + line-height: 120%; } /* @group Code Colorization */ span.keyword { - color: #008000 + color: var(--code-keyword-color); } span.keywordtype { - color: #604020 + color: var(--code-type-keyword-color); } span.keywordflow { - color: #e08000 + color: var(--code-flow-keyword-color); } span.comment { - color: #800000 + color: var(--code-comment-color); } span.preprocessor { - color: #806020 + color: var(--code-preprocessor-color); } span.stringliteral { - color: #002080 + color: var(--code-string-literal-color); } span.charliteral { - color: #008080 + color: var(--code-char-literal-color); +} + +span.xmlcdata { + color: var(--code-xml-cdata-color); } span.vhdldigit { - color: #ff00ff + color: var(--code-vhdl-digit-color); } span.vhdlchar { - color: #000000 + color: var(--code-vhdl-char-color); } span.vhdlkeyword { - color: #700070 + color: var(--code-vhdl-keyword-color); } span.vhdllogic { - color: #ff0000 + color: var(--code-vhdl-logic-color); } blockquote { - background-color: #F7F8FB; - border-left: 2px solid #9CAFD4; + background-color: var(--blockquote-background-color); + border-left: 2px solid var(--blockquote-border-color); margin: 0 24px 0 4px; padding: 0 12px 0 16px; } -blockquote.DocNodeRTL { - border-left: 0; - border-right: 2px solid #9CAFD4; - margin: 0 4px 0 24px; - padding: 0 16px 0 12px; -} - /* @end */ -/* -.search { - color: #003399; - font-weight: bold; -} - -form.search { - margin-bottom: 0px; - margin-top: 0px; -} - -input.search { - font-size: 75%; - color: #000080; - font-weight: normal; - background-color: #e8eef2; -} -*/ - td.tiny { font-size: 75%; } @@ -527,18 +959,19 @@ td.tiny { .dirtab { padding: 4px; border-collapse: collapse; - border: 1px solid #A3B4D7; + border: 1px solid var(--table-cell-border-color); } th.dirtab { - background: #EBEFF6; + background-color: var(--table-header-background-color); + color: var(--table-header-foreground-color); font-weight: bold; } hr { height: 0px; border: none; - border-top: 1px solid #4A6AAA; + border-top: 1px solid var(--separator-color); } hr.footer { @@ -566,14 +999,14 @@ table.memberdecls { } .memberdecls td.glow, .fieldtable tr.glow { - background-color: cyan; - box-shadow: 0 0 15px cyan; + background-color: var(--glow-color); + box-shadow: 0 0 15px var(--glow-color); } .mdescLeft, .mdescRight, .memItemLeft, .memItemRight, .memTemplItemLeft, .memTemplItemRight, .memTemplParams { - background-color: #F9FAFC; + background-color: var(--memdecl-background-color); border: none; margin: 4px; padding: 1px 0 0 8px; @@ -581,11 +1014,11 @@ table.memberdecls { .mdescLeft, .mdescRight { padding: 0px 8px 4px 8px; - color: #555; + color: var(--memdecl-foreground-color); } .memSeparator { - border-bottom: 1px solid #DEE4F0; + border-bottom: 1px solid var(--memdecl-separator-color); line-height: 1px; margin: 0px; padding: 0px; @@ -600,7 +1033,7 @@ table.memberdecls { } .memTemplParams { - color: #4665A2; + color: var(--memdecl-template-color); white-space: nowrap; font-size: 80%; } @@ -613,15 +1046,15 @@ table.memberdecls { .memtitle { padding: 8px; - border-top: 1px solid #A8B8D9; - border-left: 1px solid #A8B8D9; - border-right: 1px solid #A8B8D9; + border-top: 1px solid var(--memdef-border-color); + border-left: 1px solid var(--memdef-border-color); + border-right: 1px solid var(--memdef-border-color); border-top-right-radius: 4px; border-top-left-radius: 4px; margin-bottom: -1px; - background-image: url('nav_f.png'); + background-image: var(--memdef-title-gradient-image); background-repeat: repeat-x; - background-color: #E2E8F2; + background-color: var(--memdef-title-background-color); line-height: 1.25; font-weight: 300; float:left; @@ -636,20 +1069,11 @@ table.memberdecls { .memtemplate { font-size: 80%; - color: #4665A2; + color: var(--memdef-template-color); font-weight: normal; margin-left: 9px; } -.memnav { - background-color: #EBEFF6; - border: 1px solid #A3B4D7; - text-align: center; - margin: 2px; - margin-right: 15px; - padding: 2px; -} - .mempage { width: 100%; } @@ -668,7 +1092,7 @@ table.memberdecls { } .memitem.glow { - box-shadow: 0 0 15px cyan; + box-shadow: 0 0 15px var(--glow-color); } .memname { @@ -681,41 +1105,32 @@ table.memberdecls { } .memproto, dl.reflist dt { - border-top: 1px solid #A8B8D9; - border-left: 1px solid #A8B8D9; - border-right: 1px solid #A8B8D9; + border-top: 1px solid var(--memdef-border-color); + border-left: 1px solid var(--memdef-border-color); + border-right: 1px solid var(--memdef-border-color); padding: 6px 0px 6px 0px; - color: #253555; + color: var(--memdef-proto-text-color); font-weight: bold; - text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); - background-color: #DFE5F1; - /* opera specific markup */ + text-shadow: var(--memdef-proto-text-shadow); + background-color: var(--memdef-proto-background-color); box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); border-top-right-radius: 4px; - /* firefox specific markup */ - -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; - -moz-border-radius-topright: 4px; - /* webkit specific markup */ - -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); - -webkit-border-top-right-radius: 4px; - } .overload { - font-family: "courier new",courier,monospace; + font-family: var(--font-family-monospace); font-size: 65%; } .memdoc, dl.reflist dd { - border-bottom: 1px solid #A8B8D9; - border-left: 1px solid #A8B8D9; - border-right: 1px solid #A8B8D9; + border-bottom: 1px solid var(--memdef-border-color); + border-left: 1px solid var(--memdef-border-color); + border-right: 1px solid var(--memdef-border-color); padding: 6px 10px 2px 10px; - background-color: #FBFCFD; border-top-width: 0; background-image:url('nav_g.png'); background-repeat:repeat-x; - background-color: #FFFFFF; + background-color: var(--memdef-doc-background-color); /* opera specific markup */ border-bottom-left-radius: 4px; border-bottom-right-radius: 4px; @@ -745,36 +1160,44 @@ dl.reflist dd { .paramtype { white-space: nowrap; + padding: 0px; + padding-bottom: 1px; } .paramname { - color: #602020; white-space: nowrap; + padding: 0px; + padding-bottom: 1px; + margin-left: 2px; } + .paramname em { + color: var(--memdef-param-name-color); font-style: normal; + margin-right: 1px; } -.paramname code { - line-height: 14px; + +.paramname .paramdefval { + font-family: var(--font-family-monospace); } .params, .retval, .exception, .tparams { margin-left: 0px; padding-left: 0px; -} +} .params .paramname, .retval .paramname, .tparams .paramname, .exception .paramname { font-weight: bold; vertical-align: top; } - + .params .paramtype, .tparams .paramtype { font-style: italic; vertical-align: top; -} - +} + .params .paramdir, .tparams .paramdir { - font-family: "courier new",courier,monospace; + font-family: var(--font-family-monospace); vertical-align: top; } @@ -798,13 +1221,13 @@ span.mlabels { } span.mlabel { - background-color: #728DC1; - border-top:1px solid #5373B4; - border-left:1px solid #5373B4; - border-right:1px solid #C4CFE5; - border-bottom:1px solid #C4CFE5; + background-color: var(--label-background-color); + border-top:1px solid var(--label-left-top-border-color); + border-left:1px solid var(--label-left-top-border-color); + border-right:1px solid var(--label-right-bottom-border-color); + border-bottom:1px solid var(--label-right-bottom-border-color); text-shadow: none; - color: white; + color: var(--label-foreground-color); margin-right: 4px; padding: 2px 3px; border-radius: 3px; @@ -821,8 +1244,8 @@ span.mlabel { div.directory { margin: 10px 0px; - border-top: 1px solid #9CAFD4; - border-bottom: 1px solid #9CAFD4; + border-top: 1px solid var(--directory-separator-color); + border-bottom: 1px solid var(--directory-separator-color); width: 100%; } @@ -858,9 +1281,14 @@ div.directory { border-left: 1px solid rgba(0,0,0,0.05); } +.directory tr.odd { + padding-left: 6px; + background-color: var(--index-odd-item-bg-color); +} + .directory tr.even { padding-left: 6px; - background-color: #F7F8FB; + background-color: var(--index-even-item-bg-color); } .directory img { @@ -878,11 +1306,11 @@ div.directory { cursor: pointer; padding-left: 2px; padding-right: 2px; - color: #3D578C; + color: var(--page-link-color); } .arrow { - color: #9CAFD4; + color: var(--nav-arrow-color); -webkit-user-select: none; -khtml-user-select: none; -moz-user-select: none; @@ -896,14 +1324,15 @@ div.directory { } .icon { - font-family: Arial, Helvetica; + font-family: var(--font-family-icon); + line-height: normal; font-weight: bold; font-size: 12px; height: 14px; width: 16px; display: inline-block; - background-color: #728DC1; - color: white; + background-color: var(--icon-background-color); + color: var(--icon-foreground-color); text-align: center; border-radius: 4px; margin-left: 2px; @@ -920,8 +1349,7 @@ div.directory { width: 24px; height: 18px; margin-bottom: 4px; - background-image:url('folderopen.png'); - background-position: 0px -4px; + background-image:var(--icon-folder-open-image); background-repeat: repeat-y; vertical-align:top; display: inline-block; @@ -931,8 +1359,7 @@ div.directory { width: 24px; height: 18px; margin-bottom: 4px; - background-image:url('folderclosed.png'); - background-position: 0px -4px; + background-image:var(--icon-folder-closed-image); background-repeat: repeat-y; vertical-align:top; display: inline-block; @@ -942,17 +1369,13 @@ div.directory { width: 24px; height: 18px; margin-bottom: 4px; - background-image:url('doc.png'); + background-image:var(--icon-doc-image); background-position: 0px -4px; background-repeat: repeat-y; vertical-align:top; display: inline-block; } -table.directory { - font: 400 14px Roboto,sans-serif; -} - /* @end */ div.dynheader { @@ -967,7 +1390,7 @@ div.dynheader { address { font-style: normal; - color: #2A3D61; + color: var(--footer-foreground-color); } table.doxtable caption { @@ -981,28 +1404,23 @@ table.doxtable { } table.doxtable td, table.doxtable th { - border: 1px solid #2D4068; + border: 1px solid var(--table-cell-border-color); padding: 3px 7px 2px; } table.doxtable th { - background-color: #374F7F; - color: #FFFFFF; + background-color: var(--table-header-background-color); + color: var(--table-header-foreground-color); font-size: 110%; padding-bottom: 4px; padding-top: 5px; } table.fieldtable { - /*width: 100%;*/ margin-bottom: 10px; - border: 1px solid #A8B8D9; + border: 1px solid var(--memdef-border-color); border-spacing: 0px; - -moz-border-radius: 4px; - -webkit-border-radius: 4px; border-radius: 4px; - -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; - -webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); } @@ -1012,8 +1430,8 @@ table.fieldtable { .fieldtable td.fieldtype, .fieldtable td.fieldname { white-space: nowrap; - border-right: 1px solid #A8B8D9; - border-bottom: 1px solid #A8B8D9; + border-right: 1px solid var(--memdef-border-color); + border-bottom: 1px solid var(--memdef-border-color); vertical-align: top; } @@ -1022,14 +1440,13 @@ table.fieldtable { } .fieldtable td.fielddoc { - border-bottom: 1px solid #A8B8D9; - /*width: 100%;*/ + border-bottom: 1px solid var(--memdef-border-color); } .fieldtable td.fielddoc p:first-child { margin-top: 0px; -} - +} + .fieldtable td.fielddoc p:last-child { margin-bottom: 2px; } @@ -1039,22 +1456,18 @@ table.fieldtable { } .fieldtable th { - background-image:url('nav_f.png'); + background-image: var(--memdef-title-gradient-image); background-repeat:repeat-x; - background-color: #E2E8F2; + background-color: var(--memdef-title-background-color); font-size: 90%; - color: #253555; + color: var(--memdef-proto-text-color); padding-bottom: 4px; padding-top: 5px; text-align:left; font-weight: 400; - -moz-border-radius-topleft: 4px; - -moz-border-radius-topright: 4px; - -webkit-border-top-left-radius: 4px; - -webkit-border-top-right-radius: 4px; border-top-left-radius: 4px; border-top-right-radius: 4px; - border-bottom: 1px solid #A8B8D9; + border-bottom: 1px solid var(--memdef-border-color); } @@ -1062,7 +1475,7 @@ table.fieldtable { top: 0px; left: 10px; height: 36px; - background-image: url('tab_b.png'); + background-image: var(--nav-gradient-image); z-index: 101; overflow: hidden; font-size: 13px; @@ -1071,13 +1484,13 @@ table.fieldtable { .navpath ul { font-size: 11px; - background-image:url('tab_b.png'); + background-image: var(--nav-gradient-image); background-repeat:repeat-x; background-position: 0 -5px; height:30px; line-height:30px; - color:#8AA0CC; - border:solid 1px #C2CDE4; + color:var(--nav-text-normal-color); + border:solid 1px var(--nav-breadcrumb-border-color); overflow:hidden; margin:0px; padding:0px; @@ -1089,27 +1502,27 @@ table.fieldtable { float:left; padding-left:10px; padding-right:15px; - background-image:url('bc_s.png'); + background-image:var(--nav-breadcrumb-image); background-repeat:no-repeat; background-position:right; - color:#364D7C; + color: var(--nav-foreground-color); } .navpath li.navelem a { height:32px; display:block; - text-decoration: none; outline: none; - color: #283A5D; - font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; - text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); - text-decoration: none; + color: var(--nav-text-normal-color); + font-family: var(--font-family-nav); + text-shadow: var(--nav-text-normal-shadow); + text-decoration: none; } .navpath li.navelem a:hover { - color:#6884BD; + color: var(--nav-text-hover-color); + text-shadow: var(--nav-text-hover-shadow); } .navpath li.footer @@ -1121,7 +1534,7 @@ table.fieldtable { background-image:none; background-repeat:no-repeat; background-position:right; - color:#364D7C; + color: var(--footer-foreground-color); font-size: 8pt; } @@ -1133,7 +1546,7 @@ div.summary padding-right: 5px; width: 50%; text-align: right; -} +} div.summary a { @@ -1148,7 +1561,7 @@ table.classindex margin-right: 3%; width: 94%; border: 0; - border-spacing: 0; + border-spacing: 0; padding: 0; } @@ -1166,11 +1579,11 @@ div.ingroups a div.header { - background-image:url('nav_h.png'); + background-image: var(--header-gradient-image); background-repeat:repeat-x; - background-color: #F9FAFC; + background-color: var(--header-background-color); margin: 0px; - border-bottom: 1px solid #C4CFE5; + border-bottom: 1px solid var(--header-separator-color); } div.headertitle @@ -1187,17 +1600,13 @@ dl { padding: 0 0 0 0; } -/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug, dl.examples */ +/* + dl.section { margin-left: 0px; padding-left: 0px; } -dl.section.DocNodeRTL { - margin-right: 0px; - padding-right: 0px; -} - dl.note { margin-left: -7px; padding-left: 3px; @@ -1205,16 +1614,6 @@ dl.note { border-color: #D0C000; } -dl.note.DocNodeRTL { - margin-left: 0; - padding-left: 0; - border-left: 0; - margin-right: -7px; - padding-right: 3px; - border-right: 4px solid; - border-color: #D0C000; -} - dl.warning, dl.attention { margin-left: -7px; padding-left: 3px; @@ -1222,16 +1621,6 @@ dl.warning, dl.attention { border-color: #FF0000; } -dl.warning.DocNodeRTL, dl.attention.DocNodeRTL { - margin-left: 0; - padding-left: 0; - border-left: 0; - margin-right: -7px; - padding-right: 3px; - border-right: 4px solid; - border-color: #FF0000; -} - dl.pre, dl.post, dl.invariant { margin-left: -7px; padding-left: 3px; @@ -1239,16 +1628,6 @@ dl.pre, dl.post, dl.invariant { border-color: #00D000; } -dl.pre.DocNodeRTL, dl.post.DocNodeRTL, dl.invariant.DocNodeRTL { - margin-left: 0; - padding-left: 0; - border-left: 0; - margin-right: -7px; - padding-right: 3px; - border-right: 4px solid; - border-color: #00D000; -} - dl.deprecated { margin-left: -7px; padding-left: 3px; @@ -1256,16 +1635,6 @@ dl.deprecated { border-color: #505050; } -dl.deprecated.DocNodeRTL { - margin-left: 0; - padding-left: 0; - border-left: 0; - margin-right: -7px; - padding-right: 3px; - border-right: 4px solid; - border-color: #505050; -} - dl.todo { margin-left: -7px; padding-left: 3px; @@ -1273,16 +1642,6 @@ dl.todo { border-color: #00C0E0; } -dl.todo.DocNodeRTL { - margin-left: 0; - padding-left: 0; - border-left: 0; - margin-right: -7px; - padding-right: 3px; - border-right: 4px solid; - border-color: #00C0E0; -} - dl.test { margin-left: -7px; padding-left: 3px; @@ -1290,16 +1649,6 @@ dl.test { border-color: #3030E0; } -dl.test.DocNodeRTL { - margin-left: 0; - padding-left: 0; - border-left: 0; - margin-right: -7px; - padding-right: 3px; - border-right: 4px solid; - border-color: #3030E0; -} - dl.bug { margin-left: -7px; padding-left: 3px; @@ -1307,20 +1656,108 @@ dl.bug { border-color: #C08050; } -dl.bug.DocNodeRTL { - margin-left: 0; - padding-left: 0; - border-left: 0; - margin-right: -7px; - padding-right: 3px; - border-right: 4px solid; - border-color: #C08050; +*/ + +dl.bug dt a, dl.deprecated dt a, dl.todo dt a, dl.test a { + font-weight: bold !important; +} + +dl.warning, dl.attention, dl.note, dl.deprecated, dl.bug, +dl.invariant, dl.pre, dl.post, dl.todo, dl.test, dl.remark { + padding: 10px; + margin: 10px 0px; + overflow: hidden; + margin-left: 0; + border-radius: 4px; } dl.section dd { - margin-bottom: 6px; + margin-bottom: 2px; +} + +dl.warning, dl.attention { + background: var(--warning-color-bg); + border-left: 8px solid var(--warning-color-hl); + color: var(--warning-color-text); } +dl.warning dt, dl.attention dt { + color: var(--warning-color-hl); +} + +dl.note, dl.remark { + background: var(--note-color-bg); + border-left: 8px solid var(--note-color-hl); + color: var(--note-color-text); +} + +dl.note dt, dl.remark dt { + color: var(--note-color-hl); +} + +dl.todo { + background: var(--todo-color-bg); + border-left: 8px solid var(--todo-color-hl); + color: var(--todo-color-text); +} + +dl.todo dt { + color: var(--todo-color-hl); +} + +dl.test { + background: var(--test-color-bg); + border-left: 8px solid var(--test-color-hl); + color: var(--test-color-text); +} + +dl.test dt { + color: var(--test-color-hl); +} + +dl.bug dt a { + color: var(--bug-color-hl) !important; +} + +dl.bug { + background: var(--bug-color-bg); + border-left: 8px solid var(--bug-color-hl); + color: var(--bug-color-text); +} + +dl.bug dt a { + color: var(--bug-color-hl) !important; +} + +dl.deprecated { + background: var(--deprecated-color-bg); + border-left: 8px solid var(--deprecated-color-hl); + color: var(--deprecated-color-text); +} + +dl.deprecated dt a { + color: var(--deprecated-color-hl) !important; +} + +dl.section dd, dl.bug dd, dl.deprecated dd, dl.todo dd, dl.test dd { + margin-inline-start: 0px; +} + +dl.invariant, dl.pre, dl.post { + background: var(--invariant-color-bg); + border-left: 8px solid var(--invariant-color-hl); + color: var(--invariant-color-text); +} + +dl.invariant dt, dl.pre dt, dl.post dt { + color: var(--invariant-color-hl); +} + + +#projectrow +{ + height: 56px; +} #projectlogo { @@ -1328,34 +1765,38 @@ dl.section dd { vertical-align: bottom; border-collapse: separate; } - + #projectlogo img -{ +{ border: 0px none; } - + #projectalign { vertical-align: middle; + padding-left: 0.5em; } #projectname { - font: 300% Tahoma, Arial,sans-serif; + font-size: 200%; + font-family: var(--font-family-title); margin: 0px; padding: 2px 0px; } - + #projectbrief { - font: 120% Tahoma, Arial,sans-serif; + font-size: 90%; + font-family: var(--font-family-title); margin: 0px; padding: 0px; } #projectnumber { - font: 50% Tahoma, Arial,sans-serif; + font-size: 50%; + font-family: 50% var(--font-family-title); margin: 0px; padding: 0px; } @@ -1365,7 +1806,8 @@ dl.section dd { padding: 0px; margin: 0px; width: 100%; - border-bottom: 1px solid #5373B4; + border-bottom: 1px solid var(--title-separator-color); + background-color: var(--title-background-color); } .image @@ -1398,17 +1840,12 @@ dl.section dd { font-weight: bold; } -div.zoom -{ - border: 1px solid #90A5CE; -} - dl.citelist { margin-bottom:50px; } dl.citelist dt { - color:#334975; + color:var(--citation-label-color); float:left; font-weight:bold; margin-right:10px; @@ -1424,8 +1861,8 @@ dl.citelist dd { div.toc { padding: 14px 25px; - background-color: #F4F6FA; - border: 1px solid #D8DFEE; + background-color: var(--toc-background-color); + border: 1px solid var(--toc-border-color); border-radius: 7px 7px 7px 7px; float: right; height: auto; @@ -1433,28 +1870,17 @@ div.toc { width: 200px; } -.PageDocRTL-title div.toc { - float: left !important; - text-align: right; -} - div.toc li { - background: url("bdwn.png") no-repeat scroll 0 5px transparent; - font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif; + background: var(--toc-down-arrow-image) no-repeat scroll 0 5px transparent; + font: 10px/1.2 var(--font-family-toc); margin-top: 5px; padding-left: 10px; padding-top: 2px; } -.PageDocRTL-title div.toc li { - background-position-x: right !important; - padding-left: 0 !important; - padding-right: 10px; -} - div.toc h3 { - font: bold 12px/1.2 Arial,FreeSans,sans-serif; - color: #4665A2; + font: bold 12px/1.2 var(--font-family-toc); + color: var(--toc-header-color); border-bottom: 0 none; margin: 0; } @@ -1463,7 +1889,7 @@ div.toc ul { list-style: none outside none; border: medium none; padding: 0px; -} +} div.toc li.level1 { margin-left: 0px; @@ -1474,11 +1900,11 @@ div.toc li.level2 { } div.toc li.level3 { - margin-left: 30px; + margin-left: 15px; } div.toc li.level4 { - margin-left: 45px; + margin-left: 15px; } span.emoji { @@ -1487,29 +1913,13 @@ span.emoji { */ } -.PageDocRTL-title div.toc li.level1 { - margin-left: 0 !important; - margin-right: 0; -} - -.PageDocRTL-title div.toc li.level2 { - margin-left: 0 !important; - margin-right: 15px; -} - -.PageDocRTL-title div.toc li.level3 { - margin-left: 0 !important; - margin-right: 30px; -} - -.PageDocRTL-title div.toc li.level4 { - margin-left: 0 !important; - margin-right: 45px; +span.obfuscator { + display: none; } .inherit_header { font-weight: bold; - color: gray; + color: var(--inherit-header-color); cursor: pointer; -webkit-touch-callout: none; -webkit-user-select: none; @@ -1541,11 +1951,12 @@ tr.heading h2 { #powerTip { cursor: default; - white-space: nowrap; - background-color: white; - border: 1px solid gray; + /*white-space: nowrap;*/ + color: var(--tooltip-foreground-color); + background-color: var(--tooltip-background-color); + border: 1px solid var(--tooltip-border-color); border-radius: 4px 4px 4px 4px; - box-shadow: 1px 1px 7px gray; + box-shadow: var(--tooltip-shadow); display: none; font-size: smaller; max-width: 80%; @@ -1556,7 +1967,7 @@ tr.heading h2 { } #powerTip div.ttdoc { - color: grey; + color: var(--tooltip-doc-color); font-style: italic; } @@ -1564,18 +1975,24 @@ tr.heading h2 { font-weight: bold; } +#powerTip a { + color: var(--tooltip-link-color); +} + #powerTip div.ttname { font-weight: bold; } #powerTip div.ttdeci { - color: #006318; + color: var(--tooltip-declaration-color); } #powerTip div { margin: 0px; padding: 0px; - font: 12px/16px Roboto,sans-serif; + font-size: 12px; + font-family: var(--font-family-tooltip); + line-height: 16px; } #powerTip:before, #powerTip:after { @@ -1620,12 +2037,12 @@ tr.heading h2 { } #powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after { - border-top-color: #FFFFFF; + border-top-color: var(--tooltip-background-color); border-width: 10px; margin: 0px -10px; } -#powerTip.n:before { - border-top-color: #808080; +#powerTip.n:before, #powerTip.ne:before, #powerTip.nw:before { + border-top-color: var(--tooltip-border-color); border-width: 11px; margin: 0px -11px; } @@ -1648,13 +2065,13 @@ tr.heading h2 { } #powerTip.s:after, #powerTip.se:after, #powerTip.sw:after { - border-bottom-color: #FFFFFF; + border-bottom-color: var(--tooltip-background-color); border-width: 10px; margin: 0px -10px; } #powerTip.s:before, #powerTip.se:before, #powerTip.sw:before { - border-bottom-color: #808080; + border-bottom-color: var(--tooltip-border-color); border-width: 11px; margin: 0px -11px; } @@ -1675,13 +2092,13 @@ tr.heading h2 { left: 100%; } #powerTip.e:after { - border-left-color: #FFFFFF; + border-left-color: var(--tooltip-border-color); border-width: 10px; top: 50%; margin-top: -10px; } #powerTip.e:before { - border-left-color: #808080; + border-left-color: var(--tooltip-border-color); border-width: 11px; top: 50%; margin-top: -11px; @@ -1691,13 +2108,13 @@ tr.heading h2 { right: 100%; } #powerTip.w:after { - border-right-color: #FFFFFF; + border-right-color: var(--tooltip-border-color); border-width: 10px; top: 50%; margin-top: -10px; } #powerTip.w:before { - border-right-color: #808080; + border-right-color: var(--tooltip-border-color); border-width: 11px; top: 50%; margin-top: -11px; @@ -1731,7 +2148,7 @@ table.markdownTable { } table.markdownTable td, table.markdownTable th { - border: 1px solid #2D4068; + border: 1px solid var(--table-cell-border-color); padding: 3px 7px 2px; } @@ -1739,8 +2156,8 @@ table.markdownTable tr { } th.markdownTableHeadLeft, th.markdownTableHeadRight, th.markdownTableHeadCenter, th.markdownTableHeadNone { - background-color: #374F7F; - color: #FFFFFF; + background-color: var(--table-header-background-color); + color: var(--table-header-foreground-color); font-size: 110%; padding-bottom: 4px; padding-top: 5px; @@ -1758,36 +2175,51 @@ th.markdownTableHeadCenter, td.markdownTableBodyCenter { text-align: center } -.DocNodeRTL { - text-align: right; - direction: rtl; +tt, code, kbd, samp +{ + display: inline-block; } +/* @end */ -.DocNodeLTR { - text-align: left; - direction: ltr; +u { + text-decoration: underline; } -table.DocNodeRTL { - width: auto; - margin-right: 0; - margin-left: auto; +details>summary { + list-style-type: none; } -table.DocNodeLTR { - width: auto; - margin-right: auto; - margin-left: 0; +details > summary::-webkit-details-marker { + display: none; } -tt, code, kbd, samp -{ - display: inline-block; - direction:ltr; +details>summary::before { + content: "\25ba"; + padding-right:4px; + font-size: 80%; } -/* @end */ -u { - text-decoration: underline; +details[open]>summary::before { + content: "\25bc"; + padding-right:4px; + font-size: 80%; +} + +body { + scrollbar-color: var(--scrollbar-thumb-color) var(--scrollbar-background-color); +} + +::-webkit-scrollbar { + background-color: var(--scrollbar-background-color); + height: 12px; + width: 12px; +} +::-webkit-scrollbar-thumb { + border-radius: 6px; + box-shadow: inset 0 0 12px 12px var(--scrollbar-thumb-color); + border: solid 2px transparent; +} +::-webkit-scrollbar-corner { + background-color: var(--scrollbar-background-color); } diff --git a/docs/doxygen.svg b/docs/doxygen.svg index d42dad52..79a76354 100644 --- a/docs/doxygen.svg +++ b/docs/doxygen.svg @@ -1,4 +1,6 @@ +