CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

iDocument Struct Reference
[Utilities]

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

#include <document.h>

Inheritance diagram for iDocument:

iBase List of all members.

Public Methods

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 (iFile *file)=0
 Parse document file from an iFile.

virtual const char * Parse (iDataBuffer *buf)=0
 Parse document file from an iDataBuffer.

virtual const char * Parse (iString *str)=0
 Parse document file from an iString.

virtual const char * Parse (const char *buf)=0
 Parse document file from a null-terminated C-string.

virtual const char * Write (iFile *file)=0
 Write out document file to an iFile.

virtual const char * Write (iString *str)=0
 Write out document file to an iString.

virtual const char * Write (iVFS *vfs, const char *filename)=0
 Write out document file to a VFS file.

virtual int Changeable ()=0
 Returns how far this document can be changed.


Detailed Description

Representation of a document containing a hierarchical structure of nodes.

Main creators of instances implementing this interface:

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

virtual const char* iDocument::Parse const char *    buf [pure virtual]
 

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

This will clear the previous root node if any. Returns 0 if all is ok. Otherwise it will return an error string.

virtual const char* iDocument::Parse iString   str [pure virtual]
 

Parse document file from an iString.

This will clear the previous root node if any. Returns 0 if all is ok. Otherwise it will return an error string.

virtual const char* iDocument::Parse iDataBuffer   buf [pure virtual]
 

Parse document file from an iDataBuffer.

This will clear the previous root node if any. Returns 0 if all is ok. Otherwise it will return an error string.

virtual const char* iDocument::Parse iFile   file [pure virtual]
 

Parse document file from an iFile.

This will clear the previous root node if any. Returns 0 if all is ok. Otherwise it will return an error string.

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 by doxygen 1.2.18