QTextDocument Class

メンバ関数ドキュメント

[explicit] QTextDocument::QTextDocument(QObject *parent = nullptr)

空の QTextDocument を、 与えられたparent で構築します。

[explicit] QTextDocument::QTextDocument(const QString &text, QObject *parent = nullptr)

指定されたプレーンな (整形されていない)text を含む QTextDocument を、 与えられたparent とともに構築します。

[virtual noexcept] QTextDocument::~QTextDocument()

文書を破棄する。

void QTextDocument::addResource(int type, const QUrl &name, const QVariant &resource)

type とname を識別子として、 リ ソ ースresource を リ ソ ース キ ャ ッ シ ュ に追加 し ます。type にはQTextDocument::ResourceType の値を指定 し ます。

た と えば、 画像を リ ソ ース と し て追加 し て、 それを文書か ら 参照で き る よ う にす る こ と がで き ます：

    document->addResource(QTextDocument::ImageResource,
        QUrl("mydata://image.png"), QVariant(image));

画像はQTextCursor API を使っ て文書に挿入す る こ と がで き ます：

    QTextImageFormat imageFormat;
    imageFormat.setName("mydata://image.png");
    cursor.insertImage(imageFormat);

また、HTMLのimg タグを使って画像を挿入することもできます：

    editor->append("<img src=\"mydata://image.png\" />");

void QTextDocument::adjustSize()

ドキュメントを適切なサイズに調整する。

idealWidth()、textWidth 、sizeも参照 。

QList<QTextFormat> QTextDocument::allFormats() const

ドキュメントで使われているすべてのフォーマットのテキストフォーマットのリストを返します。

int QTextDocument::availableRedoSteps() const

利用可能なやり直しステップ数を返します。

isRedoAvailable()も参照 。

int QTextDocument::availableUndoSteps() const

使用可能なアンドゥステップの数を返します。

isUndoAvailable()も参照 ください。

[since 6.0] qreal QTextDocument::baselineOffset() const

ドキュメントレイアウトで使用されるベースラインオフセットを % で返します。

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

setBaselineOffset(),setSubScriptBaseline(),subScriptBaseline(),setSuperScriptBaseline(),superScriptBaseline()も参照してください 。

QTextBlock QTextDocument::begin() const

ドキュメントの最初のテキストブロックを返します。

firstBlock()も参照 ください。

[signal] void QTextDocument::blockCountChanged(int newBlockCount)

このシグナルは、ドキュメント内のテキストブロックの総数が変更されたときに発行される。newBlockCount で渡される値は新しい合計です。

QChar QTextDocument::characterAt(int pos) const

位置pos にある文字、または位置が範囲外の場合はヌル文字を返します。

characterCount()も参照 。

int QTextDocument::characterCount() const

この文書の文字数を返す。

blockCount() およびcharacterAt()も参照 。

[virtual] void QTextDocument::clear()

文書を消去する。

void QTextDocument::clearUndoRedoStacks(QTextDocument::Stacks stacksToClear = UndoAndRedoStacks)

stacksToClear で指定されたスタックをクリアします。

このメソッドは、undo スタック、redo スタック、またはその両方（デフォルト）のコマンドをクリアする。コマンドがクリアされると、QTextDocument::undoAvailable() またはQTextDocument::redoAvailable() という適切なシグナルが発せられる。

QTextDocument::undoAvailable() およびQTextDocument::redoAvailable()も参照のこと 。

QTextDocument *QTextDocument::clone(QObject *parent = nullptr) const

QTextDocument parent が返 さ れ る テ キ ス ト 文書の親。

[signal] void QTextDocument::contentsChange(int position, int charsRemoved, int charsAdded)

このシグナルは、ドキュメントの内容が変更されるたびに発行される。たとえば、テキストが挿入されたり、削除されたり、書式が適用されたりしたときなどである。

情報が提供されるのは、変更が発生したドキュメント内の文字のposition 、削除された文字数 (charsRemoved) 、追加された文字数 (charsAdded) です。

このシグナルは、ドキュメントのレイアウトマネージャーに変更が通知される前に発せられます。このフックを使うと、ドキュメントのシンタックスハイライトを実装することができます。

QAbstractTextDocumentLayout::documentChanged() とcontentsChanged()も参照してください 。

[signal] void QTextDocument::contentsChanged()

このシグナルは、ドキュメントの内容が変更されるたびに発行されます。たとえば、テキストが挿入されたり削除されたりしたときや、書式が適用されたときなどです。

contentsChange()も参照 。

[virtual protected] QTextObject *QTextDocument::createObject(const QTextFormat &format)

与えられたformat に基づいて、新しいドキュメントオブジェクト (QTextObject) を作成して返します。

QTextObject は常にこのメソッドを通して作成されるので、ドキュメント内でカスタム・テキスト・オブジェクトを使用する場合は、このメソッドを再実装する必要があります。

[signal] void QTextDocument::cursorPositionChanged(const QTextCursor &cursor)

このシグナルは、編集操作によってカーソルの位置が変化するたびに発せられる。変更されたカーソルはcursor で渡されます。ドキュメントがQTextEdit クラスで使用され、カーソルが矢印キーで移動されたときにシグナルが必要な場合は、QTextEdit でcursorPositionChanged() シグナルを使用できます。

Qt::CursorMoveStyle QTextDocument::defaultCursorMoveStyle() const

デフ ォル ト カー ソ ル移動ス タ イルは、 文書か ら 生成 さ れ る すべてのQTextCursor オブジ ェ ク ト で用い ら れます。デフォルトはQt::LogicalMoveStyle です。

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

QFont QTextDocument::defaultFont() const

ドキュメントレイアウトで使用されるデフォルトフォントを返す。

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

[static, since 6.1] QTextDocument::ResourceProvider QTextDocument::defaultResourceProvider()

デフォルトのリソースプロバイダを返します。

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

setDefaultResourceProvider(),resourceProvider(),loadResource()も参照してください 。

QTextOption QTextDocument::defaultTextOption() const

デフ ォ ル ト テキス ト オプシ ョ ンは、 文書内のすべてのQTextLayout オブジ ェ ク ト で用い ら れます。こ れに よ り 、 デフ ォ ル ト の単語折 り 返 し モー ド な ど、 文書のグ ローバルプ ロ パテ ィ を設定す る こ と がで き ます。

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

QAbstractTextDocumentLayout *QTextDocument::documentLayout() const

このドキュメントのドキュメントレイアウトを返します。

setDocumentLayout()も参照 ください。

[signal] void QTextDocument::documentLayoutChanged()

このシグナルは、新しいドキュメントレイアウトが設定されたときに発行される。

setDocumentLayout()も参照 。

void QTextDocument::drawContents(QPainter *p, const QRectF &rect = QRectF())

文書の内容を、 ペ イ ン タp で、rect に ク リ ッ プ し て描 き ます。rect がヌ ル矩形 （デ フ ォ ル ト ） の と き は、 文書は ク リ ッ プ さ れずに描かれます。

QTextBlock QTextDocument::end() const

この関数は、繰り返し処理中にドキュメントの終わりをテストするためのブロックを返します。

for (QTextBlock it = doc->begin(); it != doc->end(); it = it.next())
    std::cout << it.text().toStdString() << "\n";

返されるブロックは無効で、ドキュメントの最後のブロックの後のブロックを表します。ドキュメントの最後の有効なブロックを取得するにはlastBlock() を使用します。

lastBlock()も参照 。

QTextCursor QTextDocument::find(const QRegularExpression &expr, const QTextCursor &cursor, QTextDocument::FindFlags options = FindFlags()) const

文書内の同じ段落内で、与えられた正規表現expr にマッチする次の出現箇所を検索する。

検索は、与えられたcursor の位置から始まり、検索オプションで特に指定されない限り、文書内を前方へ進みます。options は、実行される検索のタイプを制御します。

マッチが見つかればマッチが選択されたカーソルを返し、そうでなければ NULL カーソルを返します。

指定されたcursor に選択範囲がある場合、検索は選択範囲の後から始まります。

デフォルトでは、検索は大文字小文字を区別せず、ドキュメント内のどこにあるテキストにもマッチします。

QTextCursor QTextDocument::find(const QRegularExpression &expr, int from = 0, QTextDocument::FindFlags options = FindFlags()) const

文書内の同じ段落内で、与えられた正規表現expr にマッチする次の出現箇所を検索します。

検索は、与えられたfrom の位置から始まり、検索オプションで特に指定しない限り、文書内を前方へ進みます。options は、実行される検索のタイプを制御します。

マッチが見つかればマッチを選択したカーソルを返し、そうでなければヌルカーソルを返します。

from の位置が0（デフォルト）の場合、検索は文書の先頭から始まり、それ以外の場合は指定した位置から始まる。

QTextCursor QTextDocument::find(const QString &subString, const QTextCursor &cursor, QTextDocument::FindFlags options = FindFlags()) const

文書内で文字列subString が次に出現する場所を検索する。検索は、指定されたcursor の位置から始まり、検索オプシ ョ ンで別段の指定がない限り、文書内を順次進む。options は、実行される検索のタイプを制御する。

subString が見つかれば、マッチが選択されたカーソルを返し、そうでなければ null カーソルを返します。

指定されたcursor に選択範囲がある場合、検索は選択範囲の後から始まります。

デフォルトでは、検索は大文字小文字を区別せず、ドキュメント内の任意の場所にマッチします。

QTextCursor QTextDocument::find(const QString &subString, int position = 0, QTextDocument::FindFlags options = FindFlags()) const

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

文書内で文字列subString が次に出現する場所を検索する。検索は、指定されたposition から始まり、検索オプションで特に指定されない限り、文書内を順に進みます。options は、実行される検索のタイプを制御する。

subString が見つかればマッチを選択したカーソルを返し、そうでなければヌルカーソルを返す。

position が 0 （デフ ォル ト ） の場合、 検索は文書の先頭か ら 始ま り 、 そ う でなければ指定 し た位置か ら 始ま る 。

QTextBlock QTextDocument::findBlock(int pos) const

pos-番目の文字を含むテキストブロックを返す。

QTextBlock QTextDocument::findBlockByLineNumber(int lineNumber) const

指定されたlineNumber を含むテキストブロックを返します。

QTextBlock::firstLineNumber()も参照 。

QTextBlock QTextDocument::findBlockByNumber(int blockNumber) const

指定されたblockNumber を持つテキストブロックを返します。

QTextBlock::blockNumber()も参照 。

QTextBlock QTextDocument::firstBlock() const

ドキュメントの最初のテキストブロックを返します。

qreal QTextDocument::idealWidth() const

テキスト文書の理想的な幅を返します。理想的な幅とは、オプションのアライメントを考慮しない、 実際に使われているドキュメントの幅のことです。これは常に <=size().width() です。

adjustSize() およびtextWidthも参照 。

bool QTextDocument::isEmpty() const

ドキュメントが空の場合はtrue を返し、そうでない場合はfalse を返す。

bool QTextDocument::isRedoAvailable() const

やり直しが可能な場合はtrue を返し、そうでない場合はfalse を返す。

isUndoAvailable() およびavailableRedoSteps()も参照のこと 。

bool QTextDocument::isUndoAvailable() const

元に戻せる場合はtrue を返し、そうでない場合はfalse を返す。

isRedoAvailable() およびavailableUndoSteps()も参照 。

QTextBlock QTextDocument::lastBlock() const

ドキュメントの最後の（有効な）テキストブロックを返します。

int QTextDocument::lineCount() const

このドキュメントの行数を返します（レイアウトがサポートしている場合）。そうでない場合は、これはブロック数と同じです。

blockCount() およびcharacterCount()も参照 。

[virtual protected invokable] QVariant QTextDocument::loadResource(int type, const QUrl &name)

指定 さ れたname を持つ リ ソ ース か ら 、 指定 さ れたtype のデー タ を読み込みます。

この関数はリッチテキストエンジンによって呼び出され、QTextDocument によって直接格納されていないデータを要求します。例えば、画像はQTextImageFormat オブジェクトの name 属性によって間接的に参照されます。

Qt によって呼び出されるとき、type はQTextDocument::ResourceType の値の1つになります。

QTextDocument QTextDocument が の子オブジェクトで、 や などの呼び出し可能な loadResource メソッドを持っている場合、デフォルトの実装では親オブジェクトからデータを取得しようとします。QObject QTextEdit QTextBrowser

QTextDocument::ResourceProviderも参照して ください。

void QTextDocument::markContentsDirty(int position, int length)

指定 さ れたposition とlength で指定 さ れた内容を 「dirty」 と し てマー ク し 、 文書を再度レイアウトする必要があ る こ と を知らせます。

QString QTextDocument::metaInformation(QTextDocument::MetaInformation info) const

info で指定した型のドキュメントのメタ情報を返す。

setMetaInformation()も参照 。

[signal] void QTextDocument::modificationChanged(bool changed)

このシグナルは、ドキュメントの内容が変更状態に影響を与える形で変更されるたびに発行される。changed がtrueの場合、ドキュメントは変更されたことになり、そうでない場合はfalseになります。

たとえば、setModified(false)をドキュメントにコールし、テキストを挿入すると、このシグナルが発せられます。この操作を取り消し、ドキュメントを元の変更されていない状態に戻すと、シグナルは再び発信されます。

QTextObject *QTextDocument::object(int objectIndex) const

与えられたobjectIndex に関連づけられたテキストオブジェクトを返します。

QTextObject *QTextDocument::objectForFormat(const QTextFormat &f) const

f の書式に関連づけられたテキストオブジェクトを返します。

int QTextDocument::pageCount() const

このドキュメントのページ数を返します。

void QTextDocument::print(QPagedPaintDevice *printer) const

与えられたprinter に文書を印刷する。この関数を使う前にQPagedPaintDevice をセットアップしておく必要がある。

これは、文書全体をプリンタに印刷するための便宜的な方法です。

文書がpageSize() プロパティで指定した高さですでにページ付けされている場合は、そのまま印刷されます。

文書がページ分割されていない場合 （た と えばQTextEdit で使用 さ れてい る 文書） には、 文書の一時的な コ ピーが作成 さ れ、 その コ ピーはペ イ ン ト デバ イ ス の paperRect( ) のサ イ ズに従っ て複数ページに分割 さ れます。デフ ォル ト では、 文書内容の周囲に 2 cm の余白が設定 さ れてい ます。また、各ページの最下部には現在のページ番号が印刷されます。

QTextEdit::print()も参照 。

void QTextDocument::redo(QTextCursor *cursor)

redo is available の場合、 文書に対する最後の編集操作をやり直します。

提供されるcursor は、 編集操作がやり直された場所の末尾に置かれます。

[slot] void QTextDocument::redo()

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

redo is available の場合、ドキュメントに対する最後の編集操作をやり直します。

[signal] void QTextDocument::redoAvailable(bool available)

このシグナルは、REDO操作が利用可能になる（available がtrue）か、利用不可能になる（available がfalse）たびに発行される。

QVariant QTextDocument::resource(int type, const QUrl &name) const

指定 さ れたname を持つ リ ソ ース か ら 、 指定 さ れたtype のデー タ を返 し ます。

この関数は、リッチテキストエンジンが、QTextDocument によって直接格納されていないが、まだ関連付けられているデータを要求するために呼び出される。たとえば、画像はQTextImageFormat オブジェクトの name 属性によって間接的に参照されます。

リ ソ ース は文書内で内部的にキ ャ ッ シ ュ さ れます。リソースがキャッシュに見つからない場合、loadResource が呼び出されてリソースの読み込みを試みます。loadResource はaddResource を使ってリソースをキャッシュに追加します。

loadResource がリソースをロードしない場合、resourceProvider が呼び出され、設定されていれば最後にdefaultResourceProvider が呼び出されます。プロバイダからの結果は自動的にキャッシュに追加されないことに注意してください。

QTextDocument::ResourceType およびresourceProvider()も参照してください 。

[since 6.1] QTextDocument::ResourceProvider QTextDocument::resourceProvider() const

このテキストドキュメントのリソースプロバイダを返します。

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

setResourceProvider(),defaultResourceProvider(),loadResource()も参照してください 。

int QTextDocument::revision() const

ドキュメントのリビジョンを返します (アンドゥが有効な場合)。

リビジョンは、変更されていないドキュメントが編集されたときに増加することが保証されています。

QTextBlock::revision() およびisModified()も参照 ください。

QTextFrame *QTextDocument::rootFrame() const

ドキュメントのルートフレームを返します。

[since 6.0] void QTextDocument::setBaselineOffset(qreal baseline)

ドキュメントレイアウトで使用するフォントの高さの%としての基準線をbaseline に設定します。 デフォルト値は 0 です。正の値を指定すると、対応する%分だけテキストが上に移動し、負の値を指定すると下に移動します。

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

baselineOffset(),setSubScriptBaseline(),subScriptBaseline(),setSuperScriptBaseline(),superScriptBaseline()も参照してください 。

void QTextDocument::setDefaultCursorMoveStyle(Qt::CursorMoveStyle style)

デフォルトのカーソル移動スタイルを指定されたstyle に設定します。

defaultCursorMoveStyle()も参照 。

void QTextDocument::setDefaultFont(const QFont &font)

文書レ イ ア ウ ト で用い る デ フ ォ ル トfont を設定 し ます。

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

[static, since 6.1] void QTextDocument::setDefaultResourceProvider(const QTextDocument::ResourceProvider &provider)

デフォルトのリソースプロバイダをprovider に設定します。

このデフォルト・プロバイダは、明示的なプロバイダが設定されていないすべての QTextDocuments で使用されます。

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

defaultResourceProvider(),setResourceProvider(),loadResource()も参照してください 。

void QTextDocument::setDefaultTextOption(const QTextOption &option)

デフォルトのテキストオプションをoption に設定します。

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

void QTextDocument::setDocumentLayout(QAbstractTextDocumentLayout *layout)

与えられたlayout を使うように文書を設定します。以前のレイアウトは削除されます。

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

void QTextDocument::setHtml(const QString &html)

html 文字列で指定された HTML 形式のテキストで、ドキュメントの内容全体を置き換えます。この関数が呼ばれると、取り消し/やり直しの履歴はリセットされます。

HTMLフォーマットは可能な限り尊重されます。例えば、"<b>bold</b> text "と指定すると、最初の単語が太字に見えるようなフォントの太さを持つテキストが生成されます：「太字テキスト"。

デフォルトの "screen "ルール以外のcssメディアルールを選択するには、"info "パラメータに'CssMedia'を指定して、setMetaInformation （）を使用します。

setPlainText()、Supported HTML Subset、setMetaInformation()も参照 。

void QTextDocument::setIndentWidth(qreal width)

テ キ ス ト リ ス ト と テ キ ス ト ブ ロ ッ ク の字下げに用い ら れ るwidth を設定 し ます。

QTextListFormat とQTextBlockFormat のインデント・プロパティは、この値の倍数を指定します。デフォルトのインデント幅は 40 です。

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

void QTextDocument::setMarkdown(const QString &markdown, QTextDocument::MarkdownFeatures features = MarkdownDialectGitHub)

ドキュメントの内容全体を、markdown の文字列で指定された Markdown 形式のテキストに置き換えます。features がサポートされています。デフォルトでは、サポートされているすべてのGitHubスタイルのMarkdown機能が含まれています; より基本的なパースにはMarkdownDialectCommonMark を渡します。

Markdownのフォーマットは可能な限り尊重されます。例えば、"*bold* text "と指定すると、最初の単語が強調されたようなフォントの太さのテキストが生成されます。

markdown 文字列に含まれるHTMLの解析は、setHtml と同じ方法で処理されます ; しかし、HTMLブロック内のMarkdownフォーマットはサポートされていません。

パーサーのいくつかの機能は、features 引数で有効または無効にすることができます：

デフォルトはMarkdownDialectGitHub です。

この関数が呼ばれると、取り消し/やり直しの履歴がリセットされます。

void QTextDocument::setMetaInformation(QTextDocument::MetaInformation info, const QString &string)

info で指定された型の文書のメタ情報を、与えられたstring に設定します。

metaInformation()も参照 。

void QTextDocument::setPlainText(const QString &text)

文書の内容全体を、与えられたプレーンなtext で置き換えます。この関数が呼ばれると、取り消し/やり直しの履歴はリセットされます。

setHtml()も参照 。

[since 6.1] void QTextDocument::setResourceProvider(const QTextDocument::ResourceProvider &provider)

テキストドキュメントのリソースの提供者をprovider に設定します。

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

resourceProvider() およびloadResource()も参照してください 。

[since 6.0] void QTextDocument::setSubScriptBaseline(qreal baseline)

baselineデフ ォル ト 値は 16.67% （高 さ の 1/6） です。

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

subScriptBaseline(),setSuperScriptBaseline(),superScriptBaseline(),setBaselineOffset(),baselineOffset()も参照してください 。

[since 6.0] void QTextDocument::setSuperScriptBaseline(qreal baseline)

デフォルトの上付き文字のベースラインを、ドキュメントレイアウトで使用するフォントの高さに対する%としてbaseline に設定します。 デフォルト値は 50% (高さの 1/2) です。

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

superScriptBaseline(),setSubScriptBaseline(),subScriptBaseline(),setBaselineOffset(),baselineOffset()も参照してください 。

[since 6.0] qreal QTextDocument::subScriptBaseline() const

上付き文字のベースラインを、ドキュメントレイアウトで使用されているフォントの高さの % で返します。

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

setSubScriptBaseline(),setSuperScriptBaseline(),superScriptBaseline(),setBaselineOffset(),baselineOffset()も参照してください 。

[since 6.0] qreal QTextDocument::superScriptBaseline() const

上付き文字のベースラインを、ドキュメントレイアウトで使用されているフォントの高さの % で返します。

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

setSuperScriptBaseline(),setSubScriptBaseline(),subScriptBaseline(),setBaselineOffset(),baselineOffset()も参照してください 。

QString QTextDocument::toHtml() const

ドキュメントの HTML 表現を含む文字列を返します。

ドキュメントの内容は、エンコーディングをUTF-8に指定している。返された html 文字列を後でバイト配列に変換してネットワーク経由で送信したり、ディスクに保存したりする場合は、QString::toUtf8() を使用して文字列をQByteArray に変換する必要があります。

サポートされるHTMLサブセットも参照してください 。

QString QTextDocument::toMarkdown(QTextDocument::MarkdownFeatures features = MarkdownDialectGitHub) const

与えられたfeatures を持つドキュメントの Markdown 表現を含む文字列、または何らかの理由で書き込みに失敗した場合は空文字列を返します。

setMarkdownも参照してください 。

QString QTextDocument::toPlainText() const

ドキュメントに含まれるプレーンテキストを返します。フォーマット情報が必要な場合は、代わりにQTextCursor を使用してください。

この関数はtoRawText() と同じものを返しますが、一部の unicode キ ャ ラ ク タ を ASCII の代替キ ャ ラ ク タ へ置 き 換え ます。特に、改行なしスペース (U+00A0) は通常のスペース (U+0020) に置き換えられ、段落区切り (U+2029) と行区切り (U+2028) はともに改行 (U+000A) に置き換えられます。文書の正確な内容が必要な場合は、代わりにtoRawText （）を使ってください。

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

QString QTextDocument::toRawText() const

文書に含まれる生のテキストを、書式情報なしで返します。書式情報が必要な場合は、代わりにQTextCursor を使用します。

toPlainText()も参照 。

void QTextDocument::undo(QTextCursor *cursor)

文書の最後の編集操作を元に戻す （元に戻せ る 場合）。提供されるcursor は、編集操作が取り消された場所の末尾に配置されます。

詳細はQt Undo Framework のドキュメントを参照してください。

undoAvailable() およびisUndoRedoEnabled()も参照してください 。

[slot] void QTextDocument::undo()

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

[signal] void QTextDocument::undoAvailable(bool available)

このシグナルは、元に戻す操作が利用可能になる (available が true)、または利用不可能になる (available が false) ときに発行されます。

詳細はQt Undo Framework のドキュメントを参照してください。

undo() およびisUndoRedoEnabled()も参照してください 。

[signal] void QTextDocument::undoCommandAdded()

このシグナルは、QTextDocument に新しいアンドゥ・レベルが追加されるたびに発せられる。