Public Member Functions | List of all members
pqShowWidgetDecorator Class Reference

pqShowWidgetDecorator can be used to show/hide a widget based on the status of another property not directly controlled by the widget. More...

#include <pqShowWidgetDecorator.h>

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

Public Member Functions

 pqShowWidgetDecorator (vtkPVXMLElement *config, pqPropertyWidget *parent)
 
bool canShowWidget (bool show_advanced) const override
 Override this method to override the visibility of the widget in the panel. More...
 
- Public Member Functions inherited from pqBoolPropertyWidgetDecorator
 pqBoolPropertyWidgetDecorator (vtkPVXMLElement *config, pqPropertyWidget *parent)
 
 ~pqBoolPropertyWidgetDecorator () override
 
bool isBoolProperty () const
 
- Public Member Functions inherited from pqPropertyWidgetDecorator
 pqPropertyWidgetDecorator (vtkPVXMLElement *xml, pqPropertyWidget *parent)
 Constructor. More...
 
 ~pqPropertyWidgetDecorator () override
 
pqPropertyWidgetparentWidget () const
 Returns the pqPropertyWidget parent. More...
 
virtual bool enableWidget () const
 Override this method to override the enable state of the widget in the panel. More...
 

Additional Inherited Members

- Signals inherited from pqBoolPropertyWidgetDecorator
void boolPropertyChanged ()
 
- Signals inherited from pqPropertyWidgetDecorator
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 ()
 
- Static Public Member Functions inherited from pqPropertyWidgetDecorator
static pqPropertyWidgetDecoratorcreate (vtkPVXMLElement *xml, pqPropertyWidget *parent)
 Creates a new decorator, given the xml config and the parent pqPropertyWidget for the decorator. More...
 
- Protected Member Functions inherited from pqPropertyWidgetDecorator
vtkPVXMLElementxml () const
 
- Protected Attributes inherited from pqBoolPropertyWidgetDecorator
vtkWeakPointer< vtkSMPropertyProperty
 
QString Function
 
int Index
 
unsigned long ObserverId
 
bool BoolProperty
 
QString Value
 

Detailed Description

pqShowWidgetDecorator can be used to show/hide a widget based on the status of another property not directly controlled by the widget.

Definition at line 15 of file pqShowWidgetDecorator.h.

Constructor & Destructor Documentation

◆ pqShowWidgetDecorator()

pqShowWidgetDecorator::pqShowWidgetDecorator ( vtkPVXMLElement config,
pqPropertyWidget parent 
)

Member Function Documentation

◆ canShowWidget()

bool pqShowWidgetDecorator::canShowWidget ( bool  show_advanced) const
inlineoverridevirtual

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 from pqPropertyWidgetDecorator.

Definition at line 23 of file pqShowWidgetDecorator.h.


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