En esta página

TextDocument QML Type

Una envoltura alrededor de TextEdit's respaldo QTextDocument. Más...

Import Statement: import QtQuick
In C++: QQuickTextDocument
Status: Preliminary

Este tipo está en desarrollo y está sujeto a cambios.

Propiedades

Métodos

  • void save() (preliminary)
  • void saveAs(url url) (preliminary)

Descripción detallada

Para cargar texto en el documento, establezca la propiedad source. Si a continuación el usuario modifica el texto y desea guardar el mismo documento, llame a save() para guardarlo de nuevo en la misma fuente (sólo si it's a local file). O llame a saveAs() para guardarlo en un archivo diferente.

Esta clase no puede instanciarse en QML, pero está disponible en TextEdit::textDocument.

Nota: Por ahora, todas las operaciones de carga y guardado se realizan de forma sincrónica. Esto puede bloquear la interfaz de usuario si source es una unidad de red lenta. Esto puede ser mejorado en futuras versiones de Qt.

Nota: Esta API se considera un avance técnico y puede cambiar en futuras versiones de Qt.

Documentación de Propiedades

errorString : string [read-only, preliminary]

Esta propiedad está en desarrollo y está sujeta a cambios.

Esta propiedad contiene una cadena legible por humanos que describe el error que se produjo durante la carga o el guardado, si lo hubo; en caso contrario, una cadena vacía.

Esta propiedad se introdujo en Qt 6.7.

Véase también status, source, save(), y saveAs().

modified : bool [preliminary]

Esta propiedad está en desarrollo y está sujeta a cambios.

Esta propiedad indica si el documento ha sido modificado por el usuario desde la última vez que fue cargado o guardado. Por defecto, esta propiedad es false.

Al igual que con QTextDocument::modified, puedes establecer la propiedad modified: por ejemplo, establécela a false para permitir establecer la propiedad source a una URL diferente (descartando así los cambios del usuario).

Esta propiedad se introdujo en Qt 6.7.

Véase también QTextDocument::modified.

source : url [preliminary]

Esta propiedad está en desarrollo y está sujeta a cambios.

QQuickTextDocument puede manejar cualquier formato de texto soportado por Qt, cargado desde cualquier esquema de URL soportado por Qt.

La URL puede ser absoluta o relativa a la URL del componente.

La propiedad source no puede cambiarse mientras el estado del documento modified sea true. Si el usuario ha modificado el contenido del documento, debe preguntarle si desea save(), o bien descartar los cambios estableciendo modified = false antes de establecer la propiedad source a una URL diferente.

Esta propiedad se introdujo en Qt 6.7.

Véase también QTextDocumentWriter::supportedDocumentFormats().

status : enumeration [read-only, preliminary]

Esta propiedad está en desarrollo y está sujeta a cambios.

Esta propiedad contiene el estado de carga o guardado del documento. Puede ser uno de los siguientes

ConstanteDescripción
TextDocument.NullNo se ha cargado ningún fichero
TextDocument.LoadingSe ha iniciado la lectura desde source
TextDocument.LoadedLa lectura ha finalizado correctamente
TextDocument.SavingSe ha iniciado la escritura del archivo después de save() o saveAs()
TextDocument.SavedLa escritura ha finalizado correctamente
TextDocument.ReadErrorSe ha producido un error al leer de source
TextDocument.WriteErrorSe ha producido un error en save() o saveAs()
TextDocument.NonLocalFileErrorsaveAs() se llamó con una URL que apuntaba a un recurso remoto en lugar de a un archivo local

Utilice este estado para proporcionar una actualización o responder al cambio de estado de alguna manera. Por ejemplo, podría

  • Activar un cambio de estado:
    State {
        name: 'loaded'
        when: textEdit.textDocument.status == textEdit.textDocument.Loaded
    }
  • Implementar un gestor de señales onStatusChanged:
    TextEdit {
        onStatusChanged: {
            if (textDocument.status === textDocument.Loaded)
                console.log('Loaded')
        }
    }
  • Vincular al valor de estado:
    TextEdit {
        id: edit
        width: 300
        height: 200
        textFormat: TextEdit.MarkdownText
        textDocument.source: "example.md"
        wrapMode: TextEdit.WordWrap
    
        Text {
            anchors {
                bottom: parent.bottom
                right: parent.right
            }
            color: edit.textDocument.status === TextDocument.Loaded ? "darkolivegreen" : "tomato"
            text:
                switch (edit.textDocument.status) {
                case TextDocument.Loading:
                    return qsTr("Loading ") + edit.textDocument.source
                case TextDocument.Loaded:
                    return qsTr("Loaded ") + edit.textDocument.source
                default:
                    return edit.textDocument.errorString
                }
        }
    }

Esta propiedad se introdujo en Qt 6.7.

Véase también errorString, source, save(), y saveAs().

Documentación del método

[preliminary] void save()

Este método está en desarrollo y está sujeto a cambios.

Guarda el contenido en el mismo archivo y formato especificados por source.

Nota: Sólo se puede guardar en file on a mounted filesystem.

Este método se introdujo en Qt 6.7.

Véase también source y saveAs().

[preliminary] void saveAs(url url)

Este método está en desarrollo y está sujeto a cambios.

Guarda el contenido en el archivo y formato especificados por url.

La extensión del archivo en url especifica el formato del archivo (determinado por QMimeDatabase::mimeTypeForUrl()).

Nota: Sólo se puede guardar en un file on a mounted filesystem.

Este método se introdujo en Qt 6.7.

Véase también source y save().

© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.