QCompleter 类

成员函数文档

QCompleter::QCompleter(QObject *parent = nullptr)

使用指定的parent构造一个补全过程对象。

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

使用指定的 model 构建一个具有给定 parent 的补全对象。

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

使用指定的 list 作为可能的补全长度的来源，构建一个 QCompleter 对象。

[重写虚函数 noexcept] QCompleter::~QCompleter()

销毁补全对象。

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

当用户通过点击或按回车激活 popup() 中的某个项时，发送此信号。提供了该项的 text。

注意：类中重载了信号 activated。为了使用函数指针语法连接到此信号，Qt 提供了一个方便的辅助函数，如下例所示

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

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

当用户通过点击或按回车激活 popup() 中的某个项时，发送此信号。（点击或按回车）。提供了该项在 completionModel() 中的 index。

注意：类中重载了信号 activated。为了使用函数指针语法连接到此信号，Qt 提供了一个方便的辅助函数，如下例所示

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

[槽函数] 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。

[覆盖虚受保护] bool QCompleter::event(QEvent *ev)

重实现: QObject::event(QEvent *e)。

[覆盖虚受保护] bool QCompleter::eventFilter(QObject *o, QEvent *e)

重实现: QObject::eventFilter(QObject *watched, QEvent *event)。

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

当用户突出显示popup()中的项时，将发送此信号。如果使用设置有completionMode()为QCompleter::InlineCompletion的complete()调用，也会发送此信号。给出项的text。

注意：此类中信号highlighted被重载。如果要使用函数指针语法连接到此信号，Qt提供了方便的辅助函数，如下例所示。

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

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

当用户突出显示popup()中的项时，将发送此信号。如果使用设置有completionMode()为QCompleter::InlineCompletion的complete()调用，也会发送此信号。给出项在completionModel()中的index。

注意：此类中信号highlighted被重载。如果要使用函数指针语法连接到此信号，Qt提供了方便的辅助函数，如下例所示。

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

QAbstractItemModel *QCompleter::model() const

返回提供补全字符串的模型。

另请参阅setModel()和completionModel。

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

返回给定 index 的路径。补全对象使用这个路径从底层模型中获取补全文本。

默认实现返回列表模型的项目的 编辑角色。如果模型是 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。该模型可以是列表模型或树模型。如果已设置了模型并且该模型将 QCompleter 作为其父项，则将其删除。

为了方便，如果 model 是 QFileSystemModel，则 QCompleter 在 Windows 上将 caseSensitivity 切换到 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。当在 QCompleter 上设置 QLineEdit 使用 QLineEdit::setCompleter() 或在 QComboBox 上使用 QComboBox::setCompleter() 时，此函数将自动被调用。当为自定义控件提供补全时，需要显式设置控件。

另请参阅widget()，setModel() 和 setPopup()。

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

将指定的 path 分割成字符串，用于在每个层中与 model 匹配。

splitPath() 的默认实现是在 sourceModel() 是 QFileSystemModel 时，根据 QDir::separator() 分割文件系统路径。

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

另请参阅pathFromIndex() 和 处理树形模型。

QWidget *QCompleter::widget() const

返回补全对象提供补全的控件。

另请参阅setWidget()。