QCompleter that can deal with QFileSystemModel. More...

#include <qfscompleter_p.h>

Inheritance diagram for QFSCompleter:

Collaboration diagram for QFSCompleter:

Public Member Functions
	QFSCompleter (QFileSystemModel model, QObject parent=nullptr)

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

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

Public Member Functions inherited from QCompleter
	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.

virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

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.

void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children.

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::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

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

template<typename T >
T	findChild (const QString &aName=QString(), 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 (const QString &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 >
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`.

Public Attributes
QAbstractProxyModel *	proxyModel

QFileSystemModel *	sourceModel

Additional Inherited Members
Public Types inherited from QCompleter
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 inherited from QCompleter
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 inherited from QCompleter
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.

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 Member Functions inherited from QCompleter
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)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Properties inherited from QCompleter
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

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

QCompleter that can deal with QFileSystemModel.

Definition at line 29 of file qfscompleter_p.h.

Constructor & Destructor Documentation

◆ QFSCompleter()

QFSCompleter::QFSCompleter	(	QFileSystemModel *	model,
		QObject *	parent = `nullptr`
	)

inlineexplicit

Definition at line 31 of file qfscompleter_p.h.

References Qt::CaseInsensitive, and QCompleter::setCaseSensitivity().

Here is the call graph for this function:

Member Function Documentation

◆ pathFromIndex()

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

overridevirtual

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 from QCompleter.

◆ splitPath()

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

overridevirtual

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 from QCompleter.

Member Data Documentation

◆ proxyModel

QAbstractProxyModel* QFSCompleter::proxyModel

Definition at line 41 of file qfscompleter_p.h.

◆ sourceModel

QFileSystemModel* QFSCompleter::sourceModel

Definition at line 42 of file qfscompleter_p.h.

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

qtbase/src/widgets/dialogs/qfscompleter_p.h

Public Member Functions

Public Attributes

Additional Inherited Members