PXML Class Reference

#include <pxml.h>

Inheritance diagram for PXML:

PXMLBase PObject PXMLRPCBlock PXMLSettings 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
PXMLElementGetElement (const PCaselessString &name, PINDEX idx=0) const
PXMLElementGetElement (PINDEX idx) const
PINDEX GetNumElements () const
PXMLElementGetRootElement () const
PXMLElementSetRootElement (PXMLElement *p)
PXMLElementSetRootElement (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)
PMutexGetMutex ()
 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

PXMLElementrootElement
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::AutoLoadURL  ) 
 

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

static PString PXML::CreateEndTag const PString text  )  [static]
 

static PString PXML::CreateStartTag const PString text  )  [static]
 

static PString PXML::CreateTag const PString text,
const PString data
[static]
 

static PString PXML::CreateTagNoData const PString text  )  [static]
 

PString PXML::GetAutoReloadStatus  )  [inline]
 

PString PXML::GetDocType  )  const [inline]
 

PCaselessString PXML::GetDocumentType  )  const
 

PXMLElement* PXML::GetElement PINDEX  idx  )  const
 

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

PINDEX PXML::GetErrorColumn  )  const [inline]
 

PINDEX PXML::GetErrorLine  )  const [inline]
 

PString PXML::GetErrorString  )  const [inline]
 

PMutex& PXML::GetMutex  )  [inline]
 

PINDEX PXML::GetNumElements  )  const
 

PXMLElement* PXML::GetRootElement  )  const [inline]
 

BOOL PXML::IsDirty  )  const
 

BOOL PXML::IsNoIndentElement const PString elementName  )  const [virtual]
 

Reimplemented from PXMLBase.

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

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

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

BOOL PXML::LoadURL const PURL url  ) 
 

virtual void PXML::OnAutoLoad BOOL  ok  )  [virtual]
 

virtual void PXML::OnLoaded  )  [inline, virtual]
 

PXML::PDECLARE_NOTIFIER PThread  ,
PXML  ,
AutoReloadThread 
 

PXML::PDECLARE_NOTIFIER PTimer  ,
PXML  ,
AutoReloadTimeout 
 

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.

void PXML::RemoveAll  ) 
 

BOOL PXML::RemoveElement PINDEX  idx  ) 
 

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

BOOL PXML::Save int  options = -1  ) 
 

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

void PXML::SetDocType const PString v  )  [inline]
 

PXMLElement* PXML::SetRootElement const PString documentType  ) 
 

PXMLElement* PXML::SetRootElement PXMLElement p  ) 
 

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

BOOL PXML::StopAutoReloadURL  ) 
 


Member Data Documentation

PString PXML::autoLoadError [protected]
 

PMutex PXML::autoLoadMutex [protected]
 

PTimer PXML::autoLoadTimer [protected]
 

PURL PXML::autoloadURL [protected]
 

PTimeInterval PXML::autoLoadWaitTime [protected]
 

PString PXML::docType [protected]
 

PString PXML::encoding [protected]
 

PINDEX PXML::errorCol [protected]
 

PINDEX PXML::errorLine [protected]
 

PString PXML::errorString [protected]
 

PFilePath PXML::loadFilename [protected]
 

BOOL PXML::loadFromFile [protected]
 

PSortedStringList PXML::noIndentElements [protected]
 

PXMLElement* PXML::rootElement [protected]
 

PMutex PXML::rootMutex [protected]
 

int PXML::standAlone [protected]
 

PString PXML::version [protected]
 


The documentation for this class was generated from the following file:
Generated on Tue Mar 14 16:50:14 2006 for PWLib by  doxygen 1.4.6