QPlainTextEdit Class

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

[explicit] QPlainTextEdit::QPlainTextEdit(QWidget *parent = nullptr)

親要素としてparent を持つ、空のQPlainTextEditを構築します。

[explicit] QPlainTextEdit::QPlainTextEdit(const QString &text, QWidget *parent = nullptr)

親要素としてparent を持つQPlainTextEditを生成します。このテキスト編集フィールドには、プレーンテキストtext が表示されます。

[virtual noexcept] QPlainTextEdit::~QPlainTextEdit()

デストラクタ。

QString QPlainTextEdit::anchorAt(const QPoint &pos) const

位置pos にあるアンカーの参照を返します。その位置にアンカーが存在しない場合は、空の文字列を返します。

[slot] void QPlainTextEdit::appendHtml(const QString &html)

テキスト編集の末尾に、html を含む新しい段落を追加します。

appendPlainText()

[slot] void QPlainTextEdit::appendPlainText(const QString &text)

テキスト編集内容の最後に、text を含む新しい段落を追加します。

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

[protected] QRectF QPlainTextEdit::blockBoundingGeometry(const QTextBlock &block) const

テキスト「block 」の境界矩形を、コンテンツ座標系で返します。ビューポート上の視覚座標を取得するには、contentOffset() を使用してこの矩形を平行移動させてください。

firstVisibleBlock() およびblockBoundingRect()も参照してください 。

[protected] QRectF QPlainTextEdit::blockBoundingRect(const QTextBlock &block) const

テキスト「block 」の囲み矩形を、ブロック独自の座標系で返します。

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

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

このシグナルは、ブロック数が変更されるたびに発火します。新しいブロック数は、newBlockCount に引数として渡されます。

[virtual protected] bool QPlainTextEdit::canInsertFromMimeData(const QMimeData *source) const

この関数は、source で指定された MIME データオブジェクトの内容をデコードしてドキュメントに挿入できる場合、true を返します。たとえば、ドラッグ操作中にマウスがこのウィジェット内に進入し、そのドラッグを受け入れることができるかどうかを判断する必要がある場合などに、この関数が呼び出されます。

bool QPlainTextEdit::canPaste() const

クリップボードからテキストエディットにテキストを貼り付けることができるかどうかを返します。

[slot] void QPlainTextEdit::centerCursor()

ドキュメントをスクロールして、カーソルを縦方向に中央に合わせます。

ensureCursorVisible() およびcenterOnScrollも参照してください 。

[override virtual protected] void QPlainTextEdit::changeEvent(QEvent *e)

QFrame::changeEvent(QEvent *ev) を再実装します。

[slot] void QPlainTextEdit::clear()

テキスト編集フィールド内のテキストをすべて削除します。

注：

• 元に戻す／やり直し履歴もクリアされます。
• currentCharFormat textCursor()がすでにドキュメントの先頭にある場合を除き、()はリセットされます。

cut() およびsetPlainText()も参照してください 。

[protected] QPointF QPlainTextEdit::contentOffset() const

コンテンツの起点座標をビューポート座標で返します。

プレーンテキスト編集フィールドのコンテンツの原点は、常に最初に表示されるテキストブロックの左上隅です。 テキストが水平方向にスクロールされている場合、または最初に表示されるブロックが画面から部分的にスクロールされてしまっている場合（つまり、表示されているテキストが最初に表示されるブロックの最初の行から始まっていない場合）、あるいは最初に表示されるブロックが最初のブロックであり、エディタが余白を表示している場合、コンテンツのオフセットは (0,0) とは異なります。

firstVisibleBlock()、horizontalScrollBar()、およびverticalScrollBar()も参照してください 。

[override virtual protected] void QPlainTextEdit::contextMenuEvent(QContextMenuEvent *event)

QAbstractScrollArea::contextMenuEvent(QContextMenuEvent *e) を再実装します。

createStandardContextMenu() で作成された標準のコンテキストメニューを表示します。

テキスト編集にコンテキストメニューを表示させたくない場合は、そのcontextMenuPolicy をQt::NoContextMenu に設定できます。コンテキストメニューをカスタマイズしたい場合は、この関数を再実装してください。標準のコンテキストメニューを拡張したい場合は、この関数を再実装し、createStandardContextMenu()を呼び出して、返されたメニューを拡張してください。

イベントに関する情報は、event オブジェクトを通じて渡されます。

void MyQPlainTextEdit::contextMenuEvent(QContextMenuEvent *event)
{
    QMenu *menu = createStandardContextMenu();
    menu->addAction(tr("My Menu Item"));
    //...
    menu->exec(event->globalPos());
    delete menu;
}

[slot] void QPlainTextEdit::copy()

選択したテキストをクリップボードにコピーします。

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

[signal] void QPlainTextEdit::copyAvailable(bool yes)

このシグナルは、テキスト編集フィールドでテキストが選択されたり、選択が解除されたりしたときに発せられます。

テキストが選択されると、このシグナルはyes がtrueに設定された状態で発火します。テキストが選択されていない場合、または選択されたテキストの選択が解除された場合、このシグナルはyes がfalseに設定された状態で発火します。

yes がtrueの場合、copy()を使用して、選択範囲をクリップボードにコピーできます。yes がfalseの場合、copy()は何も行いません。

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

[virtual protected] QMimeData *QPlainTextEdit::createMimeDataFromSelection() const

この関数は、テキストエディタの現在の選択範囲の内容を表す新しいMIMEデータオブジェクトを返します。この関数は、選択範囲を新しいQMimeData オブジェクトにカプセル化する必要があるときに呼び出されます。たとえば、ドラッグ＆ドロップ操作が開始されたときや、データがクリップボードにコピーされたときなどです。

この関数を再実装する場合、返されるQMimeData オブジェクトの所有権は呼び出し元に引き継がれる点に注意してください。選択範囲は、textCursor()関数を使用して取得できます。

QMenu *QPlainTextEdit::createStandardContextMenu()

この関数は、ユーザーがテキスト編集フィールドを右クリックした際に表示される標準のコンテキストメニューを作成します。これは、デフォルトのcontextMenuEvent()ハンドラから呼び出されます。ポップアップメニューの所有権は呼び出し元に引き継がれます。

代わりに、createStandardContextMenu(QPoint) バージョンを使用することをお勧めします。これにより、ユーザーがクリックした位置に応じたアクションが有効になります。

QMenu *QPlainTextEdit::createStandardContextMenu(const QPoint &position)

この関数は、ユーザーがテキスト編集フィールドをマウスの右ボタンでクリックした際に表示される標準のコンテキストメニューを作成します。この関数は、デフォルトのcontextMenuEvent()ハンドラから呼び出され、マウスクリックが発生した位置を表すドキュメント座標のposition を受け取ります。これにより、ユーザーがクリックした位置に応じた操作を有効にすることができます。ポップアップメニューの所有権は呼び出し元に譲渡されます。

QTextCharFormat QPlainTextEdit::currentCharFormat() const

新しいテキストを挿入する際に使用される文字形式を返します。

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

QTextCursor QPlainTextEdit::cursorForPosition(const QPoint &pos) const

pos の位置（ビューポート座標）にあるQTextCursor を返します。

[signal] void QPlainTextEdit::cursorPositionChanged()

この信号は、カーソルの位置が変化するたびに送信されます。

QRect QPlainTextEdit::cursorRect() const

テキスト編集フィールドのカーソルを含む矩形（ビューポート座標系）を返します。

QRect QPlainTextEdit::cursorRect(const QTextCursor &cursor) const

cursor を含む長方形（ビューポート座標系）を返します。

[slot] void QPlainTextEdit::cut()

選択したテキストをクリップボードにコピーし、テキスト編集フィールドから削除します。

選択されたテキストがない場合は、何も起こりません。

copy() およびpaste()も参照してください 。

QTextDocument *QPlainTextEdit::document() const

基となるドキュメントへのポインタを返します。

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

[override virtual protected] void QPlainTextEdit::dragEnterEvent(QDragEnterEvent *e)

QAbstractScrollArea::dragEnterEvent(QDragEnterEvent *event) を再実装します。

[override virtual protected] void QPlainTextEdit::dragLeaveEvent(QDragLeaveEvent *e)

QAbstractScrollArea::dragLeaveEvent(QDragLeaveEvent *event) を再実装します。

[override virtual protected] void QPlainTextEdit::dragMoveEvent(QDragMoveEvent *e)

QAbstractScrollArea::dragMoveEvent(QDragMoveEvent *event) を再実装します。

[override virtual protected] void QPlainTextEdit::dropEvent(QDropEvent *e)

QAbstractScrollArea::dropEvent （QDropEvent *event）を再実装します。

void QPlainTextEdit::ensureCursorVisible()

必要に応じてテキスト編集フィールドをスクロールし、カーソルが表示されていることを確認します。

centerCursor() およびcenterOnScrollも参照してください 。

QList<QTextEdit::ExtraSelection> QPlainTextEdit::extraSelections() const

以前に設定された追加の選択項目を返します。

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

bool QPlainTextEdit::find(const QString &exp, QTextDocument::FindFlags options = QTextDocument::FindFlags())

指定されたoptions を使用して、文字列exp の次の出現箇所を検索します。exp が見つかった場合はtrue を返し、カーソルを一致箇所に合わせます。それ以外の場合はfalse を返します。

bool QPlainTextEdit::find(const QRegularExpression &exp, QTextDocument::FindFlags options = QTextDocument::FindFlags())

指定されたoptions を使用して、正規表現exp に一致する次の出現箇所を検索します。

一致が見つかった場合は `true ` を返し、カーソル位置をその一致箇所に変更します。一致が見つからない場合は `false` を返します。

[protected] QTextBlock QPlainTextEdit::firstVisibleBlock() const

最初に表示されるブロックを返します。

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

[override virtual protected] void QPlainTextEdit::focusInEvent(QFocusEvent *e)

QWidget::focusInEvent(QFocusEvent *event) を再実装します。

[override virtual protected] bool QPlainTextEdit::focusNextPrevChild(bool next)

QWidget::focusNextPrevChild （bool next）を再実装します。

[override virtual protected] void QPlainTextEdit::focusOutEvent(QFocusEvent *e)

QWidget::focusOutEvent(QFocusEvent *event) を再実装します。

[protected] QAbstractTextDocumentLayout::PaintContext QPlainTextEdit::getPaintContext() const

viewport() のペイントコンテキストを返します。これは、paintEvent() を再実装する場合にのみ有用です。

[override virtual protected] void QPlainTextEdit::inputMethodEvent(QInputMethodEvent *e)

QWidget::inputMethodEvent(QInputMethodEvent *event) を再実装しています。

[override virtual] QVariant QPlainTextEdit::inputMethodQuery(Qt::InputMethodQuery property) const

QWidget::inputMethodQuery （Qt::InputMethodQuery query）const を再実装します。

[virtual protected] void QPlainTextEdit::insertFromMimeData(const QMimeData *source)

この関数は、source で指定されたMIMEデータオブジェクトの内容を、現在のカーソル位置にあるテキスト編集フィールドに挿入します。この関数は、クリップボードからの貼り付け操作の結果としてテキストが挿入されたとき、またはテキスト編集フィールドがドラッグ＆ドロップ操作からのデータを受け入れたときに呼び出されます。

[slot] void QPlainTextEdit::insertPlainText(const QString &text)

現在のカーソル位置に「text 」を挿入する便利なスロットです。

これは、

edit->textCursor().insertText(text);

[override virtual protected] void QPlainTextEdit::keyPressEvent(QKeyEvent *e)

QAbstractScrollArea::keyPressEvent(QKeyEvent *e) を再実装しています。

[override virtual protected] void QPlainTextEdit::keyReleaseEvent(QKeyEvent *e)

QWidget::keyReleaseEvent(QKeyEvent *event) を再実装します。

[virtual] QVariant QPlainTextEdit::loadResource(int type, const QUrl &name)

指定された `type ` および `name` で指定されたリソースを読み込みます。

この関数は、QTextDocument::loadResource() の拡張機能です。

QTextDocument::loadResource()も参照してください 。

void QPlainTextEdit::mergeCurrentCharFormat(const QTextCharFormat &modifier)

modifier で指定されたプロパティを、エディタのカーソルに対してQTextCursor::mergeCharFormat を呼び出すことで、現在の文字書式に統合します。エディタに選択範囲がある場合、modifier のプロパティは選択範囲に直接適用されます。

QTextCursor::mergeCharFormat()も参照してください 。

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

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

たとえば、ドキュメントに対して setModified(false) を呼び出した後にテキストを挿入すると、このシグナルが発火します。その操作を元に戻して、ドキュメントを元の変更されていない状態に戻すと、このシグナルは再び発火します。

[override virtual protected] void QPlainTextEdit::mouseDoubleClickEvent(QMouseEvent *e)

QAbstractScrollArea::mouseDoubleClickEvent(QMouseEvent *e) を再実装します。

[override virtual protected] void QPlainTextEdit::mouseMoveEvent(QMouseEvent *e)

QAbstractScrollArea::mouseMoveEvent(QMouseEvent *e) を再実装します。

[override virtual protected] void QPlainTextEdit::mousePressEvent(QMouseEvent *e)

QAbstractScrollArea::mousePressEvent(QMouseEvent *e) を再実装します。

[override virtual protected] void QPlainTextEdit::mouseReleaseEvent(QMouseEvent *e)

QAbstractScrollArea::mouseReleaseEvent(QMouseEvent *e) を再実装します。

void QPlainTextEdit::moveCursor(QTextCursor::MoveOperation operation, QTextCursor::MoveMode mode = QTextCursor::MoveAnchor)

指定されたoperation を実行して、カーソルを移動させます。

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

QTextCursor::movePosition()も参照してください 。

[override virtual protected] void QPlainTextEdit::paintEvent(QPaintEvent *e)

QAbstractScrollArea::paintEvent(QPaintEvent *event) を再実装します。

[slot] void QPlainTextEdit::paste()

クリップボード内のテキストを、現在のカーソル位置にあるテキスト編集欄に貼り付けます。

クリップボードにテキストがない場合は、何も起こりません。

この関数の動作、すなわちQPlainTextEdit が貼り付ける内容や貼り付け方法を変更するには、仮想関数canInsertFromMimeData()およびinsertFromMimeData()を再実装してください。

cut() およびcopy()も参照してください 。

void QPlainTextEdit::print(QPagedPaintDevice *printer) const

テキストエディタのドキュメントを、指定されたprinter に出力するための便利な関数です。これは、ドキュメントに対して直接printメソッドを呼び出すのと同じですが、この関数ではQPrinter::Selectionを印刷範囲として指定することも可能です。

QTextDocument::print()も参照してください 。

[slot] void QPlainTextEdit::redo()

直前の操作をやり直します。

やり直す操作がない場合、つまり元に戻す／やり直す履歴にやり直しステップがない場合は、何も起こりません。

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

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

このシグナルは、リドゥ操作が利用可能になったとき（available がtrueの場合）または利用不可能になったとき（available がfalseの場合）に発火します。

[override virtual protected] void QPlainTextEdit::resizeEvent(QResizeEvent *e)

QAbstractScrollArea::resizeEvent(QResizeEvent *event) を再実装します。

[override virtual protected] void QPlainTextEdit::scrollContentsBy(int dx, int dy)

QAbstractScrollArea::scrollContentsBy(int dx, int dy) を再実装しています。

[slot] void QPlainTextEdit::selectAll()

すべてのテキストを選択します。

copy()、cut()、およびtextCursor()も参照してください 。

[signal] void QPlainTextEdit::selectionChanged()

このシグナルは、選択内容が変更されるたびに発せられます。

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

void QPlainTextEdit::setCurrentCharFormat(const QTextCharFormat &format)

エディタのカーソルで `QTextCursor::setCharFormat()` を呼び出すことにより、format に新しいテキストを挿入する際に使用する文字形式を設定します。エディタに選択範囲がある場合、その選択範囲に文字形式が直接適用されます。

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

void QPlainTextEdit::setDocument(QTextDocument *document)

document をテキストエディタの新しいドキュメントに設定します。

指定されたドキュメントの親である `QObject ` は、引き続きそのオブジェクトの所有者となります。現在のドキュメントがテキストエディタの子である場合は、そのドキュメントは削除されます。

ドキュメントは、QPlainTextDocumentLayout を継承するドキュメントレイアウトを持っている必要があります（QTextDocument::setDocumentLayout()を参照）。

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

void QPlainTextEdit::setExtraSelections(const QList<QTextEdit::ExtraSelection> &selections)

この関数を使用すると、selections で指定された色で、ドキュメント内の特定の領域を一時的にマークすることができます。これは、例えばプログラミングエディタにおいて、ブレークポイントの存在を示すために、テキストの行全体を特定の背景色でマークする場合などに役立ちます。

QTextEdit::ExtraSelection およびextraSelections()も参照してください 。

[slot] void QPlainTextEdit::setPlainText(const QString &text)

テキスト編集フィールドのテキストを「text 」という文字列に変更します。それまでのテキストはすべて削除されます。

text はプレーンテキストとして解釈されます。

注：

• 元に戻す／やり直し履歴もクリアされます。
• currentCharFormat textCursor()がすでにドキュメントの先頭にある場合を除き、()はリセットされます。

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

void QPlainTextEdit::setTextCursor(const QTextCursor &cursor)

cursor の表示状態を設定します。

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

[override virtual protected] void QPlainTextEdit::showEvent(QShowEvent *)

QWidget::showEvent(QShowEvent *event) を再実装します。

[signal] void QPlainTextEdit::textChanged()

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

QTextCursor QPlainTextEdit::textCursor() const

現在表示されているカーソルを表すQTextCursor のコピーを返します。返されたカーソルへの変更は、QPlainTextEdit のカーソルには影響しないことに注意してください。表示されているカーソルを更新するには、setTextCursor() を使用してください。

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

QString QPlainTextEdit::toPlainText() const

テキストエディットのテキストをプレーンテキストとして返します。

関連項目： QPlainTextEdit::setPlainText()。

[slot] void QPlainTextEdit::undo()

直前の操作を取り消します。

元に戻す操作がない場合、つまり元に戻す/やり直し履歴に元に戻すステップがない場合は、何も起こりません。

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

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

このシグナルは、元に戻す操作が可能になったとき（available がtrueの場合）または不可能になったとき（available がfalseの場合）に発火します。

[signal] void QPlainTextEdit::updateRequest(const QRect &rect, int dy)

このシグナルは、テキストドキュメントが指定されたrect の更新を必要とする際に発火します。テキストがスクロールされた場合、rect はビューポート領域全体をカバーします。テキストが垂直方向にスクロールされた場合、dy には、ビューポートがスクロールされたピクセル数が格納されます。

このシグナルの目的は、行番号やブレークポイント、その他の追加情報を表示するなど、プレーンテキスト編集のサブクラスにおける追加ウィジェットをサポートすることです。

[override virtual protected] void QPlainTextEdit::wheelEvent(QWheelEvent *e)

QAbstractScrollArea::wheelEvent(QWheelEvent *e) の再実装です。

[slot] void QPlainTextEdit::zoomIn(int range = 1)

基本フォントサイズをrange ポイント大きくし、すべてのフォントサイズを新しいサイズに合わせて再計算することで、テキストを拡大表示します。この操作では、画像のサイズは変更されません。

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

[slot] void QPlainTextEdit::zoomOut(int range = 1)

ベースのフォントサイズをrange ポイント小さくし、すべてのフォントサイズを新しいサイズに合わせて再計算することで、テキストをズームアウトします。これにより、画像のサイズは変更されません。

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