QCompleter Class

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

QCompleter::QCompleter(QObject *parent = nullptr)

指定されたparent を使用して、コンプリーターオブジェクトを構築します。

QCompleter::QCompleter(QAbstractItemModel *model, QObject *parent = nullptr)

指定されたparent を使用して、指定されたmodel からの補完を提供するcompleterオブジェクトを生成します。

QCompleter::QCompleter(const QStringList &list, QObject *parent = nullptr)

指定されたparent を使用して、指定されたlist を候補の補完ソースとして使用するQCompleterオブジェクトを作成します。

[override virtual noexcept] QCompleter::~QCompleter()

コンプリーターオブジェクトを破棄します。

[signal] void QCompleter::activated(const QModelIndex &index)

このシグナルは、popup() 内のアイテムがユーザーによってアクティブ化されたとき（クリックまたはリターンキーの押下など）に送信されます。completionModel() 内のそのアイテムのindex が渡されます。

// Connect using qOverload:
connect(completer, qOverload(&QCompleter::activated),
        receiver, &ReceiverClass::slot);

// Or using a lambda:
connect(completer, qOverload(&QCompleter::activated),
        this, [](const QModelIndex &index) { /* handle activated */ });

[signal] void QCompleter::activated(const QString &text)

このシグナルは、popup()内のアイテムがユーザーによって（クリックまたはReturnキーの押下により）アクティブ化されたときに送信されます。そのアイテムのtext が渡されます。

// Connect using qOverload:
connect(completer, qOverload(&QCompleter::activated),
        receiver, &ReceiverClass::slot);

// Or using a lambda:
connect(completer, qOverload(&QCompleter::activated),
        this, [](const QString &text) { /* handle activated */ });

[slot] void QCompleter::complete(const QRect &rect = QRect())

QCompleter::PopupCompletion および QCompletion::UnfilteredPopupCompletion モードの場合、この関数を呼び出すと、現在の補完候補を表示するポップアップが表示されます。デフォルトでは、rect が指定されていない場合、ポップアップはwidget() の下部に表示されます。rect が指定された場合、ポップアップは矩形の左端に表示されます。

QCompleter::InlineCompletion モードの場合、highlighted()シグナルが現在の補完候補とともに発火します。

int QCompleter::completionCount() const

現在のプレフィックスに対する候補の数を返します。アイテム数が多く、ソートされていないモデルの場合、この処理には時間がかかることがあります。すべての候補を順に確認するには、setCurrentRow() およびcurrentCompletion() を使用してください。

QAbstractItemModel *QCompleter::completionModel() const

補完モデルを返します。補完モデルは、現在の補完プレフィックスに対するすべての候補を含む、読み取り専用のリストモデルです。補完モデルは、現在の補完内容を反映するように自動的に更新されます。

completionPrefix およびmodel()も参照してください 。

QString QCompleter::currentCompletion() const

現在の補完文字列を返します。これには `completionPrefix` が含まれます。setCurrentRow() と組み合わせて使用することで、すべての一致結果を順に処理することができます。

setCurrentRow() およびcurrentIndex()も参照してください 。

QModelIndex QCompleter::currentIndex() const

completionModel() において、現在の補完のモデルインデックスを返します。

setCurrentRow()、currentCompletion()、およびmodel()も参照してください 。

int QCompleter::currentRow() const

現在の行を返します。

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

[override virtual protected] bool QCompleter::event(QEvent *ev)

QObject::event(QEvent *e) を再実装します。

[override virtual protected] bool QCompleter::eventFilter(QObject *o, QEvent *e)

QObject::eventFilter(QObject *watched, QEvent *event) を再実装します。

[signal] void QCompleter::highlighted(const QModelIndex &index)

このシグナルは、popup() 内の項目がユーザーによってハイライトされたときに送信されます。また、completionMode() がQCompleter::InlineCompletion に設定された状態でcomplete() が呼び出された場合にも送信されます。completionModel() 内の項目のindex が渡されます。

// Connect using qOverload:
connect(completer, qOverload(&QCompleter::highlighted),
        receiver, &ReceiverClass::slot);

// Or using a lambda:
connect(completer, qOverload(&QCompleter::highlighted),
        this, [](const QModelIndex &index) { /* handle highlighted */ });

[signal] void QCompleter::highlighted(const QString &text)

このシグナルは、popup() 内の項目がユーザーによってハイライトされたときに送信されます。また、completionMode() がQCompleter::InlineCompletion に設定された状態でcomplete() が呼び出された場合にも送信されます。項目のtext が渡されます。

// Connect using qOverload:
connect(completer, qOverload(&QCompleter::highlighted),
        receiver, &ReceiverClass::slot);

// Or using a lambda:
connect(completer, qOverload(&QCompleter::highlighted),
        this, [](const QString &text) { /* handle highlighted */ });

QAbstractItemModel *QCompleter::model() const

補完文字列を提供するモデルを返します。

setModel() およびcompletionModel()も参照してください 。

[virtual] QString QCompleter::pathFromIndex(const QModelIndex &index) const

指定されたindex のパスを返します。コンプリート機能オブジェクトは、これを使用して基になるモデルから補完テキストを取得します。

デフォルトの実装では、リストモデルの場合、その項目のedit role を返します。モデルがQFileSystemModel である場合は、絶対ファイルパスを返します。

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

QAbstractItemView *QCompleter::popup() const

補完を表示するために使用されるポップアップを返します。

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

bool QCompleter::setCurrentRow(int row)

現在の行を、指定されたrow に設定します。成功した場合はtrue を返し、失敗した場合はfalse を返します。

この関数は、currentCompletion() と組み合わせて使用し、考えられるすべての補完候補を順に処理することができます。

currentRow()、currentCompletion()、およびcompletionCount()も参照してください 。

void QCompleter::setModel(QAbstractItemModel *model)

model への補完機能を提供するモデルを設定します。model は、リストモデルまたはツリーモデルのいずれかです。以前にモデルが設定されており、その親がQCompleter である場合は、そのモデルは削除されます。

便宜上、model がQFileSystemModel である場合、QCompleter は、そのcaseSensitivity をWindowsではQt::CaseInsensitive に、その他のプラットフォームではQt::CaseSensitive に切り替えます。

completionModel()、modelSorting 、およびHandling Tree Modelsも参照してください 。

void QCompleter::setPopup(QAbstractItemView *popup)

補完結果を表示するために使用されるポップアップを「popup 」に設定します。QCompleter がこのビューの所有権を取得します。

`completionMode()`が`QCompleter::PopupCompletion `または`QCompleter::UnfilteredPopupCompletion`に設定されると、QListView が自動的に作成されます。デフォルトのポップアップはcompletionColumn()を表示します。

ビューの設定を変更する前に、この関数が呼び出されていることを確認してください。これは、ビューのプロパティによっては、そのビューにモデルが設定されている必要がある場合があるためです（たとえば、ビューで列を非表示にするには、そのビューにモデルが設定されている必要があります）。

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

void QCompleter::setWidget(QWidget *widget)

補完の対象となるウィジェットを `widget` に設定します。この関数は、QLineEdit::setCompleter() を使用して `QLineEdit ` に `QCompleter ` を設定する場合、または `QComboBox::setCompleter()` を使用して `QComboBox ` に ` ` を設定する場合に、自動的に呼び出されます。カスタムウィジェットに対して補完を提供する場合は、ウィジェットを明示的に設定する必要があります。

widget()、setModel()、およびsetPopup()も参照してください 。

[virtual] QStringList QCompleter::splitPath(const QString &path) const

指定されたpath を、model()の各レベルでの照合に使用される文字列に分割します。

splitPath() のデフォルトの実装では、sourceModel() がQFileSystemModel の場合、QDir::separator() に基づいてファイルシステムパスを分割します。

リストモデルと併用する場合、返されるリストの最初の項目が照合に使用されます。

pathFromIndex() およびHandling Tree Modelsも参照してください 。

QWidget *QCompleter::widget() const

completer オブジェクトが補完を提供しているウィジェットを返します。

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