Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

skAttributeList Class Reference

This class holds a list of attributes - it is used by the Element class. More...

#include <skAttribute.h>

Inheritance diagram for skAttributeList:

skTAList< skAttribute > skAList List of all members.

Public Member Functions

IMPORT_C void setAttribute (const skString &name, const skString &value)
 This sets an attribute in this list.

IMPORT_C skString getAttribute (const skString &name) const
 This returns the value of an attribute.

IMPORT_C skString getAttribute (const skString &name, const skString &default_value) const
 This returns the value of an attribute.

IMPORT_C bool removeAttribute (const skString &name)
 This removes an attribute from the list.

IMPORT_C skAttributefindAttribute (const skString &name) const
 this method finds a named attribute


Detailed Description

This class holds a list of attributes - it is used by the Element class.


Member Function Documentation

IMPORT_C skAttribute* skAttributeList::findAttribute const skString name  )  const
 

this method finds a named attribute

Returns:
the attribute, or 0 if there was no attribute with that name

IMPORT_C skString skAttributeList::getAttribute const skString name,
const skString default_value
const
 

This returns the value of an attribute.

If the attribute does not exist, the default value is returned.

Parameters:
name - the name of the attribute being accessed
default_value - the default value for the attribute
Returns:
the value associated with the name, or a blank string.

IMPORT_C skString skAttributeList::getAttribute const skString name  )  const
 

This returns the value of an attribute.

If the attribute does not exist, a blank string is returned.

Parameters:
name - the name of the attribute being accessed
Returns:
the value associated with the name, or a blank string.

IMPORT_C bool skAttributeList::removeAttribute const skString name  ) 
 

This removes an attribute from the list.

Parameters:
name - the name of the attribute being accessed
Returns:
true if the attribute was removed, false if it was not in the list

IMPORT_C void skAttributeList::setAttribute const skString name,
const skString value
 

This sets an attribute in this list.

The attribute is added, if not already present.

Parameters:
name - the name of the attribute. If one already exists with this name, its value is overwritten.
value - the value for the attribute
Exceptions:
Symbian - a leaving function


The documentation for this class was generated from the following file:
Generated on Fri Dec 17 20:28:26 2004 for Simkin C++ for Symbian by doxygen1.3