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