CrystalSpace

Public API Reference

csDocumentNodeCommon Class Reference

Partial iDocumentNode implementation with commonly duplicated logic. More...

#include <csutil/documentcommon.h>

Inheritance diagram for csDocumentNodeCommon:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 csDocumentNodeCommon ()
csRef< iDocumentAttributeGetAttribute (const char *)
 Dummy implementation.
virtual csRef< iDocumentAttributeIteratorGetAttributes ()
 Return empty iterator.
virtual csRef< iDocumentNodeGetNode (const char *)
 Dummy implementation.
virtual csRef< iDocumentNodeIteratorGetNodes (const char *value)
 Return iterator wrapping around the one returned by GetNodes() and filtering for nodes with a value of value.
virtual csRef< iDocumentNodeIteratorGetNodes ()
 Return empty iterator.
virtual const char * GetAttributeValue (const char *name)
 Returns value of an attribute.
virtual bool GetAttributeValueAsBool (const char *name, bool defaultvalue=false)
 Returns value of an attribute.
virtual float GetAttributeValueAsFloat (const char *name)
 Returns value of an attribute.
virtual int GetAttributeValueAsInt (const char *name)
 Returns value of an attribute.
virtual const char * GetContentsValue ()
 Returns value of first child text node.
virtual float GetContentsValueAsFloat ()
 Returns value of first child text node.
virtual int GetContentsValueAsInt ()
 Returns value of first child text node.
virtual void SetAttributeAsFloat (const char *name, float value)
 Change or add an attribute to a string representation of a float.
virtual void SetAttributeAsInt (const char *name, int value)
 Converts 'value' to a string and calls SetAttribute() with it.
virtual void SetValueAsFloat (float value)
 Set value to the string representation of a float.
virtual void SetValueAsInt (int value)
 Converts 'value' to a string and calls SetValue() with it.

Detailed Description

Partial iDocumentNode implementation with commonly duplicated logic.

Definition at line 67 of file documentcommon.h.


Member Function Documentation

csRef<iDocumentAttribute> csDocumentNodeCommon::GetAttribute ( const char *   )  [inline, virtual]

Dummy implementation.

Implements iDocumentNode.

Definition at line 108 of file documentcommon.h.

virtual csRef<iDocumentAttributeIterator> csDocumentNodeCommon::GetAttributes (  )  [inline, virtual]

Return empty iterator.

Implements iDocumentNode.

Definition at line 101 of file documentcommon.h.

virtual const char* csDocumentNodeCommon::GetAttributeValue ( const char *  name  )  [virtual]

Returns value of an attribute.

Implements iDocumentNode.

virtual bool csDocumentNodeCommon::GetAttributeValueAsBool ( const char *  name,
bool  defaultvalue = false 
) [virtual]

Returns value of an attribute.

Implements iDocumentNode.

virtual float csDocumentNodeCommon::GetAttributeValueAsFloat ( const char *  name  )  [virtual]

Returns value of an attribute.

Implements iDocumentNode.

virtual int csDocumentNodeCommon::GetAttributeValueAsInt ( const char *  name  )  [virtual]

Returns value of an attribute.

Implements iDocumentNode.

virtual const char* csDocumentNodeCommon::GetContentsValue (  )  [virtual]

Returns value of first child text node.

Converts from a string if necessary.

Implements iDocumentNode.

virtual float csDocumentNodeCommon::GetContentsValueAsFloat (  )  [virtual]

Returns value of first child text node.

Converts from a string if necessary.

Implements iDocumentNode.

virtual int csDocumentNodeCommon::GetContentsValueAsInt (  )  [virtual]

Returns value of first child text node.

Converts from a string if necessary.

Implements iDocumentNode.

virtual csRef<iDocumentNode> csDocumentNodeCommon::GetNode ( const char *   )  [inline, virtual]

Dummy implementation.

Implements iDocumentNode.

Definition at line 87 of file documentcommon.h.

virtual csRef<iDocumentNodeIterator> csDocumentNodeCommon::GetNodes ( const char *  value  )  [virtual]

Return iterator wrapping around the one returned by GetNodes() and filtering for nodes with a value of value.

Implements iDocumentNode.

virtual csRef<iDocumentNodeIterator> csDocumentNodeCommon::GetNodes (  )  [inline, virtual]

Return empty iterator.

Implements iDocumentNode.

Definition at line 79 of file documentcommon.h.

virtual void csDocumentNodeCommon::SetAttributeAsFloat ( const char *  name,
float  value 
) [virtual]

Change or add an attribute to a string representation of a float.

Implements iDocumentNode.

Reimplemented in csDocumentNodeReadOnly.

virtual void csDocumentNodeCommon::SetAttributeAsInt ( const char *  name,
int  value 
) [virtual]

Converts 'value' to a string and calls SetAttribute() with it.

Implements iDocumentNode.

Reimplemented in csDocumentNodeReadOnly.

virtual void csDocumentNodeCommon::SetValueAsFloat ( float  value  )  [virtual]

Set value to the string representation of a float.

Implements iDocumentNode.

Reimplemented in csDocumentNodeReadOnly.

virtual void csDocumentNodeCommon::SetValueAsInt ( int  value  )  [virtual]

Converts 'value' to a string and calls SetValue() with it.

Implements iDocumentNode.

Reimplemented in csDocumentNodeReadOnly.


The documentation for this class was generated from the following file:
Generated for Crystal Space 1.0.2 by doxygen 1.4.7