Public Slots | Signals | Public Member Functions | Properties | List of all members
pqInputSelectorWidget Class Reference

widget for input property to choose a pipeline input. More...

#include <pqInputSelectorWidget.h>

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

Public Slots

void setSelectedInput (pqSMProxy)
 
- Public Slots inherited from pqPropertyWidget
virtual void setView (pqView *)
 called to set the active view. More...
 

Signals

void selectedInputChanged ()
 
- 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

 pqInputSelectorWidget (vtkSMProxy *proxy, vtkSMProperty *smproperty, QWidget *parent=nullptr)
 
 ~pqInputSelectorWidget () override
 
pqSMProxy selectedInput () const
 Chosen port. 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)
 
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)
 
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

pqSMProxy selectedInput
 

Additional Inherited Members

- 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

widget for input property to choose a pipeline input.

Generally, pqProxyWidget does not show widget for input properties. This is by design since changing input to filters is generally not a thing we let the user treat at same level as changing other properties. In some cases, however, we may want to show a combo-box to let user pick the input from the available pipeline proxies. pqInputSelectorWidget is designed for such exceptional cases. To use this widget for a vtkSMInputProperty, set panel_widget attribute to input_selector.

Definition at line 57 of file pqInputSelectorWidget.h.

Constructor & Destructor Documentation

◆ pqInputSelectorWidget()

pqInputSelectorWidget::pqInputSelectorWidget ( vtkSMProxy proxy,
vtkSMProperty smproperty,
QWidget *  parent = nullptr 
)

◆ ~pqInputSelectorWidget()

pqInputSelectorWidget::~pqInputSelectorWidget ( )
override

Member Function Documentation

◆ selectedInput()

pqSMProxy pqInputSelectorWidget::selectedInput ( ) const

Chosen port.

This returns vtkSmartPointer<vtkSMOutputPort> for the chosen port. if any.

◆ setSelectedInput

void pqInputSelectorWidget::setSelectedInput ( pqSMProxy  )
slot

◆ selectedInputChanged

void pqInputSelectorWidget::selectedInputChanged ( )
signal

Property Documentation

◆ selectedInput

pqSMProxy pqInputSelectorWidget::selectedInput
readwrite

Definition at line 61 of file pqInputSelectorWidget.h.


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