Member Function Documentation

QXmlInputSource::QXmlInputSource(QIODevice *dev)

Constructs an input source and gets the data from device dev. If dev is not open, it is opened in read-only mode. If dev is 0 or it is not possible to read from the device, the input source will contain no data.

See also setData(), fetchData(), and QIODevice.

QXmlInputSource::QXmlInputSource()

Constructs an input source which contains no data.

See also setData().

[virtual] QXmlInputSource::~QXmlInputSource()

Destructor.

[virtual] QString QXmlInputSource::data() const

Returns the data the input source contains or an empty string if the input source does not contain any data.

See also setData(), QXmlInputSource(), and fetchData().

[virtual] void QXmlInputSource::fetchData()

This function reads more data from the device that was set during construction. If the input source already contained data, this function deletes that data first.

This object contains no data after a call to this function if the object was constructed without a device to read data from or if this function was not able to get more data from the device.

There are two occasions where a fetch is done implicitly by another function call: during construction (so that the object starts out with some initial data where available), and during a call to next() (if the data had run out).

You don't normally need to use this function if you use next().

See also data(), next(), and QXmlInputSource().

[virtual protected] QString QXmlInputSource::fromRawData(const QByteArray &data, bool beginning = false)

This function reads the XML file from data and tries to recognize the encoding. It converts the raw data data into a QString and returns it. It tries its best to get the correct encoding for the XML file.

If beginning is true, this function assumes that the data starts at the beginning of a new XML document and looks for an encoding declaration. If beginning is false, it converts the raw data using the encoding determined from prior calls.

[virtual] QChar QXmlInputSource::next()

Returns the next character of the input source. If this function reaches the end of available data, it returns QXmlInputSource::EndOfData. If you call next() after that, it tries to fetch more data by calling fetchData(). If the fetchData() call results in new data, this function returns the first character of that data; otherwise it returns QXmlInputSource::EndOfDocument.

Readers, such as QXmlSimpleReader, will assume that the end of the XML document has been reached if the this function returns QXmlInputSource::EndOfDocument, and will check that the supplied input is well-formed. Therefore, when reimplementing this function, it is important to ensure that this behavior is duplicated.

See also reset(), fetchData(), QXmlSimpleReader::parse(), and QXmlSimpleReader::parseContinue().

[virtual] void QXmlInputSource::reset()

This function sets the position used by next() to the beginning of the data returned by data(). This is useful if you want to use the input source for more than one parse.

Note: In the case that the underlying data source is a QIODevice, the current position in the device is not automatically set to the start of input. Call QIODevice::seek(0) on the device to do this.

See also next().

[virtual] void QXmlInputSource::setData(const QString &dat)

Sets the data of the input source to dat.

If the input source already contains data, this function deletes that data first.

See also data().

[virtual] void QXmlInputSource::setData(const QByteArray &dat)

This is an overloaded function.

The data dat is passed through the correct text-codec, before it is set.