qxmlreader.3qt

linux下GUI编程工具qt的在线连接帮助手册

'\" t
.TH QXmlReader 3qt "11 October 2001" "Trolltech AS" \" -*- nroff -*-
.\" Copyright 1992-2001 Trolltech AS.  All rights reserved.  See the
.\" license file included in the distribution for a complete license
.\" statement.
.\"
.ad l
.nh
.SH NAME
QXmlReader \- Interface for XML readers (i.e. parsers)
.PP
\fC#include <qxml.h>\fR
.PP
Inherited by QXmlSimpleReader.
.PP
.SS "Public Members"
.in +1c
.ti -1c
.BI "virtual bool \fBfeature\fR ( const QString & name, bool * ok = 0 ) const"
.br
.ti -1c
.BI "virtual void \fBsetFeature\fR ( const QString & name, bool value )"
.br
.ti -1c
.BI "virtual bool \fBhasFeature\fR ( const QString & name ) const"
.br
.ti -1c
.BI "virtual void * \fBproperty\fR ( const QString & name, bool * ok = 0 ) const"
.br
.ti -1c
.BI "virtual void \fBsetProperty\fR ( const QString & name, void * value )"
.br
.ti -1c
.BI "virtual bool \fBhasProperty\fR ( const QString & name ) const"
.br
.ti -1c
.BI "virtual void \fBsetEntityResolver\fR ( QXmlEntityResolver * handler )"
.br
.ti -1c
.BI "virtual QXmlEntityResolver * \fBentityResolver\fR () const"
.br
.ti -1c
.BI "virtual void \fBsetDTDHandler\fR ( QXmlDTDHandler * handler )"
.br
.ti -1c
.BI "virtual QXmlDTDHandler * \fBDTDHandler\fR () const"
.br
.ti -1c
.BI "virtual void \fBsetContentHandler\fR ( QXmlContentHandler * handler )"
.br
.ti -1c
.BI "virtual QXmlContentHandler * \fBcontentHandler\fR () const"
.br
.ti -1c
.BI "virtual void \fBsetErrorHandler\fR ( QXmlErrorHandler * handler )"
.br
.ti -1c
.BI "virtual QXmlErrorHandler * \fBerrorHandler\fR () const"
.br
.ti -1c
.BI "virtual void \fBsetLexicalHandler\fR ( QXmlLexicalHandler * handler )"
.br
.ti -1c
.BI "virtual QXmlLexicalHandler * \fBlexicalHandler\fR () const"
.br
.ti -1c
.BI "virtual void \fBsetDeclHandler\fR ( QXmlDeclHandler * handler )"
.br
.ti -1c
.BI "virtual QXmlDeclHandler * \fBdeclHandler\fR () const"
.br
.ti -1c
.BI "virtual bool parse ( const QXmlInputSource & input )  \fI(obsolete)\fR"
.br
.ti -1c
.BI "virtual bool \fBparse\fR ( const QXmlInputSource * input )"
.br
.in -1c
.SH DESCRIPTION
The QXmlReader class provides an interface for XML readers (i.e. parsers).
.PP
This abstract class provides an interface for all XML readers in Qt. At the moment there is only one implementation of a reader included in the XML module of Qt (QXmlSimpleReader). In future releases there might be more readers with different properties available (e.g. a validating parser).
.PP
The design of the XML classes follows the SAX2 java interface. It was adapted to fit the Qt naming conventions; so it should be very easy for anybody who has worked with SAX2 to get started with the Qt XML classes.
.PP
All readers use the class QXmlInputSource to read the input document. Since you are normally interested in particular content in the XML document, the reader reports the content through special handler classes (QXmlDTDHandler, QXmlDeclHandler, QXmlContentHandler, QXmlEntityResolver, QXmlErrorHandler and QXmlLexicalHandler), which you must subclass, if you want to process the contents..
.PP
Since the handler classes describe only interfaces you must implement all functions; there is a class (QXmlDefaultHandler) to make this easier; it implements a default behaviour (do nothing) for all functions.
.PP
Features and properties of the reader can be set with setFeature() and setProperty respectively. You can set the reader to use your own subclasses with setEntityResolver(), setDTDHandler(), setContentHandler(), setErrorHandler(), setLexicalHandler() and setDeclHandler(). The parse itself is started with a call to parse().
.PP
For getting started see also the tiny SAX2 parser walkthrough.
.PP
See also QXmlSimpleReader and XML.
.SH MEMBER FUNCTION DOCUMENTATION
.SH "QXmlDTDHandler * QXmlReader::DTDHandler () const\fC [virtual]\fR"
Returns the DTD handler or 0 if none was set.
.PP
See also setDTDHandler().
.SH "QXmlContentHandler * QXmlReader::contentHandler () const\fC [virtual]\fR"
Returns the content handler or 0 if none was set.
.PP
See also setContentHandler().
.SH "QXmlDeclHandler * QXmlReader::declHandler () const\fC [virtual]\fR"
Returns the declaration handler or 0 if none was set.
.PP
See also setDeclHandler().
.SH "QXmlEntityResolver * QXmlReader::entityResolver () const\fC [virtual]\fR"
Returns the entity resolver or 0 if none was set.
.PP
See also setEntityResolver().
.SH "QXmlErrorHandler * QXmlReader::errorHandler () const\fC [virtual]\fR"
Returns the error handler or 0 if none was set.
.PP
See also setErrorHandler().
.SH "bool QXmlReader::feature ( const QString & name, bool * ok = 0 ) const\fC [virtual]\fR"
If the reader has the feature called \fIname\fR, the feature's value is returned. If no such feature exists the return value is undefined.
.PP
If \fIok\fR is not 0, then \fI*ok\fR is set to TRUE if the reader has the feature called \fIname\fR; otherwise \fI*ok\fR is set to FALSE.
.PP
See also setFeature() and hasFeature().
.SH "bool QXmlReader::hasFeature ( const QString & name ) const\fC [virtual]\fR"
Returns \fCTRUE\fR if the reader has the feature \fIname\fR; otherwise returns FALSE.
.PP
See also feature() and setFeature().
.SH "bool QXmlReader::hasProperty ( const QString & name ) const\fC [virtual]\fR"
Returns TRUE if the reader has the property \fIname\fR; otherwise returns FALSE.
.PP
See also property() and setProperty().
.SH "QXmlLexicalHandler * QXmlReader::lexicalHandler () const\fC [virtual]\fR"
Returns the lexical handler or 0 if none was set.
.PP
See also setLexicalHandler().
.SH "bool QXmlReader::parse ( const QXmlInputSource * input )\fC [virtual]\fR"
Reads an XML document from \fIinput\fR and parses it. Returns TRUE if the parsing was successful; otherwise returns FALSE.
.PP
Examples:
.)l xml/tagreader-with-features/tagreader.cpp and xml/tagreader/tagreader.cpp.
.SH "bool QXmlReader::parse ( const QXmlInputSource & input )\fC [virtual]\fR"
\fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code.
.SH "void * QXmlReader::property ( const QString & name, bool * ok = 0 ) const\fC [virtual]\fR"
If the reader has the property \fIname\fR, this function returns the value of the property and sets \fI*ok\fR to TRUE; otherwise \fI*ok\fR is set to FALSE.
.PP
See also setProperty() and hasProperty().
.SH "void QXmlReader::setContentHandler ( QXmlContentHandler * handler )\fC [virtual]\fR"
Sets the content handler to \fIhandler\fR.
.PP
See also contentHandler().
.PP
Examples:
.)l xml/tagreader-with-features/tagreader.cpp and xml/tagreader/tagreader.cpp.
.SH "void QXmlReader::setDTDHandler ( QXmlDTDHandler * handler )\fC [virtual]\fR"
Sets the DTD handler to \fIhandler\fR.
.PP
See also DTDHandler().
.SH "void QXmlReader::setDeclHandler ( QXmlDeclHandler * handler )\fC [virtual]\fR"
Sets the declaration handler to \fIhandler\fR.
.PP
See also declHandler().
.SH "void QXmlReader::setEntityResolver ( QXmlEntityResolver * handler )\fC [virtual]\fR"
Sets the entity resolver to \fIhandler\fR.
.PP
See also entityResolver().
.SH "void QXmlReader::setErrorHandler ( QXmlErrorHandler * handler )\fC [virtual]\fR"
Sets the error handler to \fIhandler\fR. Clears the error handler if \fIhandler\fR is 0.
.PP
See also errorHandler().
.SH "void QXmlReader::setFeature ( const QString & name, bool value )\fC [virtual]\fR"
Sets the feature called \fIname\fR to the given \fIvalue\fR. If the reader doesn't have the feature nothing happens.
.PP
See also feature() and hasFeature().
.PP
Example: xml/tagreader-with-features/tagreader.cpp.
.SH "void QXmlReader::setLexicalHandler ( QXmlLexicalHandler * handler )\fC [virtual]\fR"
Sets the lexical handler to \fIhandler\fR.
.PP
See also lexicalHandler().
.SH "void QXmlReader::setProperty ( const QString & name, void * value )\fC [virtual]\fR"
Sets the property \fIname\fR to \fIvalue\fR. If the reader doesn't have the property nothing happens.
.PP
See also property() and hasProperty().

.SH "SEE ALSO"
.BR http://doc.trolltech.com/qxmlreader.html
.BR http://www.trolltech.com/faq/tech.html
.SH COPYRIGHT
Copyright 1992-2001 Trolltech AS, http://www.trolltech.com.  See the
license file included in the distribution for a complete license
statement.
.SH AUTHOR
Generated automatically from the source code.
.SH BUGS
If you find a bug in Qt, please report it as described in
.BR http://doc.trolltech.com/bughowto.html .
Good bug reports help us to help you. Thank you.
.P
The definitive Qt documentation is provided in HTML format; it is
located at $QTDIR/doc/html and can be read using Qt Assistant or with
a web browser. This man page is provided as a convenience for those
users who prefer man pages, although this format is not officially
supported by Trolltech. 
.P
If you find errors in this manual page, please report them to
.BR [e-mail] .
Please include the name of the manual page (qxmlreader.3qt) and the Qt
version (3.0.0).