QTextDocument Class

Documentación de las funciones miembro

[explicit] QTextDocument::QTextDocument(QObject *parent = nullptr)

Construye un QTextDocument vacío con la dirección parent.

[explicit] QTextDocument::QTextDocument(const QString &text, QObject *parent = nullptr)

Construye un QTextDocument que contiene el texto plano (sin formato) text especificado, y con el parent dado.

[virtual noexcept] QTextDocument::~QTextDocument()

Destruye el documento.

void QTextDocument::addResource(int type, const QUrl &name, const QVariant &resource)

Añade el recurso resource a la caché de recursos, utilizando type y name como identificadores. type debe ser un valor de QTextDocument::ResourceType.

Por ejemplo, puede añadir una imagen como recurso para poder hacer referencia a ella desde dentro del documento:

    document->addResource(QTextDocument::ImageResource,
        QUrl("mydata://image.png"), QVariant(image));

La imagen puede insertarse en el documento utilizando la API QTextCursor:

    QTextImageFormat imageFormat;
    imageFormat.setName("mydata://image.png");
    cursor.insertImage(imageFormat);

Alternativamente, puede insertar imágenes utilizando la etiqueta HTML img:

    editor->append("<img src=\"mydata://image.png\" />");

void QTextDocument::adjustSize()

Ajusta el documento a un tamaño razonable.

Véase también idealWidth(), textWidth, y size.

QList<QTextFormat> QTextDocument::allFormats() const

Devuelve una lista de formatos de texto para todos los formatos utilizados en el documento.

int QTextDocument::availableRedoSteps() const

Devuelve el número de pasos de rehacer disponibles.

Véase también isRedoAvailable().

int QTextDocument::availableUndoSteps() const

Devuelve el número de pasos de deshacer disponibles.

Véase también isUndoAvailable().

[since 6.0] qreal QTextDocument::baselineOffset() const

Devuelve el desplazamiento de la línea de base en % utilizado en el diseño del documento.

Esta función se introdujo en Qt 6.0.

Véase también setBaselineOffset(), setSubScriptBaseline(), subScriptBaseline(), setSuperScriptBaseline(), y superScriptBaseline().

QTextBlock QTextDocument::begin() const

Devuelve el primer bloque de texto del documento.

Véase también firstBlock().

[signal] void QTextDocument::blockCountChanged(int newBlockCount)

Esta señal se emite cuando cambia el número total de bloques de texto del documento. El valor pasado en newBlockCount es el nuevo total.

QChar QTextDocument::characterAt(int pos) const

Devuelve el carácter en la posición pos, o un carácter nulo si la posición está fuera de rango.

Véase también characterCount().

int QTextDocument::characterCount() const

Devuelve el número de caracteres de este documento.

Véase también blockCount() y characterAt().

[virtual] void QTextDocument::clear()

Borra el documento.

void QTextDocument::clearUndoRedoStacks(QTextDocument::Stacks stacksToClear = UndoAndRedoStacks)

Borra las pilas especificadas por stacksToClear.

Este método borra cualquier orden de la pila de deshacer, de la pila de rehacer o de ambas (por defecto). Si se borran comandos, se emiten las señales apropiadas, QTextDocument::undoAvailable() o QTextDocument::redoAvailable().

Véase también QTextDocument::undoAvailable() y QTextDocument::redoAvailable().

QTextDocument *QTextDocument::clone(QObject *parent = nullptr) const

Crea un nuevo QTextDocument que es una copia de este documento de texto. parent es el padre del documento de texto devuelto.

[signal] void QTextDocument::contentsChange(int position, int charsRemoved, int charsAdded)

Esta señal se emite siempre que cambia el contenido del documento; por ejemplo, cuando se inserta o elimina texto, o cuando se aplica formato.

Se proporciona información sobre la dirección position del carácter del documento en el que se ha producido el cambio, el número de caracteres eliminados (charsRemoved) y el número de caracteres añadidos (charsAdded).

La señal se emite antes de que se notifique el cambio al gestor de maquetación del documento. Este hook permite implementar el resaltado de sintaxis para el documento.

Véase también QAbstractTextDocumentLayout::documentChanged() y contentsChanged().

[signal] void QTextDocument::contentsChanged()

Esta señal se emite cada vez que cambia el contenido del documento; por ejemplo, cuando se inserta o elimina texto, o cuando se aplica formato.

Véase también contentsChange().

[virtual protected] QTextObject *QTextDocument::createObject(const QTextFormat &format)

Crea y devuelve un nuevo objeto documento (un QTextObject), basado en el format dado.

QTextObjects siempre se creará a través de este método, por lo que debes reimplementarlo si utilizas objetos de texto personalizados dentro de tu documento.

[signal] void QTextDocument::cursorPositionChanged(const QTextCursor &cursor)

Esta señal se emite cada vez que la posición del cursor cambia debido a una operación de edición. El cursor que cambió se pasa en cursor. Si el documento se utiliza con la clase QTextEdit y se necesita una señal cuando el cursor se mueve con las teclas de flecha se puede utilizar la señal cursorPositionChanged() en QTextEdit.

Qt::CursorMoveStyle QTextDocument::defaultCursorMoveStyle() const

El estilo de movimiento del cursor por defecto es utilizado por todos los objetos QTextCursor creados a partir del documento. Por defecto es Qt::LogicalMoveStyle.

Véase también setDefaultCursorMoveStyle().

QFont QTextDocument::defaultFont() const

Devuelve la fuente por defecto que se utilizará en el diseño del documento.

Véase también setDefaultFont().

[static, since 6.1] QTextDocument::ResourceProvider QTextDocument::defaultResourceProvider()

Devuelve el proveedor de recursos por defecto.

Esta función se introdujo en Qt 6.1.

Véase también setDefaultResourceProvider(), resourceProvider() y loadResource().

QTextOption QTextDocument::defaultTextOption() const

La opción de texto por defecto se utiliza en todos los objetos QTextLayout del documento. Esto permite establecer propiedades globales para el documento, como el modo de ajuste de palabras por defecto.

Véase también setDefaultTextOption().

QAbstractTextDocumentLayout *QTextDocument::documentLayout() const

Devuelve el diseño del documento.

Véase también setDocumentLayout().

[signal] void QTextDocument::documentLayoutChanged()

Esta señal se emite cuando se establece un nuevo diseño de documento.

Véase también setDocumentLayout().

void QTextDocument::drawContents(QPainter *p, const QRectF &rect = QRectF())

Dibuja el contenido del documento con el pintor p, recortado a rect. Si rect es un rectángulo nulo (por defecto) entonces el documento se pinta sin recortar.

QTextBlock QTextDocument::end() const

Esta función devuelve un bloque para comprobar el final del documento mientras se itera sobre él.

for (QTextBlock it = doc->begin(); it != doc->end(); it = it.next())
    std::cout << it.text().toStdString() << "\n";

El bloque devuelto no es válido y representa el bloque posterior al último bloque del documento. Puede utilizar lastBlock() para recuperar el último bloque válido del documento.

Véase también lastBlock().

QTextCursor QTextDocument::find(const QRegularExpression &expr, const QTextCursor &cursor, QTextDocument::FindFlags options = FindFlags()) const

Busca la siguiente aparición que coincida con la expresión regular dada, expr, dentro del mismo párrafo del documento.

La búsqueda comienza en la posición de la expresión regular cursor, y avanza por el documento a menos que se especifique lo contrario en las opciones de búsqueda. options controla el tipo de búsqueda realizada.

Si se encuentra una coincidencia, devuelve un cursor con la coincidencia seleccionada; en caso contrario, devuelve un cursor nulo.

Si el cursor dado tiene una selección, la búsqueda comienza después de la selección; en caso contrario, comienza en la posición del cursor.

Por defecto, la búsqueda no distingue entre mayúsculas y minúsculas, y puede coincidir con texto de cualquier parte del documento.

QTextCursor QTextDocument::find(const QRegularExpression &expr, int from = 0, QTextDocument::FindFlags options = FindFlags()) const

Busca la siguiente aparición que coincida con la expresión regular dada, expr, dentro del mismo párrafo del documento.

La búsqueda comienza en la posición from y avanza por el documento, a menos que se especifique lo contrario en las opciones de búsqueda. options controla el tipo de búsqueda realizada.

Si se encuentra una coincidencia, devuelve un cursor con la coincidencia seleccionada; en caso contrario, devuelve un cursor nulo.

Si la posición de from es 0 (por defecto), la búsqueda comienza desde el principio del documento; en caso contrario, comienza en la posición especificada.

QTextCursor QTextDocument::find(const QString &subString, const QTextCursor &cursor, QTextDocument::FindFlags options = FindFlags()) const

Busca la siguiente aparición de la cadena subString en el documento. La búsqueda comienza en la posición de cursor y avanza por el documento a menos que se especifique lo contrario en las opciones de búsqueda. options controla el tipo de búsqueda.

Devuelve un cursor con la coincidencia seleccionada si se ha encontrado subString; en caso contrario devuelve un cursor nulo.

Si el cursor dado tiene una selección, la búsqueda comienza después de la selección; en caso contrario, comienza en la posición del cursor.

Por defecto, la búsqueda no distingue entre mayúsculas y minúsculas, y puede coincidir con texto de cualquier parte del documento.

QTextCursor QTextDocument::find(const QString &subString, int position = 0, QTextDocument::FindFlags options = FindFlags()) const

Busca la siguiente aparición de la cadena subString en el documento. La búsqueda comienza en la dirección position y avanza por el documento a menos que se especifique lo contrario en las opciones de búsqueda. options controla el tipo de búsqueda realizada.

Devuelve un cursor con la coincidencia seleccionada si se ha encontrado subString; en caso contrario devuelve un cursor nulo.

Si position es 0 (por defecto), la búsqueda comienza desde el principio del documento; en caso contrario, comienza en la posición especificada.

QTextBlock QTextDocument::findBlock(int pos) const

Devuelve el bloque de texto que contiene el pos-ésimo carácter.

QTextBlock QTextDocument::findBlockByLineNumber(int lineNumber) const

Devuelve el bloque de texto que contiene el lineNumber especificado.

Véase también QTextBlock::firstLineNumber().

QTextBlock QTextDocument::findBlockByNumber(int blockNumber) const

Devuelve el bloque de texto con la dirección blockNumber especificada.

Véase también QTextBlock::blockNumber().

QTextBlock QTextDocument::firstBlock() const

Devuelve el primer bloque de texto del documento.

qreal QTextDocument::idealWidth() const

Devuelve la anchura ideal del documento de texto. La anchura ideal es la anchura realmente utilizada del documento sin tener en cuenta las alineaciones opcionales. Siempre es <= size().width().

Véase también adjustSize() y textWidth.

bool QTextDocument::isEmpty() const

Devuelve true si el documento está vacío; en caso contrario, devuelve false.

bool QTextDocument::isRedoAvailable() const

Devuelve true si redo está disponible; en caso contrario devuelve false.

Véase también isUndoAvailable() y availableRedoSteps().

bool QTextDocument::isUndoAvailable() const

Devuelve true si deshacer está disponible; en caso contrario devuelve false.

Véase también isRedoAvailable() y availableUndoSteps().

QTextBlock QTextDocument::lastBlock() const

Devuelve el último bloque de texto (válido) del documento.

int QTextDocument::lineCount() const

Devuelve el número de líneas de este documento (si la maquetación lo admite). En caso contrario, es idéntico al número de bloques.

Véase también blockCount() y characterCount().

[virtual protected invokable] QVariant QTextDocument::loadResource(int type, const QUrl &name)

Carga datos del type especificado desde el recurso con el name dado.

Esta función es llamada por el motor de texto enriquecido para solicitar datos que no están directamente almacenados por QTextDocument, pero sí asociados a él. Por ejemplo, las imágenes se referencian indirectamente mediante el atributo name de un objeto QTextImageFormat.

Cuando es llamado por Qt, type es uno de los valores de QTextDocument::ResourceType.

Si QTextDocument es un objeto hijo de QObject que tiene un método loadResource invocable, como QTextEdit, QTextBrowser o el propio QTextDocument, la implementación por defecto intenta recuperar los datos del padre.

Véase también QTextDocument::ResourceProvider.

void QTextDocument::markContentsDirty(int position, int length)

Marca el contenido especificado por position y length como "sucio", informando al documento de que necesita ser maquetado de nuevo.

QString QTextDocument::metaInformation(QTextDocument::MetaInformation info) const

Devuelve metainformación sobre el documento del tipo especificado por info.

Véase también setMetaInformation().

[signal] void QTextDocument::modificationChanged(bool changed)

Esta señal se emite siempre que el contenido del documento cambia de forma que afecta al estado de modificación. Si changed es verdadero, el documento ha sido modificado; en caso contrario, es falso.

Por ejemplo, llamar a setModified(false) en un documento y luego insertar texto hace que se emita la señal. Si deshaces esa operación, haciendo que el documento vuelva a su estado original sin modificar, la señal se emitirá de nuevo.

QTextObject *QTextDocument::object(int objectIndex) const

Devuelve el objeto de texto asociado a la dirección objectIndex.

QTextObject *QTextDocument::objectForFormat(const QTextFormat &f) const

Devuelve el objeto de texto asociado al formato f.

int QTextDocument::pageCount() const

devuelve el número de páginas de este documento.

void QTextDocument::print(QPagedPaintDevice *printer) const

Imprime el documento en la dirección printer. El QPagedPaintDevice debe ser configurado antes de ser utilizado con esta función.

Este es sólo un método conveniente para imprimir todo el documento en la impresora.

Si el documento ya está paginado a través de una altura especificada en la propiedad pageSize() se imprime tal cual.

Si el documento no está paginado, como por ejemplo un documento utilizado en QTextEdit, entonces se crea una copia temporal del documento y la copia se divide en varias páginas según el tamaño del paperRect() del dispositivo de pintura. Por defecto, se establece un margen de 2 cm alrededor del contenido del documento. Además, el número de página actual se imprime en la parte inferior de cada página.

Véase también QTextEdit::print().

void QTextDocument::redo(QTextCursor *cursor)

Rehace la última operación de edición del documento si redo is available.

El cursor proporcionado se coloca al final de la ubicación donde se rehizo la operación de edición.

[slot] void QTextDocument::redo()

Rehace la última operación de edición del documento si redo is available.

// Connect using qOverload:
connect(sender, &SenderClass::signal,
        textDocument, qOverload<>(&QTextDocument::redo));

// Or using a lambda as wrapper:
connect(sender, &SenderClass::signal,
        textDocument, [receiver = textDocument]() { receiver->redo(); });

[signal] void QTextDocument::redoAvailable(bool available)

Esta señal se emite cuando las operaciones de rehacer están disponibles (available es verdadero) o no disponibles (available es falso).

QVariant QTextDocument::resource(int type, const QUrl &name) const

Devuelve datos del type especificado del recurso con el name dado.

Esta función es llamada por el motor de texto enriquecido para solicitar datos que no están directamente almacenados por QTextDocument, pero sí asociados a él. Por ejemplo, las imágenes se referencian indirectamente mediante el atributo name de un objeto QTextImageFormat.

Los recursos se almacenan en caché internamente en el documento. Si un recurso no se encuentra en la caché, se llama a loadResource para intentar cargar el recurso. loadResource debe entonces utilizar addResource para añadir el recurso a la caché.

Si loadResource no carga el recurso, entonces se llamará a resourceProvider y por último a defaultResourceProvider, si está configurado. Tenga en cuenta que el resultado del proveedor no se añadirá automáticamente a la caché.

Véase también QTextDocument::ResourceType y resourceProvider().

[since 6.1] QTextDocument::ResourceProvider QTextDocument::resourceProvider() const

Devuelve el proveedor de recursos para este documento de texto.

Esta función se introdujo en Qt 6.1.

Véase también setResourceProvider(), defaultResourceProvider() y loadResource().

int QTextDocument::revision() const

Devuelve la revisión del documento (si deshacer está activado).

Se garantiza que la revisión aumenta cuando se edita un documento que no ha sido modificado.

Véase también QTextBlock::revision() y isModified().

QTextFrame *QTextDocument::rootFrame() const

Devuelve el marco raíz del documento.

[since 6.0] void QTextDocument::setBaselineOffset(qreal baseline)

Establece la línea base como un % de la altura de la fuente a utilizar en el diseño del documento a baseline. El valor por defecto es 0. Un valor positivo desplaza el texto hacia arriba, en el % correspondiente; un valor negativo lo desplaza hacia abajo.

Esta función se introdujo en Qt 6.0.

Véase también baselineOffset(), setSubScriptBaseline(), subScriptBaseline(), setSuperScriptBaseline(), y superScriptBaseline().

void QTextDocument::setDefaultCursorMoveStyle(Qt::CursorMoveStyle style)

Establece el estilo de movimiento del cursor por defecto en style.

Véase también defaultCursorMoveStyle().

void QTextDocument::setDefaultFont(const QFont &font)

Establece el font por defecto a utilizar en la maquetación del documento.

Véase también defaultFont().

[static, since 6.1] void QTextDocument::setDefaultResourceProvider(const QTextDocument::ResourceProvider &provider)

Establece el proveedor de recursos por defecto en provider.

El proveedor por defecto será utilizado por todos los QTextDocuments que no tengan un proveedor explícito establecido.

Esta función se introdujo en Qt 6.1.

Ver también defaultResourceProvider(), setResourceProvider(), y loadResource().

void QTextDocument::setDefaultTextOption(const QTextOption &option)

Establece la opción de texto por defecto en option.

Véase también defaultTextOption().

void QTextDocument::setDocumentLayout(QAbstractTextDocumentLayout *layout)

Configura el documento para que utilice la dirección layout. El diseño anterior se elimina.

Véase también documentLayoutChanged().

void QTextDocument::setHtml(const QString &html)

Sustituye todo el contenido del documento por el texto con formato HTML dado en la cadena html. El historial de deshacer/rehacer se reinicia cuando se llama a esta función.

El formato HTML se respeta en la medida de lo posible; por ejemplo, "<b>texto en negrita</b>" producirá un texto en el que la primera palabra tiene un peso de fuente que le da un aspecto de negrita: "textoen negrita ".

Para seleccionar una regla de medios css distinta de la regla por defecto "screen", utilice setMetaInformation() con 'CssMedia' como parámetro "info".

Véase también setPlainText(), Supported HTML Subset, y setMetaInformation().

void QTextDocument::setIndentWidth(qreal width)

Establece el width utilizado para la sangría de listas y bloques de texto.

Las propiedades de sangría de QTextListFormat y QTextBlockFormat especifican múltiplos de este valor. El ancho de sangría por defecto es 40 .

Véase también indentWidth().

void QTextDocument::setMarkdown(const QString &markdown, QTextDocument::MarkdownFeatures features = MarkdownDialectGitHub)

Sustituye todo el contenido del documento por el texto con formato Markdown dado en la cadena markdown, con el soporte dado features. Por defecto, se incluyen todas las características Markdown estilo GitHub soportadas; pase MarkdownDialectCommonMark para un análisis más básico.

El formato Markdown se respeta en la medida de lo posible; por ejemplo, "*bold* text" producirá un texto en el que la primera palabra tiene un peso de fuente que le da un aspecto enfatizado.

El análisis sintáctico de HTML incluido en la cadena markdown se realiza del mismo modo que en setHtml; sin embargo, no se admite el formato Markdown dentro de bloques HTML.

Algunas características del analizador pueden activarse o desactivarse mediante el argumento features. El valor por defecto es MarkdownDialectGitHub.

El historial de deshacer/rehacer se reinicia cuando se llama a esta función.

void QTextDocument::setMetaInformation(QTextDocument::MetaInformation info, const QString &string)

Establece la metainformación del documento del tipo especificado por info en el string dado.

Véase también metaInformation().

void QTextDocument::setPlainText(const QString &text)

Sustituye todo el contenido del documento por el texto plano text. El historial de deshacer/rehacer se reinicia cuando se llama a esta función.

Véase también setHtml().

[since 6.1] void QTextDocument::setResourceProvider(const QTextDocument::ResourceProvider &provider)

Establece el proveedor de recursos para el documento de texto en provider.

Esta función se introdujo en Qt 6.1.

Véase también resourceProvider() y loadResource().

[since 6.0] void QTextDocument::setSubScriptBaseline(qreal baseline)

Establece la línea base del subíndice por defecto como un % de la altura de la fuente a usar en el diseño del documento a baseline. El valor por defecto es 16.67% (1/6 de la altura).

Esta función se introdujo en Qt 6.0.

Véase también subScriptBaseline(), setSuperScriptBaseline(), superScriptBaseline(), setBaselineOffset(), y baselineOffset().

[since 6.0] void QTextDocument::setSuperScriptBaseline(qreal baseline)

Establece la línea base del superíndice por defecto como un % de la altura de la fuente a usar en el diseño del documento a baseline. El valor por defecto es 50% (1/2 de la altura).

Esta función se introdujo en Qt 6.0.

Véase también superScriptBaseline(), setSubScriptBaseline(), subScriptBaseline(), setBaselineOffset(), y baselineOffset().

[since 6.0] qreal QTextDocument::subScriptBaseline() const

Devuelve la línea base del superíndice como un % de la altura de la fuente utilizada en el diseño del documento.

Esta función se introdujo en Qt 6.0.

Véase también setSubScriptBaseline(), setSuperScriptBaseline(), superScriptBaseline(), setBaselineOffset() y baselineOffset().

[since 6.0] qreal QTextDocument::superScriptBaseline() const

Devuelve la línea base del superíndice como un % de la altura de la fuente utilizada en el diseño del documento.

Esta función se introdujo en Qt 6.0.

Véase también setSuperScriptBaseline(), setSubScriptBaseline(), subScriptBaseline(), setBaselineOffset() y baselineOffset().

QString QTextDocument::toHtml() const

Devuelve una cadena que contiene una representación HTML del documento.

El contenido del documento especifica que su codificación es UTF-8. Si posteriormente convierte la cadena html devuelta en una matriz de bytes para transmitirla a través de una red o al guardarla en disco, deberá utilizar QString::toUtf8() para convertir la cadena en un QByteArray.

Véase también Subconjunto HTML soportado.

QString QTextDocument::toMarkdown(QTextDocument::MarkdownFeatures features = MarkdownDialectGitHub) const

Devuelve una cadena que contiene una representación Markdown del documento con la dirección features, o una cadena vacía si la escritura falla por cualquier motivo.

Véase también setMarkdown.

QString QTextDocument::toPlainText() const

Devuelve el texto sin formato contenido en el documento. Si desea información de formato, utilice QTextCursor.

Esta función devuelve lo mismo que toRawText(), pero sustituirá algunos caracteres unicode por alternativas ASCII. En particular, el espacio sin salto (U+00A0) se sustituye por un espacio normal (U+0020), y los separadores de párrafo (U+2029) y línea (U+2028) se sustituyen por un salto de línea (U+000A). Si necesita el contenido exacto del documento, utilice en su lugar toRawText().

Véase también toHtml().

QString QTextDocument::toRawText() const

Devuelve el texto en bruto contenido en el documento sin ninguna información de formato. Si desea información de formato, utilice QTextCursor.

Véase también toPlainText().

void QTextDocument::undo(QTextCursor *cursor)

Deshace la última operación de edición en el documento si deshacer está disponible. El cursor proporcionado se sitúa al final de la ubicación donde se deshizo la operación de edición.

Consulte la documentación de Qt Undo Framework para más detalles.

Véase también undoAvailable() y isUndoRedoEnabled().

[slot] void QTextDocument::undo()

// Connect using qOverload:
connect(sender, &SenderClass::signal,
        textDocument, qOverload<>(&QTextDocument::undo));

// Or using a lambda as wrapper:
connect(sender, &SenderClass::signal,
        textDocument, [receiver = textDocument]() { receiver->undo(); });

[signal] void QTextDocument::undoAvailable(bool available)

Esta señal se emite cuando las operaciones de deshacer están disponibles (available es verdadero) o no disponibles (available es falso).

Consulte la documentación de Qt Undo Framework para más detalles.

Véase también undo() y isUndoRedoEnabled().

[signal] void QTextDocument::undoCommandAdded()

Esta señal se emite cada vez que se añade un nuevo nivel de deshacer a la QTextDocument.