CrystalSpace

Public API Reference

CS::Persistence Namespace Reference

Loading and saving helper classes. More...

Classes

class  ObjectComment
 Default implementation of iObjectComment. More...

Functions

bool LoadComment (iObjectRegistry *object_reg, iObject *object, iDocumentNode *node, bool replace=false)
 Handle a comment node for a given object.
bool LoadComment (iEngine *engine, iObject *object, iDocumentNode *node, bool replace=false)
 Handle a comment node for a given object.
bool SaveComment (iObjectRegistry *object_reg, iObject *obj, iDocumentNode *parentNode)
 Helper function to save a comment.
bool SaveComment (iEngine *engine, iObject *obj, iDocumentNode *parentNode)
 Helper function to save a comment.

Detailed Description

Loading and saving helper classes.


Function Documentation

bool CS::Persistence::LoadComment ( iObjectRegistry object_reg,
iObject object,
iDocumentNode node,
bool  replace = false 
) [inline]

Handle a comment node for a given object.

If the engine saveable flag is on then an iObjectComment is created and add to the object. Otherwise nothing happens. This function returns true if a comment was added. False otherwise. If 'replace' is true then previously existing comments (if any) will be overwritten by the new comment.

Definition at line 125 of file objectcomment.h.

bool CS::Persistence::LoadComment ( iEngine engine,
iObject object,
iDocumentNode node,
bool  replace = false 
) [inline]

Handle a comment node for a given object.

If the engine saveable flag is on then an iObjectComment is created and add to the object. Otherwise nothing happens. This function returns true if a comment was added. False otherwise. If 'replace' is true then previously existing comments (if any) will be overwritten by the new comment.

Definition at line 96 of file objectcomment.h.

bool CS::Persistence::SaveComment ( iObjectRegistry object_reg,
iObject obj,
iDocumentNode parentNode 
) [inline]

Helper function to save a comment.

Returns true if it was actually saved. This function will not save if the engine saveable flag is not set.

Definition at line 82 of file objectcomment.h.

bool CS::Persistence::SaveComment ( iEngine engine,
iObject obj,
iDocumentNode parentNode 
) [inline]

Helper function to save a comment.

Returns true if it was actually saved. This function will not save if the engine saveable flag is not set.

Definition at line 64 of file objectcomment.h.


Generated for Crystal Space 2.1 by doxygen 1.6.1