Класс QXmlInputSource

Класс QXmlInputSource предоставляет входные данные для подклассов QXmlReader. Подробнее...

• Список всех членов, включая унаследованные

Примечание: Все функции в этом классе являются реентерабельными.

Открытые функции

Защищенные функции

Подробное описание

Все подклассы QXmlReader читают входной XML-документ из этого класса.

Этот класс распознаёт кодировку данных, читая объявление кодировки в XML-файле, если оно найдено, и читая данные с соответствующей кодировкой. Если объявление кодировки не найдено, предполагается, что данные находятся в UTF-8 или UTF-16 в зависимости от того, можно ли найти маркер порядка байтов.

Существует два способа заполнения входного источника данными: можно создать его с помощью QIODevice*, чтобы входной источник читал данные из этого устройства. Или можно явно задать данные с помощью одной из функций setData().

Обычно вы создаёте QXmlInputSource, который работает с QIODevice*, или создаёте пустой QXmlInputSource и задаёте данные с помощью setData(). Редко бывают случаи, когда вам нужно использовать оба метода одновременно.

Подклассы QXmlReader используют функцию next() для чтения входного символа за символом. Если вы хотите начать сначала, используйте reset().

Функции data() и fetchData() полезны, если вам нужно что-то сделать с данными, кроме парсинга, например, отобразить исходный XML-файл. Преимущество использования QXmlInputClass в таких случаях заключается в том, что он пытается использовать правильную кодировку.

См. также QXmlReader и QXmlSimpleReader.

Документация по функциям-членам

QXmlInputSource::QXmlInputSource(QIODevice *dev)

Конструирует входной источник и получает данные из устройства dev. Если dev не открыт, он открывается в режиме только для чтения. Если dev равен 0 или невозможно читать из устройства, входной источник не будет содержать данных.

См. также setData(), fetchData() и QIODevice.

QXmlInputSource::QXmlInputSource()

Конструирует входной источник, не содержащий данных.

См. также setData().

[virtual] QXmlInputSource::~QXmlInputSource()

Деструктор.

[virtual] QString QXmlInputSource::data() const

Возвращает данные, содержащиеся во входном источнике, или пустую строку, если входной источник не содержит данных.

См. также setData(), QXmlInputSource() и fetchData().

[virtual] void QXmlInputSource::fetchData()

Эта функция считывает больше данных из устройства, заданного во время создания. Если входной источник уже содержал данные, эта функция сначала удаляет эти данные.

Этот объект не содержит данных после вызова этой функции, если объект был создан без устройства для чтения данных или если эта функция не смогла получить больше данных из устройства.

В двух случаях загрузка выполняется неявно другим вызовом функции: при создании (так что объект начинает с некоторых начальных данных, если доступны), и при вызове next() (если данные закончились).

Вам обычно не нужно использовать эту функцию, если вы используете next().

См. также data(), next() и QXmlInputSource().

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

Эта функция считывает XML-файл из data и пытается определить кодировку. Она преобразует сырые данные data в QString и возвращает его. Она делает всё возможное, чтобы получить правильную кодировку для XML-файла.

Если beginning имеет значение true, эта функция предполагает, что данные начинаются с начала нового XML-документа и ищет объявление кодировки. Если beginning имеет значение false, она преобразует сырые данные с использованием кодировки, определённой по результатам предыдущих вызовов.

[virtual] QChar QXmlInputSource::next()

Возвращает следующий символ входного источника. Если эта функция достигает конца доступных данных, она возвращает QXmlInputSource::EndOfData. Если вы вызываете next() после этого, она пытается загрузить больше данных, вызвав fetchData(). Если вызов fetchData() приводит к новым данным, эта функция возвращает первый символ этих данных; в противном случае она возвращает QXmlInputSource::EndOfDocument.

Читатели, такие как QXmlSimpleReader, будут предполагать, что конец XML-документа достигнут, если эта функция возвращает QXmlInputSource::EndOfDocument, и проверят, что предоставленный ввод правильно сформирован. Поэтому при переопределении этой функции важно обеспечить дублирование этого поведения.

См. также reset(), fetchData(), QXmlSimpleReader::parse() и QXmlSimpleReader::parseContinue().

[virtual] void QXmlInputSource::reset()

Эта функция устанавливает позицию, используемую next(), в начало данных, возвращаемых data(). Это полезно, если вы хотите использовать входной источник для более чем одного разбора.

Примечание: В случае, если основным источником данных является QIODevice, текущая позиция в устройстве не устанавливается автоматически в начало ввода. Вызовите QIODevice::seek(0) на устройстве, чтобы сделать это.

См. также next().

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

Устанавливает данные входного источника на dat.

Если входной источник уже содержит данные, эта функция сначала удаляет эти данные.

См. также data().

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

Это перегруженная функция.

Данные dat передаются через правильный кодек текста, прежде чем они будут установлены.