widget to choose a color palette to load/select. More...

#include <pqColorPaletteSelectorWidget.h>

Inheritance diagram for pqColorPaletteSelectorWidget:

Collaboration diagram for pqColorPaletteSelectorWidget:

Signals
void	paletteNameChanged ()

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

void	changeAvailable ()
	This signal is fired as soon as the user starts editing in the widget. More...

void	changeFinished ()
	This signal is fired as soon as the user is done with making an atomic change. More...

void	restartRequired ()
	Indicates that a restart of the program is required for the setting to take effect. More...

Public Member Functions
	pqColorPaletteSelectorWidget (vtkSMProxy smproxy, vtkSMProperty smproperty, QWidget *parent=nullptr)

	~pqColorPaletteSelectorWidget () override

QString	paletteName () const

void	setPaletteName (const QString &name)

Public Member Functions inherited from pqPropertyWidget
	pqPropertyWidget (vtkSMProxy proxy, QWidget parent=nullptr)

	~pqPropertyWidget () override

virtual void	apply ()

virtual void	reset ()

virtual void	updateWidget (bool showing_advanced_properties)

pqView *	view () const

vtkSMProxy *	proxy () const

vtkSMProperty *	property () const

virtual char *	panelVisibility () const
	Forward calls to vtkSMProperty. More...

virtual void	setPanelVisibility (const char *vis)

virtual bool	isSingleRowItem () const
	Determines if the PropertyWidget must be constructed using a single row. More...

bool	showLabel () const

const QList< QPointer< pqPropertyWidgetDecorator > > &	decorators () const
	Provides access to the decorators for this widget. More...

void	setProperty (vtkSMProperty *property)

virtual void	select ()
	These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More...

virtual void	selectPort (int portIndex)
	These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More...

virtual void	deselect ()
	These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More...

bool	isSelected () const
	These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More...

Properties
QString	paletteName

Additional Inherited Members
Public Slots inherited from pqPropertyWidget
virtual void	setView (pqView *)
	called to set the active view. More...

Static Public Member Functions inherited from pqPropertyWidget
template<class T >
static QString	getXMLName (T *object)
	Description: This static utility method returns the XML name for an object as a QString. More...

static QString	getTooltip (vtkSMProperty *property)
	Returns the tooltip to use for the property. More...

static int	hintsWidgetHeightNumberOfRows (vtkPVXMLElement *hints, int defaultValue=10)
	Helper method to return value from WidgetHeight XML hint, if any. More...

static std::vector< std::string >	parseComponentLabels (vtkPVXMLElement *hints, unsigned int elemCount=0)
	Parse a XML element as a list of label to use for this widget. More...

Protected Member Functions inherited from pqPropertyWidget
void	addPropertyLink (QObject qobject, const char qproperty, const char qsignal, vtkSMProperty smproperty, int smindex=-1)

void	addPropertyLink (QObject qobject, const char qproperty, const char qsignal, vtkSMProxy smproxy, vtkSMProperty *smproperty, int smindex=-1)

void	removePropertyLink (QObject qobject, const char qproperty, const char qsignal, vtkSMProperty smproperty, int smindex=-1)

void	removePropertyLink (QObject qobject, const char qproperty, const char qsignal, vtkSMProxy smproxy, vtkSMProperty *smproperty, int smindex=-1)

void	setShowLabel (bool show)

void	setChangeAvailableAsChangeFinished (bool status)
	For most pqPropertyWidget subclasses a changeAvailable() signal, corresponds to a changeFinished() signal. More...

void	addDecorator (pqPropertyWidgetDecorator *)
	Register a decorator. More...

void	removeDecorator (pqPropertyWidgetDecorator *)
	Unregisters a decorator. More...

pqPropertyLinks &	links ()
	Provides access to the pqPropertyLinks instance. More...

Detailed Description

widget to choose a color palette to load/select.

pqColorPaletteSelectorWidget is a pqPropertyWidget intended to be used in two roles:

To load a specific color palette.
To select a specific color palette.

Mode (1) is used when the widget is used for a vtkSMProperty e.g. **'Load Palette'** property on the ColorPalette proxy. In that case, the user's action is expected to update the proxy with the chosen palette.

Mode (2) is used when the widget is used for a vtkSMStringVectorProperty e.g. OverrideColorPalette property on ImageOptions proxy. In that case, the selected palette name is simply set on the vtkSMStringVectorProperty.

Definition at line 31 of file pqColorPaletteSelectorWidget.h.

Constructor & Destructor Documentation

◆ pqColorPaletteSelectorWidget()

pqColorPaletteSelectorWidget::pqColorPaletteSelectorWidget	(	vtkSMProxy *	smproxy,
		vtkSMProperty *	smproperty,
		QWidget *	parent = `nullptr`
	)

◆ ~pqColorPaletteSelectorWidget()

pqColorPaletteSelectorWidget::~pqColorPaletteSelectorWidget ( )

override

Member Function Documentation

◆ paletteName()

QString pqColorPaletteSelectorWidget::paletteName ( ) const

◆ setPaletteName()

void pqColorPaletteSelectorWidget::setPaletteName ( const QString & name )

◆ paletteNameChanged

void pqColorPaletteSelectorWidget::paletteNameChanged ( )

signal

Property Documentation

◆ paletteName

QString pqColorPaletteSelectorWidget::paletteName

readwrite

Definition at line 34 of file pqColorPaletteSelectorWidget.h.

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

/builds/gitlab-kitware-sciviz-ci/Qt/ApplicationComponents/pqColorPaletteSelectorWidget.h

Signals

Public Member Functions

Properties

Additional Inherited Members