QCompleter Class

成员函数文档

QCompleter::QCompleter(QObject *parent = nullptr)

使用给定的parent 构建一个completer对象。

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

根据给定的parent 构建一个补全对象，该对象提供来自指定model 的补全建议。

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

使用给定的parent 创建一个QCompleter对象，该对象将指定的list 用作可能的补全项来源。

[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()中的某个项目（通过点击或按下回车键）时，会发送此信号。会传入该项目的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()中的某个项目时，会发送此信号。此外，如果在调用complete()时将completionMode()设置为QCompleter::InlineCompletion ，也会发送此信号。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()中的某个项目时，会发送此信号。此外，如果在调用complete()时将completionMode()设置为QCompleter::InlineCompletion ，也会发送此信号。会提供该项目的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()的各个层级进行匹配。

当 sourceModel() 为QFileSystemModel 时，splitPath() 的默认实现会根据QDir::separator() 对文件系统路径进行拆分。

当与列表模型一起使用时，将使用返回列表中的第一个项目进行匹配。

另请参阅 pathFromIndex() 和Handling Tree Models 。

QWidget *QCompleter::widget() const

返回该补全对象正在为其提供补全功能的小部件。

另请参阅 setWidget()。