class XmlFragment

Xml Fragment. More...

Full nameTelEngine::XmlFragment
Definition#include <libs/yxml/yatexml.h>
InheritsTelEngine::XmlParent [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Public Static Methods


Detailed Description

Xml Fragment a fragment from a Xml document

 XmlFragment ()

XmlFragment

Constructor

 XmlFragment (const XmlFragment& orig)

XmlFragment

Copy constructor

Parameters:
origOriginal XmlFragment

 ~XmlFragment ()

~XmlFragment

[virtual]

Destructor

XmlFragment*  fragment ()

fragment

[virtual]

Get an Xml Fragment

Returns: This

Reimplemented from XmlParent.

const ObjList&  getChildren ()

getChildren

[const virtual]

Get the list of children

Returns: The children list

Reimplemented from XmlParent.

XmlSaxParser::Error  addChild (XmlChild* child)

addChild

[virtual]

Append a new xml child to this fragment

Parameters:
childthe child to append

Returns: An error code if an error was detected

Reimplemented from XmlParent.

void  reset ()

reset

[virtual]

Reset this Xml Fragment

Reimplemented from XmlParent.

inline XmlChild*  pop ()

pop

Remove the first child from list and returns it

Returns: XmlChild pointer or 0

XmlChild*  removeChild (XmlChild* child, bool delObj = true)

removeChild

[virtual]

Remove a child. Reset the parent of not deleted xml element

Parameters:
childThe child to remove
delObjTrue to delete the object

Returns: XmlChild pointer if found and not deleted

Reimplemented from XmlParent.

void  clearChildren ()

clearChildren

[virtual]

Clear the list of children

Reimplemented from XmlParent.

void  toString (String& dump, bool escape = true, const String& indent = String::empty(), const String& origIndent = String::empty(), bool completeOnly = true, const String* auth = 0, const XmlElement* parent = 0)

toString

[const]

Build a String from this XmlFragment

Parameters:
dumpThe string where to append representation
escapeTrue if the attributes values need to be escaped
indentSpaces for output
origIndentOriginal indent
completeOnlyTrue to build only if complete
authOptional list of tag and attribute names to be replaced with '***'. This parameter can be used when the result will be printed to output to avoid printing authentication data to output. The array must end with an empty string
parentOptional parent element whose tag will be searched in the auth list

XmlElement*  findElement (ObjList* list, const String* name, const String* ns)

findElement

[static]

Find a completed xml element in a list

Parameters:
listThe list to search for the element
nameOptional element tag to match
nsOptional element namespace to match

Returns: XmlElement pointer or 0 if not found


Generated by: paulc on bussard on Tue Mar 8 18:42:27 2011, using kdoc 2.0a54.