Yate
Public Member Functions | Static Public Member Functions
XmlFragment Class Reference

Xml Fragment. More...

#include <yatexml.h>

Inheritance diagram for XmlFragment:
XmlParent

List of all members.

Public Member Functions

 XmlFragment ()
 XmlFragment (const XmlFragment &orig)
virtual ~XmlFragment ()
virtual XmlFragmentfragment ()
virtual const ObjListgetChildren () const
virtual XmlSaxParser::Error addChild (XmlChild *child)
virtual void reset ()
XmlChildpop ()
virtual XmlChildremoveChild (XmlChild *child, bool delObj=true)
virtual void clearChildren ()
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) const

Static Public Member Functions

static XmlElementfindElement (ObjList *list, const String *name, const String *ns, bool noPrefix=true)

Detailed Description

Xml Fragment.

Xml Fragment a fragment from a Xml document


Constructor & Destructor Documentation

Constructor

XmlFragment ( const XmlFragment orig)

Copy constructor

Parameters:
origOriginal XmlFragment
virtual ~XmlFragment ( ) [virtual]

Destructor


Member Function Documentation

virtual XmlSaxParser::Error addChild ( XmlChild child) [virtual]

Append a new xml child to this fragment

Parameters:
childthe child to append
Returns:
An error code if an error was detected

Implements XmlParent.

virtual void clearChildren ( ) [inline, virtual]

Clear the list of children

Reimplemented from XmlParent.

static XmlElement* findElement ( ObjList list,
const String name,
const String ns,
bool  noPrefix = true 
) [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
noPrefixTrue to compare the tag without namespace prefix, false to include namespace prefix when comparing the given tag. This parameter is ignored if name is 0 or ns is not 0
Returns:
XmlElement pointer or 0 if not found

Referenced by XmlElement::findFirstChild(), and XmlElement::findNextChild().

virtual XmlFragment* fragment ( ) [inline, virtual]

Get an Xml Fragment

Returns:
This

Reimplemented from XmlParent.

virtual const ObjList& getChildren ( ) const [inline, virtual]

Get the list of children

Returns:
The children list

Reimplemented from XmlParent.

XmlChild* pop ( ) [inline]

Remove the first child from list and returns it

Returns:
XmlChild pointer or 0
virtual XmlChild* removeChild ( XmlChild child,
bool  delObj = true 
) [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

Implements XmlParent.

virtual void reset ( ) [virtual]

Reset this Xml Fragment

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 
) 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

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