Класс QXmlContentHandler

Класс QXmlContentHandler предоставляет интерфейс для отчета о логическом содержании XML-данных. Подробнее...

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

Примечание: Все функции в этом классе являются повторно-входящими.

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

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

Если приложению нужно получить информацию о базовых событиях парсинга, оно может реализовать этот интерфейс и активировать его с помощью QXmlReader::setContentHandler(). Тогда читатель может сообщить о базовых событиях, связанных с документом, таких как начало и конец элементов и символьных данных через этот интерфейс.

Порядок событий в этом интерфейсе очень важен и отражает порядок информации в самом документе. Например, всё содержимое элемента (символьные данные, инструкции обработки и подэлементы) появляется в порядке следования между событием startElement() и соответствующим событием endElement().

Класс QXmlDefaultHandler предоставляет реализацию по умолчанию для этого интерфейса; наследование от класса QXmlDefaultHandler очень удобно, если вы хотите получать информацию только о некоторых событиях парсинга.

Функция startDocument() вызывается в начале документа, а endDocument() — в конце. Перед началом парсинга вызывается setDocumentLocator(). Для каждого элемента вызывается startElement(), и endElement() вызывается в конце каждого элемента. Функция characters() вызывается с блоками символьных данных; ignorableWhitespace() вызывается с блоками пробелов, а processingInstruction() вызывается с инструкциями обработки. Если сущность пропускается, вызывается skippedEntity(). В начале областей префикс-URI вызывается startPrefixMapping().

См. также QXmlDTDHandler, QXmlDeclHandler, QXmlEntityResolver, QXmlErrorHandler и QXmlLexicalHandler.

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

[virtual] QXmlContentHandler::~QXmlContentHandler()

Удаляет обработчик содержимого.

[pure virtual] bool QXmlContentHandler::characters(const QString &ch)

Читатель вызывает эту функцию, когда он проанализировал блок символьных данных (либо обычные символьные данные, либо символьные данные внутри раздела CDATA; если вам нужно различать эти два типа, вы должны использовать QXmlLexicalHandler::startCDATA() и QXmlLexicalHandler::endCDATA()). Символьные данные сообщаются в ch.

Некоторые читатели сообщают пробелы в содержимом элемента, используя функцию ignorableWhitespace(), а не эту.

Читатель может сообщать символьные данные элемента более чем в одном блоке; например, читатель может сообщить «a<b» в трёх событиях characters() («a », «<» и « b»).

Если эта функция возвращает false, читатель останавливает парсинг и сообщает об ошибке. Читатель использует функцию errorString() для получения сообщения об ошибке.

[pure virtual] bool QXmlContentHandler::endDocument()

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

Если эта функция возвращает false, читатель останавливает парсинг и сообщает об ошибке. Читатель использует функцию errorString() для получения сообщения об ошибке.

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

[pure virtual] bool QXmlContentHandler::endElement(const QString &namespaceURI, const QString &localName, const QString &qName)

Читатель вызывает эту функцию при парсинге закрывающей тега элемента с квалифицированным именем qName, локальным именем localName и URI пространства имён namespaceURI.

Если эта функция возвращает false, читатель останавливает парсинг и сообщает об ошибке. Читатель использует функцию errorString() для получения сообщения об ошибке.

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

[pure virtual] bool QXmlContentHandler::endPrefixMapping(const QString &prefix)

Читатель вызывает эту функцию, чтобы сигнализировать о завершении сопоставления префиксов для префикса prefix.

Если эта функция возвращает false, читатель останавливает парсинг и сообщает об ошибке. Читатель использует функцию errorString() для получения сообщения об ошибке.

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

[pure virtual] QString QXmlContentHandler::errorString() const

Читатель вызывает эту функцию для получения строки ошибки, например, если любая из функций обработчика возвращает false.

[pure virtual] bool QXmlContentHandler::ignorableWhitespace(const QString &ch)

Некоторые читатели могут использовать эту функцию для отчёта о каждом блоке пробелов в содержимом элемента. Пробелы сообщаются в ch.

Если эта функция возвращает false, читатель останавливает парсинг и сообщает об ошибке. Читатель использует функцию errorString() для получения сообщения об ошибке.

[pure virtual] bool QXmlContentHandler::processingInstruction(const QString &target, const QString &data)

Читатель вызывает эту функцию при парсинге инструкции обработки.

target — имя целевого элемента инструкции обработки, а data — данные в инструкции обработки.

Если эта функция возвращает false, чтение останавливается, и сообщается об ошибке. Чтец использует функцию errorString() для получения сообщения об ошибке.

[pure virtual] void QXmlContentHandler::setDocumentLocator(QXmlLocator *locator)

Чтец вызывает эту функцию перед началом разбора документа. Аргумент locator — указатель на QXmlLocator, который позволяет приложению получить позицию разбора внутри документа.

Не уничтожайте locator; он уничтожается при уничтожении читателя. (Не используйте locator после уничтожения читателя).

[pure virtual] bool QXmlContentHandler::skippedEntity(const QString &name)

Некоторые читатели могут пропускать сущности, если не видели их декларации (например, потому что они находятся во внешнем DTD). В этом случае они сообщают о пропущенной сущности с именем name, вызывая эту функцию.

Если эта функция возвращает false, чтение останавливается, и сообщается об ошибке. Чтец использует функцию errorString() для получения сообщения об ошибке.

[pure virtual] bool QXmlContentHandler::startDocument()

Чтец вызывает эту функцию при начале разбора документа. Чтец вызывает эту функцию только один раз после вызова setDocumentLocator() и перед вызовом любых других функций в этом классе или в классе QXmlDTDHandler.

Если эта функция возвращает false, чтение останавливается, и сообщается об ошибке. Чтец использует функцию errorString() для получения сообщения об ошибке.

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

[pure virtual] bool QXmlContentHandler::startElement(const QString &namespaceURI, const QString &localName, const QString &qName, const QXmlAttributes &atts)

Чтец вызывает эту функцию при разборе открывающего тега элемента.

Есть соответствующий вызов endElement() при чтении соответствующего закрывающего тега элемента. Вызовы startElement() и endElement() всегда вложены правильно. Пустые теги элементов (например, <x/>) вызывают вызов startElement() сразу после вызова endElement().

Список атрибутов содержит только атрибуты с явными значениями. Список атрибутов содержит атрибуты, используемые для объявления пространства имён (т.е. атрибуты, начинающиеся с xmlns), только если свойство пространства имён читателя имеет значение true.

Аргумент namespaceURI — URI пространства имён или пустая строка, если у элемента нет URI пространства имён или обработка пространства имён не выполняется. localName — локальное имя (без префикса) или пустая строка, если обработка пространства имён не выполняется, qName — квалифицированное имя (с префиксом), а atts — атрибуты, присоединённые к элементу. Если атрибутов нет, atts — пустой объект атрибутов.

Если эта функция возвращает false, чтение останавливается, и сообщается об ошибке. Чтец использует функцию errorString() для получения сообщения об ошибке.

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

[pure virtual] bool QXmlContentHandler::startPrefixMapping(const QString &prefix, const QString &uri)

Чтец вызывает эту функцию, чтобы сигнализировать о начале области сопоставления префикс-URI пространства имён. Эта информация не требуется для обычной обработки пространства имён, поскольку читатель автоматически заменяет префиксы для имён элементов и атрибутов.

Обратите внимание, что вызовы startPrefixMapping() и endPrefixMapping() не гарантируют корректное вложение друг относительно друга: все события startPrefixMapping() происходят перед соответствующим событием startElement(), а все события endPrefixMapping() происходят после соответствующего события endElement(), но их порядок иначе не гарантируется.

Аргумент prefix — префикс пространства имён, который объявляется, а аргумент uri — URI пространства имён, которому сопоставляется префикс.

Если эта функция возвращает false, чтение останавливается, и сообщается об ошибке. Чтец использует функцию errorString() для получения сообщения об ошибке.

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