QTextEdit Class

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

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

親要素がparent である空のQTextEditを作成します。

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

親要素がparent であるQTextEditを構築します。このテキスト編集フィールドには、「text 」というテキストが表示されます。このテキストはHTMLとして解釈されます。

[virtual noexcept] QTextEdit::~QTextEdit()

デストラクタ。

Qt::Alignment QTextEdit::alignment() const

現在の段落の配置を返します。

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

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

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

[slot] void QTextEdit::append(const QString &text)

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

関連項目： currentCharFormat() およびQTextCursor::blockFormat()。

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

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

追加の MIME タイプに対するドラッグ＆ドロップ機能を有効にするには、この関数を再実装してください。

bool QTextEdit::canPaste() const

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

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

QFrame::changeEvent(QEvent *ev) の再実装です。

[slot] void QTextEdit::clear()

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

注：

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

関連項目： cut()、setPlainText()、およびsetHtml()。

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

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

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

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

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

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

[slot] void QTextEdit::copy()

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

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

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

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

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

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

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

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

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

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

QMenu *QTextEdit::createStandardContextMenu()

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

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

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

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

QTextCharFormat QTextEdit::currentCharFormat() const

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

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

[signal] void QTextEdit::currentCharFormatChanged(const QTextCharFormat &f)

このシグナルは、カーソルの位置変更などにより、現在の文字形式が変更された場合に発信されます。

新しいフォーマットは `f` となります。

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

QFont QTextEdit::currentFont() const

現在のフォーマットのフォントを返します。

setCurrentFont()、setFontFamily()、およびsetFontPointSize()も参照してください 。

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

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

[signal] void QTextEdit::cursorPositionChanged()

この信号は、カーソルの位置が変化するたびに発生します。

QRect QTextEdit::cursorRect() const

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

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

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

[slot] void QTextEdit::cut()

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

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

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

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

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

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

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

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

QAbstractScrollArea::dragMoveEvent(QDragMoveEvent *event) の再実装です。

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

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

void QTextEdit::ensureCursorVisible()

必要に応じてテキスト編集欄をスクロールし、カーソルが表示されるようにします。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

QString QTextEdit::fontFamily() const

現在のフォーマットのフォントファミリーを返します。

setFontFamily()、setCurrentFont()、およびsetFontPointSize()も参照してください 。

bool QTextEdit::fontItalic() const

現在のフォーマットのフォントがイタリック体である場合は `true ` を返し、そうでない場合は `false` を返します。

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

qreal QTextEdit::fontPointSize() const

現在のフォーマットのフォントのポイントサイズを返します。

setFontFamily()、setCurrentFont()、およびsetFontPointSize()も参照してください 。

bool QTextEdit::fontUnderline() const

現在のフォーマットのフォントに下線が付いている場合は `true ` を返し、そうでない場合は `false` を返します。

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

int QTextEdit::fontWeight() const

現在の書式のフォントの太さを返します。

setFontWeight()、setCurrentFont()、setFontPointSize()、およびQFont::Weightも参照してください 。

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

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

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

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

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

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

追加のMIMEタイプに対してドラッグ＆ドロップをサポートするには、この関数を再実装してください。

[slot] void QTextEdit::insertHtml(const QString &text)

現在のカーソル位置に、HTML形式であると想定されるtext を挿入するための便利なスロットです。

これは以下と同等です：

edit->textCursor().insertHtml(fragment);

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

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

これは、

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

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

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

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

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

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

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

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

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

void QTextEdit::mergeCurrentCharFormat(const QTextCharFormat &modifier)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[override virtual protected] void QTextEdit::paintEvent(QPaintEvent *event)

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

このイベントハンドラは、event で渡されるペイントイベントを受け取るために、サブクラスで再実装することができます。通常、QTextEdit のサブクラスでこの関数を再実装する必要はありません。

[slot] void QTextEdit::paste()

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

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

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

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

void QTextEdit::print(QPagedPaintDevice *printer) const

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

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

[slot] void QTextEdit::redo()

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

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

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

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

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

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

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

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

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

[slot] void QTextEdit::scrollToAnchor(const QString &name)

指定されたname を持つアンカーが表示されるように、テキスト編集領域をスクロールします。name が空の場合、すでに表示されている場合、または見つからない場合は、何も行いません。

[slot] void QTextEdit::selectAll()

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

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

[signal] void QTextEdit::selectionChanged()

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

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

[slot] void QTextEdit::setAlignment(Qt::Alignment a)

現在の段落の配置を `a` に設定します。有効な配置は、`Qt::AlignLeft`、`Qt::AlignRight`、`Qt::AlignJustify `、および `Qt::AlignCenter `（水平方向に中央揃え）です。

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

void QTextEdit::setCurrentCharFormat(const QTextCharFormat &format)

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

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

[slot] void QTextEdit::setCurrentFont(const QFont &f)

現在のフォーマットのフォントを「f 」に設定します。

currentFont()、setFontPointSize()、およびsetFontFamily()も参照してください 。

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

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

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

[slot] void QTextEdit::setFontFamily(const QString &fontFamily)

現在の書式設定のフォントファミリーを「fontFamily 」に設定します。

fontFamily() およびsetCurrentFont()も参照してください 。

[slot] void QTextEdit::setFontItalic(bool italic)

italic が true の場合は、現在の書式をイタリックに設定します。そうでない場合は、現在の書式をイタリック以外に設定します。

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

[slot] void QTextEdit::setFontPointSize(qreal s)

現在の書式のポイントサイズをs に設定します。

なお、s が 0 または負の値の場合、この関数の挙動は未定義となります。

fontPointSize()、setCurrentFont()、およびsetFontFamily()も参照してください 。

[slot] void QTextEdit::setFontUnderline(bool underline)

underline が true の場合、現在の書式を下線付きに設定します。そうでない場合は、現在の書式を下線なしに設定します。

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

[slot] void QTextEdit::setFontWeight(int weight)

現在の書式のフォントの太さを、指定されたweight に設定します。ここで、使用される値はQFont::Weight 列挙型で定義された範囲内となります。

fontWeight()、setCurrentFont()、およびsetFontFamily()も参照してください 。

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

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

注：

• text はプレーンテキストとして解釈されます。
• 元に戻す／やり直し履歴もクリアされます。
• currentCharFormat textCursor()がすでに文書の先頭にある場合を除き、()はリセットされます。

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

[slot] void QTextEdit::setText(const QString &text)

テキスト編集フィールドのtext を設定します。テキストはプレーンテキストまたはHTMLのいずれでもよく、テキスト編集フィールドは適切な形式を推測しようとします。

テキストエディットの自動判別を回避するには、setHtml() またはsetPlainText() を直接使用してください。

toPlainText() およびtoHtml()も参照してください 。

[slot] void QTextEdit::setTextBackgroundColor(const QColor &c)

現在の書式のテキストの背景色を「c 」に設定します。

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

[slot] void QTextEdit::setTextColor(const QColor &c)

現在の書式のテキストの色を「c 」に設定します。

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

void QTextEdit::setTextCursor(const QTextCursor &cursor)

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

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

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

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

QColor QTextEdit::textBackgroundColor() const

現在の書式設定のテキストの背景色を返します。

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

[signal] void QTextEdit::textChanged()

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

QColor QTextEdit::textColor() const

現在の書式のテキストの色を返します。

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

QTextCursor QTextEdit::textCursor() const

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

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

QString QTextEdit::toPlainText() const

QString QTextEdit::toPlainText() const

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

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

[slot] void QTextEdit::undo()

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

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

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

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

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

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

QAbstractScrollArea::wheelEvent(QWheelEvent *e) を再実装します。

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

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

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

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

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

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