QAbstractTextDocumentLayout Class
La clase `QAbstractTextDocumentLayout` es una clase base abstracta que se utiliza para implementar diseños personalizados para `QTextDocuments`. Más información...
| Encabezado: | #include <QAbstractTextDocumentLayout> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Gui) target_link_libraries(mytarget PRIVATE Qt6::Gui) |
| qmake: | QT += gui |
| Heredado de: | QObject |
| Heredado por: |
- Lista de todos los miembros, incluidos los heredados
- QAbstractTextDocumentLayout forma parte de las API de procesamiento de texto enriquecido.
Nota: Todas las funciones de esta clase son reentrantes.
Tipos públicos
| struct | PaintContext |
| struct | Selection |
Funciones públicas
| QAbstractTextDocumentLayout(QTextDocument *document) | |
| QString | anchorAt(const QPointF &position) const |
| virtual QRectF | blockBoundingRect(const QTextBlock &block) const = 0 |
| QTextBlock | blockWithMarkerAt(const QPointF &pos) const |
| QTextDocument * | document() const |
| virtual QSizeF | documentSize() const = 0 |
| virtual void | draw(QPainter *painter, const QAbstractTextDocumentLayout::PaintContext &context) = 0 |
| QTextFormat | formatAt(const QPointF &pos) const |
| virtual QRectF | frameBoundingRect(QTextFrame *frame) const = 0 |
| QTextObjectInterface * | handlerForObject(int objectType) const |
| virtual int | hitTest(const QPointF &point, Qt::HitTestAccuracy accuracy) const = 0 |
| QString | imageAt(const QPointF &pos) const |
| virtual int | pageCount() const = 0 |
| QPaintDevice * | paintDevice() const |
| void | registerHandler(int objectType, QObject *component) |
| void | setPaintDevice(QPaintDevice *device) |
| void | unregisterHandler(int objectType, QObject *component = nullptr) |
Señales
| void | documentSizeChanged(const QSizeF &newSize) |
| void | pageCountChanged(int newPages) |
| void | update(const QRectF &rect = QRectF(0., 0., 1000000000., 1000000000.)) |
| void | updateBlock(const QTextBlock &block) |
Funciones protegidas
| virtual void | documentChanged(int position, int charsRemoved, int charsAdded) = 0 |
| virtual void | drawInlineObject(QPainter *painter, const QRectF &rect, QTextInlineObject object, int posInDocument, const QTextFormat &format) |
| QTextCharFormat | format(int position) |
| virtual void | positionInlineObject(QTextInlineObject item, int posInDocument, const QTextFormat &format) |
| virtual void | resizeInlineObject(QTextInlineObject item, int posInDocument, const QTextFormat &format) |
Descripción detallada
El motor de maquetación estándar de Qt permite realizar tareas sencillas de procesamiento de texto, como la inserción de imágenes en línea, listas y tablas.
Algunas aplicaciones, como por ejemplo un procesador de textos o una aplicación de autoedición, pueden necesitar más funciones que las que ofrece el motor de maquetación de Qt; en ese caso, se puede crear una subclase de `QAbstractTextDocumentLayout` para proporcionar un comportamiento de maquetación personalizado para los documentos de texto.
Se puede instalar una instancia de la subclase de `QAbstractTextDocumentLayout` en un objeto ` QTextDocument ` mediante la función ` setDocumentLayout()`.
Se pueden insertar objetos personalizados en un ` QTextDocument`; consulte la descripción de la clase ` QTextObjectInterface ` para obtener más detalles.
Véase también QTextObjectInterface.
Documentación de las funciones miembro
[explicit] QAbstractTextDocumentLayout::QAbstractTextDocumentLayout(QTextDocument *document)
Crea un nuevo diseño de documento de texto para el archivo « document » especificado.
QString QAbstractTextDocumentLayout::anchorAt(const QPointF &position) const
Devuelve la referencia del ancla del ` position` indicado, o una cadena vacía si no existe ningún ancla en ese punto.
[pure virtual] QRectF QAbstractTextDocumentLayout::blockBoundingRect(const QTextBlock &block) const
Devuelve el rectángulo delimitador de block.
QTextBlock QAbstractTextDocumentLayout::blockWithMarkerAt(const QPointF &pos) const
Devuelve el bloque (probablemente un elemento de una lista) cuyo « marker » se encuentra en la posición indicada pos.
QTextDocument *QAbstractTextDocumentLayout::document() const
Devuelve el documento de texto sobre el que está trabajando este diseño.
[pure virtual protected] void QAbstractTextDocumentLayout::documentChanged(int position, int charsRemoved, int charsAdded)
Esta función se invoca cada vez que cambia el contenido del documento. Se produce un cambio cuando se inserta o se elimina texto, o una combinación de ambas acciones. El cambio se especifica mediante position, charsRemoved y charsAdded, que corresponden a la posición inicial del carácter en el que se produce el cambio, el número de caracteres eliminados del documento y el número de caracteres añadidos.
Por ejemplo, al insertar el texto «Hello» en un documento vacío, charsRemoved sería 0 y charsAdded sería 5 (la longitud de la cadena).
La sustitución de texto es una combinación de eliminación e inserción. Por ejemplo, si el texto «Hello» se sustituye por «Hi», charsRemoved sería 5 y charsAdded sería 2.
Para las subclases de QAbstractTextDocumentLayout, esta es la función principal en la que se realiza gran parte del trabajo de maquetación y posicionamiento del contenido del documento.
Por ejemplo, en una subclase que solo se encarga de organizar bloques de texto, una implementación de esta función tendría que hacer lo siguiente:
- Determinar la lista de objetos ` QTextBlock` modificados utilizando los parámetros proporcionados.
- Es necesario procesar el objeto « QTextLayout » correspondiente a cada objeto « QTextBlock ». Se puede acceder a la disposición del « QTextBlock » mediante la función « QTextBlock::layout()». Este procesamiento debe tener en cuenta el tamaño de página del documento.
- Si cambia el número total de páginas, se debe emitir la señal pageCountChanged().
- Si cambia el tamaño total, se debe emitir la señal documentSizeChanged().
- Se debe emitir la señal update() para programar un redibujado de las áreas del diseño que lo requieran.
Véase también QTextLayout.
[pure virtual] QSizeF QAbstractTextDocumentLayout::documentSize() const
Devuelve el tamaño total del diseño del documento.
Los widgets de visualización pueden utilizar esta información para actualizar correctamente sus barras de desplazamiento.
Véase también documentSizeChanged() y QTextDocument::pageSize.
[signal] void QAbstractTextDocumentLayout::documentSizeChanged(const QSizeF &newSize)
Esta señal se emite cuando el tamaño del diseño del documento cambia a newSize.
Las subclases de ` QAbstractTextDocumentLayout ` deben emitir esta señal cuando cambie el tamaño total del diseño del documento. Esta señal resulta útil para los widgets que muestran documentos de texto, ya que les permite actualizar correctamente sus barras de desplazamiento.
Véase también ` documentSize()`.
[pure virtual] void QAbstractTextDocumentLayout::draw(QPainter *painter, const QAbstractTextDocumentLayout::PaintContext &context)
Dibuja el diseño con el ` painter ` especificado utilizando el ` context` especificado.
[virtual protected] void QAbstractTextDocumentLayout::drawInlineObject(QPainter *painter, const QRectF &rect, QTextInlineObject object, int posInDocument, const QTextFormat &format)
Esta función se invoca para dibujar el objeto en línea, object, con el painter proporcionado, dentro del rectángulo especificado por rect, utilizando el texto especificado format.
posInDocument especifica la posición del objeto dentro del documento.
La implementación por defecto invoca a drawObject() en los controladores de objetos. Esta función solo se invoca dentro de Qt. Las subclases pueden reimplementar esta función para personalizar el dibujo de los objetos en línea.
Véase también draw().
[protected] QTextCharFormat QAbstractTextDocumentLayout::format(int position)
Devuelve el formato de caracteres aplicable en el position indicado.
QTextFormat QAbstractTextDocumentLayout::formatAt(const QPointF &pos) const
Devuelve el formato de texto en la posición indicada pos.
[pure virtual] QRectF QAbstractTextDocumentLayout::frameBoundingRect(QTextFrame *frame) const
Devuelve el rectángulo delimitador de frame.
QTextObjectInterface *QAbstractTextDocumentLayout::handlerForObject(int objectType) const
Devuelve un controlador para los objetos del tipo « objectType » especificado.
[pure virtual] int QAbstractTextDocumentLayout::hitTest(const QPointF &point, Qt::HitTestAccuracy accuracy) const
Devuelve la posición del cursor para el ` point ` dado con el ` accuracy` especificado. Devuelve -1 si no se ha encontrado ninguna posición de cursor válida.
QString QAbstractTextDocumentLayout::imageAt(const QPointF &pos) const
Devuelve la fuente de la imagen en la posición indicada pos, o una cadena vacía si no hay ninguna imagen en ese punto.
[pure virtual] int QAbstractTextDocumentLayout::pageCount() const
Devuelve el número de páginas que contiene el diseño.
Véase también pageCountChanged().
[signal] void QAbstractTextDocumentLayout::pageCountChanged(int newPages)
Esta señal se emite cuando cambia el número de páginas del diseño; ` newPages ` es el recuento actualizado de páginas.
Las subclases de ` QAbstractTextDocumentLayout ` deben emitir esta señal cuando cambie el número de páginas del diseño. Los cambios en el recuento de páginas se deben a modificaciones en el diseño o en el propio contenido del documento.
Véase también pageCount().
QPaintDevice *QAbstractTextDocumentLayout::paintDevice() const
Devuelve el dispositivo de dibujo utilizado para representar el diseño del documento.
Véase también setPaintDevice().
[virtual protected] void QAbstractTextDocumentLayout::positionInlineObject(QTextInlineObject item, int posInDocument, const QTextFormat &format)
Muestra el objeto en línea item utilizando el texto indicado format.
posInDocument Especifica la posición del objeto dentro del documento.
La implementación por defecto no hace nada. Esta función solo se invoca dentro de Qt. Las subclases pueden reimplementar esta función para personalizar la posición de los objetos en línea.
Véase también drawInlineObject().
void QAbstractTextDocumentLayout::registerHandler(int objectType, QObject *component)
Registra el objeto ` component ` indicado como controlador para los elementos del tipo ` objectType` especificado.
Nota: La función `registerHandler ()` debe invocarse una vez por cada tipo de objeto. Esto significa que solo hay un controlador para varios caracteres de sustitución del mismo tipo de objeto.
El diseño del documento de texto no asume la propiedad de component.
[virtual protected] void QAbstractTextDocumentLayout::resizeInlineObject(QTextInlineObject item, int posInDocument, const QTextFormat &format)
Establece el tamaño del objeto en línea item correspondiente al texto format.
posInDocument Especifica la posición del objeto dentro del documento.
La implementación por defecto redimensiona el objeto item al tamaño devuelto por la función intrinsicSize() del gestor del objeto. Esta función solo se invoca dentro de Qt. Las subclases pueden reimplementar esta función para personalizar el redimensionamiento de los objetos en línea.
void QAbstractTextDocumentLayout::setPaintDevice(QPaintDevice *device)
Establece el dispositivo de pintura utilizado para representar el diseño del documento en el device especificado.
Véase también paintDevice().
void QAbstractTextDocumentLayout::unregisterHandler(int objectType, QObject *component = nullptr)
Elimina el registro del « component » indicado como controlador para los elementos del « objectType » especificado, o de cualquier controlador si no se ha especificado el « component ».
[signal] void QAbstractTextDocumentLayout::update(const QRectF &rect = QRectF(0., 0., 1000000000., 1000000000.))
Esta señal se emite cuando se ha actualizado el rectángulo « rect ».
Las subclases de ` QAbstractTextDocumentLayout ` deben emitir esta señal cuando cambie la disposición del contenido para que se vuelva a dibujar.
[signal] void QAbstractTextDocumentLayout::updateBlock(const QTextBlock &block)
Esta señal se emite cuando se ha actualizado el elemento « block » especificado.
Las subclases de ` QAbstractTextDocumentLayout ` deben emitir esta señal cuando haya cambiado la disposición de ` block ` para volver a dibujarlo.
© 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.