pqIntMaskPropertyWidget is designed to be used for an IntVectorProperty that can have a value that is set by or-ing together flags. More...
#include <pqIntMaskPropertyWidget.h>
Public Slots | |
| void | setMask (int mask) |
| Set the mask. More... | |
 Public Slots inherited from pqPropertyWidget | |
| virtual void | setView (pqView *) |
| called to set the active view. More... | |
Signals | |
| void | maskChanged () |
| Fired whenever the user changes the selection. 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 | |
| pqIntMaskPropertyWidget (vtkSMProxy *proxy, vtkSMProperty *smproperty, QWidget *parent=nullptr) | |
| ~pqIntMaskPropertyWidget () override | |
| int | mask () const |
| Returns the current mask value. 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 | |
| int | mask |
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... | |
| 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... | |
pqIntMaskPropertyWidget is designed to be used for an IntVectorProperty that can have a value that is set by or-ing together flags.
The user is presented with a button with menu from which they can select multiple items. The resulting property value is determined by or-ing together the flag values for each of the checked item.
The flag/mask labels and their values are specified as hints on the XML property. The following XML snippet demonstrates how to use this property widget.
Definition at line 41 of file pqIntMaskPropertyWidget.h.
| pqIntMaskPropertyWidget::pqIntMaskPropertyWidget | ( | vtkSMProxy * | proxy, |
| vtkSMProperty * | smproperty, | ||
| QWidget * | parent = nullptr |
||
| ) |
|
override |
| int pqIntMaskPropertyWidget::mask | ( | ) | const |
Returns the current mask value.
|
slot |
Set the mask.
|
signal |
Fired whenever the user changes the selection.
|
readwrite |
Definition at line 45 of file pqIntMaskPropertyWidget.h.
1.8.13 on Tue Jan 21 2025