QTextFrameFormat Class
QTextFrameFormat クラスは、QTextDocument のフレームのフォーマット情報を提供します。
ヘッダー | #include <QTextFrameFormat> |
CMake: | find_package(Qt6 REQUIRED COMPONENTS Gui) target_link_libraries(mytarget PRIVATE Qt6::Gui) |
qmake: | QT += gui |
を継承する: | QTextFormat |
継承元: |
- 継承メンバを含む全メンバのリスト
- QTextFrameFormatは、リッチテキスト処理APIと 暗黙的に共有されるクラスの一部です。
注意:このクラスの関数はすべてリエントラントです。
パブリック型
enum | BorderStyle { BorderStyle_None, BorderStyle_Dotted, BorderStyle_Dashed, BorderStyle_Solid, BorderStyle_Double, …, BorderStyle_Outset } |
enum | Position { InFlow, FloatLeft, FloatRight } |
パブリック関数
QTextFrameFormat() | |
qreal | border() const |
QBrush | borderBrush() const |
QTextFrameFormat::BorderStyle | borderStyle() const |
qreal | bottomMargin() const |
QTextLength | height() const |
bool | isValid() const |
qreal | leftMargin() const |
qreal | margin() const |
qreal | padding() const |
QTextFormat::PageBreakFlags | pageBreakPolicy() const |
QTextFrameFormat::Position | position() const |
qreal | rightMargin() const |
void | setBorder(qreal width) |
void | setBorderBrush(const QBrush &brush) |
void | setBorderStyle(QTextFrameFormat::BorderStyle style) |
void | setBottomMargin(qreal margin) |
void | setHeight(const QTextLength &height) |
void | setHeight(qreal height) |
void | setLeftMargin(qreal margin) |
void | setMargin(qreal margin) |
void | setPadding(qreal width) |
void | setPageBreakPolicy(QTextFormat::PageBreakFlags policy) |
void | setPosition(QTextFrameFormat::Position policy) |
void | setRightMargin(qreal margin) |
void | setTopMargin(qreal margin) |
void | setWidth(const QTextLength &width) |
void | setWidth(qreal width) |
qreal | topMargin() const |
QTextLength | width() const |
詳細説明
テキストフレームは、1つ以上のテキストブロックをグループ化し、段落よりも大きな構造のレイヤーを提供します。フレームのフォーマットは、それがどのようにレンダリングされ、画面上に配置されるかを指定します。フレームの書式は、フレーム内のテキスト書式の動作を直接指定しませんが、子フレームのレイアウトに制約を与えます。
フレームの書式は、画面上でのフレームのwidth() とheight() を定義します。各フレームは、その内容を長方形の枠で囲むborder() を持つことができます。枠はフレームの周囲をmargin ()で囲み、フレームの内容はフレームのpadding ()によって枠から分離されます。この方式は、HTMLページのカスケーディング・スタイル・シートで使われているボックス・モデルに似ています。
フレームのposition() はsetPosition() を使って設定され、周囲のテキストとの相対的な位置関係を決定します。
QTextFrameFormat オブジェクトの有効性は、isValid() 関数で判断できます。
QTextFrame およびQTextBlockFormatも参照して ください。
メンバ型ドキュメント
enum QTextFrameFormat::BorderStyle
この列挙型は、テキストフレームの異なるボーダースタイルを記述する。
定数 | 値 |
---|---|
QTextFrameFormat::BorderStyle_None | 0 |
QTextFrameFormat::BorderStyle_Dotted | 1 |
QTextFrameFormat::BorderStyle_Dashed | 2 |
QTextFrameFormat::BorderStyle_Solid | 3 |
QTextFrameFormat::BorderStyle_Double | 4 |
QTextFrameFormat::BorderStyle_DotDash | 5 |
QTextFrameFormat::BorderStyle_DotDotDash | 6 |
QTextFrameFormat::BorderStyle_Groove | 7 |
QTextFrameFormat::BorderStyle_Ridge | 8 |
QTextFrameFormat::BorderStyle_Inset | 9 |
QTextFrameFormat::BorderStyle_Outset | 10 |
borderStyle() およびFrameBorderStyleも参照 。
enum QTextFrameFormat::Position
この列挙型は、フレームが周囲のテキストに対してどのように配置されるかを記述する。
定数 | 値 |
---|---|
QTextFrameFormat::InFlow | 0 |
QTextFrameFormat::FloatLeft | 1 |
QTextFrameFormat::FloatRight | 2 |
メンバ関数ドキュメント
QTextFrameFormat::QTextFrameFormat()
デフォルトのプロパティを持つテキストフレームフォーマットオブジェクトを構築します。
qreal QTextFrameFormat::border() const
ボーダーの幅をピクセル単位で返します。
setBorder()も参照 。
QBrush QTextFrameFormat::borderBrush() const
フレームの枠線に使用されているブラシを返します。
setBorderBrush()も参照してください 。
QTextFrameFormat::BorderStyle QTextFrameFormat::borderStyle() const
フレームのボーダーのスタイルを返します。
setBorderStyle()も参照してください 。
qreal QTextFrameFormat::bottomMargin() const
フレームの下マージンの幅をピクセル単位で返します。
setBottomMargin()も参照 。
QTextLength QTextFrameFormat::height() const
フレームのボーダー矩形の高さを返します。
setHeight()も参照 。
bool QTextFrameFormat::isValid() const
フォーマット記述が有効な場合はtrue
を返し、そうでない場合はfalse
を返す。
qreal QTextFrameFormat::leftMargin() const
フレームの左マージンの幅をピクセル単位で返します。
setLeftMargin()も参照 。
qreal QTextFrameFormat::margin() const
フレームの外部マージンの幅をピクセル単位で返します。
setMargin()も参照 。
qreal QTextFrameFormat::padding() const
フレームの内部パディングの幅をピクセル単位で返します。
setPadding()も参照 。
QTextFormat::PageBreakFlags QTextFrameFormat::pageBreakPolicy() const
フレーム/テーブルに現在設定されている改ページポリシーを返します。デフォルトはQTextFormat::PageBreak_Auto 。
setPageBreakPolicy()も参照してください 。
QTextFrameFormat::Position QTextFrameFormat::position() const
このフレームフォーマットを持つフレームの位置決めポリシーを返します。
setPosition()も参照してください 。
qreal QTextFrameFormat::rightMargin() const
フレームの右マージンの幅をピクセル単位で返します。
setRightMargin()も参照 。
void QTextFrameFormat::setBorder(qreal width)
フレームの境界線のwidth (ピクセル単位) を設定します。
border()も参照 。
void QTextFrameFormat::setBorderBrush(const QBrush &brush)
フレームの枠線に使用するbrush を設定します。
borderBrush()も参照してください 。
void QTextFrameFormat::setBorderStyle(QTextFrameFormat::BorderStyle style)
フレームのボーダーのstyle を設定する。
borderStyle()も参照 。
void QTextFrameFormat::setBottomMargin(qreal margin)
フレームの最下部margin をピクセル単位で設定する。
bottomMargin()も参照 。
void QTextFrameFormat::setHeight(const QTextLength &height)
フレームのheight を設定する。
height()も参照 。
void QTextFrameFormat::setHeight(qreal height)
これはオーバーロードされた関数です。
フレームのheight を設定する。
void QTextFrameFormat::setLeftMargin(qreal margin)
フレームの左margin をピクセル単位で設定する。
leftMargin()も参照 。
void QTextFrameFormat::setMargin(qreal margin)
フレームのmargin をピクセル単位で設定します。このメソッドは、フレームの左、右、上、下のマージンも同じ値に設定します。個々のマージンは一般的なマージンを上書きします。
margin()も参照してください 。
void QTextFrameFormat::setPadding(qreal width)
フレームの内部パディングのwidth をピクセル単位で設定します。
padding()も参照してください 。
void QTextFrameFormat::setPageBreakPolicy(QTextFormat::PageBreakFlags policy)
フレーム/テーブルの改ページポリシーをpolicy に設定する。
pageBreakPolicy()も参照 。
void QTextFrameFormat::setPosition(QTextFrameFormat::Position policy)
このフレームフォーマットでフレームを配置するためのpolicy を設定する。
position()も参照してください 。
void QTextFrameFormat::setRightMargin(qreal margin)
フレームの右margin をピクセル単位で設定する。
rightMargin()も参照 。
void QTextFrameFormat::setTopMargin(qreal margin)
フレームの上端margin をピクセル単位で設定する。
topMargin()も参照 。
void QTextFrameFormat::setWidth(const QTextLength &width)
フレームのボーダー矩形のwidth を設定します。
width() およびQTextLengthも参照してください 。
void QTextFrameFormat::setWidth(qreal width)
これはオーバーロードされた関数です。
フレームのボーダー矩形の幅を、指定された固定幅width に設定する便利なメソッドです。
qreal QTextFrameFormat::topMargin() const
フレームの上マージンの幅をピクセル単位で返します。
setTopMargin()も参照 。
QTextLength QTextFrameFormat::width() const
フレームのボーダー矩形の幅を返します。
setWidth() およびQTextLengthも参照 。
© 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.