pqProxyWidgetDialog Class Reference

pqProxyWidgetDialog is used to show properties of any proxy in a dialog. More...

#include <pqProxyWidgetDialog.h>

Inherits QDialog.

Public Member Functions
	pqProxyWidgetDialog (vtkSMProxy *proxy, QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags{})
	pqProxyWidgetDialog (vtkSMProxy *proxy, const QStringList &properties, QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags{})
	~pqProxyWidgetDialog () override
bool	hasVisibleWidgets () const
	Returns whether that dialog has any visible widgets. More...
bool	hasAdvancedProperties () const
	Returns true if the proxy has any advanced properties. More...
vtkSMProxy *	proxy () const
	Returns the proxy. More...
void	setEnableSearchBar (bool val)
	Get/set whether the search-bar should be shown on the dialog. More...
bool	enableSearchBar () const
void	setHideAdvancedProperties (bool val)
	By default, the pqProxyWidgetDialog will show advanced properties on the proxy either by default (if EnableSearchBar is false), or based on the ui-element in search bar (if EnableSearchBar is true). More...
bool	hideAdvancedProperties () const
void	setApplyChangesImmediately (bool val)
	When set to true (default is false), pqProxyWidgetDialog will not show the 'Apply' and 'Reset' buttons. More...
bool	applyChangesImmediately () const
QString	setSettingsKey (const QString &key)
	Set the new setting key that will be used to restore/save the advanced button check state. More...

Protected Member Functions
void	showEvent (QShowEvent *event) override
	Overridden to resize widget before showing it the first time. More...
void	hideEvent (QHideEvent *event) override
void	done (int r) override

Friends
class	pqInternals

Detailed Description

pqProxyWidgetDialog is used to show properties of any proxy in a dialog.

It simply wraps the pqProxyWidget for the proxy in a dialog with Apply, Cancel, and Ok buttons. Tool buttons (QPushButtons with only icons) are also provided to save the currently applied settings as default properties as well as to reset the defaults to the application defaults.

Definition at line 19 of file pqProxyWidgetDialog.h.

Constructor & Destructor Documentation

pqProxyWidgetDialog() [1/2]

pqProxyWidgetDialog::pqProxyWidgetDialog	(	vtkSMProxy *	proxy,
		QWidget *	parent = nullptr,
		Qt::WindowFlags	f = Qt::WindowFlags{}
	)

pqProxyWidgetDialog() [2/2]

pqProxyWidgetDialog::pqProxyWidgetDialog	(	vtkSMProxy *	proxy,
		const QStringList &	properties,
		QWidget *	parent = nullptr,
		Qt::WindowFlags	f = Qt::WindowFlags{}
	)

~pqProxyWidgetDialog()

pqProxyWidgetDialog::~pqProxyWidgetDialog ( )

override

Member Function Documentation

hasVisibleWidgets()

bool pqProxyWidgetDialog::hasVisibleWidgets

(

)

const

Returns whether that dialog has any visible widgets.

hasAdvancedProperties()

bool pqProxyWidgetDialog::hasAdvancedProperties

(

)

const

Returns true if the proxy has any advanced properties.

This may be useful to determine if the search bar should be enabled or not.

proxy()

vtkSMProxy* pqProxyWidgetDialog::proxy

(

)

const

Returns the proxy.

setEnableSearchBar()

void pqProxyWidgetDialog::setEnableSearchBar

(

bool

val

)

Get/set whether the search-bar should be shown on the dialog.

Default is false. If search-bar is not enabled, the dialog cannot support default/advanced viewing modes either and hence it will simply show all property widgets.

enableSearchBar()

bool pqProxyWidgetDialog::enableSearchBar

(

)

const

setHideAdvancedProperties()

void pqProxyWidgetDialog::setHideAdvancedProperties

(

bool

val

)

By default, the pqProxyWidgetDialog will show advanced properties on the proxy either by default (if EnableSearchBar is false), or based on the ui-element in search bar (if EnableSearchBar is true).

However, there may be cases when an application doesn't want to show the advanced properties. In that case, you can use this method to hide all advanced properties. If EnableSearchBar is true and HideAdvancedProperties is false, then the gear-icon shown next to search bar to allow user to toggle the advanced properties is not shown.

hideAdvancedProperties()

bool pqProxyWidgetDialog::hideAdvancedProperties

(

)

const

setApplyChangesImmediately()

void pqProxyWidgetDialog::setApplyChangesImmediately

(

bool

val

)

When set to true (default is false), pqProxyWidgetDialog will not show the 'Apply' and 'Reset' buttons.

This has one major implication, however. Whenever the user changes a widget in the UI, the corresponding property on the proxy will immediately be changed. Thus, even if the user hits 'Cancel', the proxy will be left in modified state.

applyChangesImmediately()

bool pqProxyWidgetDialog::applyChangesImmediately

(

)

const

setSettingsKey()

QString pqProxyWidgetDialog::setSettingsKey

(

const QString &

key

)

Set the new setting key that will be used to restore/save the advanced button check state.

If the given key is valid (i.e. not empty), the button state will be restored from the key value. The old key is left unchanged in the setting to whatever its last value was. Although returned, removing (or not) the old key is up to the user.

See also

settingKey property

showEvent()

void pqProxyWidgetDialog::showEvent ( QShowEvent *  event )

overrideprotected

Overridden to resize widget before showing it the first time.

hideEvent()

void pqProxyWidgetDialog::hideEvent ( QHideEvent *  event )

overrideprotected

done()

void pqProxyWidgetDialog::done ( int  r )

overrideprotected

Friends And Related Function Documentation

pqInternals

friend class pqInternals

friend

Definition at line 113 of file pqProxyWidgetDialog.h.

---

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

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