QTextFrame Class
La classe QTextFrame représente un cadre dans un site QTextDocument. 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 : | QTextObject |
| Hérité par : |
- Liste de tous les membres, y compris les membres hérités
- QTextFrame fait partie de Rich Text Processing APIs.
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 structurent le texte d'un document. Ils sont utilisés comme conteneurs génériques pour d'autres éléments du document. Les cadres sont généralement créés à l'aide de QTextCursor::insertFrame().
Les cadres peuvent être utilisés pour créer des structures hiérarchiques dans les documents de texte riche. 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 trouvé avec parentFrame(), et la fonction childFrames() fournit une liste des cadres enfants.
Chaque cadre contient au moins un bloc de texte pour permettre 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 d'un cadre donné. Le premier et le dernier élément enfant du cadre peuvent être trouvés avec begin() et end().
Un cadre a é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 qui pointent vers la première et la dernière position valide du curseur à l'intérieur d'un cadre ; utilisez pour cela les fonctions firstCursorPosition() et lastCursorPosition(). L'étendue du cadre dans le document peut être trouvée avec firstPosition() et lastPosition().
Vous pouvez itérer sur le contenu d'un bloc en utilisant la classe QTextFrame::iterator: celle-ci fournit un accès en lecture seule à sa liste interne de blocs de texte et de blocs 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()
Détruit le bloc de texte.
Attention : Les blocs de texte sont la propriété du document, vous ne devez donc jamais les détruire vous-même. Pour supprimer un bloc de son document, supprimez son contenu à l'aide d'une adresse QTextCursor.
QTextFrame::iterator QTextFrame::begin() const
Renvoie un itérateur pointant vers le premier élément du document à l'intérieur du cadre. Voir le document STL-style-Iterators pour plus d'informations.
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 du dernier élément du document à l'intérieur du cadre. Pour plus d'informations, voir le document Iterators STL-Style.
Voir également begin().
QTextCursor QTextFrame::firstCursorPosition() const
Renvoie la première position du curseur à l'intérieur du cadre.
Voir aussi lastCursorPosition(), firstPosition() et lastPosition().
int QTextFrame::firstPosition() const
Renvoie la première position du document à l'intérieur du cadre.
Voir aussi lastPosition(), firstCursorPosition() et lastCursorPosition().
QTextFrameFormat QTextFrame::frameFormat() const
Renvoie le format du cadre.
Voir aussi setFrameFormat().
QTextCursor QTextFrame::lastCursorPosition() const
Renvoie la dernière position du curseur à l'intérieur du cadre.
Voir aussi firstCursorPosition(), firstPosition() et lastPosition().
int QTextFrame::lastPosition() const
Renvoie la dernière position du document à l'intérieur du cadre.
Voir aussi firstPosition(), firstCursorPosition() et lastCursorPosition().
QTextFrame *QTextFrame::parentFrame() const
Renvoie le cadre parent du cadre. Si le cadre est le cadre racine d'un document, la valeur renvoyée sera 0.
Voir aussi childFrames() et QTextDocument::rootFrame().
void QTextFrame::setFrameFormat(const QTextFrameFormat &format)
Définit l'adresse 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.
