QTextLayout Class

int leading = fontMetrics.leading();
qreal height = 0;
textLayout.setCacheEnabled(true);
textLayout.beginLayout();
while (true) {
    QTextLine line = textLayout.createLine();
    if (!line.isValid())
        break;

    line.setLineWidth(lineWidth);
    height += leading;
    line.setPosition(QPointF(0, height));
    height += line.height();
}
textLayout.endLayout();

QPainter painter(this);
textLayout.draw(&painter, QPoint(0, 0));

QPainter painter(this);
QFontMetrics fontMetrics = painter.fontMetrics();

int lineSpacing = fontMetrics.lineSpacing();
int y = 0;

QTextLayout textLayout(content, painter.font());
textLayout.beginLayout();
while (true) {
    QTextLine line = textLayout.createLine();

    if (!line.isValid())
        break;

    line.setLineWidth(width());
    const int nextLineY = y + lineSpacing;

    if (height() >= nextLineY + lineSpacing) {
        line.draw(&painter, QPoint(0, y));
        y = nextLineY;
    } else {
        const QString lastLine = content.mid(line.textStart());
        const QString elidedLastLine = fontMetrics.elidedText(lastLine, Qt::ElideRight, width());
        painter.drawText(QPoint(0, y + fontMetrics.ascent()), elidedLastLine);
        line = textLayout.createLine();
        break;
    }
}
textLayout.endLayout();

メンバ関数のドキュメント

QTextLayout::QTextLayout()

空のテキストレイアウトを作成します。

setText()も参照してください 。

QTextLayout::QTextLayout(const QString &text)

指定されたtext を配置するためのテキストレイアウトを構築します。

QTextLayout::QTextLayout(const QString &text, const QFont &font, const QPaintDevice *paintdevice = nullptr)

指定された `text ` を、指定された `font` に基づいて配置するためのテキストレイアウトを構築します。

すべてのメトリックおよびレイアウトの計算は、ペイントデバイスであるpaintdevice に基づいて行われます。paintdevice がnullptr の場合、計算は画面メトリックに基づいて行われます。

[noexcept] QTextLayout::~QTextLayout()

レイアウトを破棄します。

void QTextLayout::beginLayout()

レイアウト処理を開始します。

endLayout()も参照してください 。

QRectF QTextLayout::boundingRect() const

レイアウト内のすべての線を包含する最小の長方形。

bool QTextLayout::cacheEnabled() const

完全なレイアウト情報がキャッシュされている場合は `true ` を返し、そうでない場合は `false` を返します。

setCacheEnabled()も参照してください 。

void QTextLayout::clearFormats()

テキストレイアウトでサポートされている追加のフォーマットの一覧をクリアします。

formats() およびsetFormats()も参照してください 。

void QTextLayout::clearLayout()

レイアウト内の行情報を消去します。この関数を呼び出した後、lineCount() は 0 を返します。

QTextLine QTextLayout::createLine()

レイアウトに挿入するテキストがある場合は、レイアウト対象となる新しいテキスト行を返します。そうでない場合は、無効なテキスト行を返します。

テキストレイアウトは、レイアウト内の最後の行の後に始まる新しい行オブジェクトを作成します。レイアウトが空の場合は、先頭から開始されます。レイアウトは内部カーソルを保持しており、QTextLine::setLineWidth() 関数が呼び出されると、各行はカーソル位置以降からテキストで埋められます。

QTextLine::setLineWidth() が呼び出されると、新しい行を作成してテキストで埋めることができます。この処理を繰り返すことで、QTextLayout に含まれるテキストブロック全体をレイアウトします。レイアウトに挿入するテキストが残っていない場合、返されるQTextLine は無効となります（isValid() は false を返します）。

Qt::CursorMoveStyle QTextLayout::cursorMoveStyle() const

このQTextLayout のカーソル移動スタイルです。デフォルトはQt::LogicalMoveStyle です。

setCursorMoveStyle()も参照してください 。

void QTextLayout::draw(QPainter *p, const QPointF &pos, const QList<QTextLayout::FormatRange> &selections = QList<FormatRange>(), const QRectF &clip = QRectF()) const

レイアウト全体を、pos で指定された位置にあるペインターp に描画します。レンダリングされたレイアウトには、指定されたselections が含まれ、clip で指定された矩形内にクリップされます。

void QTextLayout::drawCursor(QPainter *painter, const QPointF &position, int cursorPosition, int width) const

指定されたwidth と現在のペンを使用し、指定されたpainter に基づいて、指定されたposition にテキストカーソルを描画します。テキスト内の対応する位置は、cursorPosition で指定されます。

void QTextLayout::drawCursor(QPainter *painter, const QPointF &position, int cursorPosition) const

指定されたposition の位置に、指定されたpainter を使用して、現在のペンでテキストカーソルを描画します。テキスト内の対応する位置は、cursorPosition で指定されます。

void QTextLayout::endLayout()

レイアウト処理を終了します。

beginLayout()も参照してください 。

QFont QTextLayout::font() const

レイアウトに使用されている現在のフォント、またはフォントが設定されていない場合はデフォルトのフォントを返します。

setFont()も参照してください 。

QList<QTextLayout::FormatRange> QTextLayout::formats() const

テキストレイアウトでサポートされている追加のフォーマットのリストを返します。

setFormats() およびclearFormats()も参照してください 。

QList<QGlyphRun> QTextLayout::glyphRuns(int from = -1, int length = -1) const

このQTextLayout において、位置from から始まるlength の文字に対応するすべてのグリフのインデックスと位置を返します。この関数は処理負荷が高いため、処理速度が重要な状況では呼び出さないでください。

from が0未満の場合、グリフランはレイアウトの最初の文字から始まります。length が0未満の場合、開始位置から文字列全体にわたってグリフランが形成されます。

draw() およびQPainter::drawGlyphRun()も参照してください 。

[since 6.5] QList<QGlyphRun> QTextLayout::glyphRuns(int from, int length, QTextLayout::GlyphRunRetrievalFlags retrievalFlags) const

このQTextLayout 内の位置from から始まる、length の文字に対応するすべてのグリフのインデックスと位置を返します。この関数は処理負荷が高いため、処理速度が重要な状況では呼び出さないでください。

from が0未満の場合、グリフの連続はレイアウトの最初の文字から始まります。length が0未満の場合、開始位置から文字列全体に及びます。

retrievalFlags は、レイアウトからQGlyphRun のどのプロパティを取得するかを指定します。割り当てやメモリ消費を最小限に抑えるため、後でアクセスする必要があるプロパティのみを含めるように設定する必要があります。

この関数は Qt 6.5 で導入されました。

draw() およびQPainter::drawGlyphRun()も参照してください 。

bool QTextLayout::isValidCursorPosition(int pos) const

位置pos が有効なカーソル位置である場合、true を返します。

Unicode の文脈では、テキスト内の位置の中には、Unicode サロゲートやグラフェムクラスタの内部にあるため、有効なカーソル位置ではないものがあります。

グラフエムクラスターとは、画面上で1つの分割不可能なエンティティを形成する、2つ以上のUnicode文字の連続のことです。例えば、ラテン文字の `Ä' は、Unicode では `A' (0x41) と結合ダイアレシス (0x308) の2つの文字で表されます。 テキストカーソルは、これら2つの文字の直前または直後にのみ有効に配置でき、その間には配置できません。その間への配置は意味をなさないためです。インド系言語では、すべての音節がグラフエムクラスターを形成します。

int QTextLayout::leftCursorPosition(int oldPos) const

oldPos の左側、その隣にカーソル位置を戻します。これは、双方向の並べ替え後の文字の視覚的な位置によって決まります。

rightCursorPosition() およびpreviousCursorPosition()も参照してください 。

QTextLine QTextLayout::lineAt(int i) const

このテキストレイアウト内のテキストのi 行目を返します。

lineCount() およびlineForTextPosition()も参照してください 。

int QTextLayout::lineCount() const

このテキストレイアウトの行数を返します。

lineAt()も参照してください 。

QTextLine QTextLayout::lineForTextPosition(int pos) const

pos で指定されたカーソル位置を含む行を返します。

isValidCursorPosition() およびlineAt()も参照してください 。

qreal QTextLayout::maximumWidth() const

レイアウトが拡張できる最大幅。これは、基本的にテキスト全体の幅に相当します。

minimumWidth()も参照してください 。

qreal QTextLayout::minimumWidth() const

レイアウトに必要な最小幅。これは、レイアウトの中で最も短い、分割不可能な部分文字列の幅です。

関連項目： maximumWidth()。

int QTextLayout::nextCursorPosition(int oldPos, QTextLayout::CursorMode mode = SkipCharacters) const

oldPos の直後にあり、指定されたカーソルmode を満たす有効なカーソル位置を返します。oldPos が有効なカーソル位置でない場合は、oldPos の値を返します。

isValidCursorPosition() およびpreviousCursorPosition()も参照してください 。

QPointF QTextLayout::position() const

レイアウトのグローバルな位置。これは、バウンディング・レクタングルやレイアウト処理とは独立しています。

setPosition()も参照してください 。

int QTextLayout::preeditAreaPosition() const

編集が行われる前に処理される、テキストレイアウト内の領域の位置を返します。

preeditAreaText()も参照してください 。

QString QTextLayout::preeditAreaText() const

編集が行われる前に、レイアウトに挿入されたテキストを返します。

preeditAreaPosition()も参照してください 。

int QTextLayout::previousCursorPosition(int oldPos, QTextLayout::CursorMode mode = SkipCharacters) const

指定されたカーソルmode を満たす、oldPos 以前の最初の有効なカーソル位置を返します。oldPos が有効なカーソル位置でない場合は、oldPos の値を返します。

isValidCursorPosition() およびnextCursorPosition()も参照してください 。

int QTextLayout::rightCursorPosition(int oldPos) const

カーソル位置を、oldPos の右側、その隣に戻します。これは、双方向の並べ替え後の文字の視覚的な位置に基づいています。

leftCursorPosition() およびnextCursorPosition()も参照してください 。

void QTextLayout::setCacheEnabled(bool enable)

enable がtrueの場合、レイアウト情報のすべてをキャッシュします。そうでない場合は、レイアウトのキャッシュを無効にします。通常、QTextLayout は、メモリ消費を抑えるため、endLayout()の呼び出し後にレイアウト情報の大部分を破棄します。しかし、レイアウトされたテキストを直後に描画したい場合は、キャッシュを有効にすることで描画速度が大幅に向上する可能性があります。

cacheEnabled()も参照してください 。

void QTextLayout::setCursorMoveStyle(Qt::CursorMoveStyle style)

視覚的なカーソルの移動スタイルを、指定されたstyle に設定します。QTextLayout がドキュメントをバックグラウンドとしている場合は、この設定を無視してQTextDocument のオプションを使用できます。このオプションは、QLineEdit のようなウィジェットや、QTextDocument を持たないカスタムウィジェット向けです。デフォルト値はQt::LogicalMoveStyle です。

cursorMoveStyle()も参照してください 。

void QTextLayout::setFont(const QFont &font)

レイアウトのフォントを、指定されたfont に設定します。レイアウトは無効化されるため、再度レイアウトを実行する必要があります。

font()も参照してください 。

void QTextLayout::setFormats(const QList<QTextLayout::FormatRange> &formats)

テキストレイアウトでサポートされる追加の書式を「formats 」に設定します。これらの書式は、プレエディット領域のテキストをそのまま残した状態で適用されます。

formats() およびclearFormats()も参照してください 。

void QTextLayout::setPosition(const QPointF &p)

テキストのレイアウトをp の位置に移動します。

position()も参照してください 。

void QTextLayout::setPreeditArea(int position, const QString &text)

編集が行われる前に処理される、レイアウト内の領域のposition およびtext を設定します。レイアウトは無効化されるため、再度レイアウトを実行する必要があります。

preeditAreaPosition() およびpreeditAreaText()も参照してください 。

void QTextLayout::setText(const QString &string)

レイアウトのテキストを、指定されたstring に設定します。レイアウトは無効化されるため、再度レイアウトを実行する必要があります。

なお、このQTextLayout をQTextDocument の一部として使用する場合、このメソッドは効果を発揮しません。

text()も参照してください 。

void QTextLayout::setTextOption(const QTextOption &option)

レイアウト処理を制御するテキストオプション構造を、指定されたoption に設定します。

textOption()も参照してください 。

QString QTextLayout::text() const

レイアウトのテキストを返します。

setText()も参照してください 。

const QTextOption &QTextLayout::textOption() const

レイアウト処理の制御に使用されている現在のテキストオプションを返します。

setTextOption()も参照してください 。