pqFavoritesDialog Class Reference

pqFavoritesDialog is the Manage Favorites dialog used by ParaView. More...

#include <pqFavoritesDialog.h>

Inherits QDialog.

Public Member Functions
	pqFavoritesDialog (const QVariant &filtersList, QWidget *p=nullptr)
	~pqFavoritesDialog () override

Protected Slots
void	createCategory ()
	Create a category at the top level of the favorites tree. More...
void	onAddFavoritePressed ()
	Add selected filters from the available filters tree to the top level of favorites tree. More...
void	onRemoveFavoritePressed ()
	Remove selected item (filters/categories) from favorites tree. More...
void	onAccepted ()
	Save current favorites tree and exit. More...
void	onItemChanged (QTreeWidgetItem *, int)
	Ensure category name is unique when item text is changed. More...
void	onSearchTextChanged (QString pattern)
	Update filters visibility according the search pattern. More...

Protected Member Functions
void	populateFavoritesTree ()
	Populate the favorites tree from the favorites settings. More...
void	populateFiltersTree (const QVariant &filtersList)
	Populate the filters tree from the favorites settings. More...
QString	populateSettingsValue (const QString &value, QTreeWidgetItem *item)
	Recursively explore favorites. More...
QTreeWidgetItem *	getSelectedCategory ()
bool	eventFilter (QObject *object, QEvent *event) override

Detailed Description

pqFavoritesDialog is the Manage Favorites dialog used by ParaView.

It allows to create Favorites and organize them under custom categories.

Definition at line 27 of file pqFavoritesDialog.h.

Constructor & Destructor Documentation

pqFavoritesDialog()

pqFavoritesDialog::pqFavoritesDialog	(	const QVariant &	filtersList,
		QWidget *	p = nullptr
	)

~pqFavoritesDialog()

pqFavoritesDialog::~pqFavoritesDialog ( )

override

Member Function Documentation

createCategory

void pqFavoritesDialog::createCategory ( )

protectedslot

Create a category at the top level of the favorites tree.

onAddFavoritePressed

void pqFavoritesDialog::onAddFavoritePressed ( )

protectedslot

Add selected filters from the available filters tree to the top level of favorites tree.

onRemoveFavoritePressed

void pqFavoritesDialog::onRemoveFavoritePressed ( )

protectedslot

Remove selected item (filters/categories) from favorites tree.

When removing a category, its children are removed too.

onAccepted

void pqFavoritesDialog::onAccepted ( )

protectedslot

Save current favorites tree and exit.

onItemChanged

void pqFavoritesDialog::onItemChanged ( QTreeWidgetItem *  , int    )

protectedslot

Ensure category name is unique when item text is changed.

onSearchTextChanged

void pqFavoritesDialog::onSearchTextChanged ( QString  pattern )

protectedslot

Update filters visibility according the search pattern.

populateFavoritesTree()

void pqFavoritesDialog::populateFavoritesTree ( )

protected

Populate the favorites tree from the favorites settings.

populateFiltersTree()

void pqFavoritesDialog::populateFiltersTree ( const QVariant &  filtersList )

protected

Populate the filters tree from the favorites settings.

populateSettingsValue()

QString pqFavoritesDialog::populateSettingsValue ( const QString &  value, QTreeWidgetItem *  item  )

protected

Recursively explore favorites.

Returned value is of the form "proxyGroup;[parentCategories;...];displayName;[proxyName]| ..." where :

• proxyGroup is 'filters' or 'categories'
• parentCategories is the path of current item
• proxyName is the filter proxyname (empty if the current item is a category)
• displayName

getSelectedCategory()

QTreeWidgetItem* pqFavoritesDialog::getSelectedCategory ( )

protected

eventFilter()

bool pqFavoritesDialog::eventFilter ( QObject *  object, QEvent *  event  )

overrideprotected

---

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

• /builds/gitlab-kitware-sciviz-ci/Qt/Components/pqFavoritesDialog.h