PTLib  Version 2.18.8
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
PXMLRootElement Class Reference

#include <pxml.h>

Inheritance diagram for PXMLRootElement:
Collaboration diagram for PXMLRootElement:

Public Member Functions

 PXMLRootElement (PXML &doc, const char *name=NULL)
 
 PXMLRootElement (PXML &doc, const PXMLElement &copy)
 
virtual PObjectClone ()
 
virtual PXMLElementCreateElement (const PCaselessString &name, const char *data=NULL)
 
- Public Member Functions inherited from PXMLElement
 PXMLElement (const char *name=NULL, const char *data=NULL)
 
virtual PINDEX GetObjectCount () const
 
PBoolean IsElement () const
 
void PrintOn (ostream &strm) const
 Output the contents of the object to the stream. More...
 
void Output (ostream &strm, const PXMLBase &xml, int indent) const
 
const PCaselessStringGetName () const
 
void SetName (const PString &v)
 
PCaselessString GetPathName () const
 Get the completely qualified name for the element inside the XML tree, for example "root:trunk:branch:subbranch:leaf". More...
 
PINDEX GetSize () const
 
PINDEX FindObject (const PXMLObject *ptr) const
 
bool HasSubObjects () const
 
virtual PXMLObjectAddSubObject (PXMLObject *elem, bool dirty=true)
 
bool RemoveSubObject (PINDEX idx, bool dispose=true)
 
PXMLElementAddElement (const char *name)
 
PXMLElementAddElement (const PString &name, const PString &data)
 
PXMLElementAddElement (const PString &name, const PString &attrName, const PString &attrVal)
 
void SetAttribute (const PCaselessString &key, const PString &value, bool setDirty=true)
 
PString GetAttribute (const PCaselessString &key) const
 
bool HasAttribute (const PCaselessString &key) const
 
bool HasAttributes () const
 
const PStringToStringGetAttributes () const
 
PXMLObjectGetSubObject (PINDEX idx) const
 
PXMLElementGetElement (PINDEX idx=0) const
 
PXMLElementGetElement (const PCaselessString &name, PINDEX idx=0) const
 
PXMLElementGetElement (const PCaselessString &name, const PCaselessString &attr, const PString &attrval) const
 
template<class T >
T * GetElementAs (PINDEX idx=0) const
 
template<class T >
T * GetElementAs (const PCaselessString &name, PINDEX idx=0) const
 
template<class T >
T * GetElementAs (const PCaselessString &name, const PCaselessString &attr, const PString &attrval) const
 
PString GetData (bool trim=true) const
 
PXMLObjectArray GetSubObjects () const
 
void SetData (const PString &data)
 
virtual PXMLDataAddData (const PString &data)
 
virtual void EndData ()
 
PXMLObjectClone () const
 Create a copy of the class on the heap. More...
 
void AddNamespace (const PString &prefix, const PString &uri)
 
void RemoveNamespace (const PString &prefix)
 
bool GetDefaultNamespace (PCaselessString &str) const
 
bool GetNamespace (const PCaselessString &prefix, PCaselessString &str) const
 
PCaselessString PrependNamespace (const PCaselessString &name) const
 
bool GetURIForNamespace (const PCaselessString &prefix, PCaselessString &uri) const
 
- Public Member Functions inherited from PXMLObject
PXMLElementGetParent () const
 
bool SetParent (PXMLElement *parent)
 
PXMLObjectGetNextObject () const
 
PString AsString () const
 
void SetDirty ()
 
bool IsDirty () const
 
void GetFilePosition (unsigned &col, unsigned &line) const
 
void SetFilePosition (unsigned col, unsigned line)
 
- Public Member Functions inherited from PObject
__inline unsigned GetTraceContextIdentifier () const
 Get PTRACE context identifier. More...
 
__inline void SetTraceContextIdentifier (unsigned id)
 
__inline void SetTraceContextIdentifier (const PObject &obj)
 
__inline void SetTraceContextIdentifier (const PObject *obj)
 
__inline void CopyTraceContextIdentifier (PObject &obj) const
 
__inline void CopyTraceContextIdentifier (PObject *obj) const
 
virtual ~PObject ()
 
__inline const char * GetClass () const
 
__inline bool IsClass (const char *name) const
 
__inline const PObjectPTraceObjectInstance () const
 
template<class CLS >
CLS * CloneAs () const
 As for Clone() but converts to specified type. More...
 
virtual PINDEX HashFunction () const
 This function yields a hash value required by the PDictionary class. More...
 
virtual Comparison Compare (const PObject &obj) const
 Compare the two objects and return their relative rank. More...
 
virtual Comparison CompareObjectMemoryDirect (const PObject &obj) const
 Determine the byte wise comparison of two objects. More...
 
bool operator== (const PObject &obj) const
 Compare the two objects. More...
 
bool operator!= (const PObject &obj) const
 Compare the two objects. More...
 
bool operator< (const PObject &obj) const
 Compare the two objects. More...
 
bool operator> (const PObject &obj) const
 Compare the two objects. More...
 
bool operator<= (const PObject &obj) const
 Compare the two objects. More...
 
bool operator>= (const PObject &obj) const
 Compare the two objects. More...
 
virtual void ReadFrom (istream &strm)
 Input the contents of the object from the stream. More...
 

Protected Attributes

PXMLm_document
 
- Protected Attributes inherited from PXMLElement
PCaselessString m_name
 
PStringToString m_attributes
 
PStringToString m_nameSpaces
 
PCaselessString m_defaultNamespace
 
PArray< PXMLObjectm_subObjects
 
- Protected Attributes inherited from PXMLObject
PXMLElementm_parent
 
bool m_dirty
 
unsigned m_lineNumber
 
unsigned m_column
 
- Protected Attributes inherited from PObject
unsigned m_traceContextIdentifier
 

Additional Inherited Members

- Public Types inherited from PObject
enum  Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
 Result of the comparison operation performed by the Compare() function. More...
 
- Static Public Member Functions inherited from PObject
static __inline void CopyTraceContextIdentifier (PObject &to, const PObject &from)
 
static __inline void CopyTraceContextIdentifier (PObject &to, const PObject *from)
 
static __inline void CopyTraceContextIdentifier (PObject *to, const PObject &from)
 
static __inline void CopyTraceContextIdentifier (PObject *to, const PObject *from)
 
static __inline const char * Class ()
 
static __inline const PObjectPTraceObjectInstance (const char *)
 
static __inline const PObjectPTraceObjectInstance (const PObject *obj)
 
template<typename T >
static Comparison Compare2 (T v1, T v2)
 Compare two types, returning Comparison type. More...
 
static Comparison InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
 Internal function caled from CompareObjectMemoryDirect() More...
 
- Protected Member Functions inherited from PXMLElement
 PXMLElement (const PXMLElement &copy)
 
- Protected Member Functions inherited from PXMLObject
 PXMLObject ()
 
 P_REMOVE_VIRTUAL (PXMLObject *, Clone(PXMLElement *) const, 0)
 
- Protected Member Functions inherited from PObject
 PObject ()
 Constructor for PObject, made protected so cannot ever create one on its own. More...
 

Constructor & Destructor Documentation

PXMLRootElement::PXMLRootElement ( PXML doc,
const char *  name = NULL 
)
inline
PXMLRootElement::PXMLRootElement ( PXML doc,
const PXMLElement copy 
)
inline

Member Function Documentation

virtual PObject* PXMLRootElement::Clone ( )
virtual
virtual PXMLElement* PXMLRootElement::CreateElement ( const PCaselessString name,
const char *  data = NULL 
)
virtual

Reimplemented from PXMLElement.

Member Data Documentation

PXML& PXMLRootElement::m_document
protected

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