CrystalSpace

Public API Reference

iDocument Struct Reference
[Utilities]

Representation of a document containing a hierarchical structure of nodes. More...

#include <iutil/document.h>

Inheritance diagram for iDocument:

List of all members.

Public Member Functions

virtual int Changeable ()=0
 Returns how far this document can be changed.
virtual void Clear ()=0
 Clear the document.
virtual csRef< iDocumentNodeCreateRoot ()=0
 Create a root node. This will clear the previous root node if any.
virtual csRef< iDocumentNodeGetRoot ()=0
 Get the current root node.
virtual const char * Parse (const char *buf, bool collapse=false)=0
 Parse document file from a null-terminated C-string.
virtual const char * Parse (iString *str, bool collapse=false)=0
 Parse document file from an iString.
virtual const char * Parse (iDataBuffer *buf, bool collapse=false)=0
 Parse document file from an iDataBuffer.
virtual const char * Parse (iFile *file, bool collapse=false)=0
 Parse document file from an iFile.
virtual const char * Write (iVFS *vfs, const char *filename)=0
 Write out document file to a VFS file.
virtual const char * Write (iString *str)=0
 Write out document file to an iString.
virtual const char * Write (iFile *file)=0
 Write out document file to an iFile.

Detailed Description

Representation of a document containing a hierarchical structure of nodes.

Main creators of instances implementing this interface:

Definition at line 338 of file document.h.


Member Function Documentation

virtual int iDocument::Changeable (  )  [pure virtual]

Returns how far this document can be changed.

See also:
CS_CHANGEABLE_NEVER CS_CHANGEABLE_NEWROOT CS_CHANGEABLE_YES
virtual void iDocument::Clear (  )  [pure virtual]

Clear the document.

virtual csRef<iDocumentNode> iDocument::CreateRoot (  )  [pure virtual]

Create a root node. This will clear the previous root node if any.

virtual csRef<iDocumentNode> iDocument::GetRoot (  )  [pure virtual]

Get the current root node.

Remarks:
Never returns 0.
virtual const char* iDocument::Parse ( const char *  buf,
bool  collapse = false 
) [pure virtual]

Parse document file from a null-terminated C-string.

Parameters:
buf The buffer to parse. It should contain data in whatever format is understood by the iDocument implementation receiving this invocation.
collapse Document format implementations have the option of condensing extraneous whitespace in returned CS_NODE_TEXT nodes. Set this to true to enable this option. By default, whitepsace is preserved.
Returns:
0 if all is okay; otherwise an error message.
Remarks:
This will clear the previous root node if any.
virtual const char* iDocument::Parse ( iString str,
bool  collapse = false 
) [pure virtual]

Parse document file from an iString.

Parameters:
str The string to parse. It should contain data in whatever format is understood by the iDocument implementation receiving this invocation.
collapse Document format implementations have the option of condensing extraneous whitespace in returned CS_NODE_TEXT nodes. Set this to true to enable this option. By default, whitepsace is preserved.
Returns:
0 if all is okay; otherwise an error message.
Remarks:
This will clear the previous root node if any.
virtual const char* iDocument::Parse ( iDataBuffer buf,
bool  collapse = false 
) [pure virtual]

Parse document file from an iDataBuffer.

Parameters:
buf The buffer to parse. It should contain data in whatever format is understood by the iDocument implementation receiving this invocation.
collapse Document format implementations have the option of condensing extraneous whitespace in returned CS_NODE_TEXT nodes. Set this to true to enable this option. By default, whitepsace is preserved.
Returns:
0 if all is okay; otherwise an error message.
Remarks:
This will clear the previous root node if any.
virtual const char* iDocument::Parse ( iFile file,
bool  collapse = false 
) [pure virtual]

Parse document file from an iFile.

Parameters:
file The file to parse. It should contain data in whatever format is understood by the iDocument implementation receiving this invocation.
collapse Document format implementations have the option of condensing extraneous whitespace in returned CS_NODE_TEXT nodes. Set this to true to enable this option. By default, whitepsace is preserved.
Returns:
0 if all is okay; otherwise an error message.
Remarks:
This will clear the previous root node if any.
virtual const char* iDocument::Write ( iVFS vfs,
const char *  filename 
) [pure virtual]

Write out document file to a VFS file.

This will return 0 if all is ok. Otherwise it will return an error string.

virtual const char* iDocument::Write ( iString str  )  [pure virtual]

Write out document file to an iString.

This will return 0 if all is ok. Otherwise it will return an error string.

virtual const char* iDocument::Write ( iFile file  )  [pure virtual]

Write out document file to an iFile.

This will return 0 if all is ok. Otherwise it will return an error string.


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

Generated for Crystal Space 2.1 by doxygen 1.6.1