PXML Class Reference

#include <pxml.h>

Inheritance diagram for PXML:

List of all members.

Public Member Functions
	PXML (int options=-1, const char *noIndentElements=NULL)
	PXML (const PString &data, int options=-1, const char *noIndentElements=NULL)
	PXML (const PXML &xml)
	~PXML ()
BOOL	IsDirty () const
BOOL	Load (const PString &data, int options=-1)
BOOL	StartAutoReloadURL (const PURL &url, const PTimeInterval &timeout, const PTimeInterval &refreshTime, int _options=-1)
BOOL	StopAutoReloadURL ()
PString	GetAutoReloadStatus ()
BOOL	AutoLoadURL ()
virtual void	OnAutoLoad (BOOL ok)
BOOL	LoadURL (const PURL &url)
BOOL	LoadURL (const PURL &url, const PTimeInterval &timeout, int _options=-1)
BOOL	LoadFile (const PFilePath &fn, int options=-1)
virtual void	OnLoaded ()
BOOL	Save (int options=-1)
BOOL	Save (PString &data, int options=-1)
BOOL	SaveFile (const PFilePath &fn, int options=-1)
void	RemoveAll ()
BOOL	IsNoIndentElement (const PString &elementName) const
void	PrintOn (ostream &strm) const
PXMLElement *	GetElement (const PCaselessString &name, PINDEX idx=0) const
PXMLElement *	GetElement (PINDEX idx) const
PINDEX	GetNumElements () const
PXMLElement *	GetRootElement () const
PXMLElement *	SetRootElement (PXMLElement *p)
PXMLElement *	SetRootElement (const PString &documentType)
BOOL	RemoveElement (PINDEX idx)
PCaselessString	GetDocumentType () const
PString	GetErrorString () const
PINDEX	GetErrorColumn () const
PINDEX	GetErrorLine () const
PString	GetDocType () const
void	SetDocType (const PString &v)
PMutex &	GetMutex ()
	PDECLARE_NOTIFIER (PTimer, PXML, AutoReloadTimeout)
	PDECLARE_NOTIFIER (PThread, PXML, AutoReloadThread)
Static Public Member Functions
static PString	CreateStartTag (const PString &text)
static PString	CreateEndTag (const PString &text)
static PString	CreateTagNoData (const PString &text)
static PString	CreateTag (const PString &text, const PString &data)
Protected Member Functions
void	Construct (int options, const char *noIndentElements)
Protected Attributes
PXMLElement *	rootElement
PMutex	rootMutex
BOOL	loadFromFile
PFilePath	loadFilename
PString	version
PString	encoding
int	standAlone
PTimer	autoLoadTimer
PURL	autoloadURL
PTimeInterval	autoLoadWaitTime
PMutex	autoLoadMutex
PString	autoLoadError
PString	errorString
PINDEX	errorCol
PINDEX	errorLine
PSortedStringList	noIndentElements
PString	docType

---

Constructor & Destructor Documentation

PXML::PXML	(	int	options = -1,
		const char *	noIndentElements = NULL
	)

PXML::PXML	(	const PString &	data,
		int	options = -1,
		const char *	noIndentElements = NULL
	)

PXML::PXML

(

const PXML &

xml

)

PXML::~PXML

(

)

---

Member Function Documentation

BOOL PXML::IsDirty

(

)

const

BOOL PXML::Load	(	const PString &	data,
		int	options = -1
	)

BOOL PXML::StartAutoReloadURL	(	const PURL &	url,
		const PTimeInterval &	timeout,
		const PTimeInterval &	refreshTime,
		int	_options = -1
	)

BOOL PXML::StopAutoReloadURL

(

)

PString PXML::GetAutoReloadStatus

(

)

[inline]

BOOL PXML::AutoLoadURL

(

)

virtual void PXML::OnAutoLoad

(

BOOL

ok

)

[virtual]

BOOL PXML::LoadURL

(

const PURL &

url

)

BOOL PXML::LoadURL	(	const PURL &	url,
		const PTimeInterval &	timeout,
		int	_options = -1
	)

BOOL PXML::LoadFile	(	const PFilePath &	fn,
		int	options = -1
	)

virtual void PXML::OnLoaded

(

)

[inline, virtual]

BOOL PXML::Save

(

int

options = -1

)

BOOL PXML::Save	(	PString &	data,
		int	options = -1
	)

BOOL PXML::SaveFile	(	const PFilePath &	fn,
		int	options = -1
	)

void PXML::RemoveAll

(

)

BOOL PXML::IsNoIndentElement

(

const PString &

elementName

)

const [virtual]

Reimplemented from PXMLBase.

void PXML::PrintOn

(

ostream &

strm

)

const [virtual]

Output the contents of the object to the stream. The exact output is dependent on the exact semantics of the descendent class. This is primarily used by the standard operator<<# function.

The default behaviour is to print the class name.

Reimplemented from PObject.

PXMLElement* PXML::GetElement	(	const PCaselessString &	name,
		PINDEX	idx = 0
	)			const

PXMLElement* PXML::GetElement

(

PINDEX

idx

)

const

PINDEX PXML::GetNumElements

(

)

const

PXMLElement* PXML::GetRootElement

(

)

const [inline]

PXMLElement* PXML::SetRootElement

(

PXMLElement *

p

)

PXMLElement* PXML::SetRootElement

(

const PString &

documentType

)

BOOL PXML::RemoveElement

(

PINDEX

idx

)

PCaselessString PXML::GetDocumentType

(

)

const

PString PXML::GetErrorString

(

)

const [inline]

PINDEX PXML::GetErrorColumn

(

)

const [inline]

PINDEX PXML::GetErrorLine

(

)

const [inline]

PString PXML::GetDocType

(

)

const [inline]

void PXML::SetDocType

(

const PString &

v

)

[inline]

PMutex& PXML::GetMutex

(

)

[inline]

PXML::PDECLARE_NOTIFIER	(	PTimer	,
		PXML	,
		AutoReloadTimeout
	)

PXML::PDECLARE_NOTIFIER	(	PThread	,
		PXML	,
		AutoReloadThread
	)

static PString PXML::CreateStartTag

(

const PString &

text

)

[static]

static PString PXML::CreateEndTag

(

const PString &

text

)

[static]

static PString PXML::CreateTagNoData

(

const PString &

text

)

[static]

static PString PXML::CreateTag	(	const PString &	text,
		const PString &	data
	)			[static]

void PXML::Construct	(	int	options,
		const char *	noIndentElements
	)			[protected]

---

Member Data Documentation

PXMLElement* PXML::rootElement [protected]

PMutex PXML::rootMutex [protected]

BOOL PXML::loadFromFile [protected]

PFilePath PXML::loadFilename [protected]

PString PXML::version [protected]

PString PXML::encoding [protected]

int PXML::standAlone [protected]

PTimer PXML::autoLoadTimer [protected]

PURL PXML::autoloadURL [protected]

PTimeInterval PXML::autoLoadWaitTime [protected]

PMutex PXML::autoLoadMutex [protected]

PString PXML::autoLoadError [protected]

PString PXML::errorString [protected]

PINDEX PXML::errorCol [protected]

PINDEX PXML::errorLine [protected]

PSortedStringList PXML::noIndentElements [protected]

PString PXML::docType [protected]

---

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

• pxml.h

---