qcompleter.h

Go to the documentation of this file.

// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
// Qt-Security score:significant reason:default
 
#ifndef QCOMPLETER_H
#define QCOMPLETER_H
 
#include <QtWidgets/qtwidgetsglobal.h>
#include <QtCore/qobject.h>
#include <QtCore/qpoint.h>
#include <QtCore/qstring.h>
#include <QtCore/qabstractitemmodel.h>
#include <QtCore/qrect.h>
 
QT_REQUIRE_CONFIG(completer);
 
QT_BEGIN_NAMESPACE
 
class QCompleterPrivate;
class QAbstractItemView;
class QAbstractProxyModel;
class QWidget;
 
class Q_WIDGETS_EXPORT QCompleter : public QObject
{
    Q_OBJECT
    Q_PROPERTY(QString completionPrefix READ completionPrefix WRITE setCompletionPrefix)
    Q_PROPERTY(ModelSorting modelSorting READ modelSorting WRITE setModelSorting)
    Q_PROPERTY(Qt::MatchFlags filterMode READ filterMode WRITE setFilterMode)
    Q_PROPERTY(CompletionMode completionMode READ completionMode WRITE setCompletionMode)
    Q_PROPERTY(int completionColumn READ completionColumn WRITE setCompletionColumn)
    Q_PROPERTY(int completionRole READ completionRole WRITE setCompletionRole)
    Q_PROPERTY(int maxVisibleItems READ maxVisibleItems WRITE setMaxVisibleItems)
    Q_PROPERTY(Qt::CaseSensitivity caseSensitivity READ caseSensitivity WRITE setCaseSensitivity)
    Q_PROPERTY(bool wrapAround READ wrapAround WRITE setWrapAround)
 
public:
    enum CompletionMode {
        PopupCompletion,
        UnfilteredPopupCompletion,
        InlineCompletion
    };
    Q_ENUM(CompletionMode)
 
    enum ModelSorting {
        UnsortedModel = 0,
        CaseSensitivelySortedModel,
        CaseInsensitivelySortedModel
    };
    Q_ENUM(ModelSorting)
 
    QCompleter(QObject *parent = nullptr);
    QCompleter(QAbstractItemModel *model, QObject *parent = nullptr);
#if QT_CONFIG(stringlistmodel)
    QCompleter(const QStringList& completions, QObject *parent = nullptr);
#endif
    ~QCompleter() override;
 
    void setWidget(QWidget *widget);
    QWidget *widget() const;
 
    void setModel(QAbstractItemModel *c);
    QAbstractItemModel *model() const;
 
    void setCompletionMode(CompletionMode mode);
    CompletionMode completionMode() const;
 
    void setFilterMode(Qt::MatchFlags filterMode);
    Qt::MatchFlags filterMode() const;
 
    QAbstractItemView *popup() const;
    void setPopup(QAbstractItemView *popup);
 
    void setCaseSensitivity(Qt::CaseSensitivity caseSensitivity);
    Qt::CaseSensitivity caseSensitivity() const;
 
    void setModelSorting(ModelSorting sorting);
    ModelSorting modelSorting() const;
 
    void setCompletionColumn(int column);
    int  completionColumn() const;
 
    void setCompletionRole(int role);
    int  completionRole() const;
 
    bool wrapAround() const;
 
    int maxVisibleItems() const;
    void setMaxVisibleItems(int maxItems);
 
    int completionCount() const;
    bool setCurrentRow(int row);
    int currentRow() const;
 
    QModelIndex currentIndex() const;
    QString currentCompletion() const;
 
    QAbstractItemModel *completionModel() const;
 
    QString completionPrefix() const;
 
public Q_SLOTS:
    void setCompletionPrefix(const QString &prefix);
    void complete(const QRect& rect = QRect());
    void setWrapAround(bool wrap);
 
public:
    virtual QString pathFromIndex(const QModelIndex &index) const;
    virtual QStringList splitPath(const QString &path) const;
 
protected:
    bool eventFilter(QObject *o, QEvent *e) override;
    bool event(QEvent *) override;
 
Q_SIGNALS:
    void activated(const QString &text);
    void activated(const QModelIndex &index);
    void highlighted(const QString &text);
    void highlighted(const QModelIndex &index);
 
private:
    Q_DISABLE_COPY(QCompleter)
    Q_DECLARE_PRIVATE(QCompleter)
 
    Q_PRIVATE_SLOT(d_func(), void _q_complete(QModelIndex))
    Q_PRIVATE_SLOT(d_func(), void _q_completionSelected(const QItemSelection&))
    Q_PRIVATE_SLOT(d_func(), void _q_autoResizePopup())
    Q_PRIVATE_SLOT(d_func(), void _q_fileSystemModelDirectoryLoaded(const QString&))
};
 
QT_END_NAMESPACE
 
#endif // QCOMPLETER_H