ParaView
|
pqPropertyWidgetDecorator provides a mechanism to decorate pqPropertyWidget instances to add logic to the widget to add additional control logic. More...
#include <pqPropertyWidgetDecorator.h>
Signals | |
void | visibilityChanged () |
This signal is fired whenever the decorator has determined that the panel may need a refresh since the state of the system has changed which would deem changes in the widget visibility or enable state. More... | |
void | enableStateChanged () |
Public Member Functions | |
pqPropertyWidgetDecorator (vtkPVXMLElement *xml, pqPropertyWidget *parent) | |
Constructor. More... | |
virtual | ~pqPropertyWidgetDecorator () |
pqPropertyWidget * | parentWidget () const |
Returns the pqPropertyWidget parent. More... | |
virtual bool | canShowWidget (bool show_advanced) const |
Override this method to override the visibility of the widget in the panel. More... | |
virtual bool | enableWidget () const |
Override this method to override the enable state of the widget in the panel. More... | |
Protected Member Functions | |
vtkPVXMLElement * | xml () const |
pqPropertyWidgetDecorator provides a mechanism to decorate pqPropertyWidget instances to add logic to the widget to add additional control logic.
Subclasses can be used to logic to control when the widget is enabled/disabled, hidden/visible, etc. based on values of other properties of UI elements.
Definition at line 45 of file pqPropertyWidgetDecorator.h.
pqPropertyWidgetDecorator::pqPropertyWidgetDecorator | ( | vtkPVXMLElement * | xml, |
pqPropertyWidget * | parent | ||
) |
Constructor.
parent
cannot be NULL. xml
is the XML element from the <Hints> section for the proxy/property that resulted in the creation of the decorator. Decorators can be provided configuration parameters from the XML.
|
virtual |
pqPropertyWidget* pqPropertyWidgetDecorator::parentWidget | ( | ) | const |
Returns the pqPropertyWidget parent.
|
inlinevirtual |
Override this method to override the visibility of the widget in the panel.
This is called after the generic tests for advanced and text filtering are passed. Since there can be multiple decorators, the first decorator that returns 'false' wins. Default implementation returns true. Thus subclasses typically override this method only to force the widget invisible given the current state.
Reimplemented in pqGenericPropertyWidgetDecorator, pqOSPRayHidingDecorator, and pqShowWidgetDecorator.
Definition at line 66 of file pqPropertyWidgetDecorator.h.
|
inlinevirtual |
Override this method to override the enable state of the widget in the panel.
This is called after the generic tests for advanced and text filtering are passed. Since there can be multiple decorators, the first decorator that returns 'false' wins. Default implementation returns true. Thus subclasses typically override this method only to force the widget disabled given the current state.
Reimplemented in pqGenericPropertyWidgetDecorator, pqInputDataTypeDecorator, and pqEnableWidgetDecorator.
Definition at line 78 of file pqPropertyWidgetDecorator.h.
|
signal |
This signal is fired whenever the decorator has determined that the panel may need a refresh since the state of the system has changed which would deem changes in the widget visibility or enable state.
|
signal |
|
protected |