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

XmlTag

Detailed Description

The following methods and properties are available to handle an XML element that represents a configuration entry


Functions

 XmlTag::XmlTag (const char *name, XmlTag *parentEntry)
 the XmlTag class constructor

 XmlTag::XmlTag (const char *name, char *val, XmlTag *parentEntry)
 the XmlTag class alternative constructor. This constructor let you specify the tag value directly, without having to call the value(char *val) method later on to set tha element value

 XmlTag::~XmlTag ()
 the XmlTag class destructor

char * XmlTag::path ()
 get the path of an element

char * XmlTag::name ()
 get the name of an element

XmlTag * XmlTag::parent ()
 get the parent element

char * XmlTag::value ()
 get the element value

XmlErr XmlTag::value (char *val)
 set the element value

XmlErr XmlTag::addChild (XmlTag *child)
 add a new child to the current XmlTag element

int XmlTag::numChildren ()
 get the number of children

XmlTag * XmlTag::getChild (int index)
 get a child object

XmlTag * XmlTag::getChild (char *name)
 get a child object

XmlTagAttribute * XmlTag::getAttribute (int index)
 get an attribute by index

XmlTagAttribute * XmlTag::getAttribute (char *name)
 get an attribute by name

XmlErr XmlTag::addAttribute (char *attrName, char *attrValue)
 add a new attribute

int XmlTag::numAttributes ()
 get the number of element's attributes


Variables

Linklist * XmlTag::children
 linked list containing element's children

Linklist * XmlTag::attributes
 linked list containing element's attributes

Function Documentation

XmlErr XmlTag::addAttribute (  char *  attrName,
char *  attrValue
)  [inherited]
 

add a new attribute

Parameters:
the attribute name
the attribute value
Returns:
an XmlErr error status. XML_NOERR is returned if the new attribute have been added successfully

Definition at line 602 of file xmlprofile.cpp.

XmlErr XmlTag::addChild (  XmlTag *  child  )  [inherited]
 

add a new child to the current XmlTag element

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

Definition at line 576 of file xmlprofile.cpp.

XmlTagAttribute * XmlTag::getAttribute (  char *  name  )  [inherited]
 

get an attribute by name

Parameters:
the attribute name
Returns:
the selected attribute (if present) or NULL if no such attribute

Definition at line 621 of file xmlprofile.cpp.

XmlTagAttribute * XmlTag::getAttribute (  int  index  )  [inherited]
 

get an attribute by index

Parameters:
the attribute index
Returns:
the selected attribute (if present) or NULL if no such attribute

Definition at line 612 of file xmlprofile.cpp.

XmlTag * XmlTag::getChild (  char *  name  )  [inherited]
 

get a child object

Parameters:
the child name
Returns:
the selected child object (if present) or NULL if no such child

Definition at line 593 of file xmlprofile.cpp.

XmlTag * XmlTag::getChild (  int  index  )  [inherited]
 

get a child object

Parameters:
the child index
Returns:
the selectef child object (if present) or NULL if no such child

Definition at line 587 of file xmlprofile.cpp.

char * XmlTag::name (   )  [inherited]
 

get the name of an element

Returns:
the element name

Definition at line 556 of file xmlprofile.cpp.

int XmlTag::numAttributes (   )  [inherited]
 

get the number of element's attributes

Returns:
the number of element's attributes

Definition at line 630 of file xmlprofile.cpp.

XmlErr XmlTag::numChildren (   )  [inherited]
 

get the number of children

Returns:
the number of childer

Definition at line 583 of file xmlprofile.cpp.

XmlTag * XmlTag::parent (   )  [inherited]
 

get the parent element

Returns:
the parent element (if present) or NULL if this is a root element

Definition at line 564 of file xmlprofile.cpp.

char * XmlTag::path (   )  [inherited]
 

get the path of an element

Returns:
the path as a string of the form : //

Definition at line 552 of file xmlprofile.cpp.

XmlErr XmlTag::value (  char *  val  )  [inherited]
 

set the element value

Parameters:
val the new value
Returns:
an XmlErr result status. (XML_NOERR if successfull)

Definition at line 568 of file xmlprofile.cpp.

char * XmlTag::value (   )  [inherited]
 

get the element value

Returns:
the element value

Definition at line 560 of file xmlprofile.cpp.

XmlTag::XmlTag (  const char *  name,
char *  val,
XmlTag *  parentEntry
)  [inherited]
 

the XmlTag class alternative constructor. This constructor let you specify the tag value directly, without having to call the value(char *val) method later on to set tha element value

Parameters:
name is the name of the element
val is the element value
parentEntry is the parent xml element (if present)

Definition at line 518 of file xmlprofile.cpp.

XmlTag::XmlTag (  const char *  name,
XmlTag *  parentEntry
)  [inherited]
 

the XmlTag class constructor

Parameters:
name is the name of the element
parentEntry is the parent xml element (if present)

Definition at line 495 of file xmlprofile.cpp.

XmlTag::~XmlTag (   )  [inherited]
 

the XmlTag class destructor

Definition at line 523 of file xmlprofile.cpp.

Variable Documentation

Linklist* XmlTag::attributes [inherited]
 

linked list containing element's attributes

Definition at line 179 of file xmlprofile.h.

Linklist* XmlTag::children [inherited]
 

linked list containing element's children

Definition at line 178 of file xmlprofile.h.