#include <pqBackgroundEditorWidget.h>

Inheritance diagram for pqBackgroundEditorWidget:

Collaboration diagram for pqBackgroundEditorWidget:

Signals
void	gradientBackgroundChanged ()

void	imageBackgroundChanged ()

void	skyboxBackgroundChanged ()

void	environmentLightingChanged ()

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
	pqBackgroundEditorWidget (vtkSMProxy smproxy, vtkSMPropertyGroup smgroup, QWidget *parentObject=nullptr, bool forEnvironment=false)

	~pqBackgroundEditorWidget () override

bool	gradientBackground () const

void	setGradientBackground (bool gradientBackground)

bool	imageBackground () const

void	setImageBackground (bool imageBackground)

bool	skyboxBackground () const

void	setSkyboxBackground (bool skyboxBackground)

bool	environmentLighting () const

void	setEnvironmentLighting (bool envLighting)

Public Member Functions inherited from pqPropertyGroupWidget
	pqPropertyGroupWidget (vtkSMProxy proxy, vtkSMPropertyGroup smGroup, QWidget *parent=nullptr)

vtkSMPropertyGroup *	propertyGroup () const

void	addPropertyLink (QComboBox cb, const char propertyName, int smindex=-1)

void	addPropertyLink (QLineEdit edit, const char propertyName, int smindex=-1)

void	addPropertyLink (QCheckBox button, const char propertyName, int smindex=-1)

void	addPropertyLink (QToolButton button, const char propertyName, int smindex=-1)

void	addPropertyLink (QGroupBox groupBox, const char propertyName, int smindex=-1)

void	addPropertyLink (QDoubleSpinBox spinBox, const char propertyName, int smindex=-1)

void	addPropertyLink (QSpinBox spinBox, const char propertyName, int smindex=-1)

void	addPropertyLink (pqColorChooserButton color, const char propertyName, int smindex=-1)

void	addPropertyLink (pqDoubleSliderWidget slider, const char propertyName, int smindex=-1)

char *	panelVisibility () const override
	Overwrite pqPropertyWidget to forward calls to vtkSMPropertyGroup. More...

void	setPanelVisibility (const char *vis) override

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 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...

virtual void	setReadOnly (bool readOnly)
	Set widget in read-only mode. 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...

Protected Slots
void	currentIndexChangedBackgroundType (int type)

void	clickedRestoreDefaultColor ()

void	clickedRestoreDefaultColor2 ()

Properties
bool	gradientBackground

bool	imageBackground

bool	skyboxBackground

bool	environmentLighting

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

Definition at line 13 of file pqBackgroundEditorWidget.h.

Constructor & Destructor Documentation

◆ pqBackgroundEditorWidget()

pqBackgroundEditorWidget::pqBackgroundEditorWidget	(	vtkSMProxy *	smproxy,
		vtkSMPropertyGroup *	smgroup,
		QWidget *	parentObject = `nullptr`,
		bool	forEnvironment = `false`
	)

◆ ~pqBackgroundEditorWidget()

pqBackgroundEditorWidget::~pqBackgroundEditorWidget ( )

override

Member Function Documentation

◆ gradientBackground()

bool pqBackgroundEditorWidget::gradientBackground ( ) const

◆ setGradientBackground()

void pqBackgroundEditorWidget::setGradientBackground ( bool gradientBackground )

◆ imageBackground()

bool pqBackgroundEditorWidget::imageBackground ( ) const

◆ setImageBackground()

void pqBackgroundEditorWidget::setImageBackground ( bool imageBackground )

◆ skyboxBackground()

bool pqBackgroundEditorWidget::skyboxBackground ( ) const

◆ setSkyboxBackground()

void pqBackgroundEditorWidget::setSkyboxBackground ( bool skyboxBackground )

◆ environmentLighting()

bool pqBackgroundEditorWidget::environmentLighting ( ) const

◆ setEnvironmentLighting()

void pqBackgroundEditorWidget::setEnvironmentLighting ( bool envLighting )

◆ gradientBackgroundChanged

void pqBackgroundEditorWidget::gradientBackgroundChanged ( )

signal

◆ imageBackgroundChanged

void pqBackgroundEditorWidget::imageBackgroundChanged ( )

signal

◆ skyboxBackgroundChanged

void pqBackgroundEditorWidget::skyboxBackgroundChanged ( )

signal

◆ environmentLightingChanged

void pqBackgroundEditorWidget::environmentLightingChanged ( )

signal

◆ currentIndexChangedBackgroundType

void pqBackgroundEditorWidget::currentIndexChangedBackgroundType ( int type )

protectedslot

◆ clickedRestoreDefaultColor

void pqBackgroundEditorWidget::clickedRestoreDefaultColor ( )

protectedslot

◆ clickedRestoreDefaultColor2

void pqBackgroundEditorWidget::clickedRestoreDefaultColor2 ( )

protectedslot

Property Documentation

◆ gradientBackground

bool pqBackgroundEditorWidget::gradientBackground

readwrite

Definition at line 47 of file pqBackgroundEditorWidget.h.

◆ imageBackground

bool pqBackgroundEditorWidget::imageBackground

readwrite

Definition at line 48 of file pqBackgroundEditorWidget.h.

◆ skyboxBackground

bool pqBackgroundEditorWidget::skyboxBackground

readwrite

Definition at line 49 of file pqBackgroundEditorWidget.h.

◆ environmentLighting

bool pqBackgroundEditorWidget::environmentLighting

readwrite

Definition at line 50 of file pqBackgroundEditorWidget.h.

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

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

Signals

Public Member Functions

Protected Slots

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ pqBackgroundEditorWidget()

◆ ~pqBackgroundEditorWidget()

Member Function Documentation

◆ gradientBackground()

◆ setGradientBackground()

◆ imageBackground()

◆ setImageBackground()

◆ skyboxBackground()

◆ setSkyboxBackground()

◆ environmentLighting()

◆ setEnvironmentLighting()

◆ gradientBackgroundChanged

◆ imageBackgroundChanged

◆ skyboxBackgroundChanged

◆ environmentLightingChanged

◆ currentIndexChangedBackgroundType

◆ clickedRestoreDefaultColor

◆ clickedRestoreDefaultColor2

Property Documentation

◆ gradientBackground

◆ imageBackground

◆ skyboxBackground

◆ environmentLighting