QXmlStreamReader Class

QXmlStreamReader xml;
//...
while (!xml.atEnd()) {
    xml.readNext();
    //... do processing
}
if (xml.hasError()) {
    //... do error handling
}

Documentación de funciones miembro

QXmlStreamReader::QXmlStreamReader()

Construye un lector de flujo.

Véase también setDevice() y addData().

[explicit] QXmlStreamReader::QXmlStreamReader(QAnyStringView data)

Crea un nuevo lector de flujo que lee de data.

Ver también addData(), clear(), y setDevice().

[explicit] QXmlStreamReader::QXmlStreamReader(QIODevice *device)

Crea un nuevo lector de flujo que lee de device.

Véase también setDevice() y clear().

[explicit] QXmlStreamReader::QXmlStreamReader(const QByteArray &data)

Crea un nuevo lector de flujo que lee de data.

Véase también addData(), clear(), y setDevice().

[noexcept] QXmlStreamReader::~QXmlStreamReader()

Destruye el lector.

void QXmlStreamReader::addData(QAnyStringView data)

Añade más data para que los lea el lector. Esta función no hace nada si el lector tiene un device().

Véase también readNext() y clear().

void QXmlStreamReader::addData(const QByteArray &data)

Añade más data para que los lea el lector. Esta función no hace nada si el lector tiene un device().

Véase también readNext() y clear().

void QXmlStreamReader::addExtraNamespaceDeclaration(const QXmlStreamNamespaceDeclaration &extraNamespaceDeclaration)

Añade un extraNamespaceDeclaration. La declaración será válida para los hijos del elemento actual o, si se llama a la función antes de leer ningún elemento, para todo el documento XML.

Véase también namespaceDeclarations(), addExtraNamespaceDeclarations() y setNamespaceProcessing().

void QXmlStreamReader::addExtraNamespaceDeclarations(const QXmlStreamNamespaceDeclarations &extraNamespaceDeclarations)

Añade un vector de declaraciones especificado por extraNamespaceDeclarations.

Véase también namespaceDeclarations() y addExtraNamespaceDeclaration().

bool QXmlStreamReader::atEnd() const

Devuelve true si el lector ha leído hasta el final del documento XML, o si se ha producido un error error() y se ha interrumpido la lectura. En caso contrario, devuelve false.

Cuando atEnd() y hasError() devuelven true y error() devuelve PrematureEndOfDocumentError, significa que el XML se ha formado bien hasta el momento, pero no se ha analizado un documento XML completo. El siguiente trozo de XML puede añadirse con addData(), si el XML se está leyendo desde un QByteArray, o esperando a que lleguen más datos si el XML se está leyendo desde un QIODevice. En cualquier caso, atEnd() devolverá false cuando haya más datos disponibles.

Véase también hasError(), error(), device() y QIODevice::atEnd().

QXmlStreamAttributes QXmlStreamReader::attributes() const

Devuelve los atributos de un StartElement.

qint64 QXmlStreamReader::characterOffset() const

Devuelve el desplazamiento de caracteres actual, empezando por 0.

Véase también lineNumber() y columnNumber().

void QXmlStreamReader::clear()

Elimina cualquier device() o dato del lector y restablece su estado interno al estado inicial.

Véase también addData().

qint64 QXmlStreamReader::columnNumber() const

Devuelve el número de columna actual, empezando por 0.

Véase también lineNumber() y characterOffset().

QIODevice *QXmlStreamReader::device() const

Devuelve el dispositivo actual asociado a QXmlStreamReader, o nullptr si no se ha asignado ningún dispositivo.

Véase también setDevice().

QStringView QXmlStreamReader::documentEncoding() const

Si tokenType() es StartDocument, esta función devuelve la cadena de codificación especificada en la declaración XML. En caso contrario, devuelve una cadena vacía.

QStringView QXmlStreamReader::documentVersion() const

Si tokenType() es StartDocument, esta función devuelve la cadena de versión especificada en la declaración XML. En caso contrario, devuelve una cadena vacía.

QStringView QXmlStreamReader::dtdName() const

Si tokenType() es DTD, esta función devuelve el nombre del DTD. En caso contrario, devuelve una cadena vacía.

QStringView QXmlStreamReader::dtdPublicId() const

Si tokenType() es DTD, esta función devuelve el identificador público del DTD. En caso contrario, devuelve una cadena vacía.

QStringView QXmlStreamReader::dtdSystemId() const

Si tokenType() es DTD, esta función devuelve el identificador de sistema del DTD. En caso contrario, devuelve una cadena vacía.

QXmlStreamEntityDeclarations QXmlStreamReader::entityDeclarations() const

Si tokenType() es DTD, esta función devuelve las declaraciones de entidad (externas) no analizadas de la DTD. En caso contrario, devuelve un vector vacío.

La clase QXmlStreamEntityDeclarations se define como QList de QXmlStreamEntityDeclaration.

int QXmlStreamReader::entityExpansionLimit() const

Devuelve la cantidad máxima de caracteres a los que puede expandirse una entidad. Si una sola entidad se expande más allá del límite dado, el documento no se considera bien formado.

Véase también setEntityExpansionLimit.

QXmlStreamEntityResolver *QXmlStreamReader::entityResolver() const

Devuelve el resolvedor de entidades, o nullptr si no hay resolvedor de entidades.

Véase también setEntityResolver().

QXmlStreamReader::Error QXmlStreamReader::error() const

Devuelve el tipo del error actual, o NoError si no se ha producido ningún error.

Véase también errorString() y raiseError().

QString QXmlStreamReader::errorString() const

Devuelve el mensaje de error que se estableció con raiseError().

Véase también error(), lineNumber(), columnNumber() y characterOffset().

bool QXmlStreamReader::hasError() const

Devuelve true si se ha producido un error, en caso contrario false.

Véase también errorString() y error().

[since 6.6] bool QXmlStreamReader::hasStandaloneDeclaration() const

Devuelve true si este documento tiene una declaración independiente explícita (puede ser "sí" o "no"); en caso contrario, devuelve false;

Si no se ha analizado ninguna declaración XML, esta función devuelve false.

Esta función se introdujo en Qt 6.6.

Véase también isStandaloneDocument().

bool QXmlStreamReader::isCDATA() const

Devuelve true si el lector informa de caracteres que proceden de una sección CDATA; en caso contrario devuelve false.

Véase también isCharacters() y text().

bool QXmlStreamReader::isCharacters() const

Devuelve true si tokenType() es igual a Characters; en caso contrario devuelve false.

Véase también isWhitespace() y isCDATA().

bool QXmlStreamReader::isComment() const

Devuelve true si tokenType() es igual a Comment; en caso contrario devuelve false.

bool QXmlStreamReader::isDTD() const

Devuelve true si tokenType() es igual a DTD; en caso contrario devuelve false.

bool QXmlStreamReader::isEndDocument() const

Devuelve true si tokenType() es igual a EndDocument; en caso contrario devuelve false.

bool QXmlStreamReader::isEndElement() const

Devuelve true si tokenType() es igual a EndElement; en caso contrario devuelve false.

bool QXmlStreamReader::isEntityReference() const

Devuelve true si tokenType() es igual a EntityReference; en caso contrario devuelve false.

bool QXmlStreamReader::isProcessingInstruction() const

Devuelve true si tokenType() es igual a ProcessingInstruction; en caso contrario devuelve false.

bool QXmlStreamReader::isStandaloneDocument() const

Devuelve true si este documento se ha declarado independiente en la declaración XML; en caso contrario, devuelve false.

Si no se ha analizado ninguna declaración XML, esta función devuelve false.

Véase también hasStandaloneDeclaration().

bool QXmlStreamReader::isStartDocument() const

Devuelve true si tokenType() es igual a StartDocument; en caso contrario devuelve false.

bool QXmlStreamReader::isStartElement() const

Devuelve true si tokenType() es igual a StartElement; en caso contrario devuelve false.

bool QXmlStreamReader::isWhitespace() const

Devuelve true si el lector informa de caracteres que sólo constan de espacios en blanco; en caso contrario, devuelve false.

Véase también isCharacters() y text().

qint64 QXmlStreamReader::lineNumber() const

Devuelve el número de línea actual, empezando por 1.

Véase también columnNumber() y characterOffset().

QStringView QXmlStreamReader::name() const

Devuelve el nombre local de un StartElement, EndElement, o un EntityReference.

Véase también namespaceUri() y qualifiedName().

QXmlStreamNamespaceDeclarations QXmlStreamReader::namespaceDeclarations() const

Si tokenType() es StartElement, esta función devuelve las declaraciones de espacio de nombres del elemento. En caso contrario, devuelve un vector vacío.

La clase QXmlStreamNamespaceDeclarations se define como un QList de QXmlStreamNamespaceDeclaration.

Véase también addExtraNamespaceDeclaration() y addExtraNamespaceDeclarations().

QStringView QXmlStreamReader::namespaceUri() const

Devuelve el namespaceUri de un StartElement o EndElement.

Véase también name() y qualifiedName().

QXmlStreamNotationDeclarations QXmlStreamReader::notationDeclarations() const

Si tokenType() es DTD, esta función devuelve las declaraciones de notación de la DTD. En caso contrario, devuelve un vector vacío.

La clase QXmlStreamNotationDeclarations se define como una QList de QXmlStreamNotationDeclaration.

QStringView QXmlStreamReader::prefix() const

Devuelve el prefijo de un StartElement o EndElement.

Véase también name() y qualifiedName().

QStringView QXmlStreamReader::processingInstructionData() const

Devuelve los datos de un ProcessingInstruction.

QStringView QXmlStreamReader::processingInstructionTarget() const

Devuelve el destino de un ProcessingInstruction.

QStringView QXmlStreamReader::qualifiedName() const

Devuelve el nombre cualificado de un StartElement o EndElement;

Un nombre cualificado es el nombre en bruto de un elemento en los datos XML. Consiste en el prefijo del espacio de nombres, seguido de dos puntos, seguido del nombre local del elemento. Dado que el prefijo del espacio de nombres no es único (el mismo prefijo puede apuntar a diferentes espacios de nombres y diferentes prefijos pueden apuntar al mismo espacio de nombres), no debería utilizar qualifiedName(), sino el namespaceUri() resuelto y el name() local del atributo.

Véase también name(), prefix() y namespaceUri().

void QXmlStreamReader::raiseError(const QString &message = QString())

Genera un error personalizado con un error opcional message.

Véase también error() y errorString().

QString QXmlStreamReader::readElementText(QXmlStreamReader::ReadElementTextBehaviour behaviour = ErrorOnUnexpectedElement)

Función de conveniencia que se llama en caso de que se haya leído un StartElement. Lee hasta el correspondiente EndElement y devuelve todo el texto intermedio. En caso de que no se produzca ningún error, el token actual (véase tokenType()) después de haber llamado a esta función es EndElement.

La función concatena text() cuando lee los tokens Characters o EntityReference, pero se salta ProcessingInstruction y Comment. Si el token actual no es StartElement, se devuelve una cadena vacía.

behaviour define lo que ocurre en caso de que se lea cualquier otra cosa antes de llegar a EndElement. La función puede incluir el texto de los elementos hijos (útil, por ejemplo, para HTML), ignorar los elementos hijos, o lanzar un UnexpectedElementError y devolver lo que se ha leído hasta el momento (por defecto).

QXmlStreamReader::TokenType QXmlStreamReader::readNext()

Lee el siguiente token y devuelve su tipo.

Con una excepción, una vez que readNext() informa de un error(), no es posible seguir leyendo el flujo XML. Entonces atEnd() devuelve true, hasError() devuelve true, y esta función devuelve QXmlStreamReader::Invalid.

La excepción es cuando error() devuelve PrematureEndOfDocumentError. Este error se produce cuando se alcanza el final de un trozo de XML que, por lo demás, está bien formado, pero el trozo no representa un documento XML completo. En ese caso, el análisis se puede reanudar llamando a addData() para añadir el siguiente trozo de XML, cuando el flujo se está leyendo desde QByteArray, o esperando a que lleguen más datos cuando el flujo se está leyendo desde device().

Véase también tokenType() y tokenString().

bool QXmlStreamReader::readNextStartElement()

Lee hasta el siguiente elemento de inicio dentro del elemento actual. Devuelve true cuando se ha alcanzado un elemento de inicio. Cuando se ha alcanzado el elemento final, o cuando se ha producido un error, se devuelve false.

El elemento actual es el elemento que coincide con el elemento inicial analizado más recientemente y del que aún no se ha alcanzado un elemento final coincidente. Cuando el analizador sintáctico ha alcanzado el elemento final, el elemento actual se convierte en el elemento padre.

Se trata de una función muy útil cuando sólo se desea analizar elementos XML. El ejemplo de marcadores QXmlStream hace un uso extensivo de esta función.

Véase también readNext().

[since 6.10] QString QXmlStreamReader::readRawInnerData()

Lee y devuelve el contenido XML interno sin procesar del elemento actual. Esta función es útil para recuperar el contenido completo incrustado dentro de un elemento, incluyendo etiquetas anidadas, texto, comentarios, instrucciones de procesamiento, secciones CDATA y otras marcas - preservando la estructura XML original.

El elemento actual es el elemento que coincide con el elemento inicial analizado más recientemente y del que aún no se ha alcanzado un elemento final coincidente. Cuando el analizador sintáctico ha alcanzado el elemento final, el elemento actual se convierte en el elemento padre.

Esta función se introdujo en Qt 6.10.

void QXmlStreamReader::setDevice(QIODevice *device)

Establece el dispositivo actual en device. Al establecer el dispositivo se restablece el flujo a su estado inicial.

Véase también device() y clear().

void QXmlStreamReader::setEntityExpansionLimit(int limit)

Establece la cantidad máxima de caracteres en los que se puede expandir una sola entidad en limit. Si una sola entidad se expande más allá del límite dado, el documento no se considera bien formado.

El límite está ahí para prevenir ataques DoS cuando se cargan documentos XML desconocidos en los que la expansión recursiva de entidades podría agotar toda la memoria disponible.

El valor por defecto de esta propiedad es de 4096 caracteres.

Véase también entityExpansionLimit.

void QXmlStreamReader::setEntityResolver(QXmlStreamEntityResolver *resolver)

Hace de resolver el nuevo entityResolver().

El lector de flujo no se apropia del resolver. Es responsabilidad de quien llama asegurarse de que el resolver es válido durante todo el tiempo de vida del objeto lector de flujo, o hasta que se establezca otro resolver o nullptr.

Véase también entityResolver().

void QXmlStreamReader::skipCurrentElement()

Lee hasta el final del elemento actual, saltándose cualquier nodo hijo. Esta función es útil para saltar elementos desconocidos.

El elemento actual es el elemento que coincide con el elemento inicial analizado más recientemente y del que aún no se ha alcanzado un elemento final coincidente. Cuando el analizador sintáctico ha alcanzado el elemento final, el elemento actual se convierte en el elemento padre.

QStringView QXmlStreamReader::text() const

Devuelve el texto de Characters, Comment, DTD, o EntityReference.

QString QXmlStreamReader::tokenString() const

Devuelve el token actual del lector como cadena.

Véase también tokenType().

QXmlStreamReader::TokenType QXmlStreamReader::tokenType() const

Devuelve el tipo del token actual.

El token actual también puede consultarse con las funciones de conveniencia isStartDocument(), isEndDocument(), isStartElement(), isEndElement(), isCharacters(), isComment(), isDTD(), isEntityReference() y isProcessingInstruction().

Véase también tokenString().