CrystalSpace

Public API Reference

iObjectComment Struct Reference

This interface represents a comment that is associated with an object in XML. More...

#include <imap/objectcomment.h>

Inheritance diagram for iObjectComment:

List of all members.

Public Member Functions

virtual iStringGetComment ()=0
 Get the comment string.
virtual iObjectQueryObject ()=0
 Get the iObject for this object.

Detailed Description

This interface represents a comment that is associated with an object in XML.

When the engine saveable flag is set then (some) of the loader and saver plugins will respect this comment and try to load/save it as an XML comment together with the object.

Definition at line 36 of file objectcomment.h.


Member Function Documentation

virtual iString* iObjectComment::GetComment (  )  [pure virtual]

Get the comment string.

Implemented in CS::Persistence::ObjectComment.

virtual iObject* iObjectComment::QueryObject (  )  [pure virtual]

Get the iObject for this object.

Implemented in CS::Persistence::ObjectComment.


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

Generated for Crystal Space 2.1 by doxygen 1.6.1