Public Member Functions | Static Public Member Functions | List of all members
pqStringVectorPropertyWidget Class Reference

#include <pqStringVectorPropertyWidget.h>

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

Public Member Functions

 pqStringVectorPropertyWidget (vtkSMProperty *property, vtkSMProxy *proxy, QWidget *parent=nullptr)
 
 ~pqStringVectorPropertyWidget () override
 
void setReadOnly (bool readOnly) override
 Set widget in read-only mode. 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...
 

Static Public Member Functions

static pqPropertyWidgetcreateWidget (vtkSMStringVectorProperty *smproperty, vtkSMProxy *smproxy, QWidget *parent=nullptr)
 Factory method to instantiate a hard-coded type of pqPropertyWidget subclass for t he vtkSMStringVectorProperty. More...
 
static void processFileChooserHints (vtkPVXMLElement *hints, bool &directoryMode, bool &anyFile, QString &filter, bool &browseLocalFileSystem)
 Method to process file-choice related hints. 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::stringparseComponentLabels (vtkPVXMLElement *hints, unsigned int elemCount=0)
 Parse a XML element as a list of label to use for this widget. 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...
 
- 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

Definition at line 12 of file pqStringVectorPropertyWidget.h.

Constructor & Destructor Documentation

◆ pqStringVectorPropertyWidget()

pqStringVectorPropertyWidget::pqStringVectorPropertyWidget ( vtkSMProperty property,
vtkSMProxy proxy,
QWidget *  parent = nullptr 
)

◆ ~pqStringVectorPropertyWidget()

pqStringVectorPropertyWidget::~pqStringVectorPropertyWidget ( )
override

Member Function Documentation

◆ createWidget()

static pqPropertyWidget* pqStringVectorPropertyWidget::createWidget ( vtkSMStringVectorProperty smproperty,
vtkSMProxy smproxy,
QWidget *  parent = nullptr 
)
static

Factory method to instantiate a hard-coded type of pqPropertyWidget subclass for t he vtkSMStringVectorProperty.

◆ processFileChooserHints()

static void pqStringVectorPropertyWidget::processFileChooserHints ( vtkPVXMLElement hints,
bool &  directoryMode,
bool &  anyFile,
QString &  filter,
bool &  browseLocalFileSystem 
)
static

Method to process file-choice related hints.

◆ setReadOnly()

void pqStringVectorPropertyWidget::setReadOnly ( bool  readOnly)
overridevirtual

Set widget in read-only mode.

By default, this call setEnabled(!readOnly)

Reimplemented from pqPropertyWidget.


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