En esta página

QTextDocument Class

La clase QTextDocument contiene texto formateado. Más información...

Encabezado: #include <QTextDocument>
CMake: find_package(Qt6 REQUIRED COMPONENTS Gui)
target_link_libraries(mytarget PRIVATE Qt6::Gui)
qmake: QT += gui
Heredado de: QObject

Nota: Todas las funciones de esta clase son reentrantes.

Tipos públicos

enum FindFlag { FindBackward, FindCaseSensitively, FindWholeWords }
flags FindFlags
enum MarkdownFeature { MarkdownNoHTML, MarkdownDialectCommonMark, MarkdownDialectGitHub }
flags MarkdownFeatures
enum MetaInformation { DocumentTitle, DocumentUrl, CssMedia, FrontMatter }
(since 6.1) ResourceProvider
enum ResourceType { UnknownResource, HtmlResource, ImageResource, StyleSheetResource, MarkdownResource, UserResource }
enum Stacks { UndoStack, RedoStack, UndoAndRedoStacks }

Propiedades

Funciones públicas

QTextDocument(QObject *parent = nullptr)
QTextDocument(const QString &text, QObject *parent = nullptr)
virtual ~QTextDocument()
void addResource(int type, const QUrl &name, const QVariant &resource)
void adjustSize()
QList<QTextFormat> allFormats() const
int availableRedoSteps() const
int availableUndoSteps() const
QUrl baseUrl() const
(since 6.0) qreal baselineOffset() const
QTextBlock begin() const
int blockCount() const
QChar characterAt(int pos) const
int characterCount() const
virtual void clear()
void clearUndoRedoStacks(QTextDocument::Stacks stacksToClear = UndoAndRedoStacks)
QTextDocument *clone(QObject *parent = nullptr) const
Qt::CursorMoveStyle defaultCursorMoveStyle() const
QFont defaultFont() const
QString defaultStyleSheet() const
QTextOption defaultTextOption() const
QAbstractTextDocumentLayout *documentLayout() const
qreal documentMargin() const
void drawContents(QPainter *p, const QRectF &rect = QRectF())
QTextBlock end() const
QTextCursor find(const QRegularExpression &expr, const QTextCursor &cursor, QTextDocument::FindFlags options = FindFlags()) const
QTextCursor find(const QRegularExpression &expr, int from = 0, QTextDocument::FindFlags options = FindFlags()) const
QTextCursor find(const QString &subString, const QTextCursor &cursor, QTextDocument::FindFlags options = FindFlags()) const
QTextCursor find(const QString &subString, int position = 0, QTextDocument::FindFlags options = FindFlags()) const
QTextBlock findBlock(int pos) const
QTextBlock findBlockByLineNumber(int lineNumber) const
QTextBlock findBlockByNumber(int blockNumber) const
QTextBlock firstBlock() const
qreal idealWidth() const
qreal indentWidth() const
bool isEmpty() const
bool isLayoutEnabled() const
bool isModified() const
bool isRedoAvailable() const
bool isUndoAvailable() const
bool isUndoRedoEnabled() const
QTextBlock lastBlock() const
int lineCount() const
void markContentsDirty(int position, int length)
int maximumBlockCount() const
QString metaInformation(QTextDocument::MetaInformation info) const
QTextObject *object(int objectIndex) const
QTextObject *objectForFormat(const QTextFormat &f) const
int pageCount() const
QSizeF pageSize() const
void print(QPagedPaintDevice *printer) const
void redo(QTextCursor *cursor)
QVariant resource(int type, const QUrl &name) const
(since 6.1) QTextDocument::ResourceProvider resourceProvider() const
int revision() const
QTextFrame *rootFrame() const
void setBaseUrl(const QUrl &url)
(since 6.0) void setBaselineOffset(qreal baseline)
void setDefaultCursorMoveStyle(Qt::CursorMoveStyle style)
void setDefaultFont(const QFont &font)
void setDefaultStyleSheet(const QString &sheet)
void setDefaultTextOption(const QTextOption &option)
void setDocumentLayout(QAbstractTextDocumentLayout *layout)
void setDocumentMargin(qreal margin)
void setHtml(const QString &html)
void setIndentWidth(qreal width)
void setLayoutEnabled(bool b)
void setMarkdown(const QString &markdown, QTextDocument::MarkdownFeatures features = MarkdownDialectGitHub)
void setMaximumBlockCount(int maximum)
void setMetaInformation(QTextDocument::MetaInformation info, const QString &string)
void setPageSize(const QSizeF &size)
void setPlainText(const QString &text)
(since 6.1) void setResourceProvider(const QTextDocument::ResourceProvider &provider)
(since 6.0) void setSubScriptBaseline(qreal baseline)
(since 6.0) void setSuperScriptBaseline(qreal baseline)
void setTextWidth(qreal width)
void setUndoRedoEnabled(bool enable)
void setUseDesignMetrics(bool b)
QSizeF size() const
(since 6.0) qreal subScriptBaseline() const
(since 6.0) qreal superScriptBaseline() const
qreal textWidth() const
QString toHtml() const
QString toMarkdown(QTextDocument::MarkdownFeatures features = MarkdownDialectGitHub) const
QString toPlainText() const
QString toRawText() const
void undo(QTextCursor *cursor)
bool useDesignMetrics() const

Ranuras públicas

void redo()
void setModified(bool m = true)
void undo()

Señales

void baseUrlChanged(const QUrl &url)
void blockCountChanged(int newBlockCount)
void contentsChange(int position, int charsRemoved, int charsAdded)
void contentsChanged()
void cursorPositionChanged(const QTextCursor &cursor)
void documentLayoutChanged()
void modificationChanged(bool changed)
void redoAvailable(bool available)
void undoAvailable(bool available)
void undoCommandAdded()

Miembros públicos estáticos

(since 6.1) QTextDocument::ResourceProvider defaultResourceProvider()
(since 6.1) void setDefaultResourceProvider(const QTextDocument::ResourceProvider &provider)

Funciones protegidas

virtual QTextObject *createObject(const QTextFormat &format)
virtual QVariant loadResource(int type, const QUrl &name)

Descripción detallada

QTextDocument es un contenedor para documentos de texto enriquecido estructurados, que admite texto con estilo y diversos tipos de elementos de documento, como listas, tablas, marcos e imágenes. Se pueden crear para su uso en un ` QTextEdit` o utilizarse de forma independiente.

Cada elemento del documento se describe mediante un objeto de formato asociado. QTextDocuments trata cada objeto de formato como un objeto único, y puede pasarse a ` objectForFormat()` para obtener el elemento del documento al que se aplica.

Un `QTextDocument` puede editarse mediante programación utilizando ` QTextCursor`, y su contenido puede examinarse recorriendo la estructura del documento. Toda la estructura del documento se almacena como una jerarquía de elementos de documento bajo el marco raíz, al que se accede mediante la función ` rootFrame()`. Alternativamente, si solo se desea recorrer el contenido textual del documento, se pueden utilizar ` begin()`, ` end()` y ` findBlock()` para recuperar bloques de texto que se pueden examinar y recorrer.

El diseño de un documento viene determinado por la función ` documentLayout`(); puedes crear tu propia subclase de ` QAbstractTextDocumentLayout ` y establecerla mediante ` setDocumentLayout()` si deseas utilizar tu propia lógica de diseño. El título del documento y otra metainformación se pueden obtener llamando a la función metaInformation(). Para los documentos que se muestran a los usuarios a través de la clase QTextEdit, el título del documento también está disponible mediante la función QTextEdit::documentTitle().

Las funciones de conveniencia toPlainText() y toHtml() permiten recuperar el contenido del documento como texto sin formato y como HTML. Se puede realizar una búsqueda en el texto del documento utilizando las funciones find().

Las operaciones de deshacer y rehacer realizadas en el documento se pueden controlar mediante la función ` setUndoRedoEnabled()`. El sistema de deshacer/rehacer puede controlarse desde un widget de editor a través de las ranuras ` undo()` y ` redo()`; el documento también proporciona las señales ` contentsChanged()`, ` undoAvailable()` y ` redoAvailable()`, que informan a los widgets de editor conectados sobre el estado del sistema de deshacer/rehacer. A continuación se describen las operaciones de deshacer/rehacer de un QTextDocument:

  • Inserción o eliminación de caracteres. Una secuencia de inserciones o eliminaciones dentro del mismo bloque de texto se considera una única operación de deshacer/rehacer.
  • Inserción o eliminación de bloques de texto. Las secuencias de inserciones o eliminaciones en una única operación (por ejemplo, al seleccionar y luego borrar texto) se consideran una única operación de deshacer/rehacer.
  • Cambios en el formato de los caracteres de texto.
  • Cambios en el formato de bloques de texto.
  • Cambios en el formato de grupos de bloques de texto.

Véase también « QTextCursor », « QTextEdit » y «Rich Text Processing».

Documentación sobre tipos de miembro

enum QTextDocument::FindFlag
flags QTextDocument::FindFlags

Esta enumeración describe las opciones disponibles para la función «find» de QTextDocument. Las opciones se pueden combinar mediante la operación «O» a partir de la siguiente lista:

ConstanteValorDescripción
QTextDocument::FindBackward0x00001Busca hacia atrás en lugar de hacia adelante.
QTextDocument::FindCaseSensitively0x00002Por defecto, la función «find» no distingue entre mayúsculas y minúsculas. Al especificar esta opción, el comportamiento cambia a una búsqueda que distingue entre mayúsculas y minúsculas.
QTextDocument::FindWholeWords0x00004Hace que la búsqueda solo coincida con palabras completas.

El tipo `FindFlags` es una definición de tipo para `QFlags<FindFlag>`. Almacena una combinación «o» de valores de `FindFlag`.

enum QTextDocument::MarkdownFeature
flags QTextDocument::MarkdownFeatures

Esta enumeración selecciona el conjunto de características compatibles al leer o escribir Markdown.

ConstanteValorDescripción
QTextDocument::MarkdownNoHTML0x0020 | 0x0040Se descartarán todas las etiquetas HTML presentes en el texto Markdown
QTextDocument::MarkdownDialectCommonMark0Solo las funciones estandarizadas por CommonMark
QTextDocument::MarkdownDialectGitHub0x0004 | 0x0008 | 0x0400 | 0x0100 | 0x0200 | 0x0800 | 0x4000 | 0x100000La mayoría de las características del dialecto de GitHub

En concreto, el subconjunto compatible del dialecto de GitHub incluye todo lo que contiene CommonMark, además de:

  • reconocer direcciones URL, «www» y direcciones de correo electrónico, y convertirlas en enlaces
  • tachado
  • subrayado (distinto de la cursiva; en CommonMark es lo mismo)
  • tablas
  • listas de tareas
  • front matter

La «parte preliminar» suele consistir en metadatos en formato YAML. Actualmente, Qt no incluye un analizador para ello; sin embargo, puedes elegir un analizador de terceros, llamar a QTextDocument::metaInformation() para obtener el bloque completo e invocar tu propio analizador una vez que Qt haya analizado el archivo Markdown.

Nota: La salida Markdown de toMarkdown() puede incluir actualmente características de GitHub, incluso si intentas desactivarlas especificando otro valor de enumeración. Es posible que esto se solucione en una futura versión de Qt.

El tipo `MarkdownFeatures` es una definición de tipo para ` QFlags<MarkdownFeature>`. Almacena una combinación OR de valores de `MarkdownFeature`.

Véase también toMarkdown() y setMarkdown().

enum QTextDocument::MetaInformation

Esta enumeración describe los diferentes tipos de metainformación que se pueden añadir a un documento.

ConstanteValorDescripción
QTextDocument::DocumentTitle0El título del documento.
QTextDocument::DocumentUrl1La URL del documento. La función loadResource() utiliza esta URL como base al cargar recursos relativos.
QTextDocument::CssMedia2Este valor se utiliza para seleccionar la regla «@media» correspondiente, si la hay, de una hoja de estilos CSS especificada cuando se llama a setHtml(). Este valor de enumeración se ha introducido en Qt 6.3.
QTextDocument::FrontMatter3Este valor se utiliza para seleccionar el material de cabecera, si se extrajo alguno durante el análisis del archivo fuente (actualmente solo del formato Markdown). Este valor de enumeración se ha introducido en Qt 6.8.

Véase también metaInformation(), setMetaInformation() y setHtml().

[alias, since 6.1] QTextDocument::ResourceProvider

Alias de tipo para std::function<QVariant(const QUrl&)>.

Este typedef se introdujo en Qt 6.1.

enum QTextDocument::ResourceType

Esta enumeración describe los tipos de recursos que pueden cargarse mediante la función loadResource() de QTextDocument o mediante QTextBrowser::setSource().

ConstanteValorDescripción
QTextDocument::UnknownResource0No se ha cargado ningún recurso o se desconoce el tipo de recurso.
QTextDocument::HtmlResource1El recurso contiene HTML.
QTextDocument::ImageResource2El recurso contiene datos de imagen. Los tipos de datos compatibles actualmente son QMetaType::QPixmap y QMetaType::QImage. Si la variante correspondiente es de tipo QMetaType::QByteArray, Qt intenta cargar la imagen utilizando QImage::loadFromData. Actualmente no se admite QMetaType::QIcon. El icono debe convertirse primero a uno de los tipos compatibles, por ejemplo, utilizando QIcon::pixmap.
QTextDocument::StyleSheetResource3El recurso contiene CSS.
QTextDocument::MarkdownResource4El recurso contiene Markdown.
QTextDocument::UserResource100El primer valor disponible para los tipos de recursos definidos por el usuario.

Véase también loadResource() y QTextBrowser::sourceType().

enum QTextDocument::Stacks

ConstanteValorDescripción
QTextDocument::UndoStack0x01La pila de deshacer.
QTextDocument::RedoStack0x02La pila de rehacer.
QTextDocument::UndoAndRedoStacksUndoStack | RedoStackTanto la pila de deshacer como la de rehacer.

Documentación de propiedades

baseUrl : QUrl

Esta propiedad contiene la URL base que se utiliza para resolver las URL relativas de los recursos dentro del documento.

Las URL de los recursos se resuelven como si estuvieran en el mismo directorio que el destino de la URL base, lo que significa que se ignorará cualquier parte de la ruta que se encuentre después de la última «/».

URL baseURL relativaURL resuelta
file:///ruta/al/contenidoimages/logo.pngfile:///ruta/a/imágenes/logo.png
file:///ruta/al/contenido/imágenes/logotipo.pngarchivo:///ruta/al/contenido/imágenes/logotipo.png
file:///ruta/a/contenido/index.htmlimágenes/logo.pngfile:///ruta/al/contenido/imágenes/logo.png
file:///ruta/al/contenido/imágenes/../imágenes/logo.pngfile:///ruta/al/contenido/imágenes/logo.png

Funciones de acceso:

QUrl baseUrl() const
void setBaseUrl(const QUrl &url)

Señal del notificador:

void baseUrlChanged(const QUrl &url)

[read-only] blockCount : int

Esta propiedad contiene el número de bloques de texto del documento.

El valor de esta propiedad no está definido en documentos con tablas o marcos.

Por defecto, si está definida, esta propiedad contiene el valor 1.

Funciones de acceso:

int blockCount() const

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

defaultFont : QFont

Esta propiedad contiene la fuente predeterminada que se utiliza para mostrar el texto del documento

Funciones de Access:

QFont defaultFont() const
void setDefaultFont(const QFont &font)

defaultStyleSheet : QString

La hoja de estilo predeterminada se aplica a todo el texto con formato HTML nuevo que se inserte en el documento, por ejemplo, utilizando setHtml() o QTextCursor::insertHtml().

La hoja de estilo debe cumplir con la sintaxis de CSS 2.1.

Nota: Cambiar la hoja de estilo predeterminada no tiene ningún efecto sobre el contenido ya existente del documento.

Funciones de acceso:

QString defaultStyleSheet() const
void setDefaultStyleSheet(const QString &sheet)

Véase también «Subconjunto HTML compatible».

defaultTextOption : QTextOption

Esta propiedad establece que la opción de texto predeterminada se aplicará a todos los elementos « QTextLayout» del documento.

Cuando se crean los « QTextBlock», la propiedad «defaultTextOption» se establece en su « QTextLayout ». Esto permite configurar propiedades globales para el documento, como el modo predeterminado de ajuste de línea.

Funciones de Access:

QTextOption defaultTextOption() const
void setDefaultTextOption(const QTextOption &option)

documentMargin : qreal

El margen que rodea el documento. El valor por defecto es 4.

Funciones de Access:

qreal documentMargin() const
void setDocumentMargin(qreal margin)

indentWidth : qreal

Devuelve la anchura utilizada para la sangría de las listas de texto y los 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.

Funciones de Access:

qreal indentWidth() const
void setIndentWidth(qreal width)

[since 6.4] layoutEnabled : bool

Esta propiedad determina si QTextDocument debe volver a calcular el diseño tras cada cambio

Si esta propiedad se establece en «true», cualquier cambio en el documento activa un proceso de maquetación, lo que hace que todo funcione como se espera, pero lleva tiempo.

Desactivar temporalmente el diseño puede ahorrar tiempo al realizar múltiples cambios (no solo en el contenido del texto, sino también en la fuente predeterminada, la opción de texto predeterminada...), de modo que el documento solo se maquetará una vez al final. Esto puede resultar útil cuando aún se desconoce el ancho del texto o el tamaño de la página, por ejemplo.

Por defecto, esta propiedad tiene el valor « true ».

Esta enumeración se introdujo en Qt 6.4.

Funciones de acceso:

bool isLayoutEnabled() const
void setLayoutEnabled(bool b)

Véase también setTextWidth.

maximumBlockCount : int

Especifica el límite de bloques del documento.

Especifica el número máximo de bloques que puede contener el documento. Si el documento contiene más bloques de los especificados con esta propiedad, los bloques se eliminarán del principio del documento.

Un valor negativo o igual a cero indica que el documento puede contener un número ilimitado de bloques.

El valor por defecto es 0.

Ten en cuenta que al establecer esta propiedad, el límite se aplicará inmediatamente al contenido del documento.

Al establecer esta propiedad, también se desactiva el historial de deshacer y rehacer.

Esta propiedad no está definida en documentos con tablas o marcos.

Funciones de Access:

int maximumBlockCount() const
void setMaximumBlockCount(int maximum)

modified : bool

Esta propiedad indica si el usuario ha modificado el documento

Por defecto, esta propiedad es « false ».

Funciones de acceso:

bool isModified() const
void setModified(bool m = true)

Véase también modificationChanged().

pageSize : QSizeF

Esta propiedad contiene el tamaño de página que debe utilizarse para maquetar el documento

Las unidades vienen determinadas por el dispositivo de dibujo subyacente. El tamaño se mide en píxeles lógicos cuando se dibuja en pantalla, y en puntos (1/72 de pulgada) cuando se dibuja en una impresora.

De forma predeterminada, en un documento vacío recién creado, esta propiedad contiene un tamaño indefinido.

Funciones de acceso:

QSizeF pageSize() const
void setPageSize(const QSizeF &size)

Véase también modificationChanged().

[read-only] size : QSizeF

Esta propiedad contiene el tamaño real del documento. Es equivalente a documentLayout()->documentSize();

El tamaño del documento se puede modificar estableciendo el ancho del texto o el tamaño de toda la página.

Ten en cuenta que el ancho es siempre >= pageSize().width().

Por defecto, en un documento vacío recién creado, esta propiedad contiene un tamaño que depende de la configuración.

Funciones de acceso:

QSizeF size() const

Véanse también setTextWidth(), setPageSize() y idealWidth().

textWidth : qreal

El ancho de texto especifica el ancho preferido para el texto del documento. Si el texto (o el contenido en general) es más ancho que el especificado, se divide en varias líneas y se amplía verticalmente. Si el texto no puede dividirse en varias líneas para ajustarse al ancho de texto especificado, será más grande y las propiedades size() y idealWidth() reflejarán ese cambio.

Si el ancho del texto se establece en -1, el texto no se dividirá en varias líneas a menos que se imponga mediante un salto de línea explícito o un nuevo párrafo.

El valor por defecto es -1.

Al establecer el ancho del texto, la altura de la página también se fijará en -1, lo que hará que el documento se amplíe o se reduzca verticalmente de forma continua. Si deseas que el diseño del documento divida el texto en varias páginas, debes establecer en su lugar la propiedad pageSize.

Funciones de Access:

qreal textWidth() const
void setTextWidth(qreal width)

Véanse también « size()», « idealWidth()» y « pageSize()».

undoRedoEnabled : bool

Esta propiedad indica si las funciones de deshacer y rehacer están activadas para este documento

El valor por defecto es «true». Si se desactiva, la pila de deshacer se borra y no se añadirá ningún elemento a ella.

Funciones de acceso:

bool isUndoRedoEnabled() const
void setUndoRedoEnabled(bool enable)

useDesignMetrics : bool

Esta propiedad determina si el documento utiliza métricas de diseño de las fuentes para mejorar la precisión de la maquetación del texto

Si esta propiedad se establece en «true», la maquetación utilizará métricas de diseño. De lo contrario, se utilizarán las métricas del dispositivo de dibujo tal y como se definen en ` QAbstractTextDocumentLayout::setPaintDevice()``.

El uso de métricas de diseño hace que el ancho de una maquetación ya no dependa del hinting ni del redondeo de píxeles. Esto significa que la maquetación de texto WYSIWYG pasa a ser posible, ya que el ancho se escala de forma mucho más lineal en función de las métricas del dispositivo de pintura de lo que lo haría de otro modo.

Por defecto, esta propiedad es false.

Funciones de acceso:

bool useDesignMetrics() const
void setUseDesignMetrics(bool b)

Documentación de funciones de miembro

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

Crea un QTextDocument vacío con el parent proporcionado.

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

Crea un QTextDocument que contiene el texto sin formato (sin formato) text especificado, y con el parent indicado.

[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, puedes añadir una imagen como recurso para poder hacer referencia a ella desde el propio documento:

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

La imagen se puede insertar en el documento utilizando la API QTextCursor:

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

Como alternativa, puedes 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 con 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 que se pasa a « newBlockCount » es el nuevo total.

QChar QTextDocument::characterAt(int pos) const

Devuelve el carácter situado 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.

Nota: Dado que un objeto ` QTextDocument ` siempre contiene al menos un objeto ` QChar::ParagraphSeparator`, este método devolverá como mínimo 1.

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 mediante ` stacksToClear`.

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

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

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

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

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

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

Se proporciona información sobre la position del carácter del documento en el que se produjo 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 gancho permite implementar el resaltado de sintaxis en 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 se 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 de documento (un ` QTextObject`), basado en el ` format` proporcionado.

Los QTextObjects siempre se crearán mediante este método, por lo que deberás 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 cambia la posición del cursor debido a una operación de edición. El cursor que ha cambiado se pasa en ` cursor`. Si el documento se utiliza con la clase ` QTextEdit ` y necesitas una señal cuando el cursor se desplaza con las teclas de flecha, puedes utilizar la señal ` cursorPositionChanged()` en ` QTextEdit`.

Qt::CursorMoveStyle QTextDocument::defaultCursorMoveStyle() const

Todos los objetos « QTextCursor » creados a partir del documento utilizan el estilo de movimiento del cursor predeterminado. El valor predeterminado es « Qt::LogicalMoveStyle ».

Véase también setDefaultCursorMoveStyle().

QFont QTextDocument::defaultFont() const

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

Nota: Funcióngetter para la propiedad defaultFont.

Véase también setDefaultFont().

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

Devuelve el proveedor de recursos predeterminado.

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 predeterminada se aplica a todos los objetos ` QTextLayout ` del documento. Esto permite establecer propiedades globales para el documento, como el modo predeterminado de ajuste de línea.

Nota: Funcióngetter para la propiedad defaultTextOption.

Véase también setDefaultTextOption().

QAbstractTextDocumentLayout *QTextDocument::documentLayout() const

Devuelve el diseño de este 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 según rect. Si rect es un rectángulo nulo (por defecto), el documento se dibuja sin recortar.

QTextBlock QTextDocument::end() const

Esta función devuelve un bloque para comprobar si se ha llegado al final del documento mientras se recorre este.

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 situado después del último bloque del documento. Puedes 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 indicada, expr, dentro del mismo párrafo del documento.

La búsqueda comienza en la posición de la expresión « cursor » especificada y avanza hacia delante por el documento, salvo que se especifique lo contrario en las opciones de búsqueda. Los parámetros « options » controlan el tipo de búsqueda que se realiza.

Devuelve un cursor con la coincidencia seleccionada si se ha encontrado alguna; de lo contrario, devuelve un cursor nulo.

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

Por defecto, la búsqueda no distingue entre mayúsculas y minúsculas, y puede encontrar coincidencias en 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 indicada, expr, dentro del mismo párrafo del documento.

La búsqueda comienza en la posición indicada from y avanza hacia adelante por el documento, salvo que se especifique lo contrario en las opciones de búsqueda. Los parámetros options controlan el tipo de búsqueda que se realiza.

Devuelve un cursor con la coincidencia seleccionada si se ha encontrado alguna; de lo contrario, devuelve un cursor nulo.

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

Advertencia: por motivos históricos, se ignora la opción de distinción entre mayúsculas y minúsculas establecida en ` expr `. En su lugar, se utilizan los parámetros ` options ` para determinar si la búsqueda distingue entre mayúsculas y minúsculas o no.

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 indicada por « cursor » y avanza hacia delante por el documento, salvo que se especifique lo contrario en las opciones de búsqueda. Los parámetros « options » determinan el tipo de búsqueda que se realiza.

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

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

Por defecto, la búsqueda no distingue entre mayúsculas y minúsculas, y puede encontrar coincidencias en 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 posición indicada « position » y avanza hacia adelante por el documento, salvo que se especifique lo contrario en las opciones de búsqueda. Los parámetros « options » determinan el tipo de búsqueda que se realiza.

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

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

Esta es una función sobrecargada.

QTextBlock QTextDocument::findBlock(int pos) const

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

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 el ` blockNumber` especificado.

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

QTextBlock QTextDocument::firstBlock() const

Devuelve el primer bloque de texto del documento.

qreal QTextDocument::idealWidth() const

Devuelve el ancho ideal del documento de texto. El ancho ideal es el ancho realmente utilizado por el 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 la opción «redo» está disponible; en caso contrario, devuelve « false ».

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

bool QTextDocument::isUndoAvailable() const

Devuelve « true » si la función «undo» 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 el diseño lo permite). En caso contrario, este valor 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 los datos del documento « type » especificado a partir del recurso indicado en « name ».

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

Cuando Qt la invoca, ` type ` es uno de los valores de ` QTextDocument::ResourceType`.

Si el QTextDocument es un objeto hijo de un 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.

Nota: Esta función se puede invocar a través del sistema de metaobjetos y desde QML. Véase Q_INVOKABLE.

Véase también QTextDocument::ResourceProvider.

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

Marca como «modificados» los contenidos especificados por los enlaces position y length, indicando al documento que debe volver a maquetarse.

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 cada vez 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, si se invoca a ` setModified(false)` en un documento y, a continuación, se inserta texto, se emite la señal. Si se deshace esa operación, con lo que el documento vuelve 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 entrada « objectIndex » indicada.

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 el dispositivo de impresión especificado printer. El dispositivo de impresión QPagedPaintDevice debe estar configurado antes de utilizarlo con esta función.

Se trata únicamente de un método de conveniencia para imprimir todo el documento en la impresora.

Si el documento ya está paginado según una altura especificada en la propiedad pageSize(), se imprime tal cual.

Si el documento no está paginado, como por ejemplo un documento utilizado en un ` QTextEdit`, se crea una copia temporal del documento y dicha copia se divide en varias páginas según el tamaño de `paperRect()` del dispositivo de impresión. 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)

Vuelve a realizar la última operación de edición en el documento si redo is available.

El objeto « cursor » proporcionado se sitúa al final de la ubicación en la que se ha repetido la operación de edición.

[slot] void QTextDocument::redo()

Vuelve a realizar la última operación de edición en el documento si redo is available.

Nota: Esta ranura está sobrecargada. Para conectarse a esta ranura:

// 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(); });
Para ver más ejemplos y métodos, consulta «Conexión a ranuras sobrecargadas».

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

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

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

Devuelve los datos del « type » especificado a partir del recurso con el « name » indicado.

El motor de texto enriquecido invoca esta función para solicitar datos que no están almacenados directamente en QTextDocument, pero que sí están 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 no se encuentra un recurso en la caché, se invoca a loadResource para intentar cargarlo. A continuación, loadResource debería utilizar addResource para añadir el recurso a la caché.

Si loadResource no carga el recurso, se llamará a resourceProvider y, por último, a defaultResourceProvider, si están definidos. Ten 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 de 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 la función de deshacer está activada).

Se garantiza que la revisión aumentará cuando se edite un documento que no haya 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 de base como un porcentaje de la altura de la fuente que se utilizará en el diseño del documento en baseline. El valor por defecto es 0. Un valor positivo desplaza el texto hacia arriba en el porcentaje 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 predeterminado de movimiento del cursor en el valor indicado en style.

Véase también ` defaultCursorMoveStyle()`.

void QTextDocument::setDefaultFont(const QFont &font)

Establece el valor predeterminado de la propiedad « font » que se utilizará en el diseño del documento.

Nota: Funciónde asignación para la propiedad defaultFont.

Véase también defaultFont().

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

Establece el proveedor de recursos predeterminado en provider.

Todos los objetos QTextDocument que no tengan un proveedor establecido explícitamente utilizarán el proveedor por defecto.

Esta función se introdujo en Qt 6.1.

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

void QTextDocument::setDefaultTextOption(const QTextOption &option)

Establece la opción de texto predeterminada en « option ».

Nota: Funciónde asignación para la propiedad ` defaultTextOption`.

Véase también ` defaultTextOption()`.

void QTextDocument::setDocumentLayout(QAbstractTextDocumentLayout *layout)

Establece que el documento utilice el « layout » indicado. Se elimina el diseño anterior.

Véase también documentLayoutChanged().

void QTextDocument::setHtml(const QString &html)

Sustituye todo el contenido del documento por el texto con formato HTML que figura en la cadena html. El historial de deshacer/rehacer se restablece al llamar a esta función.

Se respeta el formato HTML en la medida de lo posible; por ejemplo, «<b>texto en negrita</b>» generará un texto en el que la primera palabra tendrá un peso de fuente que le dará un aspecto en negrita: «textoen negrita ».

Para seleccionar una regla de medios CSS distinta de la regla predeterminada «screen», utiliza setMetaInformation() con «CssMedia » como parámetro «info».

Nota: Es responsabilidad del usuario asegurarse de que el texto se decodifique correctamente cuando se cree un objeto QString que contenga HTML y se pase a setHtml().

Véase también setPlainText(), Subconjunto de HTML compatible y setMetaInformation().

void QTextDocument::setIndentWidth(qreal width)

Establece el valor de « width » utilizado para la sangría de las listas de texto y los bloques de texto.

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

Nota: Funciónde asignación para la propiedad ` indentWidth`.

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 proporcionado en la cadena « markdown », y admite la configuración indicada en « features ». De forma predeterminada, se incluyen todas las características compatibles con el Markdown al estilo de GitHub; pasa « MarkdownDialectCommonMark » para un análisis más básico.

El formato Markdown se respeta en la medida de lo posible; por ejemplo, «texto *en negrita*» generará un texto en el que la primera palabra tendrá un peso de fuente que le dará un aspecto resaltado.

El análisis del HTML incluido en la cadena markdown se gestiona de la misma forma que en setHtml; sin embargo, no se admite el formato Markdown dentro de bloques HTML.

Algunas características del analizador se pueden activar o desactivar mediante el argumento features. El valor por defecto es MarkdownDialectGitHub.

El historial de deshacer/rehacer se restablece al llamar 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 valor dado string.

Véase también metaInformation().

void QTextDocument::setPlainText(const QString &text)

Sustituye todo el contenido del documento por el texto sin formato proporcionado: text. El historial de deshacer/rehacer se restablece al llamar a esta función.

Véase también setHtml().

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

Establece el proveedor de recursos del 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 de base predeterminada de los subíndices como un porcentaje de la altura de la fuente que se utilizará en el diseño del documento en baseline. El valor predeterminado es el 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 de base predeterminada de los superíndices como un porcentaje de la altura de la fuente que se utilizará en el diseño del documento en baseline. El valor predeterminado es el 50 % (la mitad 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 de base del superíndice como un porcentaje 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 de base del superíndice como porcentaje 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 conviertes la cadena HTML devuelta en una matriz de bytes para transmitirla por una red o al guardarla en disco, debes utilizar QString::toUtf8() para convertir la cadena en un QByteArray.

Véase también «Subconjunto HTML compatible».

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

Devuelve una cadena que contiene una representación en Markdown del documento con el features especificado, 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 que contiene el documento. Si deseas obtener información sobre el formato, utiliza en su lugar la función ` QTextCursor `.

Esta función devuelve lo mismo que toRawText(), pero sustituirá algunos caracteres Unicode por sus equivalentes ASCII. En concreto, el espacio no separable (U+00A0) se sustituye por un espacio normal (U+0020), y tanto los separadores de párrafo (U+2029) como los de línea (U+2028) se sustituyen por un salto de línea (U+000A). Si necesitas el contenido exacto del documento, utiliza en su lugar toRawText().

Nota: Los objetosincrustados , como las imágenes, se representan mediante el valor Unicode U+FFFC (CARÁCTER DE SUSTITUCIÓN DE OBJETO).

Véase también toHtml().

QString QTextDocument::toRawText() const

Devuelve el texto sin formato que contiene el documento, sin ninguna información de formato. Si deseas obtener información de formato, utiliza en su lugar « QTextCursor ».

Véase también toPlainText().

void QTextDocument::undo(QTextCursor *cursor)

Deshace la última operación de edición realizada en el documento, si la función de deshacer está disponible. El objeto ` cursor ` proporcionado se sitúa al final de la ubicación en la que se ha deshecho la operación de edición.

Consulta la documentación del marco de trabajo «Qt Undo Framework » para obtener más detalles.

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

[slot] void QTextDocument::undo()

Nota: Esta ranura está sobrecargada. Para conectarse a esta ranura:

// 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(); });
Para ver más ejemplos y métodos, consulta «Conexión a ranuras sobrecargadas».

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

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

Consulta la documentación del marco de trabajo de deshacer de Qt para obtener más detalles.

Véanse 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 clase ` QTextDocument`.

© 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.