QCompleter Class

成员函数文档

QCompleter::QCompleter(QObject *parent = nullptr)

用给定的parent 构建一个完成器对象。

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 已给出。

注：在该类中，信号activated被重载。要使用函数指针语法连接该信号，Qt 提供了一个方便的辅助工具来获取函数指针，如本例所示：

connect(completer, QOverload<const QModelIndex &>::of(&QCompleter::activated),
    [=](const QModelIndex &index){ /* ... */ });

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

当popup() 中的某个项目被用户激活（通过点击或按回车键）时，就会发送该信号。项目的text 已给出。

注：该类重载了信号activated。要使用函数指针语法连接到此信号，Qt 提供了一个方便的辅助工具来获取函数指针，如本例所示：

connect(completer, QOverload<const QString &>::of(&QCompleter::activated),
    [=](const QString &text){ /* ... */ });

[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 已给出。

注：该类重载了高亮显示信号。要使用函数指针语法连接到该信号，Qt 提供了一个方便的辅助工具来获取函数指针，如本例所示：

connect(completer, QOverload<const QModelIndex &>::of(&QCompleter::highlighted),
    [=](const QModelIndex &index){ /* ... */ });

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

当popup() 中的某个项目被用户高亮显示时，就会发送该信号。如果调用complete() 时将completionMode() 设为QCompleter::InlineCompletion ，也会发送此信号。项目的text 已给出。

注：该类重载了高亮显示信号。要使用函数指针语法连接该信号，Qt 提供了一个方便的辅助工具来获取函数指针，如本例所示：

connect(completer, QOverload<const QString &>::of(&QCompleter::highlighted),
    [=](const QString &text){ /* ... */ });

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 切换为Qt::CaseInsensitive （在 Windows 平台上）和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() 中的每一级。

当源模型（）是QFileSystemModel 时，splitPath() 的默认实现会根据QDir::separator() 分割文件系统路径。

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

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

QWidget *QCompleter::widget() const

返回补全器对象正在为其提供补全的 widget。

另请参见 setWidget()。