Enables filtering of the SelectionTreeModel. More...

#include </home/runner/work/hal/hal/plugins/gui/include/gui/selection_details_widget/tree_navigation/selection_tree_proxy.h>

Inheritance diagram for hal::SelectionTreeProxyModel:

Collaboration diagram for hal::SelectionTreeProxyModel:

Public Member Functions
	SelectionTreeProxyModel (QObject *parent=nullptr)

bool	isGraphicsBusy () const

gui_utility::mSortMechanism	sortMechanism ()

void	setSortMechanism (gui_utility::mSortMechanism sortMechanism)

void	startSearch (QString text, int options) override

Public Member Functions inherited from hal::SearchProxyModel
	SearchProxyModel (QObject *parent=nullptr)

virtual QList< QString >	getColumnNames ()

Public Member Functions inherited from QSortFilterProxyModel
	QSortFilterProxyModel (QObject *parent)

virtual	~QSortFilterProxyModel ()

virtual void	setSourceModel (QAbstractItemModel *sourceModel) override

virtual QModelIndex	mapToSource (const QModelIndex &proxyIndex) const const override

virtual QModelIndex	mapFromSource (const QModelIndex &sourceIndex) const const override

virtual QItemSelection	mapSelectionToSource (const QItemSelection &proxySelection) const const override

virtual QItemSelection	mapSelectionFromSource (const QItemSelection &sourceSelection) const const override

QRegExp	filterRegExp () const const

QRegularExpression	filterRegularExpression () const const

int	filterKeyColumn () const const

void	setFilterKeyColumn (int column)

Qt::CaseSensitivity	filterCaseSensitivity () const const

void	setFilterCaseSensitivity (Qt::CaseSensitivity cs)

Qt::CaseSensitivity	sortCaseSensitivity () const const

void	setSortCaseSensitivity (Qt::CaseSensitivity cs)

bool	isSortLocaleAware () const const

void	setSortLocaleAware (bool on)

int	sortColumn () const const

Qt::SortOrder	sortOrder () const const

bool	dynamicSortFilter () const const

void	setDynamicSortFilter (bool enable)

int	sortRole () const const

void	setSortRole (int role)

int	filterRole () const const

void	setFilterRole (int role)

bool	isRecursiveFilteringEnabled () const const

void	setRecursiveFilteringEnabled (bool recursive)

void	setFilterRegExp (const QString &pattern)

void	setFilterRegExp (const QRegExp &regExp)

void	setFilterRegularExpression (const QString &pattern)

void	setFilterRegularExpression (const QRegularExpression &regularExpression)

void	setFilterWildcard (const QString &pattern)

void	setFilterFixedString (const QString &pattern)

void	clear ()

void	invalidate ()

virtual QModelIndex	index (int row, int column, const QModelIndex &parent) const const override

virtual QModelIndex	parent (const QModelIndex &child) const const override

virtual QModelIndex	sibling (int row, int column, const QModelIndex &idx) const const override

virtual int	rowCount (const QModelIndex &parent) const const override

virtual int	columnCount (const QModelIndex &parent) const const override

virtual bool	hasChildren (const QModelIndex &parent) const const override

virtual QVariant	data (const QModelIndex &index, int role) const const override

virtual bool	setData (const QModelIndex &index, const QVariant &value, int role) override

virtual QVariant	headerData (int section, Qt::Orientation orientation, int role) const const override

virtual bool	setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role) override

virtual QMimeData *	mimeData (const QModelIndexList &indexes) const const override

virtual bool	dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override

virtual bool	insertRows (int row, int count, const QModelIndex &parent) override

virtual bool	insertColumns (int column, int count, const QModelIndex &parent) override

virtual bool	removeRows (int row, int count, const QModelIndex &parent) override

virtual bool	removeColumns (int column, int count, const QModelIndex &parent) override

virtual void	fetchMore (const QModelIndex &parent) override

virtual bool	canFetchMore (const QModelIndex &parent) const const override

virtual Qt::ItemFlags	flags (const QModelIndex &index) const const override

virtual QModelIndex	buddy (const QModelIndex &index) const const override

virtual QModelIndexList	match (const QModelIndex &start, int role, const QVariant &value, int hits, Qt::MatchFlags flags) const const override

virtual QSize	span (const QModelIndex &index) const const override

virtual void	sort (int column, Qt::SortOrder order) override

virtual QStringList	mimeTypes () const const override

virtual Qt::DropActions	supportedDropActions () const const override

void	filterCaseSensitivityChanged (Qt::CaseSensitivity filterCaseSensitivity)

void	sortCaseSensitivityChanged (Qt::CaseSensitivity sortCaseSensitivity)

void	sortLocaleAwareChanged (bool sortLocaleAware)

void	sortRoleChanged (int sortRole)

void	filterRoleChanged (int filterRole)

void	recursiveFilteringEnabledChanged (bool recursiveFilteringEnabled)

Public Member Functions inherited from QAbstractProxyModel
	QAbstractProxyModel (QObject *parent)

virtual	~QAbstractProxyModel ()

QAbstractItemModel *	sourceModel () const const

virtual bool	submit () override

virtual void	revert () override

virtual QMap< int, QVariant >	itemData (const QModelIndex &proxyIndex) const const override

virtual bool	setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles) override

virtual bool	canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const const override

virtual Qt::DropActions	supportedDragActions () const const override

void	sourceModelChanged ()

Public Member Functions inherited from QAbstractItemModel
	QAbstractItemModel (QObject *parent)

virtual	~QAbstractItemModel ()

bool	hasIndex (int row, int column, const QModelIndex &parent) const const

void	setSupportedDragActions (Qt::DropActions actions)

virtual bool	moveRows (const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild)

virtual bool	moveColumns (const QModelIndex &sourceParent, int sourceColumn, int count, const QModelIndex &destinationParent, int destinationChild)

bool	insertRow (int row, const QModelIndex &parent)

bool	insertColumn (int column, const QModelIndex &parent)

bool	removeRow (int row, const QModelIndex &parent)

bool	removeColumn (int column, const QModelIndex &parent)

bool	moveRow (const QModelIndex &sourceParent, int sourceRow, const QModelIndex &destinationParent, int destinationChild)

bool	moveColumn (const QModelIndex &sourceParent, int sourceColumn, const QModelIndex &destinationParent, int destinationChild)

virtual QHash< int, QByteArray >	roleNames () const const

bool	checkIndex (const QModelIndex &index, QAbstractItemModel::CheckIndexOptions options) const const

void	dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QVector< int > &roles)

void	headerDataChanged (Qt::Orientation orientation, int first, int last)

void	layoutChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)

void	layoutAboutToBeChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)

void	rowsAboutToBeInserted (const QModelIndex &parent, int start, int end)

void	rowsInserted (const QModelIndex &parent, int first, int last)

void	rowsAboutToBeRemoved (const QModelIndex &parent, int first, int last)

void	rowsRemoved (const QModelIndex &parent, int first, int last)

void	columnsAboutToBeInserted (const QModelIndex &parent, int first, int last)

void	columnsInserted (const QModelIndex &parent, int first, int last)

void	columnsAboutToBeRemoved (const QModelIndex &parent, int first, int last)

void	columnsRemoved (const QModelIndex &parent, int first, int last)

void	modelAboutToBeReset ()

void	modelReset ()

void	rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)

void	rowsMoved (const QModelIndex &parent, int start, int end, const QModelIndex &destination, int row)

void	columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)

void	columnsMoved (const QModelIndex &parent, int start, int end, const QModelIndex &destination, int column)

Public Member Functions inherited from QObject
virtual const QMetaObject *	metaObject () const const

	QObject (QObject *parent)

virtual	~QObject ()

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

QString	objectName () const const

void	setObjectName (const QString &name)

bool	isWidgetType () const const

bool	isWindowType () const const

bool	signalsBlocked () const const

bool	blockSignals (bool block)

QThread *	thread () const const

void	moveToThread (QThread *targetThread)

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

void	killTimer (int id)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

const QObjectList &	children () const const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

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

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectTree ()

void	dumpObjectInfo ()

void	dumpObjectTree () const const

void	dumpObjectInfo () const const

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

QVariant	property (const char *name) const const

QList< QByteArray >	dynamicPropertyNames () const const

void	destroyed (QObject *obj)

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

bool	inherits (const char *className) const const

void	deleteLater ()

	Q_DISABLE_COPY (Class)

	Q_DISABLE_MOVE (Class)

	Q_DISABLE_COPY_MOVE (Class)

T	qobject_cast (QObject *object)

T	qobject_cast (const QObject *object)

T	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

	Q_CLASSINFO (Name, Value)

	Q_INTERFACES (...)

	Q_PROPERTY (...)

	Q_ENUMS (...)

	Q_FLAGS (...)

	Q_ENUM (...)

	Q_FLAG (...)

	Q_ENUM_NS (...)

	Q_FLAG_NS (...)

	Q_OBJECT Q_OBJECT

	Q_GADGET Q_GADGET

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_SIGNALS Q_SIGNALS

	Q_SIGNAL Q_SIGNAL

	Q_SLOTS Q_SLOTS

	Q_SLOT Q_SLOT

	Q_EMIT Q_EMIT

	Q_INVOKABLE Q_INVOKABLE

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

Protected Member Functions
bool	filterAcceptsRow (int source_row, const QModelIndex &source_parent) const override

bool	lessThan (const QModelIndex &source_left, const QModelIndex &source_right) const override

Protected Member Functions inherited from hal::SearchProxyModel
bool	isMatching (const QString searchString, const QString stringToCheck) const
	Check if a string matches the SearchOptions. More...

bool	checkRow (int sourceRow, const QModelIndex &sourceParent, int startIndex, int endIndex, int offset=0) const
	Should be called inside filterAcceptsRow function and returns `true` if the source_row, source_parent matches given SearchOptions. More...

virtual bool	checkRowRecursion (int sourceRow, const QModelIndex &sourceParent, int startIndex, int endIndex, int offset=0) const

Protected Member Functions inherited from QSortFilterProxyModel
virtual bool	filterAcceptsColumn (int source_column, const QModelIndex &source_parent) const const

void	filterChanged ()

void	invalidateFilter ()

Protected Member Functions inherited from QAbstractProxyModel
void	resetInternalData ()

Protected Member Functions inherited from QAbstractItemModel
void	resetInternalData ()

QModelIndex	createIndex (int row, int column, void *ptr) const const

QModelIndex	createIndex (int row, int column, quintptr id) const const

void	beginInsertRows (const QModelIndex &parent, int first, int last)

void	endInsertRows ()

void	beginRemoveRows (const QModelIndex &parent, int first, int last)

void	endRemoveRows ()

bool	beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)

void	endMoveRows ()

void	beginInsertColumns (const QModelIndex &parent, int first, int last)

void	endInsertColumns ()

void	beginRemoveColumns (const QModelIndex &parent, int first, int last)

void	endRemoveColumns ()

bool	beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)

void	endMoveColumns ()

void	reset ()

void	beginResetModel ()

void	endResetModel ()

void	changePersistentIndex (const QModelIndex &from, const QModelIndex &to)

void	changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)

QModelIndexList	persistentIndexList () const const

void	setRoleNames (const QHash< int, QByteArray > &roleNames)

Protected Member Functions inherited from QObject
QObject *	sender () const const

int	senderSignalIndex () const const

int	receivers (const char *signal) const const

bool	isSignalConnected (const QMetaMethod &signal) const const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

Additional Inherited Members
Public Types inherited from QAbstractItemModel
enum	LayoutChangeHint

enum	CheckIndexOption

Public Slots inherited from hal::SearchProxyModel
Static Public Member Functions inherited from QObject
QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

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

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

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

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

Public Attributes inherited from QAbstractItemModel
typedef	CheckIndexOptions

	NoLayoutChangeHint

	VerticalSortHint

	HorizontalSortHint

	NoOption

	IndexIsValid

	DoNotUseParent

	ParentIsInvalid

Public Attributes inherited from QObject
typedef	QObjectList

Protected Attributes inherited from hal::SearchProxyModel
SearchOptions	mSearchOptions

QString	mSearchString

Properties inherited from QSortFilterProxyModel
	filterRegExp

	filterRegularExpression

	filterKeyColumn

	dynamicSortFilter

	filterCaseSensitivity

	sortCaseSensitivity

	isSortLocaleAware

	sortRole

	filterRole

	recursiveFilteringEnabled

Properties inherited from QAbstractProxyModel
	sourceModel

Properties inherited from QObject
	objectName

Detailed Description

Enables filtering of the SelectionTreeModel.

A proxy model to filter the SelectionTreeModel. This allows to search efficiently through the model and the results can be displayed within the view in a tree-styled fashion.

Definition at line 43 of file selection_tree_proxy.h.

Constructor & Destructor Documentation

◆ SelectionTreeProxyModel()

hal::SelectionTreeProxyModel::SelectionTreeProxyModel ( QObject * parent = nullptr )

The constructor.

Parameters

parent - The model's parent.

Definition at line 8 of file selection_tree_proxy.cpp.

References QRegularExpression::CaseInsensitiveOption, and QRegularExpression::setPatternOptions().

Member Function Documentation

◆ filterAcceptsRow()

bool hal::SelectionTreeProxyModel::filterAcceptsRow	(	int	source_row,
		const QModelIndex &	source_parent
	)		const

overrideprotectedvirtual

Overwritten Qt function that is necessary for the model. For further information pleaser refer to the Qt documentation.

Reimplemented from QSortFilterProxyModel.

Definition at line 14 of file selection_tree_proxy.cpp.

References hal::SearchProxyModel::checkRowRecursion().

◆ isGraphicsBusy()

bool hal::SelectionTreeProxyModel::isGraphicsBusy ( ) const

inline

Calls the suppressedByFilter() function to get all items that should not be displayed in the view because they do not match the filter-string. Then it tells the selection relay to update these items. Checks if the model is still busy with applying the changes (in applyFilterOnGraphics()).

Returns: true if the model is still busy. false otherwise.

Definition at line 67 of file selection_tree_proxy.h.

Referenced by hal::SelectionDetailsWidget::handleSelectionUpdate(), and hal::SelectionTreeView::populate().

◆ lessThan()

bool hal::SelectionTreeProxyModel::lessThan	(	const QModelIndex &	source_left,
		const QModelIndex &	source_right
	)		const

overrideprotectedvirtual

Overwritten Qt function that is necessary for the model. For further information pleaser refer to the Qt documentation.

Reimplemented from QSortFilterProxyModel.

Definition at line 19 of file selection_tree_proxy.cpp.

References Qt::AscendingOrder, Qt::CaseInsensitive, hal::gui_utility::compare(), QModelIndex::data(), QSortFilterProxyModel::sortCaseSensitivity, QSortFilterProxyModel::sortOrder(), QVariant::toBool(), QString::toLower(), QVariant::toString(), and Qt::UserRole.

◆ setSortMechanism()

void hal::SelectionTreeProxyModel::setSortMechanism ( gui_utility::mSortMechanism sortMechanism )

Sets the given sort mechanism.

Parameters

sortMechanism - The new mechanism.

Definition at line 66 of file selection_tree_proxy.cpp.

References QSortFilterProxyModel::invalidate(), and sortMechanism().

◆ sortMechanism()

gui_utility::mSortMechanism hal::SelectionTreeProxyModel::sortMechanism ( )

Get the currently set sort mechanism.

Returns: The sorting mechanism.

Definition at line 61 of file selection_tree_proxy.cpp.

Referenced by setSortMechanism().

◆ startSearch()

void hal::SelectionTreeProxyModel::startSearch	(	QString	text,
		int	options
	)

overridevirtual

Implements hal::SearchProxyModel.

Definition at line 72 of file selection_tree_proxy.cpp.

References QSortFilterProxyModel::invalidateFilter(), hal::SearchProxyModel::mSearchOptions, and hal::SearchProxyModel::mSearchString.

Referenced by hal::SelectionDetailsWidget::SelectionDetailsWidget().

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

plugins/gui/include/gui/selection_details_widget/tree_navigation/selection_tree_proxy.h
plugins/gui/src/selection_details_widget/tree_navigation/selection_tree_proxy.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members