QXmlStreamWriter Class

Documentación de funciones miembro

QXmlStreamWriter::QXmlStreamWriter()

Construye un escritor de flujo.

Véase también setDevice().

[explicit] QXmlStreamWriter::QXmlStreamWriter(QByteArray *array)

Construye un stream writer que escribe en array. Esto es lo mismo que crear un escritor xml que opera en un dispositivo QBuffer que a su vez opera en array.

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

Construye un escritor de flujo que escribe en device;

[explicit] QXmlStreamWriter::QXmlStreamWriter(QString *string)

Construye un escritor de flujo que escribe en string.

[noexcept] QXmlStreamWriter::~QXmlStreamWriter()

Destructor.

bool QXmlStreamWriter::autoFormatting() const

Devuelve true si el autoformateo está activado, en caso contrario false.

Véase también setAutoFormatting().

QIODevice *QXmlStreamWriter::device() const

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

Véase también setDevice().

[since 6.10] QXmlStreamWriter::Error QXmlStreamWriter::error() const

Devuelve el estado de error actual del escritor.

Si no se ha producido ningún error, esta función devuelve QXmlStreamWriter::Error::None.

Esta función se introdujo en Qt 6.10.

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

[since 6.10] QString QXmlStreamWriter::errorString() const

Si se ha producido un error, devuelve el mensaje de error asociado.

El mensaje de error es establecido internamente por QXmlStreamWriter o proporcionado por el usuario a través de raiseError(). Si no se ha producido ningún error, esta función devuelve una cadena nula.

Esta función se introdujo en Qt 6.10.

Véase también error(), raiseError() y hasError().

bool QXmlStreamWriter::hasError() const

Devuelve true si se ha producido un error al intentar escribir datos.

Si el error es Error::IO, las subsiguientes escrituras en el subyacente QIODevice fallarán. En otros casos podrían escribirse datos malformados en el documento.

El estado de error nunca se restablece. Las escrituras que se produzcan después de que ocurra el error pueden ser ignoradas, incluso si se borra el estado de error.

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

[since 6.10] void QXmlStreamWriter::raiseError(QAnyStringView message)

Genera un error personalizado con la dirección message.

Esta función sirve para indicar manualmente que se ha producido un error durante la escritura, como un fallo de validación a nivel de aplicación.

Esta función se introdujo en Qt 6.10.

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

void QXmlStreamWriter::setAutoFormatting(bool enable)

Activa el autoformateo si enable es true, en caso contrario lo desactiva.

El valor por defecto es false.

Véase también autoFormatting().

void QXmlStreamWriter::setDevice(QIODevice *device)

Establece el dispositivo actual en device. Si desea que el flujo escriba en QByteArray, puede crear un dispositivo QBuffer.

Véase también device().

void QXmlStreamWriter::writeAttribute(QAnyStringView namespaceUri, QAnyStringView name, QAnyStringView value)

Escribe un atributo con name y value, prefijado para el namespaceUri especificado. Si el espacio de nombres aún no ha sido declarado, QXmlStreamWriter generará una declaración de espacio de nombres para él.

Esta función sólo puede invocarse después de writeStartElement() antes de que se escriba cualquier contenido, o después de writeEmptyElement().

void QXmlStreamWriter::writeAttribute(const QXmlStreamAttribute &attribute)

Escribe el contenido de attribute.

Esta función sólo puede invocarse después de writeStartElement() antes de que se escriba cualquier contenido, o después de writeEmptyElement().

void QXmlStreamWriter::writeAttribute(QAnyStringView qualifiedName, QAnyStringView value)

Escribe un atributo con qualifiedName y value.

Esta función sólo puede invocarse después de writeStartElement() antes de que se escriba cualquier contenido, o después de writeEmptyElement().

void QXmlStreamWriter::writeAttributes(const QXmlStreamAttributes &attributes)

Escribe el vector de atributos attributes. Si un espacio de nombres referenciado en un atributo no ha sido declarado todavía, QXmlStreamWriter generará una declaración de espacio de nombres para él.

Esta función sólo puede invocarse después de writeStartElement() antes de que se escriba cualquier contenido, o después de writeEmptyElement().

Véase también writeAttribute() y writeNamespace().

void QXmlStreamWriter::writeCDATA(QAnyStringView text)

Escribe text como sección CDATA. Si text contiene la secuencia de caracteres prohibida "]]>", se divide en diferentes secciones CDATA.

Esta función existe principalmente como complemento. Normalmente no debería ser necesario utilizarla, ya que writeCharacters() escapa automáticamente todos los caracteres no contenidos.

void QXmlStreamWriter::writeCharacters(QAnyStringView text)

Escribe text. Los caracteres "<", "&" y """ se escapan como referencias de entidad "&lt;", "&amp; y "&quot;". Para evitar la secuencia prohibida "]]>", ">" también se escapa como "&gt;".

Véase también writeEntityReference().

void QXmlStreamWriter::writeComment(QAnyStringView text)

Escribe text como comentario XML, donde text no debe contener la secuencia prohibida -- ni terminar con -. Tenga en cuenta que XML no proporciona ninguna forma de escapar - en un comentario.

void QXmlStreamWriter::writeCurrentToken(const QXmlStreamReader &reader)

Escribe el estado actual de reader. Se admiten todos los estados válidos posibles.

El propósito de esta función es soportar el procesamiento encadenado de datos XML.

Véase también QXmlStreamReader::tokenType().

void QXmlStreamWriter::writeDTD(QAnyStringView dtd)

Escribe una sección DTD. El dtd representa toda la producción doctypedecl de la especificación XML 1.0.

void QXmlStreamWriter::writeDefaultNamespace(QAnyStringView namespaceUri)

Escribe una declaración de espacio de nombres por defecto para namespaceUri.

Si se ha llamado a writeStartElement() o writeEmptyElement(), la declaración se aplica al elemento actual; en caso contrario, se aplica al siguiente elemento hijo.

Nótese que los espacios de nombres http://www.w3.org/XML/1998/namespace (ligado a xmlns) y http://www.w3.org/2000/xmlns/ (ligado a xml) por definición no pueden ser declarados por defecto.

void QXmlStreamWriter::writeEmptyElement(QAnyStringView namespaceUri, QAnyStringView name)

Escribe un elemento vacío con name, prefijado para el namespaceUri especificado. Si el espacio de nombres no ha sido declarado, QXmlStreamWriter generará una declaración de espacio de nombres para él. Las siguientes llamadas a writeAttribute() añadirán atributos a este elemento.

Véase también writeNamespace().

void QXmlStreamWriter::writeEmptyElement(QAnyStringView qualifiedName)

Escribe un elemento vacío con el nombre cualificado qualifiedName. Las siguientes llamadas a writeAttribute() añadirán atributos a este elemento.

void QXmlStreamWriter::writeEndDocument()

Cierra todos los elementos de inicio abiertos y escribe una nueva línea.

Véase también writeStartDocument().

void QXmlStreamWriter::writeEndElement()

Cierra el elemento de inicio anterior.

Véase también writeStartElement().

void QXmlStreamWriter::writeEntityReference(QAnyStringView name)

Escribe la referencia de entidad name en el flujo, como "&name;".

void QXmlStreamWriter::writeNamespace(QAnyStringView namespaceUri, QAnyStringView prefix = {})

Escribe una declaración de espacio de nombres para namespaceUri con prefix. Si prefix está vacío, QXmlStreamWriter asigna un prefijo único consistente en la letra 'n' seguida de un número.

Si se ha llamado a writeStartElement() o writeEmptyElement(), la declaración se aplica al elemento actual; en caso contrario, se aplica al siguiente elemento hijo.

Tenga en cuenta que el prefijo xml está predefinido y reservado para http://www.w3.org/XML/1998/namespace, que a su vez no puede vincularse a ningún otro prefijo. El prefijo xmlns y su URI http://www.w3.org/2000/xmlns/ se utilizan para el propio mecanismo del espacio de nombres y, por tanto, están completamente prohibidos en las declaraciones.

void QXmlStreamWriter::writeProcessingInstruction(QAnyStringView target, QAnyStringView data = {})

Escribe una instrucción de procesamiento XML con target y data, donde data no debe contener la secuencia "?>".

void QXmlStreamWriter::writeStartDocument(QAnyStringView version)

Escribe un inicio de documento con el número de versión XML version.

Véase también writeEndDocument().

void QXmlStreamWriter::writeStartDocument(QAnyStringView version, bool standalone)

Escribe un inicio de documento con el número de versión XML version y un atributo independiente standalone.

Véase también writeEndDocument().

void QXmlStreamWriter::writeStartDocument()

Escribe un inicio de documento con el número de versión XML "1.0".

Véase también writeEndDocument().

void QXmlStreamWriter::writeStartElement(QAnyStringView namespaceUri, QAnyStringView name)

Escribe un elemento de inicio con name, prefijado para el namespaceUri especificado. Si el espacio de nombres aún no ha sido declarado, QXmlStreamWriter generará una declaración de espacio de nombres para él. Las siguientes llamadas a writeAttribute() añadirán atributos a este elemento.

Véase también writeNamespace(), writeEndElement(), y writeEmptyElement().

void QXmlStreamWriter::writeStartElement(QAnyStringView qualifiedName)

Escribe un elemento de inicio con qualifiedName. Las siguientes llamadas a writeAttribute() añadirán atributos a este elemento.

Véase también writeEndElement() y writeEmptyElement().

void QXmlStreamWriter::writeTextElement(QAnyStringView namespaceUri, QAnyStringView name, QAnyStringView text)

Escribe un elemento de texto con name, prefijo para el espacio de nombres especificado namespaceUri, y text. Si el espacio de nombres no ha sido declarado, QXmlStreamWriter generará una declaración de espacio de nombres para él.

Esta es una función de conveniencia equivalente a:

stream.writeStartElement(namespaceUri, name);
stream.writeCharacters(text);
stream.writeEndElement();

void QXmlStreamWriter::writeTextElement(QAnyStringView qualifiedName, QAnyStringView text)

Escribe un elemento de texto con qualifiedName y text.

Esta es una función de conveniencia equivalente a:

stream.writeStartElement(qualifiedName);
stream.writeCharacters(text);
stream.writeEndElement();