CrystalSpace

Public API Reference

csDocumentNodeCommon Class Reference

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

#include <csutil/documentcommon.h>

Inherits scfImplementation1< csDocumentNodeCommon, iDocumentNode >.

Inherited by scfImplementationExt0< csDocumentNodeReadOnly, csDocumentNodeCommon >, and scfImplementationExt0< csDocumentNodeReadOnly, csDocumentNodeCommon >.

List of all members.

Public Member Functions

csRef< iDocumentAttributeGetAttribute (const char *)
 Dummy implementation.
virtual csRef
< iDocumentAttributeIterator
GetAttributes ()
 Return empty iterator.
virtual csRef< iDocumentNodeGetNode (const char *)
 Dummy implementation.
virtual csRef
< iDocumentNodeIterator
GetNodes (const char *value)
 Return iterator wrapping around the one returned by GetNodes() and filtering for nodes with a value of value.
virtual csRef
< iDocumentNodeIterator
GetNodes ()
 Return empty iterator.

virtual void SetValueAsInt (int value)
 Converts 'value' to a string and calls SetValue() with it.
virtual void SetValueAsFloat (float value)
 Converts 'value' to a string and calls SetValue() with it.

virtual const char * GetContentsValue ()
 Returns value of first child text node.
virtual int GetContentsValueAsInt ()
 Returns value of first child text node.
virtual float GetContentsValueAsFloat ()
 Returns value of first child text node.

virtual const char * GetAttributeValue (const char *name)
 Returns value of an attribute.
virtual int GetAttributeValueAsInt (const char *name)
 Returns value of an attribute.
virtual float GetAttributeValueAsFloat (const char *name)
 Returns value of an attribute.
virtual bool GetAttributeValueAsBool (const char *name, bool defaultvalue=false)
 Returns value of an attribute.

virtual void SetAttributeAsInt (const char *name, int value)
 Converts 'value' to a string and calls SetAttribute() with it.
virtual void SetAttributeAsFloat (const char *name, float value)
 Converts 'value' to a string and calls SetAttribute() with it.

Detailed Description

Partial iDocumentNode implementation with commonly duplicated logic.

Definition at line 69 of file documentcommon.h.


Member Function Documentation

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

Dummy implementation.

Definition at line 110 of file documentcommon.h.

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

Return empty iterator.

Definition at line 103 of file documentcommon.h.

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

Returns value of an attribute.

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

Returns value of an attribute.

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

Returns value of an attribute.

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

Returns value of an attribute.

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

Returns value of first child text node.

Converts from a string if necessary.

virtual float csDocumentNodeCommon::GetContentsValueAsFloat (  )  [virtual]

Returns value of first child text node.

Converts from a string if necessary.

virtual int csDocumentNodeCommon::GetContentsValueAsInt (  )  [virtual]

Returns value of first child text node.

Converts from a string if necessary.

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

Dummy implementation.

Definition at line 89 of file documentcommon.h.

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

Return empty iterator.

Definition at line 81 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.

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

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

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

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

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

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

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

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


The documentation for this class was generated from the following file:

Generated for Crystal Space 1.4.1 by doxygen 1.7.1