property-widget for creating selection queries. More...
#include <pqSelectionQueryPropertyWidget.h>
Signals | |
| void | queryChanged () |
 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 | |
| pqSelectionQueryPropertyWidget (vtkSMProxy *proxy, vtkSMProperty *property, QWidget *parent=nullptr) | |
| ~pqSelectionQueryPropertyWidget () override | |
| void | setQuery (const QString &) |
| Get/Set the query string. More... | |
| const QString & | query () const |
| Get/Set the query string. 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 | |
| QString | query |
Friends | |
| class | pqInternals |
| class | pqValueWidget |
| class | pqQueryWidget |
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... | |
property-widget for creating selection queries.
pqSelectionQueryPropertyWidget is a pqPropertyWidget subclass that can be used for a property accepting a string representing a selection query. The widget allows users to build selection queries easily.
To use this widget on a property with vtkSMSelectionQueryDomain, set the panel_widget to selection_query (
Currently, this widget can faithfully present GUI for query strings that follow a specific form that is generated by this property itself. Any other forms, though valid queries, will not be represented properly in the GUI.
Definition at line 30 of file pqSelectionQueryPropertyWidget.h.
| pqSelectionQueryPropertyWidget::pqSelectionQueryPropertyWidget | ( | vtkSMProxy * | proxy, |
| vtkSMProperty * | property, | ||
| QWidget * | parent = nullptr |
||
| ) |
|
override |
| void pqSelectionQueryPropertyWidget::setQuery | ( | const QString & | ) |
Get/Set the query string.
| const QString& pqSelectionQueryPropertyWidget::query | ( | ) | const |
Get/Set the query string.
|
signal |
|
friend |
Definition at line 60 of file pqSelectionQueryPropertyWidget.h.
|
friend |
Definition at line 63 of file pqSelectionQueryPropertyWidget.h.
|
friend |
Definition at line 64 of file pqSelectionQueryPropertyWidget.h.
|
readwrite |
Definition at line 35 of file pqSelectionQueryPropertyWidget.h.
1.8.13 on Sat Jan 11 2025