pqPropertiesPanel is the default panel used by paraview to edit source properties and display properties for pipeline objects. More...

#include <pqPropertiesPanel.h>

Inherits QWidget.

Public Types
enum	{ SOURCE_PROPERTIES = 0x01, DISPLAY_PROPERTIES = 0x02, VIEW_PROPERTIES = 0x04, ALL_PROPERTIES = SOURCE_PROPERTIES \| DISPLAY_PROPERTIES \| VIEW_PROPERTIES }

Public Slots
void	apply ()
	Apply the changes properties to the proxies. More...

void	reset ()
	Reset the changes made. More...

void	showHelp ()
	Shows the help dialog. More...

void	propertiesRestoreDefaults ()
	Restores the application defaults for the source properties. More...

void	propertiesSaveAsDefaults ()
	Saves the current property settings as default. More...

void	displayRestoreDefaults ()
	Restores the application defaults for the display properties. More...

void	displaySaveAsDefaults ()
	Saves the current display settings as default. More...

void	viewRestoreDefaults ()
	Restores the application defaults for the view properties. More...

void	viewSaveAsDefaults ()
	Saves the current view settings as default. More...

void	setView (pqView *)
	Set the view currently managed by the panel, should be called automatically when the active view changes. More...

void	setPipelineProxy (pqProxy *)
	Set the `pqProxy` to show properties for under the "Properties" section. More...

void	setRepresentation (pqDataRepresentation *)
	Set the representation currently managed by the panel, should be called automatically when the active representation changes. More...

Signals
void	applied ()
	This signal is emitted after the user clicks the apply button. More...

void	applied (pqProxy *)
	This signal is emitted after a panel for a proxy is applied. More...

void	viewChanged (pqView *)
	This signal is emitted when the current view changes. More...

void	modified ()

void	resetDone ()

void	helpRequested (const QString &groupname, const QString &proxyType)
	This signal is emitted when the user clicks the help button. More...

void	deleteRequested (pqProxy *source)
	This signal is emitted when the user clicks the delete button. More...

void	applyEnableStateChanged ()
	This signal is emitted when the apply button's enable state changes. More...

Public Member Functions
	pqPropertiesPanel (QWidget *parent=nullptr)

	~pqPropertiesPanel () override

pqView *	view () const
	Returns the current view, if any. More...

void	setPanelMode (int val)
	Get/Set the panel mode. More...

int	panelMode () const

bool	canApply ()
	Returns true if there are changes to be applied. More...

bool	canReset ()
	Returns true if there are changes to be reset. More...

Static Public Member Functions
static int	suggestedMargin ()
	methods used to obtain the recommended spacing and margins to be used for widgets. More...

static QMargins	suggestedMargins ()

static int	suggestedHorizontalSpacing ()

static int	suggestedVerticalSpacing ()

Protected Member Functions
void	updatePropertiesPanel (pqProxy *source)

void	updateDisplayPanel (pqDataRepresentation *repr)

void	updateViewPanel (pqView *view)

Properties
int	panelMode

Friends
class	pqInternals

Detailed Description

pqPropertiesPanel is the default panel used by paraview to edit source properties and display properties for pipeline objects.

pqPropertiesPanel supports auto-generating widgets for properties of the proxy as well as a mechanism to provide custom widgets/panels for the proxy or its representations. pqPropertiesPanel uses pqProxyWidget to create and manage the widgets for the source and representation proxies.

pqPropertiesPanel comprises of 3 separate parts for showing the source properties, display properties and view properties. One can control which parts are shown by setting the panelMode property.

Definition at line 32 of file pqPropertiesPanel.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
SOURCE_PROPERTIES
DISPLAY_PROPERTIES
VIEW_PROPERTIES
ALL_PROPERTIES

Definition at line 56 of file pqPropertiesPanel.h.

Constructor & Destructor Documentation

◆ pqPropertiesPanel()

pqPropertiesPanel::pqPropertiesPanel ( QWidget * parent = nullptr )

◆ ~pqPropertiesPanel()

pqPropertiesPanel::~pqPropertiesPanel ( )

override

Member Function Documentation

◆ view()

pqView* pqPropertiesPanel::view ( ) const

Returns the current view, if any.

◆ suggestedMargin()

static int pqPropertiesPanel::suggestedMargin ( )

inlinestatic

methods used to obtain the recommended spacing and margins to be used for widgets.

Definition at line 51 of file pqPropertiesPanel.h.

◆ suggestedMargins()

static QMargins pqPropertiesPanel::suggestedMargins ( )

inlinestatic

Definition at line 52 of file pqPropertiesPanel.h.

◆ suggestedHorizontalSpacing()

static int pqPropertiesPanel::suggestedHorizontalSpacing ( )

inlinestatic

Definition at line 53 of file pqPropertiesPanel.h.

◆ suggestedVerticalSpacing()

static int pqPropertiesPanel::suggestedVerticalSpacing ( )

inlinestatic

Definition at line 54 of file pqPropertiesPanel.h.

◆ setPanelMode()

void pqPropertiesPanel::setPanelMode ( int val )

Get/Set the panel mode.

◆ panelMode()

int pqPropertiesPanel::panelMode ( ) const

inline

Definition at line 68 of file pqPropertiesPanel.h.

◆ canApply()

bool pqPropertiesPanel::canApply ( )

Returns true if there are changes to be applied.

◆ canReset()

bool pqPropertiesPanel::canReset ( )

Returns true if there are changes to be reset.

◆ apply

void pqPropertiesPanel::apply ( )

slot

Apply the changes properties to the proxies.

This is triggered when the user clicks the "Apply" button on the properties panel.

◆ reset

void pqPropertiesPanel::reset ( )

slot

Reset the changes made.

This is triggered when the user clicks the "Reset" button on the properties panel.

◆ showHelp

void pqPropertiesPanel::showHelp ( )

slot

Shows the help dialog.

This is triggered when the user clicks the "?" button on the properties panel.

◆ propertiesRestoreDefaults

void pqPropertiesPanel::propertiesRestoreDefaults ( )

slot

Restores the application defaults for the source properties.

This is triggered when the user clicks the button with the reload button next to the properties button.

◆ propertiesSaveAsDefaults

void pqPropertiesPanel::propertiesSaveAsDefaults ( )

slot

Saves the current property settings as default.

This is triggered when the user clicks the button with the save icon next to the properties button.

◆ displayRestoreDefaults

void pqPropertiesPanel::displayRestoreDefaults ( )

slot

Restores the application defaults for the display properties.

This is triggered when the user clicks the button with the reload button next to the display button.

◆ displaySaveAsDefaults

void pqPropertiesPanel::displaySaveAsDefaults ( )

slot

Saves the current display settings as default.

This is triggered when the user clicks the button with the save icon next to the display button.

◆ viewRestoreDefaults

void pqPropertiesPanel::viewRestoreDefaults ( )

slot

Restores the application defaults for the view properties.

This is triggered when the user clicks the button with the reload button next to the view button.

◆ viewSaveAsDefaults

void pqPropertiesPanel::viewSaveAsDefaults ( )

slot

Saves the current view settings as default.

This is triggered when the user clicks the button with the save icon next to the view button.

◆ setView

void pqPropertiesPanel::setView ( pqView * )

slot

Set the view currently managed by the panel, should be called automatically when the active view changes.

◆ setPipelineProxy

void pqPropertiesPanel::setPipelineProxy ( pqProxy * )

slot

Set the pqProxy to show properties for under the "Properties" section.

Typically, this is a pqPipelineSource (or subclass), pqOutputPort, or a pqExtractor.

◆ setRepresentation

void pqPropertiesPanel::setRepresentation ( pqDataRepresentation * )

slot

Set the representation currently managed by the panel, should be called automatically when the active representation changes.

◆ applied [1/2]

void pqPropertiesPanel::applied ( )

signal

This signal is emitted after the user clicks the apply button.

◆ applied [2/2]

void pqPropertiesPanel::applied ( pqProxy * )

signal

This signal is emitted after a panel for a proxy is applied.

◆ viewChanged

void pqPropertiesPanel::viewChanged ( pqView * )

signal

This signal is emitted when the current view changes.

◆ modified

void pqPropertiesPanel::modified ( )

signal

◆ resetDone

void pqPropertiesPanel::resetDone ( )

signal

◆ helpRequested

void pqPropertiesPanel::helpRequested	(	const QString &	groupname,
		const QString &	proxyType
	)

signal

This signal is emitted when the user clicks the help button.

◆ deleteRequested

void pqPropertiesPanel::deleteRequested ( pqProxy * source )

signal

This signal is emitted when the user clicks the delete button.

◆ applyEnableStateChanged

void pqPropertiesPanel::applyEnableStateChanged ( )

signal

This signal is emitted when the apply button's enable state changes.

This is intended for other controls that call apply on the panel so that they can be enabled/disabled correctly (i.e. menu items).

◆ updatePropertiesPanel()

void pqPropertiesPanel::updatePropertiesPanel ( pqProxy * source )

protected

◆ updateDisplayPanel()

void pqPropertiesPanel::updateDisplayPanel ( pqDataRepresentation * repr )

protected

◆ updateViewPanel()

void pqPropertiesPanel::updateViewPanel ( pqView * view )

protected

Friends And Related Function Documentation

◆ pqInternals

friend class pqInternals

friend

Definition at line 265 of file pqPropertiesPanel.h.

Property Documentation

◆ panelMode

int pqPropertiesPanel::panelMode

readwrite

Definition at line 35 of file pqPropertiesPanel.h.

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

/builds/gitlab-kitware-sciviz-ci/Qt/Components/pqPropertiesPanel.h

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ pqPropertiesPanel()

◆ ~pqPropertiesPanel()

Member Function Documentation

◆ view()

◆ suggestedMargin()

◆ suggestedMargins()

◆ suggestedHorizontalSpacing()

◆ suggestedVerticalSpacing()

◆ setPanelMode()

◆ panelMode()

◆ canApply()

◆ canReset()

◆ apply

◆ reset

◆ showHelp

◆ propertiesRestoreDefaults

◆ propertiesSaveAsDefaults

◆ displayRestoreDefaults

◆ displaySaveAsDefaults

◆ viewRestoreDefaults

◆ viewSaveAsDefaults

◆ setView

◆ setPipelineProxy

◆ setRepresentation

◆ applied [1/2]

◆ applied [2/2]

◆ viewChanged

◆ modified

◆ resetDone

◆ helpRequested

◆ deleteRequested

◆ applyEnableStateChanged

◆ updatePropertiesPanel()

◆ updateDisplayPanel()

◆ updateViewPanel()

Friends And Related Function Documentation

◆ pqInternals

Property Documentation

◆ panelMode