Main Page | Modules | File List | Globals

XaintTree


Typedefs

typedef XaintTree_type XaintTree
typedef XaintBool(* XaintTreeDataEvent )(XaintTree *xainttr, XaintUnknown data, XaintNum size, XaintBool finished)
typedef void(* XaintTreeDataRequest )(XaintTree *xainttr)

Functions

XAINT_API XaintTree * XaintTree_new (void)
XAINT_API void XaintTree_delete (XaintTree *xainttr)
XAINT_API void XaintTree_setUseBOM (XaintTree *xainttr, XaintBool useBOM)
XAINT_API XaintBool XaintTree_getUseBOM (XaintTree *xainttr)
XAINT_API void XaintTree_setPath (XaintTree *xainttr, XaintChar *path)
XAINT_API XaintChar * XaintTree_getPath (XaintTree *xainttr)
XAINT_API void XaintTree_setUserData (XaintTree *cametr, XaintUnknown userData)
XAINT_API XaintUnknown XaintTree_getUserData (XaintTree *xainttr)
XAINT_API XaintErr XaintTree_getLastError (XaintTree *xainttr)
XAINT_API XaintNum XaintTree_getRowNum (XaintTree *xainttr)
XAINT_API XaintNum XaintTree_getColNum (XaintTree *xainttr)
XAINT_API XaintElement * XaintTree_getRoot (XaintTree *xainttr)
XAINT_API XaintBool XaintTree_load (XaintTree *xainttr, XaintChar *path)
XAINT_API XaintBool XaintTree_parse (XaintTree *xainttr)
XAINT_API XaintBool XaintTree_parseString (XaintTree *xainttr, XaintChar *string)
XAINT_API XaintBool XaintTree_save (XaintTree *xainttr)
XAINT_API XaintChar * XaintTree_saveToMemory (XaintTree *xainttr)
XAINT_API XaintBool XaintTree_saveToEvent (XaintTree *xainttr, XaintTreeDataEvent event)
XAINT_API void XaintTree_setDataRequest (XaintTree *xainttr, XaintTreeDataRequest dataRequest)
XAINT_API void XaintTree_feedData (XaintTree *xainttr, XaintUnknown data, XaintNum size)
XAINT_API XaintBool XaintTree_setAutoWS (XaintTree *xainttr, XaintBool autoWS, XaintChar *lineBreak, XaintChar character, XaintNum count)
XAINT_API void XaintTree_deleteAllElements (XaintTree *xainttr)

Typedef Documentation

typedef struct XaintTree_type XaintTree
 

The XaintTree Class

Definition at line 385 of file xaint.h.

typedef XaintBool(* XaintTreeDataEvent)(XaintTree *xainttr, XaintUnknown data, XaintNum size, XaintBool finished)
 

The data callback event. Returns save data in small chunks.

Definition at line 387 of file xaint.h.

typedef void(* XaintTreeDataRequest)(XaintTree *xainttr)
 

A type definition for the DataRequest callback of the XaintTree.

Definition at line 389 of file xaint.h.

Function Documentation

XAINT_API void XaintTree_delete (  XaintTree *  xainttr  ) 
 

Deletes an XaintTree object from memory.

XAINT_API void XaintTree_deleteAllElements (  XaintTree *  xainttr  ) 
 

Deletes all the elements in the tree.

XAINT_API void XaintTree_feedData (  XaintTree *  xainttr,
XaintUnknown  data,
XaintNum  size
) 
 

Gets the data request callback event for the XaintTree.

XAINT_API XaintNum XaintTree_getColNum (  XaintTree *  xainttr  ) 
 

Get the current ColNum.

XAINT_API XaintErr XaintTree_getLastError (  XaintTree *  xainttr  ) 
 

Get the LastError code from the previous parse.

XAINT_API XaintChar* XaintTree_getPath (  XaintTree *  xainttr  ) 
 

Get the saving Path property.

XAINT_API XaintElement* XaintTree_getRoot (  XaintTree *  xainttr  ) 
 

Get the root XaintElement.

XAINT_API XaintNum XaintTree_getRowNum (  XaintTree *  xainttr  ) 
 

Get the current RowNum.

XAINT_API XaintBool XaintTree_getUseBOM (  XaintTree *  xainttr  ) 
 

Get the UseBOM property.

XAINT_API XaintUnknown XaintTree_getUserData (  XaintTree *  xainttr  ) 
 

Get the UserData property.

XAINT_API XaintBool XaintTree_load (  XaintTree *  xainttr,
XaintChar *  path
) 
 

Loads and parses an xaint file into the tree.

XAINT_API XaintTree* XaintTree_new (  void   ) 
 

Creates a new XaintTree object.

XAINT_API XaintBool XaintTree_parse (  XaintTree *  xainttr  ) 
 

Starts the parsing process. Builds a tree.

XAINT_API XaintBool XaintTree_parseString (  XaintTree *  xainttr,
XaintChar *  string
) 
 

Parses a string, and returns immediately.

XAINT_API XaintBool XaintTree_save (  XaintTree *  xainttr  ) 
 

Saves the tree to a file. Make sure the Path is set.

XAINT_API XaintBool XaintTree_saveToEvent (  XaintTree *  xainttr,
XaintTreeDataEvent  event
) 
 

Save the memory to an event. Small chunks of data will be returned at a time.

XAINT_API XaintChar* XaintTree_saveToMemory (  XaintTree *  xainttr  ) 
 

Saves the tree to memory. Returns the memory.

XAINT_API XaintBool XaintTree_setAutoWS (  XaintTree *  xainttr,
XaintBool  autoWS,
XaintChar *  lineBreak,
XaintChar  character,
XaintNum  count
) 
 

Sets the AutoWS property. If set to true, when saving a tree, the whitespace will be automatically inserted based on the lineBreak, character, and count values.

Parameters:
lineBreak A character string to be used as the linebreak. Such as, "\r\n" or "\n" or "" (if no linebreaks are wanted). Must be a whitespace character.
character A character that is used for the indention of the elements. Such as, '' or ' ' or '
'. Must be a whitespace character.
count The number of indention character's to be inserted. The value 0 can be used if no indention characters are wanted.

XAINT_API void XaintTree_setDataRequest (  XaintTree *  xainttr,
XaintTreeDataRequest  dataRequest
) 
 

Sets the data request callback event for the XaintTree.

XAINT_API void XaintTree_setPath (  XaintTree *  xainttr,
XaintChar *  path
) 
 

Set the saving Path property.

XAINT_API void XaintTree_setUseBOM (  XaintTree *  xainttr,
XaintBool  useBOM
) 
 

Set the UseBOM property. If set to true, a saving method will place the UTF8 BOM in front of the data.

XAINT_API void XaintTree_setUserData (  XaintTree *  cametr,
XaintUnknown  userData
) 
 

Set the UserData property.

Generated on Sun Apr 25 11:36:04 2004 for Xaint by doxygen 1.3.6