pqSeriesEditorPropertyWidget is the pqPropertyWidget used to edit plot-options for a xy-series. More...

#include <pqSeriesEditorPropertyWidget.h>

Inheritance diagram for pqSeriesEditorPropertyWidget:

Collaboration diagram for pqSeriesEditorPropertyWidget:

Signals
void	presetLabelChanged ()

void	presetColorChanged ()


void	seriesVisibilityChanged ()
	Fired when the series visibility changes. More...


void	seriesLabelChanged ()
	Fired when the series labels change. More...


void	seriesColorChanged ()
	Fired when the series colors change. More...


void	seriesOpacityChanged ()
	Fired when the series opacity changes. More...


void	seriesLineThicknessChanged ()
	Fired when the series line thickness changes. More...


void	seriesLineStyleChanged ()
	Fired when the series line style changes. More...


void	seriesMarkerStyleChanged ()
	Fired when the series marker style changes. More...


void	seriesMarkerSizeChanged ()
	Fired when the series marker size changes. More...


void	seriesPlotCornerChanged ()
	Fired when the series plot corners change. More...

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
	pqSeriesEditorPropertyWidget (vtkSMProxy proxy, vtkSMPropertyGroup smgroup, QWidget *parent=nullptr)

	~pqSeriesEditorPropertyWidget () override

QList< QVariant >	presetColor () const

void	setPresetColor (const QList< QVariant > &)

QList< QVariant >	presetLabel () const

void	setPresetLabel (const QList< QVariant > &)


QList< QVariant >	seriesVisibility () const
	Get/Set the visibility for series. More...

void	setSeriesVisibility (const QList< QVariant > &)
	Get/Set the visibility for series. More...


QList< QVariant >	seriesColor () const
	Get/Set the color for each of the series. More...

void	setSeriesColor (const QList< QVariant > &)
	Get/Set the color for each of the series. More...


QList< QVariant >	seriesOpacity () const
	Get/Set the opacity for each of the series. More...

void	setSeriesOpacity (const QList< QVariant > &)
	Get/Set the opacity for each of the series. More...


QList< QVariant >	seriesLabel () const
	Get/Set the label for each of the series. More...

void	setSeriesLabel (const QList< QVariant > &)
	Get/Set the label for each of the series. More...


QList< QVariant >	seriesLineThickness () const
	Get/Set the line-thickness for each of the series. More...

void	setSeriesLineThickness (const QList< QVariant > &)
	Get/Set the line-thickness for each of the series. More...


QList< QVariant >	seriesLineStyle () const
	Get/Set the line-style for each of the series. More...

void	setSeriesLineStyle (const QList< QVariant > &)
	Get/Set the line-style for each of the series. More...


QList< QVariant >	seriesMarkerStyle () const
	Get/Set the marker-style for each of the series. More...

void	setSeriesMarkerStyle (const QList< QVariant > &)
	Get/Set the marker-style for each of the series. More...


QList< QVariant >	seriesMarkerSize () const
	Get/Set the marker-size for each of the series. More...

void	setSeriesMarkerSize (const QList< QVariant > &)
	Get/Set the marker-size for each of the series. More...


QList< QVariant >	seriesPlotCorner () const
	Get/Set the plot-corner for each of the series. More...

void	setSeriesPlotCorner (const QList< QVariant > &)
	Get/Set the plot-corner for each of the series. More...

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

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

Properties
QList< QVariant >	seriesVisibility

QList< QVariant >	presetLabel

QList< QVariant >	seriesLabel

QList< QVariant >	seriesColor

QList< QVariant >	seriesOpacity

QList< QVariant >	presetColor

QList< QVariant >	seriesLineThickness

QList< QVariant >	seriesLineStyle

QList< QVariant >	seriesMarkerStyle

QList< QVariant >	seriesMarkerSize

QList< QVariant >	seriesPlotCorner

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

pqSeriesEditorPropertyWidget is the pqPropertyWidget used to edit plot-options for a xy-series.

It works with a property-group with properties for various functions, including required properties (SeriesVisibility) and optional properties (SeriesLabel, SeriesColor, SeriesLineThickness, SeriesLineStyle, SeriesMarkerStyle, and SeriesPlotCorner). If any of optional property functions are missing from the group, the corresponding widgets will be hidden.

Definition at line 23 of file pqSeriesEditorPropertyWidget.h.

Constructor & Destructor Documentation

◆ pqSeriesEditorPropertyWidget()

pqSeriesEditorPropertyWidget::pqSeriesEditorPropertyWidget	(	vtkSMProxy *	proxy,
		vtkSMPropertyGroup *	smgroup,
		QWidget *	parent = `nullptr`
	)

◆ ~pqSeriesEditorPropertyWidget()

pqSeriesEditorPropertyWidget::~pqSeriesEditorPropertyWidget ( )

override

Member Function Documentation

◆ seriesVisibility()

QList<QVariant> pqSeriesEditorPropertyWidget::seriesVisibility ( ) const

Get/Set the visibility for series.

◆ setSeriesVisibility()

void pqSeriesEditorPropertyWidget::setSeriesVisibility ( const QList< QVariant > & )

Get/Set the visibility for series.

◆ seriesColor()

QList<QVariant> pqSeriesEditorPropertyWidget::seriesColor ( ) const

Get/Set the color for each of the series.

◆ setSeriesColor()

void pqSeriesEditorPropertyWidget::setSeriesColor ( const QList< QVariant > & )

Get/Set the color for each of the series.

◆ presetColor()

QList<QVariant> pqSeriesEditorPropertyWidget::presetColor ( ) const

◆ setPresetColor()

void pqSeriesEditorPropertyWidget::setPresetColor ( const QList< QVariant > & )

◆ seriesOpacity()

QList<QVariant> pqSeriesEditorPropertyWidget::seriesOpacity ( ) const

Get/Set the opacity for each of the series.

◆ setSeriesOpacity()

void pqSeriesEditorPropertyWidget::setSeriesOpacity ( const QList< QVariant > & )

Get/Set the opacity for each of the series.

◆ seriesLabel()

QList<QVariant> pqSeriesEditorPropertyWidget::seriesLabel ( ) const

Get/Set the label for each of the series.

◆ setSeriesLabel()

void pqSeriesEditorPropertyWidget::setSeriesLabel ( const QList< QVariant > & )

Get/Set the label for each of the series.

◆ presetLabel()

QList<QVariant> pqSeriesEditorPropertyWidget::presetLabel ( ) const

◆ setPresetLabel()

void pqSeriesEditorPropertyWidget::setPresetLabel ( const QList< QVariant > & )

◆ seriesLineThickness()

QList<QVariant> pqSeriesEditorPropertyWidget::seriesLineThickness ( ) const

Get/Set the line-thickness for each of the series.

◆ setSeriesLineThickness()

void pqSeriesEditorPropertyWidget::setSeriesLineThickness ( const QList< QVariant > & )

Get/Set the line-thickness for each of the series.

◆ seriesLineStyle()

QList<QVariant> pqSeriesEditorPropertyWidget::seriesLineStyle ( ) const

Get/Set the line-style for each of the series.

◆ setSeriesLineStyle()

void pqSeriesEditorPropertyWidget::setSeriesLineStyle ( const QList< QVariant > & )

Get/Set the line-style for each of the series.

◆ seriesMarkerStyle()

QList<QVariant> pqSeriesEditorPropertyWidget::seriesMarkerStyle ( ) const

Get/Set the marker-style for each of the series.

◆ setSeriesMarkerStyle()

void pqSeriesEditorPropertyWidget::setSeriesMarkerStyle ( const QList< QVariant > & )

Get/Set the marker-style for each of the series.

◆ seriesMarkerSize()

QList<QVariant> pqSeriesEditorPropertyWidget::seriesMarkerSize ( ) const

Get/Set the marker-size for each of the series.

◆ setSeriesMarkerSize()

void pqSeriesEditorPropertyWidget::setSeriesMarkerSize ( const QList< QVariant > & )

Get/Set the marker-size for each of the series.

◆ seriesPlotCorner()

QList<QVariant> pqSeriesEditorPropertyWidget::seriesPlotCorner ( ) const

Get/Set the plot-corner for each of the series.

◆ setSeriesPlotCorner()

void pqSeriesEditorPropertyWidget::setSeriesPlotCorner ( const QList< QVariant > & )

Get/Set the plot-corner for each of the series.

◆ seriesVisibilityChanged

void pqSeriesEditorPropertyWidget::seriesVisibilityChanged ( )

signal

Fired when the series visibility changes.

◆ seriesLabelChanged

void pqSeriesEditorPropertyWidget::seriesLabelChanged ( )

signal

Fired when the series labels change.

◆ presetLabelChanged

void pqSeriesEditorPropertyWidget::presetLabelChanged ( )

signal

◆ seriesColorChanged

void pqSeriesEditorPropertyWidget::seriesColorChanged ( )

signal

Fired when the series colors change.

◆ presetColorChanged

void pqSeriesEditorPropertyWidget::presetColorChanged ( )

signal

◆ seriesOpacityChanged

void pqSeriesEditorPropertyWidget::seriesOpacityChanged ( )

signal

Fired when the series opacity changes.

◆ seriesLineThicknessChanged

void pqSeriesEditorPropertyWidget::seriesLineThicknessChanged ( )

signal

Fired when the series line thickness changes.

◆ seriesLineStyleChanged

void pqSeriesEditorPropertyWidget::seriesLineStyleChanged ( )

signal

Fired when the series line style changes.

◆ seriesMarkerStyleChanged

void pqSeriesEditorPropertyWidget::seriesMarkerStyleChanged ( )

signal

Fired when the series marker style changes.

◆ seriesMarkerSizeChanged

void pqSeriesEditorPropertyWidget::seriesMarkerSizeChanged ( )

signal

Fired when the series marker size changes.

◆ seriesPlotCornerChanged

void pqSeriesEditorPropertyWidget::seriesPlotCornerChanged ( )

signal

Fired when the series plot corners change.

Property Documentation

◆ seriesVisibility

QList<QVariant> pqSeriesEditorPropertyWidget::seriesVisibility

readwrite

Definition at line 27 of file pqSeriesEditorPropertyWidget.h.

◆ presetLabel

QList<QVariant> pqSeriesEditorPropertyWidget::presetLabel

readwrite

Definition at line 30 of file pqSeriesEditorPropertyWidget.h.

◆ seriesLabel

QList<QVariant> pqSeriesEditorPropertyWidget::seriesLabel

readwrite

Definition at line 33 of file pqSeriesEditorPropertyWidget.h.

◆ seriesColor

QList<QVariant> pqSeriesEditorPropertyWidget::seriesColor

readwrite

Definition at line 36 of file pqSeriesEditorPropertyWidget.h.

◆ seriesOpacity

QList<QVariant> pqSeriesEditorPropertyWidget::seriesOpacity

readwrite

Definition at line 39 of file pqSeriesEditorPropertyWidget.h.

◆ presetColor

QList<QVariant> pqSeriesEditorPropertyWidget::presetColor

readwrite

Definition at line 42 of file pqSeriesEditorPropertyWidget.h.

◆ seriesLineThickness

QList<QVariant> pqSeriesEditorPropertyWidget::seriesLineThickness

readwrite

Definition at line 45 of file pqSeriesEditorPropertyWidget.h.

◆ seriesLineStyle

QList<QVariant> pqSeriesEditorPropertyWidget::seriesLineStyle

readwrite

Definition at line 48 of file pqSeriesEditorPropertyWidget.h.

◆ seriesMarkerStyle

QList<QVariant> pqSeriesEditorPropertyWidget::seriesMarkerStyle

readwrite

Definition at line 51 of file pqSeriesEditorPropertyWidget.h.

◆ seriesMarkerSize

QList<QVariant> pqSeriesEditorPropertyWidget::seriesMarkerSize

readwrite

Definition at line 54 of file pqSeriesEditorPropertyWidget.h.

◆ seriesPlotCorner

QList<QVariant> pqSeriesEditorPropertyWidget::seriesPlotCorner

readwrite

Definition at line 57 of file pqSeriesEditorPropertyWidget.h.

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

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

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ pqSeriesEditorPropertyWidget()

◆ ~pqSeriesEditorPropertyWidget()

Member Function Documentation

◆ seriesVisibility()

◆ setSeriesVisibility()

◆ seriesColor()

◆ setSeriesColor()

◆ presetColor()

◆ setPresetColor()

◆ seriesOpacity()

◆ setSeriesOpacity()

◆ seriesLabel()

◆ setSeriesLabel()

◆ presetLabel()

◆ setPresetLabel()

◆ seriesLineThickness()

◆ setSeriesLineThickness()

◆ seriesLineStyle()

◆ setSeriesLineStyle()

◆ seriesMarkerStyle()

◆ setSeriesMarkerStyle()

◆ seriesMarkerSize()

◆ setSeriesMarkerSize()

◆ seriesPlotCorner()

◆ setSeriesPlotCorner()

◆ seriesVisibilityChanged

◆ seriesLabelChanged

◆ presetLabelChanged

◆ seriesColorChanged

◆ presetColorChanged

◆ seriesOpacityChanged

◆ seriesLineThicknessChanged

◆ seriesLineStyleChanged

◆ seriesMarkerStyleChanged

◆ seriesMarkerSizeChanged

◆ seriesPlotCornerChanged

Property Documentation

◆ seriesVisibility

◆ presetLabel

◆ seriesLabel

◆ seriesColor

◆ seriesOpacity

◆ presetColor

◆ seriesLineThickness

◆ seriesLineStyle

◆ seriesMarkerStyle

◆ seriesMarkerSize

◆ seriesPlotCorner