XmlFragment Class Reference

Xml Fragment. More...

#include <yatexml.h>

Inheritance diagram for XmlFragment:

Public Member Functions
	XmlFragment ()
	XmlFragment (const XmlFragment &orig)
virtual	~XmlFragment ()
virtual XmlFragment *	fragment ()
virtual const ObjList &	getChildren () const
virtual XmlSaxParser::Error	addChild (XmlChild *child)
virtual void	reset ()
XmlChild *	pop ()
XmlElement *	popElement ()
virtual XmlChild *	removeChild (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
Public Member Functions inherited from XmlParent
	XmlParent ()
virtual	~XmlParent ()
virtual XmlDocument *	document ()
virtual XmlElement *	element ()
XmlChild *	addChildSafe (XmlChild *child)
bool	hasChildren () const

Static Public Member Functions
static XmlElement *	findElement (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

XmlFragment

(

)

Constructor

XmlFragment

(

const XmlFragment &

orig

)

Copy constructor

Parameters

orig	Original XmlFragment

virtual ~XmlFragment ( )

virtual

Destructor

Member Function Documentation

virtual XmlSaxParser::Error addChild ( XmlChild *  child )

virtual

Append a new xml child to this fragment

Parameters

child

the child to append

Returns

An error code if an error was detected

Implements XmlParent.

virtual void clearChildren ( )

inlinevirtual

Clear the list of children

Reimplemented from XmlParent.

References ObjList::clear().

Referenced by XmlElement::clearChildren().

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

static

Find a completed xml element in a list

Parameters

list	The list to search for the element
name	Optional element tag to match
ns	Optional element namespace to match
noPrefix	True 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 ( )

inlinevirtual

Get an Xml Fragment

Returns

This

Reimplemented from XmlParent.

virtual const ObjList& getChildren ( ) const

inlinevirtual

Get the list of children

Returns

The children list

Reimplemented from XmlParent.

Referenced by XmlElement::getChildren().

XmlChild* pop ( )

inline

Remove the first child from list and returns it

Returns

XmlChild pointer or 0

References ObjList::remove().

XmlElement* popElement

(

)

Remove the first XmlElement from list and returns it if completed

Returns

XmlElement pointer or 0 if no XmlElement is found or the first one is not completed

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

virtual

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

Parameters

child	The child to remove
delObj	True to delete the object

Returns

XmlChild pointer if found and not deleted

Implements XmlParent.

Referenced by XmlElement::pop(), and XmlDocument::removeChild().

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

dump	The string where to append representation
escape	True if the attributes values need to be escaped
indent	Spaces for output
origIndent	Original indent
completeOnly	True to build only if complete
auth	Optional 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
parent	Optional parent element whose tag will be searched in the auth list

---

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

• yatexml.h