QTextCursor Class

メンバ関数ドキュメント

QTextCursor::QTextCursor()

NULLカーソルを構築する。

[explicit] QTextCursor::QTextCursor(QTextDocument *document)

document の先頭を指すカーソルを構築する。

[explicit] QTextCursor::QTextCursor(QTextFrame *frame)

frame の先頭を指すカーソルを構築する。

[explicit] QTextCursor::QTextCursor(const QTextBlock &block)

block の先頭を指すカーソルを構築する。

QTextCursor::QTextCursor(const QTextCursor &cursor)

cursor のコピーである新しいカーソルを構築する。

[noexcept] QTextCursor::~QTextCursor()

QTextCursor を破壊する。

int QTextCursor::anchor() const

これは、position() と同じである。ただし、選択範囲がある場合は、position() が選択範囲の一方の端を示し、anchor() がもう一方の端を示す。カーソル位置と同様、アンカー位置は文字と文字の間になります。

position(),setPosition(),movePosition(),selectionStart(),selectionEnd()も参照のこと 。

bool QTextCursor::atBlockEnd() const

カーソルがブロックの末尾にある場合はtrue を返し、そうでない場合はfalse を返す。

atBlockStart() およびatEnd()も参照のこと 。

bool QTextCursor::atBlockStart() const

カーソルがブロックの先頭にある場合はtrue を返し、そうでない場合はfalse を返す。

atBlockEnd() およびatStart()も参照のこと 。

bool QTextCursor::atEnd() const

カーソルがドキュメントの末尾にある場合はtrue を返し、そうでない場合はfalse を返す。

atStart() およびatBlockEnd()も参照のこと 。

bool QTextCursor::atStart() const

カーソルがドキュメントの先頭にある場合はtrue を返し、そうでない場合はfalse を返す。

atBlockStart() およびatEnd()も参照のこと 。

void QTextCursor::beginEditBlock()

ドキュメントに対する編集操作のブロックの開始を示し、アンドゥ/リドゥの観点からは単一の操作として表示されます。

例えば

QTextCursor cursor(textDocument);
cursor.beginEditBlock();
cursor.insertText("Hello");
cursor.insertText("World");
cursor.endEditBlock();

textDocument->undo();

undo()をコールすると、両方の挿入が取り消され、"World "と "Hello "の両方が削除されます。

beginEditBlockとendEditBlock 。一番上のペアが、元に戻す／やり直す操作の範囲を決定する。

endEditBlock()も参照のこと 。

QTextBlock QTextCursor::block() const

カーソルを含むブロックを返す。

QTextCharFormat QTextCursor::blockCharFormat() const

カーソルがあるブロックのブロック文字書式を返す。

ブロック文字書式は、空のブロックの先頭にテキストを挿入するときに使用する書式です。

setBlockCharFormat()も参照 。

QTextBlockFormat QTextCursor::blockFormat() const

カーソルがあるブロックのブロックフォーマットを返す。

setBlockFormat() およびcharFormat()も参照 。

int QTextCursor::blockNumber() const

カーソルが存在するブロックの番号を返し、カーソルが無効な場合は0を返す。

この関数は、テーブルやフレームのような複雑なオブジェクトを持たない文書でのみ意味を持つことに注意してください。

QTextCharFormat QTextCursor::charFormat() const

カーソルposition()の直前の文字の書式を返す。カーソルが空でないテキストブロックの先頭にある場合は、カーソルの直後の文字の書式が返されます。

setCharFormat()、insertText()、blockFormat()も参照 。

void QTextCursor::clearSelection()

アンカーをカーソル位置にセットすることにより、現在の選択範囲をクリアする。

選択範囲のテキストは削除されないことに注意。

removeSelectedText() およびhasSelection()も参照 。

int QTextCursor::columnNumber() const

カーソルが含まれる行内の位置を返す。

これは折り返し行からの相対的な列番号であり、ブロック（つまり段落）からの相対的な列番号ではないことに注意してください。

おそらく、代わりにpositionInBlock() を呼び出したいでしょう。

positionInBlock()も参照 。

QTextList *QTextCursor::createList(const QTextListFormat &format)

与えられたformat で新しいリストを作成し、それを返します。

insertList() およびcurrentList()も参照 。

QTextList *QTextCursor::createList(QTextListFormat::Style style)

これはオーバーロードされた関数です。

与えられたstyle で新しいリストを作成し、カーソルの現在の段落を最初のリスト項目として返します。

使用されるスタイルはQTextListFormat::Style enumで定義されます。

insertList() およびcurrentList()も参照してください 。

QTextFrame *QTextCursor::currentFrame() const

現在のフレームへのポインタを返す。カーソルが無効な場合はnullptr を返す。

insertFrame()も参照 。

QTextList *QTextCursor::currentList() const

カーソルposition() がリストの一部であるブロック内にある場合、現在のリストを返す。そうでない場合はnullptr を返す。

insertList() およびcreateList()も参照 。

QTextTable *QTextCursor::currentTable() const

カーソルposition() がテーブルの一部であるブロック内にある場合、現在のテーブルへのポインタを返す。そうでない場合はnullptr を返す。

insertTable()も参照のこと 。

void QTextCursor::deleteChar()

選択テキストがない場合は、現在のカーソル位置の文字を削除し、そうでない場合は選択テキストを削除する。

deletePreviousChar()、hasSelection()、clearSelection()も参照 。

void QTextCursor::deletePreviousChar()

選択テキストがない場合は、現在のカーソル位置より前の文字を削除し、そうでない場合は選択テキストを削除する。

deleteChar()、hasSelection()、clearSelection()も参照 。

QTextDocument *QTextCursor::document() const

このカーソルが関連付けられているドキュメントを返します。

void QTextCursor::endEditBlock()

文書に対する編集操作のブロックの終了を示し、 undo/redoの観点からは単一の操作として表示されます。

beginEditBlock()も参照 。

bool QTextCursor::hasComplexSelection() const

カーソルがselectionStart() からselectionEnd() までの単純な範囲でない選択範囲を含んでいる場合、true を返し、そうでない場合はfalse を返す。

複雑な選択範囲とは、テーブルの少なくとも2つのセルにまたがる選択範囲のことで、その範囲はselectedTableCells() で指定します。

bool QTextCursor::hasSelection() const

カーソルが選択範囲を含んでいる場合はtrue を返し、そうでない場合はfalse を返す。

void QTextCursor::insertBlock()

カーソルposition() に、現在のblockFormat() とcharFormat() で新しい空のブロックを挿入する。

setBlockFormat()も参照 。

void QTextCursor::insertBlock(const QTextBlockFormat &format)

これはオーバーロードされた関数である。

カーソルposition() に、ブロック書式format および現在のcharFormat() を char ブロック書式として、新しい空のブロックを挿入する。

setBlockFormat()も参照 。

void QTextCursor::insertBlock(const QTextBlockFormat &format, const QTextCharFormat &charFormat)

これはオーバーロードされた関数である。

ブロック書式format とcharFormat をブロック文字書式として、カーソルposition() に新しい空のブロックを挿入する。

setBlockFormat()も参照 。

void QTextCursor::insertFragment(const QTextDocumentFragment &fragment)

テキス トfragment を現在のposition() に挿入する。

QTextFrame *QTextCursor::insertFrame(const QTextFrameFormat &format)

現在のカーソルposition() に、与えられたformat を持つフレームを挿入し、カーソルposition() をフレーム内に移動し、フレームを返す。

カーソルが選択範囲を保持している場合、選択範囲全体がフレーム内に移動します。

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

void QTextCursor::insertHtml(const QString &html)

テキストhtml を現在のposition() に挿入する。テキストはHTMLとして解釈される。

void QTextCursor::insertImage(const QTextImageFormat &format)

format で定義された画像を、現在のposition() に挿入する。

void QTextCursor::insertImage(const QString &name)

これはオーバーロードされた関数です。

与えられたname の画像を、現在のposition() に挿入するための便利なメソッドです。

QImage img;
textDocument->addResource(QTextDocument::ImageResource, QUrl("myimage"), img);
cursor.insertImage("myimage");

void QTextCursor::insertImage(const QImage &image, const QString &name = QString())

これはオーバーロードされた関数である。

与えられたimage を、現在のposition() にオプションのname とともに挿入するための便利な関数です。

void QTextCursor::insertImage(const QTextImageFormat &format, QTextFrameFormat::Position alignment)

これはオーバーロードされた関数である。

与えられたformat で定義された画像を、指定されたalignment でカーソルの現在位置に挿入する。

position()も参照 。

QTextList *QTextCursor::insertList(const QTextListFormat &format)

現在の位置に新しいブロックを挿入し、与えられたformat で新しく作成されたリストの最初のリスト項目にします。作成されたリストを返します。

currentList()、createList() およびinsertBlock()も参照 。

QTextList *QTextCursor::insertList(QTextListFormat::Style style)

これはオーバーロードされた関数です。

現在の位置に新しいブロックを挿入し、与えられたstyle で新しく作成されたリストの最初のリスト項目にします。作成されたリストを返します。

currentList()、createList()、insertBlock()も参照してください 。

[since 6.4] void QTextCursor::insertMarkdown(const QString &markdown, QTextDocument::MarkdownFeatures features = QTextDocument::MarkdownDialectGitHub)

現在のposition() に、指定された Markdownfeatures でmarkdown テキストを挿入します。デフォルトは GitHub 方言です。

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

QTextTable *QTextCursor::insertTable(int rows, int columns, const QTextTableFormat &format)

指定されたformat に、指定された数のrows とcolumns を持つ新しい表を作成し、文書内の現在のカーソルposition() に挿入し、表オブジェクトを返す。カーソルは最初のセルの先頭に移動します。

テーブルには、少なくとも1つの行と1つの列が必要です。

currentTable()も参照 。

QTextTable *QTextCursor::insertTable(int rows, int columns)

これはオーバーロードされた関数である。

与えられた数のrows とcolumns を持つ新しい表を作成し、それをドキュメントの現在のカーソルposition() に挿入し、表オブジェクトを返します。カーソルは最初のセルの先頭に移動します。

テーブルには、少なくとも1つの行と1つの列が必要です。

currentTable()も参照 。

void QTextCursor::insertText(const QString &text)

現在の文字書式で、現在の位置にtext を挿入する。

選択範囲がある場合、その選択範囲は削除され、例えばtext で置き換えられる：

cursor.clearSelection();
cursor.movePosition(QTextCursor::NextWord, QTextCursor::KeepAnchor);
cursor.insertText("Hello World");

これは、既存の選択範囲をすべてクリアし、カーソル位置の単語 (position() から先) を選択し、選択範囲を "Hello World" というフレーズで置き換えます。

挿入されたテキスト内の ASCII 改行文字 (\n) は、insertBlock() 呼び出しに対応する unicode ブロック区切り文字に変換されます。

charFormat() およびhasSelection()も参照のこと 。

void QTextCursor::insertText(const QString &text, const QTextCharFormat &format)

これはオーバーロードされた関数である。

与えられたformat でtext を現在の位置に挿入する。

bool QTextCursor::isCopyOf(const QTextCursor &other) const

このカーソルとother がお互いのコピーである場合、つまりどちらかがもう一方のコピーとして作成され、その後どちらも移動していない場合、true を返します。これは等価よりもはるかに厳格である。

operator=() およびoperator==()も参照のこと 。

bool QTextCursor::isNull() const

カーソルがNULLの場合はtrue 、それ以外の場合はfalse を返します。NULLカーソルはデフォルトのコンストラクタによって作成されます。

void QTextCursor::joinPreviousEditBlock()

beginEditBlock()と同様に、アンドゥ／リドゥのための単一の操作として表示されるべき編集操作のブロックの開始を示す。しかし、beginEditBlock()とは異なり、新しいブロックを開始するのではなく、endEditBlock()を呼び出す前の操作を取り消すため、次の操作は前に作成された編集ブロックの一部となります。

例えば

QTextCursor cursor(textDocument);
cursor.beginEditBlock();
cursor.insertText("Hello");
cursor.insertText("World");
cursor.endEditBlock();

// ...

cursor.joinPreviousEditBlock();
cursor.insertText("Hey");
cursor.endEditBlock();

textDocument->undo();

undo()を呼び出すと、3つの挿入がすべて取り消されます。

beginEditBlock() およびendEditBlock()も参照の こと。

bool QTextCursor::keepPositionOnInsert() const

カーソルの位置にテキストが挿入されたときに、カーソルの現在位置を保持するかどうかを返します。

デフォルトは false です；

setKeepPositionOnInsert()も参照 。

void QTextCursor::mergeBlockCharFormat(const QTextCharFormat &modifier)

カ レ ン ト ブ ロ ッ ク （または選択範囲に含まれるすべてのブ ロ ッ ク ） の文字ブ ロ ッ ク 書式を、modifier で指定 さ れたブ ロ ッ ク 書式で変更 し ます。

setBlockCharFormat()も参照 。

void QTextCursor::mergeBlockFormat(const QTextBlockFormat &modifier)

カ レ ン ト ブ ロ ッ ク （または選択範囲に含まれるすべてのブ ロ ッ ク ） のブ ロ ッ ク 書式を、modifier で指定 さ れてい る ブ ロ ッ ク 書式で変更 し ます。

setBlockFormat() およびblockFormat()も参照 。

void QTextCursor::mergeCharFormat(const QTextCharFormat &modifier)

カーソルの現在の文字書式を formatmodifier で記述されたプロパティとマージする。カーソルに選択範囲がある場合、この関数は、modifier で設定されたすべてのプロパティを、選択範囲の一部であるすべての文字書式に適用する。

hasSelection() およびsetCharFormat()も参照のこと 。

bool QTextCursor::movePosition(QTextCursor::MoveOperation operation, QTextCursor::MoveMode mode = MoveAnchor, int n = 1)

指定されたmode を使用して、指定されたoperation n を何度も実行してカーソルを移動し、すべての操作が正常に完了した場合はtrue を返し、そうでない場合はfalse を返す。

例えば、この関数を繰り返し使用して次の単語の末尾をシークすると、最終的に文書の末尾に到達した時点で失敗する。

デフォルトでは、移動操作は1回だけ行われる (n = 1)。

mode がKeepAnchor の場合、カーソルは移動したテキストを選択する。これは、ユーザーがShiftキーを押しながらカーソルキーでカーソルを移動させたときと同じ効果である。

setVisualNavigation()も参照のこと 。

int QTextCursor::position() const

ドキュメント内のカーソルの絶対位置を返す。カーソルは文字と文字の間に配置される。

setPosition(),movePosition(),anchor(),positionInBlock()も参照のこと 。

int QTextCursor::positionInBlock() const

ブロック内のカーソルの相対位置を返す。カーソルは文字と文字の間に配置される。

これはposition() - block().position() と等価である。

position()も参照 。

void QTextCursor::removeSelectedText()

選択範囲があればその内容が削除され、なければ何もしない。

hasSelection()も参照 。

void QTextCursor::select(QTextCursor::SelectionType selection)

与えられたselection に従っ て文書内のテ キ ス ト を選択 し ます。

void QTextCursor::selectedTableCells(int *firstRow, int *numRows, int *firstColumn, int *numColumns) const

選択範囲が表セルにまたがる場合、firstRow には選択範囲の最初の行の番号が、firstColumn には選択範囲の最初の列の番号が、numRows とnumColumns には選択範囲の行と列の番号が入ります。選択範囲がテーブルセルにまたがっていない場合、結果は無害ですが未定義です。

QString QTextCursor::selectedText() const

現在の選択範囲のテキストを返します（空でもかまいません）。これはテキストのみを返し、リッチテキストの書式情報は返しません。ドキュメントの断片 (つまりフォーマットされたリッチテキスト) が必要な場合は、代わりにselection() を使用してください。

QTextDocumentFragment QTextCursor::selection() const

現在の選択範囲 (空でもよい) を、すべての書式情報とともに返します。選択されたテキスト (すなわちプレーンテキスト) だけが欲しい場合は、代わりにselectedText() を使用します。

QTextDocumentFragment::toPlainText()も参照してください 。

int QTextCursor::selectionEnd() const

選択範囲の終わりを返すか、カーソルに選択範囲がない場合はposition() を返す。

selectionStart()、position()、anchor()も参照 。

int QTextCursor::selectionStart() const

選択範囲の開始位置を返すか、カーソルに選択範囲がない場合はposition() を返す。

selectionEnd()、position()、anchor()も参照 。

void QTextCursor::setBlockCharFormat(const QTextCharFormat &format)

カ レ ン ト ブ ロ ッ ク （または選択範囲に含まれるすべてのブ ロ ッ ク ） のブ ロ ッ ク文字書式をformat に設定する。

blockCharFormat()も参照 。

void QTextCursor::setBlockFormat(const QTextBlockFormat &format)

カ レ ン ト ブ ロ ッ ク （または選択範囲に含まれるすべてのブ ロ ッ ク ） のブ ロ ッ ク 書式をformat に設定。

blockFormat() およびmergeBlockFormat()も参照 。

void QTextCursor::setCharFormat(const QTextCharFormat &format)

カーソルの現在の文字フォーマットを指定されたformat に設定する。カーソルに選択範囲がある場合、与えられたformat が現在の選択範囲に適用される。

charFormat()、hasSelection()、mergeCharFormat()も参照 。

void QTextCursor::setKeepPositionOnInsert(bool b)

カーソルの現在位置にテキストが挿入されたとき、カーソルが現在位置を保持するかどうかを定義する。

b がtrueの場合、テキストがカーソルの位置に挿入されたとき、カーソルは現在の位置を維持する。b が偽の場合、カーソルは挿入されたテキストと共に移動する。

デフォルトはfalseである。

カーソルの現在位置より前にテキストが挿入されると、カーソルは常に移動し、カーソルの現在位置より後にテキストが挿入されると、カーソルは常にその位置を維持することに注意してください。

keepPositionOnInsert()も参照 。

void QTextCursor::setPosition(int pos, QTextCursor::MoveMode m = MoveAnchor)

m で指定されたMoveMode を使って、pos で指定されたドキュメント内の絶対位置にカーソルを移動する。カーソルは文字と文字の間に配置される。

position(),movePosition(),anchor()も参照 。

void QTextCursor::setVerticalMovementX(int x)

垂直カーソル移動の視覚的 x 位置をx に設定する。

カーソルが水平方向に移動すると、垂直方向の移動 x 位置は自動的にクリアされ、カーソルが垂直方向に移動すると変更されない。このメカニズムにより、カーソルはプロポーショナルフォントで視覚的に直線上を上下に移動し、短い行を緩やかに「ジャンプ」することができる。

値 -1 は、あらかじめ定義された x 位置がないことを示す。次にカーソルが上下に動いたときに自動的に設定される。

verticalMovementX()も参照のこと 。

void QTextCursor::setVisualNavigation(bool b)

ビジュアル・ナビゲーションをb に設定する。

ビジュアル・ナビゲーションとは、隠れたテキストの段落をスキップすることです。デフォルトは false です。

visualNavigation() およびmovePosition()も参照 。

[noexcept] void QTextCursor::swap(QTextCursor &other)

このテキスト・カーソルのインスタンスをother と交換する。この操作は非常に高速で、失敗することはない。

int QTextCursor::verticalMovementX() const

垂直方向のカーソル移動の視覚的な x 位置を返す。

値 -1 は、定義済みの x 位置がないことを示す。この値は、カーソルが次に上下に移動したときに自動的に設定されます。

setVerticalMovementX()も参照 。

bool QTextCursor::visualNavigation() const

カーソルがビジュアル・ナビゲーションを行う場合はtrue を返し、そうでない場合はfalse を返す。

ビジュアル・ナビゲーションとは、隠されたテキストの段落をスキップすることです。デフォルトは false です。

setVisualNavigation() およびmovePosition()も参照 。

bool QTextCursor::operator!=(const QTextCursor &other) const

other カーソルがこのカーソルと文書内の異なる位置にある場合はtrue を返し、そうでない場合はfalse を返す。

bool QTextCursor::operator<(const QTextCursor &other) const

other カーソルがこのカーソルよりドキュメント内で後に位置している場合はtrue を返し、そうでない場合はfalse を返す。

bool QTextCursor::operator<=(const QTextCursor &other) const

other カーソルがこのカーソルと同じドキュメントの後か同じ位置にある場合はtrue を返し、そうでない場合は false を返す。

QTextCursor &QTextCursor::operator=(const QTextCursor &cursor)

cursor のコピーを作成し、このQTextCursor に代入する。QTextCursor は暗黙の共有クラスであることに注意。

bool QTextCursor::operator==(const QTextCursor &other) const

other カーソルがこのカーソルと同じドキュメントの位置にある場合はtrue を返し、そうでない場合はfalse を返す。

bool QTextCursor::operator>(const QTextCursor &other) const

other カーソルがこのカーソルよりもドキュメント内で前に位置している場合はtrue を返し、そうでない場合はfalse を返す。

bool QTextCursor::operator>=(const QTextCursor &other) const

other カーソルがこのカーソルとドキュメント内で同じ位置にある場合はtrue を返し、そうでない場合は false を返す。