QTextFrame Class
La clase QTextFrame representa un marco en un QTextDocument. Más información...
| Encabezado: | #include <QTextFrame> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Gui) target_link_libraries(mytarget PRIVATE Qt6::Gui) |
| qmake: | QT += gui |
| Heredado de: | QTextObject |
| Heredado por: |
- Lista de todos los miembros, incluidos los heredados
- QTextFrame forma parte de las API de procesamiento de texto enriquecido.
Nota: Todas las funciones de esta clase son reentrantes.
Tipos públicos
Funciones públicas
| QTextFrame(QTextDocument *document) | |
| virtual | ~QTextFrame() |
| QTextFrame::iterator | begin() const |
| QList<QTextFrame *> | childFrames() const |
| QTextFrame::iterator | end() const |
| QTextCursor | firstCursorPosition() const |
| int | firstPosition() const |
| QTextFrameFormat | frameFormat() const |
| QTextCursor | lastCursorPosition() const |
| int | lastPosition() const |
| QTextFrame * | parentFrame() const |
| void | setFrameFormat(const QTextFrameFormat &format) |
Descripción detallada
Los marcos de texto proporcionan estructura al texto de un documento. Se utilizan como contenedores genéricos para otros elementos del documento. Los marcos se suelen crear mediante la función QTextCursor::insertFrame().
Los marcos se pueden utilizar para crear estructuras jerárquicas en documentos de texto enriquecido. Cada documento tiene un marco raíz (QTextDocument::rootFrame()), y cada marco situado debajo del marco raíz tiene un marco padre y una lista (posiblemente vacía) de marcos hijos. El marco padre se puede localizar mediante parentFrame(), y la función childFrames() proporciona una lista de marcos hijos.
Cada marco contiene al menos un bloque de texto para permitir que los cursores de texto inserten nuevos elementos del documento en su interior. Por ello, la clase ` QTextFrame::iterator ` se utiliza para recorrer tanto los bloques como los marcos hijos dentro de un marco determinado. Los elementos hijos primero y último del marco se pueden localizar mediante ` begin()` y ` end()`.
Un marco también tiene un formato (especificado mediante QTextFrameFormat) que puede establecerse con setFormat() y leerse con format().
Se pueden obtener cursores de texto que apunten a la primera y última posición válida del cursor dentro de un marco; para ello, utilice las funciones firstCursorPosition() y lastCursorPosition(). La extensión del marco en el documento se puede averiguar con firstPosition() y lastPosition().
Se puede recorrer el contenido de un marco utilizando la clase ` QTextFrame::iterator `: esta proporciona acceso de solo lectura a su lista interna de bloques de texto y marcos secundarios.
Véase también QTextCursor y QTextDocument.
Documentación sobre los tipos de miembros
QTextFrame::Iterator
Sinónimo al estilo Qt de « QTextFrame::iterator ».
Documentación de la función miembro
[explicit] QTextFrame::QTextFrame(QTextDocument *document)
Crea un nuevo marco vacío para el texto « document ».
[virtual noexcept] QTextFrame::~QTextFrame()
Elimina el marco de texto.
Advertencia: Los marcosde texto pertenecen al documento, por lo que nunca debes eliminarlos tú mismo. Para eliminar un marco del documento, elimina su contenido utilizando un « QTextCursor ».
QTextFrame::iterator QTextFrame::begin() const
Devuelve un iterador que apunta al primer elemento del documento dentro del marco. Para obtener más información, consulta el documento «Iteradores al estilo STL ».
Véase también end().
QList<QTextFrame *> QTextFrame::childFrames() const
Devuelve una lista (que puede estar vacía) de los marcos secundarios del marco.
Véase también parentFrame().
QTextFrame::iterator QTextFrame::end() const
Devuelve un iterador que apunta a la posición situada más allá del último elemento de documento dentro del marco. Para obtener más información, consulta el documento «Iteradores al estilo STL ».
Véase también ` begin()`.
QTextCursor QTextFrame::firstCursorPosition() const
Devuelve la primera posición del cursor dentro del fotograma.
Véase también lastCursorPosition(), firstPosition() y lastPosition().
int QTextFrame::firstPosition() const
Devuelve la posición del primer documento dentro del marco.
Véase también lastPosition(), firstCursorPosition() y lastCursorPosition().
QTextFrameFormat QTextFrame::frameFormat() const
Devuelve el formato del fotograma.
Véase también setFrameFormat().
QTextCursor QTextFrame::lastCursorPosition() const
Devuelve la última posición del cursor dentro del fotograma.
Véanse también firstCursorPosition(), firstPosition() y lastPosition().
int QTextFrame::lastPosition() const
Devuelve la última posición del documento dentro del marco.
Véase también firstPosition(), firstCursorPosition() y lastCursorPosition().
QTextFrame *QTextFrame::parentFrame() const
Devuelve el marco padre del marco. Si el marco es el marco raíz de un documento, se devolverá 0.
Véase también childFrames() y QTextDocument::rootFrame().
void QTextFrame::setFrameFormat(const QTextFrameFormat &format)
Establece el valor de « format » del marco.
Véase también frameFormat().
© 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.