pqProxyWidget represents a panel for a vtkSMProxy.
More...
#include <pqProxyWidget.h>
Inherits QWidget.
|
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...
|
|
pqProxyWidget represents a panel for a vtkSMProxy.
pqProxyWidget creates widgets for each of the properties (or proxy groups) of the proxy respecting any registered pqPropertyWidgetInterface instances to create custom widgets. pqProxyWidget is used by pqPropertiesPanel to create panels for the source/filter and the display/representation sections of the panel.
pqProxyWidget doesn't show any widgets in the panel by default (after constructor). Use filterWidgets() or updatePanel() to show widgets matching criteria.
Note: This class replaces pqProxyPanel (and subclasses). pqProxyPanel is still available (and supported) for backwards compatibility.
Definition at line 57 of file pqProxyWidget.h.
◆ DocumentationType
Enumerator |
---|
NONE | |
USE_DESCRIPTION | |
USE_SHORT_HELP | |
USE_LONG_HELP | |
Definition at line 105 of file pqProxyWidget.h.
◆ pqProxyWidget() [1/2]
pqProxyWidget::pqProxyWidget |
( |
vtkSMProxy * |
proxy, |
|
|
QWidget * |
parent = nullptr , |
|
|
Qt::WindowFlags |
flags = Qt::WindowFlags{} |
|
) |
| |
◆ pqProxyWidget() [2/2]
pqProxyWidget::pqProxyWidget |
( |
vtkSMProxy * |
proxy, |
|
|
const QStringList & |
properties, |
|
|
bool |
showHeadersFooters = true , |
|
|
QWidget * |
parent = 0 , |
|
|
Qt::WindowFlags |
flags = Qt::WindowFlags{} |
|
) |
| |
◆ ~pqProxyWidget()
pqProxyWidget::~pqProxyWidget |
( |
| ) |
|
|
override |
◆ proxy()
Returns the proxy this panel shows.
◆ setApplyChangesImmediately()
void pqProxyWidget::setApplyChangesImmediately |
( |
bool |
value | ) |
|
When set to true, whenever the widget changes, the values are immediately pushed to the ServerManager property without having to wait for apply().
This is used for panels such as the display panel. Default is false.
◆ applyChangesImmediately()
bool pqProxyWidget::applyChangesImmediately |
( |
| ) |
const |
|
inline |
◆ useDocumentationForLabels() [1/2]
bool pqProxyWidget::useDocumentationForLabels |
( |
| ) |
const |
|
inline |
When this is true, the panel uses a descriptive layout where the documentation for properties is used instead of their labels.
pqProxyWidget automatically adopts this style of layout if <UseDocumentationForLabels />
hint is present in the proxy.
Definition at line 88 of file pqProxyWidget.h.
◆ newGroupLabelWidget()
static QWidget* pqProxyWidget::newGroupLabelWidget |
( |
const QString & |
label, |
|
|
QWidget * |
parentWidget, |
|
|
const QList< QWidget *> & |
buttons = QList< QWidget *>() |
|
) |
| |
|
static |
Returns a new widget that has the label and a h-line separator.
This is used on the pqProxyWidget to separate groups. Other widgets can use it for the same purpose, as needed.
◆ useDocumentationForLabels() [2/2]
static bool pqProxyWidget::useDocumentationForLabels |
( |
vtkSMProxy * |
proxy | ) |
|
|
static |
Returns true of the proxy provided has XML hints indicating that labels should use documentation instead of the XML label for the widgets in the UI.
◆ documentationText() [1/2]
Returns formatted (HTML or plainText) documentation for the property.
type
cannot be NONE.
◆ documentationText() [2/2]
Returns formatted (HTML or plainText) documentation for the proxy.
type
cannot be NONE.
◆ showProxyDocumentationInPanel()
Returns true if the proxy has XML hints indicating that the panel should show a header label for the documentation.
pqProxyWidget uses the <ShowProxyDocumentationInPanel />
hint for this purpose.
◆ changeAvailable
void pqProxyWidget::changeAvailable |
( |
| ) |
|
|
signal |
This signal is fired as soon as the user starts editing in the widget.
The editing may not be complete.
◆ changeFinished
void pqProxyWidget::changeFinished |
( |
| ) |
|
|
signal |
◆ restartRequired
void pqProxyWidget::restartRequired |
( |
| ) |
|
|
signal |
Indicates that a restart of the program is required for the setting to take effect.
◆ filterWidgets
bool pqProxyWidget::filterWidgets |
( |
bool |
show_advanced = false , |
|
|
const QString & |
filterText = QString() |
|
) |
| |
|
slot |
Updates the property widgets shown based on the filterText or show_advanced flag.
Calling filterWidgets() without any arguments will result in the panel showing all the non-advanced properties. Returns true, if any widgets were shown.
◆ apply
void pqProxyWidget::apply |
( |
| ) |
const |
|
slot |
Accepts the property widget changes changes.
◆ reset
void pqProxyWidget::reset |
( |
| ) |
const |
|
slot |
Cleans the property widget changes and resets the widgets.
◆ setView
void pqProxyWidget::setView |
( |
pqView * |
| ) |
|
|
slot |
Set the current view to use to show 3D widgets, if any for the panel.
◆ updatePanel
void pqProxyWidget::updatePanel |
( |
| ) |
|
|
slot |
◆ restoreDefaults
virtual bool pqProxyWidget::restoreDefaults |
( |
| ) |
|
|
virtualslot |
Restores application default proxy settings.
Returns true if any properties were modified.
◆ saveAsDefaults
void pqProxyWidget::saveAsDefaults |
( |
| ) |
|
|
slot |
Saves settings as defaults for proxy.
◆ createWidgetForProperty
create a widget for a property.
◆ showEvent()
void pqProxyWidget::showEvent |
( |
QShowEvent * |
event | ) |
|
|
overrideprotected |
◆ hideEvent()
void pqProxyWidget::hideEvent |
( |
QHideEvent * |
event | ) |
|
|
overrideprotected |
The documentation for this class was generated from the following file: