QTextFrame Class
QTextFrame クラスはQTextDocument のフレームを表します。
| Header: | #include <QTextFrame> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Gui)target_link_libraries(mytarget PRIVATE Qt6::Gui) |
| qmake: | QT += gui |
| Inherits: | QTextObject |
| Inherited By: |
- 継承メンバを含む全メンバ一覧
- QTextFrameはリッチテキスト処理APIの一部です。
注意:このクラスの関数はすべてリエントラントです。
パブリック型
パブリック関数
| 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) |
詳細説明
テキストフレームは、ドキュメント内のテキストの構造を提供します。他の文書要素の汎用コンテナとして使用されます。フレームは通常QTextCursor::insertFrame() を使って作成されます。
フレームは、リッチテキスト文書の階層構造を作成するために使用することができます。各文書にはルートフレーム (QTextDocument::rootFrame()) があり、ルートフレームの下にある各フレームには親フレームと子フレームのリスト (空の場合もあります) があります。親フレームはparentFrame() で見つけることができ、childFrames() 関数は子フレームのリストを提供します。
各フレームには少なくとも1つのテキストブロックがあり、テキストカーソルで新しいドキュメント要素を挿入することができます。その結果、QTextFrame::iterator クラスは、与えられたフレーム内のブロックと子フレームの両方を走査するために使用されます。フレーム内の最初と最後の子要素はbegin() とend() で見つけることができます。
フレームにはフォーマット（QTextFrameFormat で指定）もあり、setFormat() で設定し、format() で読み込むことができます。
フレーム内の有効なカーソル位置の最初と最後を指すテキストカーソルを取得することができます。これにはfirstCursorPosition() とlastCursorPosition() 関数を使用します。ドキュメント内のフレームの範囲は、firstPosition() およびlastPosition() で確認できます。
QTextFrame::iterator クラスを使えば、フレームの内容を繰り返し見ることができます。このクラスは、内部のテキストブロックや子フレームのリストに読み込み専用でアクセスできます。
QTextCursor およびQTextDocumentも参照して ください。
メンバ関数ドキュメント
[explicit] QTextFrame::QTextFrame(QTextDocument *document)
テキスト用の新しい空のフレームを作成しますdocument 。
[virtual noexcept] QTextFrame::~QTextFrame()
テキストフレームを破棄します。
警告： テキストフレームはドキュメントに所有されているので、決して自分で破棄してはいけません。フレームをドキュメントから削除するには、QTextCursor を使ってその内容を削除してください。
QTextFrame::iterator QTextFrame::begin() const
フレーム内の最初のドキュメント要素を指すイテレータを返します。詳しくはSTL-style-Iteratorsを参照してください。
end()も参照してください 。
QList<QTextFrame *> QTextFrame::childFrames() const
フレームの子フレームの（おそらく空の）リストを返します。
parentFrame() も参照して ください。
QTextFrame::iterator QTextFrame::end() const
フレーム内の最後のドキュメント要素を過ぎた位置を指すイテレータを返します。詳しくはSTL-Style Iteratorsを参照してください。
begin() も参照して ください。
QTextCursor QTextFrame::firstCursorPosition() const
フレーム内の最初のカーソル位置を返します。
lastCursorPosition()、firstPosition()、lastPosition() も参照 。
int QTextFrame::firstPosition() const
フレーム内の最初のドキュメント位置を返します。
lastPosition()、firstCursorPosition()、lastCursorPosition() も参照 。
QTextFrameFormat QTextFrame::frameFormat() const
フレームの書式を返します。
setFrameFormat() も参照 。
QTextCursor QTextFrame::lastCursorPosition() const
フレーム内の最後のカーソル位置を返します。
firstCursorPosition()、firstPosition()、lastPosition() も参照 。
int QTextFrame::lastPosition() const
フレーム内の最後のドキュメント位置を返します。
firstPosition()、firstCursorPosition()、lastCursorPosition() も参照 。
QTextFrame *QTextFrame::parentFrame() const
フレームの親フレームを返します。フレームがドキュメントのルートフレームである場合は 0 を返します。
childFrames() およびQTextDocument::rootFrame()も参照して ください。
void QTextFrame::setFrameFormat(const QTextFrameFormat &format)
フレームのformat を設定します。
frameFormat()も参照して ください。
本ドキュメントに含まれる文書の著作権は、それぞれの所有者に帰属します。 本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。
