Sur cette page

QTextFrame Class

La classe QTextFrame représente un cadre dans un QTextDocument. En savoir plus...

En-tête : #include <QTextFrame>
CMake : find_package(Qt6 REQUIRED COMPONENTS Gui)
target_link_libraries(mytarget PRIVATE Qt6::Gui)
qmake : QT += gui
Hérite de : QTextObject
Hérité par :

QTextTable

Remarque : toutes les fonctions de cette classe sont réentrantes.

Types publics

Fonctions publiques

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)

Description détaillée

Les cadres de texte permettent de structurer le texte d’un document. Ils servent de conteneurs génériques pour d’autres éléments du document. Les cadres sont généralement créés à l’aide de la fonction QTextCursor::insertFrame().

Les cadres peuvent servir à créer des structures hiérarchiques dans des documents de texte enrichi. Chaque document possède un cadre racine (QTextDocument::rootFrame()), et chaque cadre situé sous le cadre racine possède un cadre parent et une liste (éventuellement vide) de cadres enfants. Le cadre parent peut être identifié à l'aide de la fonction parentFrame(), tandis que la fonction childFrames() fournit la liste des cadres enfants.

Chaque cadre contient au moins un bloc de texte permettant aux curseurs de texte d’y insérer de nouveaux éléments de document. Par conséquent, la classe ` QTextFrame::iterator ` est utilisée pour parcourir à la fois les blocs et les cadres enfants au sein d’un cadre donné. Les premier et dernier éléments enfants du cadre peuvent être trouvés à l’aide des fonctions ` begin()` et ` end()`.

Un cadre possède également un format (spécifié à l’aide de ` QTextFrameFormat`) qui peut être défini avec ` setFormat()` et lu avec ` format()`.

Il est possible d’obtenir des curseurs de texte pointant vers les première et dernière positions de curseur valides au sein d’un cadre ; utilisez pour cela les fonctions firstCursorPosition() et lastCursorPosition(). L’étendue du cadre dans le document peut être déterminée à l’aide de firstPosition() et lastPosition().

Vous pouvez parcourir le contenu d’un cadre à l’aide de la classe QTextFrame::iterator: celle-ci fournit un accès en lecture seule à sa liste interne de blocs de texte et de cadres enfants.

Voir également QTextCursor et QTextDocument.

Documentation sur les types de membres

QTextFrame::Iterator

Synonyme de style Qt pour « QTextFrame::iterator ».

Documentation des fonctions membres

[explicit] QTextFrame::QTextFrame(QTextDocument *document)

Crée un nouveau cadre vide pour le texte « document ».

[virtual noexcept] QTextFrame::~QTextFrame()

Supprime le cadre de texte.

Avertissement : les cadresde texte appartiennent au document ; vous ne devez donc jamais les supprimer vous-même. Pour supprimer un cadre d'un document, supprimez son contenu à l'aide d'un « QTextCursor ».

QTextFrame::iterator QTextFrame::begin() const

Renvoie un itérateur pointant vers le premier élément de document à l'intérieur du cadre. Pour plus d'informations, veuillez consulter le document « Itérateurs de type STL ».

Voir également ` end()`.

QList<QTextFrame *> QTextFrame::childFrames() const

Renvoie une liste (éventuellement vide) des cadres enfants du cadre.

Voir aussi parentFrame().

QTextFrame::iterator QTextFrame::end() const

Renvoie un itérateur pointant vers la position située après le dernier élément de document à l'intérieur du cadre. Pour plus d'informations, veuillez consulter le document « Itérateurs de type STL ».

Voir également ` begin()`.

QTextCursor QTextFrame::firstCursorPosition() const

Renvoie la position du premier curseur à l'intérieur du cadre.

Voir également lastCursorPosition(), firstPosition() et lastPosition().

int QTextFrame::firstPosition() const

Renvoie la position du premier document à l'intérieur du cadre.

Voir également lastPosition(), firstCursorPosition() et lastCursorPosition().

QTextFrameFormat QTextFrame::frameFormat() const

Renvoie le format de l'image.

Voir aussi setFrameFormat().

QTextCursor QTextFrame::lastCursorPosition() const

Renvoie la dernière position du curseur à l'intérieur du cadre.

Voir également firstCursorPosition(), firstPosition() et lastPosition().

int QTextFrame::lastPosition() const

Renvoie la dernière position du document à l'intérieur du cadre.

Voir également firstPosition(), firstCursorPosition() et lastCursorPosition().

QTextFrame *QTextFrame::parentFrame() const

Renvoie le cadre parent du cadre. Si le cadre est le cadre racine d'un document, cette fonction renvoie 0.

Voir également childFrames() et QTextDocument::rootFrame().

void QTextFrame::setFrameFormat(const QTextFrameFormat &format)

Définit l'format du cadre.

Voir aussi 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.