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

XmlCodecBase Class Reference

An abstract predecessor of all XML codecs. More...

#include <xmlcodecbase.h>

Inheritance diagram for XmlCodecBase:

UserOfTextCodec ExaltCodec XmlCodec List of all members.

Public Methods

 XmlCodecBase (void)
 A constructor.

virtual ~XmlCodecBase (void)
 A destructor. More...

virtual bool encode (IODevice *inDevice, IODevice *outDevice)=0
 Encode data from one device to another (the PULL mode). More...

virtual void initializePushCoder (IODevice *outDevice)=0
 Initialize the coder in PUSH mode. More...

virtual bool encodePush (const char *data, int length, bool isFinal=false)=0
 Encode the data in PUSH mode. More...

virtual bool decode (IODevice *inDevice, SAXReceptor *receptor, void *userData=0)=0
 Decode data from one device and use given SAX receptor. More...


Protected Attributes

XmlCoderType coderType
 The type of the coder.


Detailed Description

An abstract predecessor of all XML codecs.

This class implements a simple and unified interface for all XMl coding related classes.

Definition at line 62 of file xmlcodecbase.h.


Constructor & Destructor Documentation

virtual XmlCodecBase::~XmlCodecBase void    [inline, virtual]
 

A destructor.

Does nothing.

Definition at line 73 of file xmlcodecbase.h.


Member Function Documentation

virtual bool XmlCodecBase::decode IODevice   inDevice,
SAXReceptor   receptor,
void *    userData = 0
[pure virtual]
 

Decode data from one device and use given SAX receptor.

Parameters:
inDevice  The input device.
receptor  The SAX event receptor.
userData  The user data structure.

Implemented in ExaltCodec.

Referenced by ExaltCodec::decode.

virtual bool XmlCodecBase::encode IODevice   inDevice,
IODevice   outDevice
[pure virtual]
 

Encode data from one device to another (the PULL mode).

Parameters:
inDevice  The input device.
outDevice  The output device.

Implemented in ExaltCodec.

Referenced by ExaltCodec::encode.

virtual bool XmlCodecBase::encodePush const char *    data,
int    length,
bool    isFinal = false
[pure virtual]
 

Encode the data in PUSH mode.

The coder encodes given chunk of data.

Parameters:
data  The chunk of XML data.
length  The length of the data.
isFinal  Indication whether the coder received the last chunk of data.

Implemented in ExaltCodec.

Referenced by ExaltCodec::encodePush.

virtual void XmlCodecBase::initializePushCoder IODevice   outDevice [pure virtual]
 

Initialize the coder in PUSH mode.

Parameters:
outDevice  The output device.

Implemented in ExaltCodec.

Referenced by ExaltCodec::initializePushCoder.


The documentation for this class was generated from the following file:
Generated on Wed Feb 5 10:43:06 2003 for Exalt by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002