From 618dfb51d93898632830f1b87443d3f748780871 Mon Sep 17 00:00:00 2001 From: Daniel Wilhelm Date: Fri, 18 Apr 2014 17:05:53 +0200 Subject: 3.5 --- shared/tinyxml/docs/classTiXmlBase.html | 276 ++++++++++++++++---------------- 1 file changed, 136 insertions(+), 140 deletions(-) (limited to 'shared/tinyxml/docs/classTiXmlBase.html') diff --git a/shared/tinyxml/docs/classTiXmlBase.html b/shared/tinyxml/docs/classTiXmlBase.html index bdb63893..4d1ba67e 100644 --- a/shared/tinyxml/docs/classTiXmlBase.html +++ b/shared/tinyxml/docs/classTiXmlBase.html @@ -1,98 +1,99 @@ - - + + + + TinyXml: TiXmlBase Class Reference - - - - -
-
-
-
-

TiXmlBase Class Reference

TiXmlBase is a base class for every class in TinyXml. -More... -

-#include <tinyxml.h> -

-

Inheritance diagram for TiXmlBase: -

- -TiXmlAttribute -TiXmlNode -TiXmlComment -TiXmlDeclaration -TiXmlDocument -TiXmlElement -TiXmlText -TiXmlUnknown + + + + + + +
+

TiXmlBase Class Reference

+

TiXmlBase is a base class for every class in TinyXml. +More...

+ +

#include <tinyxml.h>

+
+Inheritance diagram for TiXmlBase:
+
+
+ + +TiXmlAttribute +TiXmlNode +TiXmlComment +TiXmlDeclaration +TiXmlDocument +TiXmlElement +TiXmlText +TiXmlUnknown -List of all members. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + +

List of all members.

+

Public Member Functions

virtual void Print (FILE *cfile, int depth) const =0
 All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.
int Row () const
 Return the position, in the original source file, of this node or attribute.
-int Column () const
 See Row().
-void SetUserData (void *user)
 Set a pointer to arbitrary user data.
-void * GetUserData ()
 Get a pointer to arbitrary user data.
-const void * GetUserData () const
 Get a pointer to arbitrary user data.

Static Public Member Functions

static void SetCondenseWhiteSpace (bool condense)
 The world does not agree on whether white space should be kept or not.
-static bool IsWhiteSpaceCondensed ()
 Return the current white space setting.
static void EncodeString (const TIXML_STRING &str, TIXML_STRING *out)
 Expands entities in a string.

Protected Attributes

-void * userData
 Field containing a generic user pointer.

Friends

-class TiXmlNode
-class TiXmlElement
-class TiXmlDocument
+ + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions

virtual void Print (FILE *cfile, int depth) const =0
 All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.
int Row () const
 Return the position, in the original source file, of this node or attribute.
+int Column () const
 See Row().
+void SetUserData (void *user)
 Set a pointer to arbitrary user data.
+void * GetUserData ()
 Get a pointer to arbitrary user data.
+const void * GetUserData () const
 Get a pointer to arbitrary user data.

Static Public Member Functions

static void SetCondenseWhiteSpace (bool condense)
 The world does not agree on whether white space should be kept or not.
+static bool IsWhiteSpaceCondensed ()
 Return the current white space setting.
static void EncodeString (const TIXML_STRING &str, TIXML_STRING *out)
 Expands entities in a string.

Protected Attributes

+void * userData
 Field containing a generic user pointer.

Friends

+class TiXmlNode
+class TiXmlElement
+class TiXmlDocument
-

Detailed Description

-TiXmlBase is a base class for every class in TinyXml. -

-It does little except to establish that TinyXml classes can be printed and provide some utility functions.

-In XML, the document and elements can contain other elements and other types of nodes.

-

	A Document can contain:	Element	(container or leaf)
+
Detailed Description

+
TiXmlBase is a base class for every class in TinyXml. 

+
It does little except to establish that TinyXml classes can be printed and provide some utility functions.

+
In XML, the document and elements can contain other elements and other types of nodes.

+
+	A Document can contain:	Element	(container or leaf)
 							Comment (leaf)
 							Unknown (leaf)
 							Declaration( leaf )
@@ -104,15 +105,13 @@ In XML, the document and elements can contain other elements and other types of
 							Unknown (leaf)
 
 	A Decleration contains: Attributes (not on tree)
-	
 
-

-
Member Function Documentation

-
+

Member Function Documentation

+
- + @@ -126,24 +125,23 @@ In XML, the document and elements can contain other elements and other types of - +
static void TiXmlBase::EncodeString static void TiXmlBase::EncodeString ( const TIXML_STRING &  str,
) [static] [static]
-

-Expands entities in a string. -

-Note this should not contian the tag's '<', '>', etc, or they will be transformed into entities! +

Expands entities in a string.

+

Note this should not contian the tag's '<', '>', etc, or they will be transformed into entities!

+
-

- +

+
- + @@ -157,74 +155,72 @@ Note this should not contian the tag's '<', '>', etc, or they will be tran - +
virtual void TiXmlBase::Print virtual void TiXmlBase::Print ( FILE *  cfile,
) const [pure virtual] const [pure virtual]
-

-All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode. -

-) Either or both cfile and str can be null.

-This is a formatted print, and will insert tabs and newlines.

-(For an unformatted stream, use the << operator.) -

-Implemented in TiXmlAttribute, TiXmlElement, TiXmlComment, TiXmlText, TiXmlDeclaration, TiXmlUnknown, and TiXmlDocument. +

All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.

+

) Either or both cfile and str can be null.

+

This is a formatted print, and will insert tabs and newlines.

+

(For an unformatted stream, use the << operator.)

+ +

Implemented in TiXmlAttribute, TiXmlElement, TiXmlComment, TiXmlText, TiXmlDeclaration, TiXmlUnknown, and TiXmlDocument.

+
-

- +

+
- + - + - +
int TiXmlBase::Row int TiXmlBase::Row (  )  const [inline] const [inline]
-

-Return the position, in the original source file, of this node or attribute. -

-The row and column are 1-based. (That is the first row and first column is 1,1). If the returns values are 0 or less, then the parser does not have a row and column value.

-Generally, the row and column value will be set when the TiXmlDocument::Load(), TiXmlDocument::LoadFile(), or any TiXmlNode::Parse() is called. It will NOT be set when the DOM was created from operator>>.

-The values reflect the initial load. Once the DOM is modified programmatically (by adding or changing nodes and attributes) the new values will NOT update to reflect changes in the document.

-There is a minor performance cost to computing the row and column. Computation can be disabled if TiXmlDocument::SetTabSize() is called with 0 as the value.

-

See also:
TiXmlDocument::SetTabSize()
+

Return the position, in the original source file, of this node or attribute.

+

The row and column are 1-based. (That is the first row and first column is 1,1). If the returns values are 0 or less, then the parser does not have a row and column value.

+

Generally, the row and column value will be set when the TiXmlDocument::Load(), TiXmlDocument::LoadFile(), or any TiXmlNode::Parse() is called. It will NOT be set when the DOM was created from operator>>.

+

The values reflect the initial load. Once the DOM is modified programmatically (by adding or changing nodes and attributes) the new values will NOT update to reflect changes in the document.

+

There is a minor performance cost to computing the row and column. Computation can be disabled if TiXmlDocument::SetTabSize() is called with 0 as the value.

+
See also:
TiXmlDocument::SetTabSize()
-

- +

+
- + - + - +
static void TiXmlBase::SetCondenseWhiteSpace static void TiXmlBase::SetCondenseWhiteSpace ( bool  condense condense  )  [inline, static] [inline, static]
-

-The world does not agree on whether white space should be kept or not. -

-In order to make everyone happy, these global, static functions are provided to set whether or not TinyXml will condense all white space into a single space or not. The default is to condense. Note changing this value is not thread safe. +

The world does not agree on whether white space should be kept or not.

+

In order to make everyone happy, these global, static functions are provided to set whether or not TinyXml will condense all white space into a single space or not. The default is to condense. Note changing this value is not thread safe.

+ +
+
+
The documentation for this class was generated from the following file: -

-

The documentation for this class was generated from the following file: -
Generated on Sun May 6 15:41:23 2007 for TinyXml by  +
Generated by  -doxygen 1.4.7
+doxygen 1.6.2
-- cgit