QTextFrame Class
Die Klasse QTextFrame repräsentiert einen Rahmen in einem QTextDocument. Mehr...
| Kopfzeile: | #include <QTextFrame> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Gui)target_link_libraries(mytarget PRIVATE Qt6::Gui) |
| qmake: | QT += gui |
| Vererbt: | QTextObject |
| Vererbt von: |
- Liste aller Mitglieder, einschließlich geerbter Mitglieder
- QTextFrame ist Teil der Rich Text Processing APIs.
Hinweis: Alle Funktionen in dieser Klasse sind reentrant.
Öffentliche Typen
Öffentliche Funktionen
| 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) |
Detaillierte Beschreibung
Textrahmen bieten eine Struktur für den Text in einem Dokument. Sie werden als generische Container für andere Dokumentelemente verwendet. Frames werden in der Regel durch die Verwendung von QTextCursor::insertFrame() erstellt.
Frames können verwendet werden, um hierarchische Strukturen in Rich-Text-Dokumenten zu schaffen. Jedes Dokument hat einen Wurzelrahmen (QTextDocument::rootFrame()), und jeder Rahmen unterhalb des Wurzelrahmens hat einen übergeordneten Rahmen und eine (möglicherweise leere) Liste von untergeordneten Rahmen. Der übergeordnete Rahmen kann mit parentFrame() gefunden werden, und die Funktion childFrames() liefert eine Liste der untergeordneten Rahmen.
Jeder Rahmen enthält mindestens einen Textblock, in den der Textcursor neue Dokumentelemente einfügen kann. Folglich wird die Klasse QTextFrame::iterator verwendet, um sowohl die Blöcke als auch die untergeordneten Rahmen innerhalb eines bestimmten Rahmens zu durchlaufen. Das erste und letzte untergeordnete Element im Rahmen kann mit begin() und end() gefunden werden.
Ein Rahmen hat auch ein Format (angegeben mit QTextFrameFormat), das mit setFormat() eingestellt und mit format() gelesen werden kann.
Es können Textcursor ermittelt werden, die auf die erste und letzte gültige Cursorposition innerhalb eines Rahmens zeigen; verwenden Sie dazu die Funktionen firstCursorPosition() und lastCursorPosition(). Die Ausdehnung des Rahmens im Dokument kann mit firstPosition() und lastPosition() ermittelt werden.
Mit der Klasse QTextFrame::iterator können Sie über den Inhalt eines Rahmens iterieren: Dies ermöglicht einen Nur-Lese-Zugriff auf die interne Liste der Textblöcke und untergeordneten Rahmen.
Siehe auch QTextCursor und QTextDocument.
Dokumentation der Mitgliedsfunktionen
[explicit] QTextFrame::QTextFrame(QTextDocument *document)
Erzeugt einen neuen leeren Rahmen für den Text document.
[virtual noexcept] QTextFrame::~QTextFrame()
Zerstört den Textrahmen.
Achtung! Textrahmen sind Eigentum des Dokuments, Sie sollten sie also niemals selbst zerstören. Um einen Rahmen aus seinem Dokument zu entfernen, müssen Sie seinen Inhalt mit QTextCursor entfernen.
QTextFrame::iterator QTextFrame::begin() const
Gibt einen Iterator zurück, der auf das erste Dokumentenelement innerhalb des Rahmens zeigt. Bitte lesen Sie das Dokument STL-style-Iterators für weitere Informationen.
Siehe auch end().
QList<QTextFrame *> QTextFrame::childFrames() const
Gibt eine (möglicherweise leere) Liste der untergeordneten Rahmen des Rahmens zurück.
Siehe auch parentFrame().
QTextFrame::iterator QTextFrame::end() const
Gibt einen Iterator zurück, der auf die Position hinter dem letzten Dokumentenelement innerhalb des Rahmens zeigt. Bitte lesen Sie das Dokument STL-Style Iterators für weitere Informationen.
Siehe auch begin().
QTextCursor QTextFrame::firstCursorPosition() const
Gibt die erste Cursorposition innerhalb des Rahmens zurück.
Siehe auch lastCursorPosition(), firstPosition(), und lastPosition().
int QTextFrame::firstPosition() const
Gibt die erste Dokumentposition innerhalb des Rahmens zurück.
Siehe auch lastPosition(), firstCursorPosition(), und lastCursorPosition().
QTextFrameFormat QTextFrame::frameFormat() const
Gibt das Format des Rahmens zurück.
Siehe auch setFrameFormat().
QTextCursor QTextFrame::lastCursorPosition() const
Gibt die letzte Cursorposition innerhalb des Rahmens zurück.
Siehe auch firstCursorPosition(), firstPosition(), und lastPosition().
int QTextFrame::lastPosition() const
Gibt die letzte Dokumentposition innerhalb des Rahmens zurück.
Siehe auch firstPosition(), firstCursorPosition(), und lastCursorPosition().
QTextFrame *QTextFrame::parentFrame() const
Gibt den übergeordneten Rahmen des Rahmens zurück. Ist der Rahmen der Wurzelrahmen eines Dokuments, wird 0 zurückgegeben.
Siehe auch childFrames() und QTextDocument::rootFrame().
void QTextFrame::setFrameFormat(const QTextFrameFormat &format)
Setzt den Rahmen auf format.
Siehe auch frameFormat().
© 2025 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.
