QXmlStreamReader Class Reference

#include <qxmlstream.h>

Class Description

Definition at line 290 of file qxmlstream.h.

Public Types
enum	TokenType {   NoToken = 0, Invalid, StartDocument, EndDocument,   StartElement, EndElement, Characters, Comment,   DTD, EntityReference, ProcessingInstruction }
enum	ReadElementTextBehaviour { ErrorOnUnexpectedElement, IncludeChildElements, SkipChildElements }
enum	Error {   NoError, UnexpectedElementError, CustomError, NotWellFormedError,   PrematureEndOfDocumentError }

Public Member Functions
	QXmlStreamReader ()
	QXmlStreamReader (QIODevice *device)
	QXmlStreamReader (const QByteArray &data)
	QXmlStreamReader (const QString &data)
	QXmlStreamReader (const char *data)
	~QXmlStreamReader ()
void	setDevice (QIODevice *device)
QIODevice *	device () const
void	addData (const QByteArray &data)
void	addData (const QString &data)
void	addData (const char *data)
void	clear ()
bool	atEnd () const
TokenType	readNext ()
bool	readNextStartElement ()
void	skipCurrentElement ()
TokenType	tokenType () const
QString	tokenString () const
void	setNamespaceProcessing (bool)
bool	namespaceProcessing () const
bool	isStartDocument () const
bool	isEndDocument () const
bool	isStartElement () const
bool	isEndElement () const
bool	isCharacters () const
bool	isWhitespace () const
bool	isCDATA () const
bool	isComment () const
bool	isDTD () const
bool	isEntityReference () const
bool	isProcessingInstruction () const
bool	isStandaloneDocument () const
QStringRef	documentVersion () const
QStringRef	documentEncoding () const
qint64	lineNumber () const
qint64	columnNumber () const
qint64	characterOffset () const
QXmlStreamAttributes	attributes () const
QString	readElementText (ReadElementTextBehaviour behaviour)
QString	readElementText ()
QStringRef	name () const
QStringRef	namespaceUri () const
QStringRef	qualifiedName () const
QStringRef	prefix () const
QStringRef	processingInstructionTarget () const
QStringRef	processingInstructionData () const
QStringRef	text () const
QXmlStreamNamespaceDeclarations	namespaceDeclarations () const
void	addExtraNamespaceDeclaration (const QXmlStreamNamespaceDeclaration &extraNamespaceDeclaraction)
void	addExtraNamespaceDeclarations (const QXmlStreamNamespaceDeclarations &extraNamespaceDeclaractions)
QXmlStreamNotationDeclarations	notationDeclarations () const
QXmlStreamEntityDeclarations	entityDeclarations () const
QStringRef	dtdName () const
QStringRef	dtdPublicId () const
QStringRef	dtdSystemId () const
void	raiseError (const QString &message=QString())
QString	errorString () const
Error	error () const
bool	hasError () const
void	setEntityResolver (QXmlStreamEntityResolver *resolver)
QXmlStreamEntityResolver *	entityResolver () const

Member Enumeration Documentation

enum TokenType

Enumerator
NoToken
Invalid
StartDocument
EndDocument
StartElement
EndElement
Characters
Comment
DTD
EntityReference
ProcessingInstruction

Definition at line 293 of file qxmlstream.h.

                   {
        NoToken = 0,
        Invalid,
        StartDocument,
        EndDocument,
        StartElement,
        EndElement,
        Characters,
        Comment,
        DTD,
        EntityReference,
        ProcessingInstruction
    };

enum ReadElementTextBehaviour

Enumerator
ErrorOnUnexpectedElement
IncludeChildElements
SkipChildElements

Definition at line 357 of file qxmlstream.h.

                                  {
        ErrorOnUnexpectedElement,
        IncludeChildElements,
        SkipChildElements
    };

enum Error

Enumerator
NoError
UnexpectedElementError
CustomError
NotWellFormedError
PrematureEndOfDocumentError

Definition at line 385 of file qxmlstream.h.

               {
        NoError,
        UnexpectedElementError,
        CustomError,
        NotWellFormedError,
        PrematureEndOfDocumentError
    };

Constructor & Destructor Documentation

QXmlStreamReader

(

)

QXmlStreamReader

(

QIODevice *

device

)

QXmlStreamReader

(

const QByteArray &

data

)

QXmlStreamReader

(

const QString &

data

)

QXmlStreamReader

(

const char *

data

)

~QXmlStreamReader

(

)

Member Function Documentation

void setDevice

(

QIODevice *

device

)

QIODevice* device

(

)

const

void addData

(

const QByteArray &

data

)

void addData

(

const QString &

data

)

void addData

(

const char *

data

)

void clear

(

)

bool atEnd

(

)

const

TokenType readNext

(

)

bool readNextStartElement

(

)

void skipCurrentElement

(

)

TokenType tokenType

(

)

const

QString tokenString

(

)

const

void setNamespaceProcessing

(

bool

)

bool namespaceProcessing

(

)

const

bool isStartDocument ( ) const

inline

Definition at line 335 of file qxmlstream.h.

{ return tokenType() == StartDocument; }

bool isEndDocument ( ) const

inline

Definition at line 336 of file qxmlstream.h.

{ return tokenType() == EndDocument; }

bool isStartElement ( ) const

inline

Definition at line 337 of file qxmlstream.h.

{ return tokenType() == StartElement; }

bool isEndElement ( ) const

inline

Definition at line 338 of file qxmlstream.h.

{ return tokenType() == EndElement; }

bool isCharacters ( ) const

inline

Definition at line 339 of file qxmlstream.h.

{ return tokenType() == Characters; }

bool isWhitespace

(

)

const

bool isCDATA

(

)

const

bool isComment ( ) const

inline

Definition at line 342 of file qxmlstream.h.

{ return tokenType() == Comment; }

bool isDTD ( ) const

inline

Definition at line 343 of file qxmlstream.h.

{ return tokenType() == DTD; }

bool isEntityReference ( ) const

inline

Definition at line 344 of file qxmlstream.h.

{ return tokenType() == EntityReference; }

bool isProcessingInstruction ( ) const

inline

Definition at line 345 of file qxmlstream.h.

{ return tokenType() == ProcessingInstruction; }

bool isStandaloneDocument

(

)

const

QStringRef documentVersion

(

)

const

QStringRef documentEncoding

(

)

const

qint64 lineNumber

(

)

const

qint64 columnNumber

(

)

const

qint64 characterOffset

(

)

const

QXmlStreamAttributes attributes

(

)

const

QString readElementText

(

ReadElementTextBehaviour

behaviour

)

QString readElementText

(

)

QStringRef name

(

)

const

QStringRef namespaceUri

(

)

const

QStringRef qualifiedName

(

)

const

QStringRef prefix

(

)

const

QStringRef processingInstructionTarget

(

)

const

QStringRef processingInstructionData

(

)

const

QStringRef text

(

)

const

QXmlStreamNamespaceDeclarations namespaceDeclarations

(

)

const

void addExtraNamespaceDeclaration

(

const QXmlStreamNamespaceDeclaration &

extraNamespaceDeclaraction

)

void addExtraNamespaceDeclarations

(

const QXmlStreamNamespaceDeclarations &

extraNamespaceDeclaractions

)

QXmlStreamNotationDeclarations notationDeclarations

(

)

const

QXmlStreamEntityDeclarations entityDeclarations

(

)

const

QStringRef dtdName

(

)

const

QStringRef dtdPublicId

(

)

const

QStringRef dtdSystemId

(

)

const

void raiseError

(

const QString &

message = QString()

)

QString errorString

(

)

const

Error error

(

)

const

bool hasError ( ) const

inline

Definition at line 396 of file qxmlstream.h.

    {
        return error() != NoError;
    }

void setEntityResolver

(

QXmlStreamEntityResolver *

resolver

)

QXmlStreamEntityResolver* entityResolver

(

)

const

---

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

• QtCore/qxmlstream.h