The QCompleter class provides completions based on an item model. More...

#include <qcompleter.h>

Inheritance diagram for QCompleter:

Collaboration diagram for QCompleter:

Public Types
enum	CompletionMode { PopupCompletion , UnfilteredPopupCompletion , InlineCompletion }
	This enum specifies how completions are provided to the user. More...

enum	ModelSorting { UnsortedModel = 0 , CaseSensitivelySortedModel , CaseInsensitivelySortedModel }
	This enum specifies how the items in the model are sorted. More...

Public Slots
void	setCompletionPrefix (const QString &prefix)

void	complete (const QRect &rect=QRect())
	For QCompleter::PopupCompletion and QCompletion::UnfilteredPopupCompletion modes, calling this function displays the popup displaying the current completions.

void	setWrapAround (bool wrap)

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	activated (const QString &text)
	This signal is sent when an item in the popup() is activated by the user (by clicking or pressing return).

void	activated (const QModelIndex &index)
	This signal is sent when an item in the popup() is activated by the user.

void	highlighted (const QString &text)
	This signal is sent when an item in the popup() is highlighted by the user.

void	highlighted (const QModelIndex &index)
	This signal is sent when an item in the popup() is highlighted by the user.

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	QCompleter (QObject *parent=nullptr)
	Constructs a completer object with the given parent.

	QCompleter (QAbstractItemModel model, QObject parent=nullptr)
	Constructs a completer object with the given parent that provides completions from the specified model.

	~QCompleter () override
	Destroys the completer object.

void	setWidget (QWidget *widget)
	Sets the widget for which completion are provided for to widget.

QWidget *	widget () const
	Returns the widget for which the completer object is providing completions.

void	setModel (QAbstractItemModel *c)
	Sets the model which provides completions to model.

QAbstractItemModel *	model () const
	Returns the model that provides completion strings.

void	setCompletionMode (CompletionMode mode)

CompletionMode	completionMode () const

void	setFilterMode (Qt::MatchFlags filterMode)

Qt::MatchFlags	filterMode () const

QAbstractItemView *	popup () const
	Returns the popup used to display completions.

void	setPopup (QAbstractItemView *popup)
	Sets the popup used to display completions to 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
	Returns the number of completions for the current prefix.

bool	setCurrentRow (int row)
	Sets the current row to the row specified.

int	currentRow () const
	Returns the current row.

QModelIndex	currentIndex () const
	Returns the model index of the current completion in the completionModel().

QString	currentCompletion () const
	Returns the current completion string.

QAbstractItemModel *	completionModel () const
	Returns the completion model.

QString	completionPrefix () const

virtual QString	pathFromIndex (const QModelIndex &index) const
	Returns the path for the given index.

virtual QStringList	splitPath (const QString &path) const
	Splits the given path into strings that are used to match at each level in the model().

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

void	killTimer (Qt::TimerId id)

template<typename T >
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Protected Member Functions
bool	eventFilter (QObject o, QEvent e) override
	\reimp

bool	event (QEvent *) override
	\reimp

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Properties
QString	completionPrefix
	the completion prefix used to provide completions.

ModelSorting	modelSorting
	the way the model is sorted

Qt::MatchFlags	filterMode
	This property controls how filtering is performed.

CompletionMode	completionMode
	how the completions are provided to the user

int	completionColumn
	the column in the model in which completions are searched for.

int	completionRole
	the item role to be used to query the contents of items for matching.

int	maxVisibleItems
	the maximum allowed size on screen of the completer, measured in items

Qt::CaseSensitivity	caseSensitivity
	the case sensitivity of the matching

bool	wrapAround
	the completions wrap around when navigating through items

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

The QCompleter class provides completions based on an item model.

Since: 4.2

\inmodule QtWidgets

You can use QCompleter to provide auto completions in any Qt widget, such as QLineEdit and QComboBox. When the user starts typing a word, QCompleter suggests possible ways of completing the word, based on a word list. The word list is provided as a QAbstractItemModel. (For simple applications, where the word list is static, you can pass a QStringList to QCompleter's constructor.)

Definition at line 23 of file qcompleter.h.

Member Enumeration Documentation

◆ CompletionMode

enum QCompleter::CompletionMode

This enum specifies how completions are provided to the user.

\value PopupCompletion Current completions are displayed in a popup window. \value InlineCompletion Completions appear inline (as selected text). \value UnfilteredPopupCompletion All possible completions are displayed in a popup window with the most likely suggestion indicated as current.

See also: setCompletionMode()

Enumerator
PopupCompletion
UnfilteredPopupCompletion
InlineCompletion

Definition at line 37 of file qcompleter.h.

◆ ModelSorting

enum QCompleter::ModelSorting

This enum specifies how the items in the model are sorted.

\value UnsortedModel The model is unsorted. \value CaseSensitivelySortedModel The model is sorted case sensitively. \value CaseInsensitivelySortedModel The model is sorted case insensitively.

See also: setModelSorting()

Enumerator
UnsortedModel
CaseSensitivelySortedModel
CaseInsensitivelySortedModel

Definition at line 44 of file qcompleter.h.

Constructor & Destructor Documentation

◆ QCompleter() [1/2]

QCompleter::QCompleter ( QObject * parent = nullptr )

Constructs a completer object with the given parent.

Definition at line 978 of file qcompleter.cpp.

References d.

◆ QCompleter() [2/2]

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

Constructs a completer object with the given parent that provides completions from the specified model.

Definition at line 989 of file qcompleter.cpp.

References d, and model.

◆ ~QCompleter()

QCompleter::~QCompleter ( )

override

Destroys the completer object.

Definition at line 1012 of file qcompleter.cpp.

Member Function Documentation

◆ activated [1/2]

void QCompleter::activated ( const QModelIndex & index )

signal

This signal is sent when an item in the popup() is activated by the user.

(by clicking or pressing return). The item's index in the completionModel() is given.

◆ activated [2/2]

void QCompleter::activated ( const QString & text )

signal

This signal is sent when an item in the popup() is activated by the user (by clicking or pressing return).

The item's text is given.

Referenced by setPopup().

Here is the caller graph for this function:

◆ caseSensitivity()

Qt::CaseSensitivity QCompleter::caseSensitivity ( ) const

Definition at line 1723 of file qcompleter.cpp.

References d.

◆ complete

void QCompleter::complete ( const QRect & rect = QRect() )

slot

For QCompleter::PopupCompletion and QCompletion::UnfilteredPopupCompletion modes, calling this function displays the popup displaying the current completions.

By default, if rect is not specified, the popup is displayed on the bottom of the widget(). If rect is specified the popup is displayed on the left edge of the rectangle.

For QCompleter::InlineCompletion mode, the highlighted() signal is fired with the current completion.

Definition at line 1492 of file qcompleter.cpp.

References d, InlineCompletion, QModelIndex::isValid(), popup(), PopupCompletion, Q_ASSERT, rect, and UnfilteredPopupCompletion.

Here is the call graph for this function:

◆ completionColumn()

int QCompleter::completionColumn ( ) const

Definition at line 1631 of file qcompleter.cpp.

References d.

◆ completionCount()

int QCompleter::completionCount ( ) const

Returns the number of completions for the current prefix.

For an unsorted model with a large number of items this can be expensive. Use setCurrentRow() and currentCompletion() to iterate through all the completions.

Definition at line 1551 of file qcompleter.cpp.

References d.

◆ completionMode()

QCompleter::CompletionMode QCompleter::completionMode ( ) const

Definition at line 1142 of file qcompleter.cpp.

References d.

◆ completionModel()

QAbstractItemModel * QCompleter::completionModel ( ) const

Returns the completion model.

The completion model is a read-only list model that contains all the possible matches for the current completion prefix. The completion model is auto-updated to reflect the current completions.

Note: The return value of this function is defined to be an QAbstractItemModel purely for generality. This actual kind of model returned is an instance of an QAbstractProxyModel subclass.

See also: completionPrefix, model()

Definition at line 1784 of file qcompleter.cpp.

References d.

◆ completionPrefix()

QString QCompleter::completionPrefix ( ) const

Definition at line 1743 of file qcompleter.cpp.

References d.

◆ completionRole()

int QCompleter::completionRole ( ) const

Definition at line 1654 of file qcompleter.cpp.

References d.

◆ currentCompletion()

QString QCompleter::currentCompletion ( ) const

Returns the current completion string.

This includes the \l completionPrefix. When used alongside setCurrentRow(), it can be used to iterate through all the matches.

See also: setCurrentRow(), currentIndex()

Definition at line 1767 of file qcompleter.cpp.

References d, and pathFromIndex().

Referenced by QWidgetLineControl::processKeyEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ currentIndex()

QModelIndex QCompleter::currentIndex ( ) const

Returns the model index of the current completion in the completionModel().

See also: setCurrentRow(), currentCompletion(), model()

Definition at line 1754 of file qcompleter.cpp.

References d.

◆ currentRow()

int QCompleter::currentRow ( ) const

Returns the current row.

See also: setCurrentRow()

Definition at line 1540 of file qcompleter.cpp.

References d.

◆ event()

bool QCompleter::event ( QEvent * ev )

overrideprotectedvirtual

\reimp

Reimplemented from QObject.

Definition at line 1287 of file qcompleter.cpp.

References QObject::event().

Here is the call graph for this function:

◆ eventFilter()

bool QCompleter::eventFilter	(	QObject *	o,
		QEvent *	e )

overrideprotectedvirtual

\reimp

Reimplemented from QObject.

Definition at line 1295 of file qcompleter.cpp.

References Qt::AltModifier, QKeySequence::Cancel, Qt::ControlModifier, d, QObject::eventFilter(), QEvent::FocusOut, QEvent::Hide, QEvent::InputMethod, QEvent::isAccepted(), Qt::Key_Back, Qt::Key_Backtab, Qt::Key_Down, Qt::Key_End, Qt::Key_Enter, Qt::Key_F4, Qt::Key_Home, Qt::Key_PageDown, Qt::Key_PageUp, Qt::Key_Return, Qt::Key_Select, Qt::Key_Tab, Qt::Key_Up, QEvent::KeyPress, QEvent::KeyRelease, QEvent::MouseButtonPress, o, pos, Q_ASSERT, qobject_cast< QWidget * >(), QCoreApplication::sendEvent(), QEvent::ShortcutOverride, QEvent::type(), UnfilteredPopupCompletion, and QApplication::widgetAt().

Here is the call graph for this function:

◆ filterMode()

Qt::MatchFlags QCompleter::filterMode ( ) const

Definition at line 1187 of file qcompleter.cpp.

References d.

◆ highlighted [1/2]

void QCompleter::highlighted ( const QModelIndex & index )

signal

This signal is sent when an item in the popup() is highlighted by the user.

It is also sent if complete() is called with the completionMode() set to QCompleter::InlineCompletion. The item's index in the completionModel() is given.

◆ highlighted [2/2]

void QCompleter::highlighted ( const QString & text )

signal

This signal is sent when an item in the popup() is highlighted by the user.

It is also sent if complete() is called with the completionMode() set to QCompleter::InlineCompletion. The item's text is given.

◆ maxVisibleItems()

int QCompleter::maxVisibleItems ( ) const

Definition at line 1688 of file qcompleter.cpp.

References d.

◆ model()

QAbstractItemModel * QCompleter::model ( ) const

Returns the model that provides completion strings.

See also: completionModel()

Definition at line 1099 of file qcompleter.cpp.

References d.

◆ modelSorting()

QCompleter::ModelSorting QCompleter::modelSorting ( ) const

Definition at line 1601 of file qcompleter.cpp.

References d.

◆ pathFromIndex()

QString QCompleter::pathFromIndex ( const QModelIndex & index ) const

virtual

Returns the path for the given index.

The completer object uses this to obtain the completion text from the underlying model.

The default implementation returns the \l{Qt::EditRole}{edit role} of the item for list models. It returns the absolute file path if the model is a QFileSystemModel.

See also: splitPath()

Reimplemented in QFSCompleter.

Definition at line 1801 of file qcompleter.cpp.

References QList< T >::clear(), d, QAbstractItemModel::data(), QFileSystemModel::FileNameRole, QModelIndex::isValid(), list, QModelIndex::parent(), QObject::parent(), QList< T >::prepend(), QDir::separator(), and QList< T >::size().

Referenced by currentCompletion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ popup()

QAbstractItemView * QCompleter::popup ( ) const

Returns the popup used to display completions.

See also: setPopup()

Definition at line 1266 of file qcompleter.cpp.

References completionMode, d, InlineCompletion, listView, QAbstractItemView::NoEditTriggers, Qt::ScrollBarAlwaysOff, QAbstractItemView::SelectRows, QAbstractItemView::setEditTriggers(), QListView::setModelColumn(), setPopup(), QAbstractItemView::setSelectionBehavior(), QAbstractItemView::setSelectionMode(), and QAbstractItemView::SingleSelection.

Referenced by complete(), and setPopup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCaseSensitivity()

void QCompleter::setCaseSensitivity ( Qt::CaseSensitivity caseSensitivity )

Definition at line 1713 of file qcompleter.cpp.

References d.

Referenced by QComboBox::setLineEdit(), and setModel().

Here is the caller graph for this function:

◆ setCompletionColumn()

void QCompleter::setCompletionColumn ( int column )

Definition at line 1618 of file qcompleter.cpp.

References d, listView, and QListView::setModelColumn().

Referenced by QComboBox::setLineEdit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCompletionMode()

void QCompleter::setCompletionMode ( QCompleter::CompletionMode mode )

Definition at line 1123 of file qcompleter.cpp.

References d, InlineCompletion, and UnfilteredPopupCompletion.

Referenced by QComboBox::setLineEdit().

Here is the caller graph for this function:

◆ setCompletionPrefix

void QCompleter::setCompletionPrefix ( const QString & prefix )

slot

Definition at line 1736 of file qcompleter.cpp.

References d, and splitPath().

Here is the call graph for this function:

◆ setCompletionRole()

void QCompleter::setCompletionRole ( int role )

Definition at line 1645 of file qcompleter.cpp.

References d.

Referenced by setModel().

Here is the caller graph for this function:

◆ setCurrentRow()

bool QCompleter::setCurrentRow ( int row )

Sets the current row to the row specified.

Returns true if successful; otherwise returns false.

This function may be used along with currentCompletion() to iterate through all the possible completions.

See also: currentCompletion(), completionCount()

Definition at line 1529 of file qcompleter.cpp.

References d.

◆ setFilterMode()

void QCompleter::setFilterMode ( Qt::MatchFlags filterMode )

Definition at line 1168 of file qcompleter.cpp.

References d, filterMode, Qt::MatchContains, Qt::MatchEndsWith, Qt::MatchStartsWith, Q_UNLIKELY, and qWarning.

◆ setMaxVisibleItems()

void QCompleter::setMaxVisibleItems ( int maxItems )

Definition at line 1694 of file qcompleter.cpp.

References d, Q_UNLIKELY, and qWarning.

◆ setModel()

void QCompleter::setModel ( QAbstractItemModel * model )

Sets the model which provides completions to model.

The model can be list model or a tree model. If a model has been already previously set and it has the QCompleter as its parent, it is deleted.

For convenience, if model is a QFileSystemModel, QCompleter switches its caseSensitivity to Qt::CaseInsensitive on Windows and Qt::CaseSensitive on other platforms.

See also: completionModel(), modelSorting, {Handling Tree Models}

Definition at line 1065 of file qcompleter.cpp.

References Qt::CaseInsensitive, Qt::CaseSensitive, QObject::connect(), d, Qt::EditRole, QFileSystemModel::FileNameRole, model, setCaseSensitivity(), setCompletionRole(), setPopup(), SIGNAL, and SLOT.

Referenced by QFileDialogPrivate::setVisible().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setModelSorting()

void QCompleter::setModelSorting ( QCompleter::ModelSorting sorting )

Definition at line 1591 of file qcompleter.cpp.

References d.

◆ setPopup()

void QCompleter::setPopup ( QAbstractItemView * popup )

Sets the popup used to display completions to popup.

QCompleter takes ownership of the view.

A QListView is automatically created when the completionMode() is set to QCompleter::PopupCompletion or QCompleter::UnfilteredPopupCompletion. The default popup displays the completionColumn().

Ensure that this function is called before the view settings are modified. This is required since view's properties may require that a model has been set on the view (for example, hiding columns in the view requires a model to be set on the view).

See also: popup()

Definition at line 1208 of file qcompleter.cpp.

References activated(), QObject::connect(), d, QObject::disconnect(), hide(), listView, Qt::NoFocus, Qt::Popup, popup(), Q_ASSERT, QAbstractItemView::setModel(), QListView::setModelColumn(), SIGNAL, and SLOT.

Referenced by popup(), and setModel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setWidget()

void QCompleter::setWidget ( QWidget * widget )

Sets the widget for which completion are provided for to widget.

This function is automatically called when a QCompleter is set on a QLineEdit using QLineEdit::setCompleter() or on a QComboBox using QComboBox::setCompleter(). The widget needs to be set explicitly when providing completions for custom widgets.

See also: widget(), setModel(), setPopup()

Definition at line 1025 of file qcompleter.cpp.

References d, QObject::installEventFilter(), and widget().

Here is the call graph for this function:

◆ setWrapAround

void QCompleter::setWrapAround ( bool wrap )

slot

Definition at line 1667 of file qcompleter.cpp.

References d, and wrap().

Here is the call graph for this function:

◆ splitPath()

QStringList QCompleter::splitPath ( const QString & path ) const

virtual

Splits the given path into strings that are used to match at each level in the model().

The default implementation of splitPath() splits a file system path based on QDir::separator() when the sourceModel() is a QFileSystemModel.

When used with list models, the first item in the returned list is used for matching.

See also: pathFromIndex(), {Handling Tree Models}

Reimplemented in QFSCompleter.

Definition at line 1850 of file qcompleter.cpp.

References completionPrefix, d, sep, QDir::separator(), and QDir::toNativeSeparators().

Referenced by setCompletionPrefix().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ widget()

QWidget * QCompleter::widget ( ) const

Returns the widget for which the completer object is providing completions.

See also: setWidget()

Definition at line 1048 of file qcompleter.cpp.

References d.

Referenced by setWidget().

Here is the caller graph for this function:

◆ wrapAround()

bool QCompleter::wrapAround ( ) const

Definition at line 1675 of file qcompleter.cpp.

References d.

Property Documentation

◆ caseSensitivity

QCompleter::caseSensitivity

readwrite

the case sensitivity of the matching

The default value is Qt::CaseSensitive.

See also: completionColumn, completionRole, modelSorting, filterMode

Definition at line 33 of file qcompleter.h.

◆ completionColumn

QCompleter::completionColumn

readwrite

the column in the model in which completions are searched for.

If the popup() is a QListView, it is automatically setup to display this column.

By default, the match column is 0.

See also: completionRole, caseSensitivity

Definition at line 30 of file qcompleter.h.

◆ completionMode

QCompleter::completionMode

readwrite

how the completions are provided to the user

The default value is QCompleter::PopupCompletion.

Definition at line 29 of file qcompleter.h.

Referenced by popup(), and QWidgetLineControl::processKeyEvent().

◆ completionPrefix

QCompleter::completionPrefix

readwrite

the completion prefix used to provide completions.

The completionModel() is updated to reflect the list of possible matches for prefix.

Definition at line 26 of file qcompleter.h.

Referenced by QWidgetLineControl::processKeyEvent(), and splitPath().

◆ completionRole

QCompleter::completionRole

readwrite

the item role to be used to query the contents of items for matching.

The default role is Qt::EditRole.

See also: completionColumn, caseSensitivity

Definition at line 31 of file qcompleter.h.

◆ filterMode

QCompleter::filterMode

readwrite

This property controls how filtering is performed.

Since: 5.2

If filterMode is set to Qt::MatchStartsWith, only those entries that start with the typed characters will be displayed. Qt::MatchContains will display the entries that contain the typed characters, and Qt::MatchEndsWith the ones that end with the typed characters.

Setting filterMode to any other Qt::MatchFlag will issue a warning, and no action will be performed. Because of this, the Qt::MatchCaseSensitive flag has no effect. Use the \l caseSensitivity property to control case sensitivity.

The default mode is Qt::MatchStartsWith.

See also: caseSensitivity

Definition at line 28 of file qcompleter.h.

Referenced by setFilterMode().

◆ maxVisibleItems

QCompleter::maxVisibleItems

readwrite

the maximum allowed size on screen of the completer, measured in items

Since: 4.6

By default, this property has a value of 7.

Definition at line 32 of file qcompleter.h.

◆ modelSorting

QCompleter::modelSorting

readwrite

the way the model is sorted

By default, no assumptions are made about the order of the items in the model that provides the completions.

If the model's data for the completionColumn() and completionRole() is sorted in ascending order, you can set this property to \l CaseSensitivelySortedModel or \l CaseInsensitivelySortedModel. On large models, this can lead to significant performance improvements because the completer object can then use a binary search algorithm instead of linear search algorithm.

The sort order (i.e ascending or descending order) of the model is determined dynamically by inspecting the contents of the model.

{Note:} The performance improvements described above cannot take place when the completer's \l caseSensitivity is different to the case sensitivity used by the model's when sorting.

See also: setCaseSensitivity(), QCompleter::ModelSorting

Definition at line 27 of file qcompleter.h.

◆ wrapAround

QCompleter::wrapAround

readwrite

the completions wrap around when navigating through items

Since: 4.3

The default is true.

Definition at line 34 of file qcompleter.h.

The documentation for this class was generated from the following files:

qtbase/src/widgets/util/qcompleter.h (05fc3aef53348fb58be6308076e000825b704e58)
qtbase/src/widgets/util/qcompleter.cpp (24859d7deaf995e992f0d9439a1c476126d5f654)

Public Types

Public Slots

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ CompletionMode

◆ ModelSorting

Constructor & Destructor Documentation

◆ QCompleter() [1/2]

◆ QCompleter() [2/2]

◆ ~QCompleter()

Member Function Documentation

◆ activated [1/2]

◆ activated [2/2]

◆ caseSensitivity()

◆ complete

◆ completionColumn()

◆ completionCount()

◆ completionMode()

◆ completionModel()

◆ completionPrefix()

◆ completionRole()

◆ currentCompletion()

◆ currentIndex()

◆ currentRow()

◆ event()

◆ eventFilter()

◆ filterMode()

◆ highlighted [1/2]

◆ highlighted [2/2]

◆ maxVisibleItems()

◆ model()

◆ modelSorting()

◆ pathFromIndex()

◆ popup()

◆ setCaseSensitivity()

◆ setCompletionColumn()

◆ setCompletionMode()

◆ setCompletionPrefix

◆ setCompletionRole()

◆ setCurrentRow()

◆ setFilterMode()

◆ setMaxVisibleItems()

◆ setModel()

◆ setModelSorting()

◆ setPopup()

◆ setWidget()

◆ setWrapAround

◆ splitPath()

◆ widget()

◆ wrapAround()

Property Documentation

◆ caseSensitivity

◆ completionColumn

◆ completionMode

◆ completionPrefix

◆ completionRole

◆ filterMode

◆ maxVisibleItems

◆ modelSorting

◆ wrapAround