diff options
Diffstat (limited to 'doc/man/man3/tqxmlsimplereader.3qt')
| -rw-r--r-- | doc/man/man3/tqxmlsimplereader.3qt | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/man/man3/tqxmlsimplereader.3qt b/doc/man/man3/tqxmlsimplereader.3qt index 131493a8c..068365d28 100644 --- a/doc/man/man3/tqxmlsimplereader.3qt +++ b/doc/man/man3/tqxmlsimplereader.3qt @@ -51,7 +51,7 @@ See also XML. .SH "TQXmlSimpleReader::TQXmlSimpleReader ()" Constructs a simple XML reader with the following feature settings: <center>.nf .TS -l - l. Feature Setting \fIhttp://xml.org/sax/features/namespaces\fR TRUE \fIhttp://xml.org/sax/features/namespace-prefixes\fR FALSE \fIhttp://trolltech.com/xml/features/report-whitespace-only-CharData\fR TRUE \fIhttp://trolltech.com/xml/features/report-start-end-entity\fR +l - l. Feature Setting \fIhttp://xml.org/sax/features/namespaces\fR true \fIhttp://xml.org/sax/features/namespace-prefixes\fR false \fIhttp://trolltech.com/xml/features/report-whitespace-only-CharData\fR true \fIhttp://trolltech.com/xml/features/report-start-end-entity\fR .TE .fi </center> @@ -62,26 +62,26 @@ See also setFeature(). .SH "TQXmlSimpleReader::~TQXmlSimpleReader ()\fC [virtual]\fR" Destroys the simple XML reader. .SH "bool TQXmlSimpleReader::parse ( const TQXmlInputSource * input, bool incremental )\fC [virtual]\fR" -Reads an XML document from \fIinput\fR and parses it. Returns FALSE if the parsing detects an error; otherwise returns TRUE. +Reads an XML document from \fIinput\fR and parses it. Returns false if the parsing detects an error; otherwise returns true. .PP -If \fIincremental\fR is TRUE, the parser does not return FALSE when it reaches the end of the \fIinput\fR without reaching the end of the XML file. Instead it stores the state of the parser so that parsing can be continued at a later stage when more data is available. You can use the function parseContinue() to continue with parsing. This class stores a pointer to the input source \fIinput\fR and the parseContinue() function tries to read from that input souce. This means that you should not delete the input source \fIinput\fR until you've finished your calls to parseContinue(). If you call this function with \fIincremental\fR TRUE whilst an incremental parse is in progress a new parsing session will be started and the previous session lost. +If \fIincremental\fR is true, the parser does not return false when it reaches the end of the \fIinput\fR without reaching the end of the XML file. Instead it stores the state of the parser so that parsing can be continued at a later stage when more data is available. You can use the function parseContinue() to continue with parsing. This class stores a pointer to the input source \fIinput\fR and the parseContinue() function tries to read from that input souce. This means that you should not delete the input source \fIinput\fR until you've finished your calls to parseContinue(). If you call this function with \fIincremental\fR true whilst an incremental parse is in progress a new parsing session will be started and the previous session lost. .PP -If \fIincremental\fR is FALSE, this function behaves like the normal parse function, i.e. it returns FALSE when the end of input is reached without reaching the end of the XML file and the parsing cannot be continued. +If \fIincremental\fR is false, this function behaves like the normal parse function, i.e. it returns false when the end of input is reached without reaching the end of the XML file and the parsing cannot be continued. .PP See also parseContinue() and TQSocket. .PP Examples: .)l xml/tagreader-with-features/tagreader.cpp and xml/tagreader/tagreader.cpp. .SH "bool TQXmlSimpleReader::parseContinue ()\fC [virtual]\fR" -Continues incremental parsing; this function reads the input from the TQXmlInputSource that was specified with the last parse() command. To use this function, you \fImust\fR have called parse() with the incremental argument set to TRUE. +Continues incremental parsing; this function reads the input from the TQXmlInputSource that was specified with the last parse() command. To use this function, you \fImust\fR have called parse() with the incremental argument set to true. .PP -Returns FALSE if a parsing error occurs; otherwise returns TRUE. +Returns false if a parsing error occurs; otherwise returns true. .PP If the input source returns an empty string for the function TQXmlInputSource::data(), then this means that the end of the XML file has been reached; this is quite important, especially if you want to use the reader to parse more than one XML file. .PP The case of the end of the XML file being reached without having finished parsing is not considered to be an error: you can continue parsing at a later stage by calling this function again when there is more data available to parse. .PP -This function assumes that the end of the XML document is reached if the TQXmlInputSource::next() function returns TQXmlInputSource::EndOfDocument. If the parser has not finished parsing when it encounters this symbol, it is an error and FALSE is returned. +This function assumes that the end of the XML document is reached if the TQXmlInputSource::next() function returns TQXmlInputSource::EndOfDocument. If the parser has not finished parsing when it encounters this symbol, it is an error and false is returned. .PP See also parse() and TQXmlInputSource::next(). .SH "void TQXmlSimpleReader::setFeature ( const TQString & name, bool value )\fC [virtual]\fR" @@ -91,7 +91,7 @@ If the feature is not recognized, it is ignored. .PP The following features are supported: <center>.nf .TS -l - l. Feature Notes \fIhttp://xml.org/sax/features/namespaces\fR If this feature is TRUE, namespace processing is performed. \fIhttp://xml.org/sax/features/namespace-prefixes\fR If this feature is TRUE, the the original prefixed names and attributes used for namespace declarations are reported. \fIhttp://trolltech.com/xml/features/report-whitespace-only-CharData\fR If this feature is TRUE, CharData that only contain whitespace are not ignored, but are reported via TQXmlContentHandler::characters(). \fIhttp://trolltech.com/xml/features/report-start-end-entity\fR +l - l. Feature Notes \fIhttp://xml.org/sax/features/namespaces\fR If this feature is true, namespace processing is performed. \fIhttp://xml.org/sax/features/namespace-prefixes\fR If this feature is true, the the original prefixed names and attributes used for namespace declarations are reported. \fIhttp://trolltech.com/xml/features/report-whitespace-only-CharData\fR If this feature is true, CharData that only contain whitespace are not ignored, but are reported via TQXmlContentHandler::characters(). \fIhttp://trolltech.com/xml/features/report-start-end-entity\fR .TE .fi </center> @@ -105,7 +105,7 @@ l - l. Feature Notes \fIhttp://xml.org/sax/features/namespaces\fR If this featur .br reader.setFeature( "http://xml.org/sax/features/namespace-prefixes", .br - TRUE ); + true ); .fi .PP (Code taken from xml/tagreader-with-features/tagreader.cpp) |