include/QtWidgets/qcompleter.h

0001 // Copyright (C) 2016 The Qt Company Ltd.
0002 // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
0003 // Qt-Security score:significant reason:default
0004
0005 #ifndef QCOMPLETER_H
0006 #define QCOMPLETER_H
0007
0008 #include <QtWidgets/qtwidgetsglobal.h>
0009 #include <QtCore/qobject.h>
0010 #include <QtCore/qpoint.h>
0011 #include <QtCore/qstring.h>
0012 #include <QtCore/qabstractitemmodel.h>
0013 #include <QtCore/qrect.h>
0014
0015 QT_REQUIRE_CONFIG(completer);
0016
0017 QT_BEGIN_NAMESPACE
0018
0019 class QCompleterPrivate;
0020 class QAbstractItemView;
0021 class QAbstractProxyModel;
0022 class QWidget;
0023
0024 class Q_WIDGETS_EXPORT QCompleter : public QObject
0025 {
0026     Q_OBJECT
0027     Q_PROPERTY(QString completionPrefix READ completionPrefix WRITE setCompletionPrefix)
0028     Q_PROPERTY(ModelSorting modelSorting READ modelSorting WRITE setModelSorting)
0029     Q_PROPERTY(Qt::MatchFlags filterMode READ filterMode WRITE setFilterMode)
0030     Q_PROPERTY(CompletionMode completionMode READ completionMode WRITE setCompletionMode)
0031     Q_PROPERTY(int completionColumn READ completionColumn WRITE setCompletionColumn)
0032     Q_PROPERTY(int completionRole READ completionRole WRITE setCompletionRole)
0033     Q_PROPERTY(int maxVisibleItems READ maxVisibleItems WRITE setMaxVisibleItems)
0034     Q_PROPERTY(Qt::CaseSensitivity caseSensitivity READ caseSensitivity WRITE setCaseSensitivity)
0035     Q_PROPERTY(bool wrapAround READ wrapAround WRITE setWrapAround)
0036
0037 public:
0038     enum CompletionMode {
0039         PopupCompletion,
0040         UnfilteredPopupCompletion,
0041         InlineCompletion
0042     };
0043     Q_ENUM(CompletionMode)
0044
0045     enum ModelSorting {
0046         UnsortedModel = 0,
0047         CaseSensitivelySortedModel,
0048         CaseInsensitivelySortedModel
0049     };
0050     Q_ENUM(ModelSorting)
0051
0052     QCompleter(QObject *parent = nullptr);
0053     QCompleter(QAbstractItemModel *model, QObject *parent = nullptr);
0054 #if QT_CONFIG(stringlistmodel)
0055     QCompleter(const QStringList& completions, QObject *parent = nullptr);
0056 #endif
0057     ~QCompleter() override;
0058
0059     void setWidget(QWidget *widget);
0060     QWidget *widget() const;
0061
0062     void setModel(QAbstractItemModel *c);
0063     QAbstractItemModel *model() const;
0064
0065     void setCompletionMode(CompletionMode mode);
0066     CompletionMode completionMode() const;
0067
0068     void setFilterMode(Qt::MatchFlags filterMode);
0069     Qt::MatchFlags filterMode() const;
0070
0071     QAbstractItemView *popup() const;
0072     void setPopup(QAbstractItemView *popup);
0073
0074     void setCaseSensitivity(Qt::CaseSensitivity caseSensitivity);
0075     Qt::CaseSensitivity caseSensitivity() const;
0076
0077     void setModelSorting(ModelSorting sorting);
0078     ModelSorting modelSorting() const;
0079
0080     void setCompletionColumn(int column);
0081     int  completionColumn() const;
0082
0083     void setCompletionRole(int role);
0084     int  completionRole() const;
0085
0086     bool wrapAround() const;
0087
0088     int maxVisibleItems() const;
0089     void setMaxVisibleItems(int maxItems);
0090
0091     int completionCount() const;
0092     bool setCurrentRow(int row);
0093     int currentRow() const;
0094
0095     QModelIndex currentIndex() const;
0096     QString currentCompletion() const;
0097
0098     QAbstractItemModel *completionModel() const;
0099
0100     QString completionPrefix() const;
0101
0102 public Q_SLOTS:
0103     void setCompletionPrefix(const QString &prefix);
0104     void complete(const QRect& rect = QRect());
0105     void setWrapAround(bool wrap);
0106
0107 public:
0108     virtual QString pathFromIndex(const QModelIndex &index) const;
0109     virtual QStringList splitPath(const QString &path) const;
0110
0111 protected:
0112     bool eventFilter(QObject *o, QEvent *e) override;
0113     bool event(QEvent *) override;
0114
0115 Q_SIGNALS:
0116     void activated(const QString &text);
0117     void activated(const QModelIndex &index);
0118     void highlighted(const QString &text);
0119     void highlighted(const QModelIndex &index);
0120
0121 private:
0122     Q_DISABLE_COPY(QCompleter)
0123     Q_DECLARE_PRIVATE(QCompleter)
0124
0125     Q_PRIVATE_SLOT(d_func(), void _q_complete(QModelIndex))
0126     Q_PRIVATE_SLOT(d_func(), void _q_completionSelected(const QItemSelection&))
0127     Q_PRIVATE_SLOT(d_func(), void _q_autoResizePopup())
0128     Q_PRIVATE_SLOT(d_func(), void _q_fileSystemModelDirectoryLoaded(const QString&))
0129 };
0130
0131 QT_END_NAMESPACE
0132
0133 #endif // QCOMPLETER_H