- -( dyne // software :: culture :: events :: planet :: discussion :: museum \\ freaknet )- -
 
Main Page | Modules | Class Hierarchy | Class List | File List | Class Members | File Members

XmlProfile

Detailed Description

The following methods and properties are available to handle an XML profile that represents a configuration tree composed of XmlTag entries


Functions

 XmlProfile::XmlProfile (char *category, char *repository)
 the XmlProfile class constructor

 XmlProfile::~XmlProfile ()
 the XmlProfile class destructor

XmlErr XmlProfile::addRootElement (XmlTag *element)
 add a new root element to the current profile

XmlTag * XmlProfile::getRootElement (char *name)
 get a root element by its name

XmlTag * XmlProfile::getRootElement (int index)
 get a root element by its index

XmlTag * XmlProfile::getElement (char *path)
 get an element inside the configuration profile
  • the path (in the configuration tree) to reach the element. path is just a streing of the form : " RootElement1/ChildElement1/SubChildElement1/RequestedElement " that represent a path of element names to reach the element.


XmlErr XmlProfile::XmlParseBuffer (char *buf)
XmlErr XmlProfile::XmlParseFile (char *path)
XmlErr XmlProfile::update ()
char * XmlProfile::dumpBranch (XmlTag *rTag, unsigned int depth)
char * XmlProfile::dumpXml ()

Function Documentation

XmlErr XmlProfile::addRootElement (  XmlTag *  element  )  [inherited]
 

add a new root element to the current profile

Parameters:
the XmlTag object representing the new element
Returns:
an XmlErr result status. (XML_NOERR if successfull)

Definition at line 289 of file xmlprofile.cpp.

char * XmlProfile::dumpBranch (  XmlTag *  rTag,
unsigned int  depth
)  [inherited]
 

Definition at line 360 of file xmlprofile.cpp.

char * XmlProfile::dumpXml (   )  [inherited]
 

Definition at line 342 of file xmlprofile.cpp.

XmlTag * XmlProfile::getElement (  char *  path  )  [inherited]
 

get an element inside the configuration profile

  • the path (in the configuration tree) to reach the element. path is just a streing of the form : " RootElement1/ChildElement1/SubChildElement1/RequestedElement " that represent a path of element names to reach the element.

Definition at line 316 of file xmlprofile.cpp.

XmlTag * XmlProfile::getRootElement (  int  index  )  [inherited]
 

get a root element by its index

Parameters:
the null terminated string representing the name of the root element we are looking for
Returns:
the XmlTag object representing the selected root element

Definition at line 305 of file xmlprofile.cpp.

XmlTag * XmlProfile::getRootElement (  char *  name  )  [inherited]
 

get a root element by its name

Parameters:
the null terminated string representing the name of the root element
Returns:
the XmlTag object representing the selected root element

Definition at line 296 of file xmlprofile.cpp.

XmlErr XmlProfile::update (   )  [inherited]
 

Definition at line 448 of file xmlprofile.cpp.

XmlErr XmlProfile::XmlParseBuffer (  char *  buf  )  [inherited]
 

Definition at line 155 of file xmlprofile.cpp.

XmlErr XmlProfile::XmlParseFile (  char *  path  )  [inherited]
 

Definition at line 137 of file xmlprofile.cpp.

XmlProfile::XmlProfile (  char *  category,
char *  repository
)  [inherited]
 

the XmlProfile class constructor

Parameters:
category of the new profile handler (used to create de configuration file)
the directory where xml files are stored (to save & load the configuration profile)

Definition at line 45 of file xmlprofile.cpp.

XmlProfile::~XmlProfile (   )  [inherited]
 

the XmlProfile class destructor

Definition at line 55 of file xmlprofile.cpp.