Public Member Functions | Protected Slots | List of all members
pqCommandPropertyWidget Class Reference

pqCommandPropertyWidget is used for vtkSMProperty instances (not one of its subclasses). More...

#include <pqCommandPropertyWidget.h>

Inheritance diagram for pqCommandPropertyWidget:
Inheritance graph
[legend]
Collaboration diagram for pqCommandPropertyWidget:
Collaboration graph
[legend]

Public Member Functions

 pqCommandPropertyWidget (vtkSMProperty *property, vtkSMProxy *proxy, QWidget *parent=0)
 
 ~pqCommandPropertyWidget () override
 
- Public Member Functions inherited from pqPropertyWidget
 pqPropertyWidget (vtkSMProxy *proxy, QWidget *parent=0)
 
 ~pqPropertyWidget () override
 
virtual void apply ()
 
virtual void reset ()
 
virtual void select ()
 These methods are called by pqPropertiesPanel when the panel for proxy becomes active/deactive. More...
 
virtual void deselect ()
 
bool isSelected () const
 
virtual void updateWidget (bool showing_advanced_properties)
 
pqViewview () const
 
vtkSMProxyproxy () const
 
vtkSMPropertyproperty () 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)
 

Protected Slots

virtual void buttonClicked ()
 called when the button is clicked by the user. More...
 

Additional Inherited Members

- Public Slots inherited from pqPropertyWidget
virtual void setView (pqView *)
 called to set the active view. 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...
 
- 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...
 
- 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...
 
pqPropertyLinkslinks ()
 Provides access to the pqPropertyLinks instance. More...
 

Detailed Description

pqCommandPropertyWidget is used for vtkSMProperty instances (not one of its subclasses).

It simply creates a button that the users can press. Unlike other pqPropertyWidget subclasses, the result of clicking this button does not affect the state of the Apply/Reset buttons. It triggers the action prompted by the property immediately.

Definition at line 44 of file pqCommandPropertyWidget.h.

Constructor & Destructor Documentation

◆ pqCommandPropertyWidget()

pqCommandPropertyWidget::pqCommandPropertyWidget ( vtkSMProperty property,
vtkSMProxy proxy,
QWidget *  parent = 0 
)

◆ ~pqCommandPropertyWidget()

pqCommandPropertyWidget::~pqCommandPropertyWidget ( )
override

Member Function Documentation

◆ buttonClicked

virtual void pqCommandPropertyWidget::buttonClicked ( )
protectedvirtualslot

called when the button is clicked by the user.


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