Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

FX::FXXMLFile Class Reference

procesing XML file More...

#include <FXXMLFile.h>

Inheritance diagram for FX::FXXMLFile:
FX::FXXML

List of all members.

Public Member Functions

 FXXMLFile ()
 Create XML file i/o object.
 FXXMLFile (const FXString &filename, Direction d=Load, FXuval sz=4096)
 Create XML file i/o object and open it.
FXbool open (FXInputHandle h, Direction d=Load, FXuval sz=4096)
 Open XML file handle for direction d.
FXbool open (const FXString &filename, Direction d=Load, FXuval sz=4096)
 Open XML file for direction d.
virtual FXbool fill ()
 Fill buffer from file.
virtual FXbool flush ()
 Flush buffer to file.
virtual FXbool close ()
 Close XML file and delete buffers.
virtual ~FXXMLFile ()
 Close XML file.
- Public Member Functions inherited from FX::FXXML
 FXXML ()
 Construct XML serializer.
 FXXML (FXchar *data, FXuval sz=4096, Direction d=Load)
 Construct XML serializer and open for direction d.
FXbool open (FXchar *data=NULL, FXuval sz=4096, Direction d=Load)
 Open XML stream for given direction d.
Error parse ()
 Parse the file, return error code to indicate success or failure.
Error startDocument ()
 Document start.
Error startElement (const FXString &tag)
 Element start w/no attributes.
Error startElement (const FXString &tag, const FXStringDictionary &atts)
 Element start w/attributes.
Error characters (const FXString &text)
 Characters.
Error comment (const FXString &text)
 Comment.
Error processing (const FXString &target, const FXString &text)
 Processing instruction.
Error endElement (const FXString &tag)
 Element end.
Error endDocument ()
 Document end.
FXuval size () const
 Return size of parse buffer.
Direction direction () const
 Return direction in effect.
FXint getLine () const
 Return current line number.
FXint getColumn () const
 Return current column number.
virtual ~FXXML ()
 Close XML stream and clean up.

Additional Inherited Members

- Public Types inherited from FX::FXXML
enum  Error {
  ErrOK, ErrEmpty, ErrSave, ErrLoad,
  ErrSpace, ErrEquals, ErrName, ErrString,
  ErrToken, ErrDigit, ErrHexDigit, ErrSemiColon,
  ErrReference, ErrNoMatch, ErrEof
}
enum  Direction { Stop = 0, Save = 1, Load = 2 }
enum  { CRLF = 0x0001, REFS = 0x0002 }
enum  {
  UTF8 = 1, UTF16LE = 2, UTF16BE = 3, UTF32LE = 4,
  UTF32BE = 5
}
- Static Public Member Functions inherited from FX::FXXML
static const FXchar * getError (Error err)
 Returns error code for given error.
static FXbool decode (FXString &dst, const FXString &src, FXuint flags=CRLF|REFS)
 Decode escaped special characters from XML stream.
static FXbool encode (FXString &dst, const FXString &src, FXuint flags=CRLF|REFS)
 Encode special characters for inclusion into XML stream.
- Public Attributes inherited from FX::FXXML
FXCallback< Error() > startDocumentCB
 Called when start of document is recognized.
FXCallback< Error(const
FXString &, const
FXStringDictionary &) > 
startElementCB
 Called when start of element is recognized.
FXCallback< Error(const
FXString &) > 
charactersCB
 Called to pass batch of decoded characters.
FXCallback< Error(const
FXString &) > 
commentCB
 Called to pass comment string.
FXCallback< Error(const
FXString &, const FXString &) > 
processingCB
 Called to pass processing instruction.
FXCallback< Error(const
FXString &) > 
endElementCB
 Called when end of element is recognized.
FXCallback< Error() > endDocumentCB
 Called when end of document is recognized.
- Protected Attributes inherited from FX::FXXML
FXchar * begptr
FXchar * endptr
FXchar * sptr
FXchar * rptr
FXchar * wptr
Element * current
FXint column
FXint line
Direction dir
FXString vers
FXuint enc
FXbool owns

Detailed Description

procesing XML file


Member Function Documentation

virtual FXbool FX::FXXMLFile::fill ( )
virtual

Fill buffer from file.

Return false if not open for reading, or fail to read from disk.

Reimplemented from FX::FXXML.

virtual FXbool FX::FXXMLFile::flush ( )
virtual

Flush buffer to file.

Return false if not open for writing, or if fail to write to disk.

Reimplemented from FX::FXXML.


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

Copyright © 1997-2016 Jeroen van der Zijp