Класс QXmlInputSource

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

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

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

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

Статические открытые члены

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

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

Класс 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()

Создаёт входной источник, не содержащий данных.

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

QXmlInputSource::QXmlInputSource(QIODevice *dev)

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

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

[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 передаются через правильный кодек текста, прежде чем они будут установлены.