Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
pqApplyBehavior Class Reference

pqApplyBehavior collects the logic that needs to happen after the user hits "Apply" on the pqPropertiesPanel. More...

#include <pqApplyBehavior.h>

Inherits QObject.

Signals

void triggerApply ()
 

Public Member Functions

 pqApplyBehavior (QObject *parent=nullptr)
 
 ~pqApplyBehavior () override
 
void registerPanel (pqPropertiesPanel *panel)
 Register/unregister pqPropertiesPanel instances to monitor. More...
 
void unregisterPanel (pqPropertiesPanel *panel)
 Register/unregister pqPropertiesPanel instances to monitor. More...
 

Static Public Member Functions

static void hideInputIfRequired (pqPipelineFilter *filter, pqView *view)
 

Protected Slots

virtual void applied (pqPropertiesPanel *panel, pqProxy *proxy)
 Called when apply is triggered. More...
 
virtual void applied (pqPropertiesPanel *panel=nullptr)
 Called when apply is triggered. More...
 

Protected Member Functions

virtual void showData (pqPipelineSource *source, pqView *view)
 

Detailed Description

pqApplyBehavior collects the logic that needs to happen after the user hits "Apply" on the pqPropertiesPanel.

Since "Apply" is an important concept in ParaView application, it gets its own behavior so applications can customize it, if needed.

pqApplyBehavior can work with or without registered pqPropertiesPanel. One could still manually register any pqPropertiesPanel instance(s). pqParaViewBehaviors does that automatically for pqPropertiesPanel instances available during the startup.

This behavior is also responsible for managing the AutoApply mechanism with is controllable using vtkPVGeneralSettings

This behavior is also responsible for enabling/disabling the abort mechanism on the progressManager.

Definition at line 35 of file pqApplyBehavior.h.

Constructor & Destructor Documentation

◆ pqApplyBehavior()

pqApplyBehavior::pqApplyBehavior ( QObject *  parent = nullptr)

◆ ~pqApplyBehavior()

pqApplyBehavior::~pqApplyBehavior ( )
override

Member Function Documentation

◆ registerPanel()

void pqApplyBehavior::registerPanel ( pqPropertiesPanel panel)

Register/unregister pqPropertiesPanel instances to monitor.

◆ unregisterPanel()

void pqApplyBehavior::unregisterPanel ( pqPropertiesPanel panel)

Register/unregister pqPropertiesPanel instances to monitor.

◆ hideInputIfRequired()

static void pqApplyBehavior::hideInputIfRequired ( pqPipelineFilter filter,
pqView view 
)
static

◆ triggerApply

void pqApplyBehavior::triggerApply ( )
signal

◆ applied [1/2]

virtual void pqApplyBehavior::applied ( pqPropertiesPanel panel,
pqProxy proxy 
)
protectedvirtualslot

Called when apply is triggered.

Update the pipeline and show the data as needed. Also handle aborting the pipeline.

◆ applied [2/2]

virtual void pqApplyBehavior::applied ( pqPropertiesPanel panel = nullptr)
protectedvirtualslot

Called when apply is triggered.

Update the pipeline and show the data as needed. Also handle aborting the pipeline.

◆ showData()

virtual void pqApplyBehavior::showData ( pqPipelineSource source,
pqView view 
)
protectedvirtual

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