Classes | Public Member Functions | Protected Slots | Protected Member Functions | List of all members
pqStandardViewFrameActionsImplementation Class Reference

pqStandardViewFrameActionsImplementation implements pqViewFrameActionsInterface to add the default view toolbar buttons/actions used in ParaView for various types of views, including chart views and render views. More...

#include <pqStandardViewFrameActionsImplementation.h>

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

Classes

struct  ViewType
 

Public Member Functions

 pqStandardViewFrameActionsImplementation (QObject *parent=nullptr)
 
 ~pqStandardViewFrameActionsImplementation () override
 
void frameConnected (pqViewFrame *frame, pqView *view) override
 This method is called after a frame is assigned to a view. More...
 
- Public Member Functions inherited from pqViewFrameActionsInterface
virtual ~pqViewFrameActionsInterface ()
 

Protected Slots

void aboutToShowConvertMenu ()
 Called before the "Convert To" menu is shown. More...
 
void selectSurfaceCellsTriggered ()
 slots for various shortcuts. More...
 
void selectSurfacePointsTriggered ()
 
void selectFrustumCellsTriggered ()
 
void selectFrustumPointsTriggered ()
 
void selectBlocksTriggered ()
 
void escTriggered ()
 
void manageGroupExclusivity (QAction *)
 If a QAction is added to an exclusive QActionGroup, then a checked action cannot be unchecked by clicking on it. More...
 
void escapeableActionToggled (bool checked)
 A slot called when any action that can be "cancelled" with Esc is toggled. More...
 
void interactiveSelectionToggled (bool checked)
 A slot called when an interactive selection is toggled. More...
 
void captureViewTriggered ()
 This slot is called when a capture view action is triggered. More...
 

Protected Member Functions

virtual void setupEmptyFrame (QWidget *frame)
 called to setup empty frame. More...
 
virtual void addGenericActions (pqViewFrame *frame, pqView *view)
 called to add view type independent actions first. More...
 
virtual QActionGroup * addSelectionModifierActions (pqViewFrame *frame, pqView *view)
 called to add view type independent actions first. More...
 
virtual void addSeparator (pqViewFrame *frame, pqView *view)
 called to add a separator in the action bar More...
 
virtual void addContextViewActions (pqViewFrame *frame, pqContextView *chart_view)
 called to add context view actions. More...
 
virtual void addRenderViewActions (pqViewFrame *frame, pqRenderView *view)
 called to add render view actions. More...
 
virtual void addSpreadSheetViewActions (pqViewFrame *frame, pqSpreadSheetView *view)
 called to add actions/decorator for pqSpreadSheetView. More...
 
virtual bool isButtonVisible (const std::string &buttonName, pqView *view)
 check the XML hints to see if a button with the given name should be added to the view frame More...
 
virtual QList< ViewTypeavailableViewTypes ()
 Returns available view types in the application. More...
 
virtual pqViewhandleCreateView (const ViewType &viewType)
 Called when user clicks "Convert To" or create a view from the empty frame. More...
 
void invoked (pqViewFrame *, const ViewType &type, const QString &command)
 This is called either from an action in the "Convert To" menu, or from the buttons on an empty frame. More...
 

Detailed Description

pqStandardViewFrameActionsImplementation implements pqViewFrameActionsInterface to add the default view toolbar buttons/actions used in ParaView for various types of views, including chart views and render views.

Toolbar buttons/actions can be added/removed in the XML for a view using hints. For example,

* <Hints>
*   <StandardViewFrameActions default_actions="none" />
* </Hints>
* 

disables all toolbar buttons while

* <Hints>
*   <StandardViewFrameActions default_actions="none" />
*   <ToggleInteractionMode />
* </Hints>
* 

disables all toolbar buttons except for the button that toggles between 2D/3D camera interactions. This type of hint can be used to add only the toolbar buttons that are desired for the view.

To show all the default toolbar buttons except for the button that brings up the camera control dialog, use

* <Hints>
*   <StandardViewFrameActions>
*     <AdjustCamera visibility="never" />
*   </StandardViewFrameActions>
* </Hints>
* 

Definition at line 88 of file pqStandardViewFrameActionsImplementation.h.

Constructor & Destructor Documentation

◆ pqStandardViewFrameActionsImplementation()

pqStandardViewFrameActionsImplementation::pqStandardViewFrameActionsImplementation ( QObject *  parent = nullptr)

◆ ~pqStandardViewFrameActionsImplementation()

pqStandardViewFrameActionsImplementation::~pqStandardViewFrameActionsImplementation ( )
override

Member Function Documentation

◆ frameConnected()

void pqStandardViewFrameActionsImplementation::frameConnected ( pqViewFrame frame,
pqView view 
)
overridevirtual

This method is called after a frame is assigned to a view.

The view may be nullptr, indicating the frame has been assigned to an empty view. Frames are never reused (except a frame assigned to an empty view).

Implements pqViewFrameActionsInterface.

◆ aboutToShowConvertMenu

void pqStandardViewFrameActionsImplementation::aboutToShowConvertMenu ( )
protectedslot

Called before the "Convert To" menu is shown.

We populate the menu with actions for available view types.

◆ selectSurfaceCellsTriggered

void pqStandardViewFrameActionsImplementation::selectSurfaceCellsTriggered ( )
protectedslot

slots for various shortcuts.

◆ selectSurfacePointsTriggered

void pqStandardViewFrameActionsImplementation::selectSurfacePointsTriggered ( )
protectedslot

◆ selectFrustumCellsTriggered

void pqStandardViewFrameActionsImplementation::selectFrustumCellsTriggered ( )
protectedslot

◆ selectFrustumPointsTriggered

void pqStandardViewFrameActionsImplementation::selectFrustumPointsTriggered ( )
protectedslot

◆ selectBlocksTriggered

void pqStandardViewFrameActionsImplementation::selectBlocksTriggered ( )
protectedslot

◆ escTriggered

void pqStandardViewFrameActionsImplementation::escTriggered ( )
protectedslot

◆ manageGroupExclusivity

void pqStandardViewFrameActionsImplementation::manageGroupExclusivity ( QAction *  )
protectedslot

If a QAction is added to an exclusive QActionGroup, then a checked action cannot be unchecked by clicking on it.

We need that to work. Hence, we manually manage the exclusivity of the action group.

◆ escapeableActionToggled

void pqStandardViewFrameActionsImplementation::escapeableActionToggled ( bool  checked)
protectedslot

A slot called when any action that can be "cancelled" with Esc is toggled.

◆ interactiveSelectionToggled

void pqStandardViewFrameActionsImplementation::interactiveSelectionToggled ( bool  checked)
protectedslot

A slot called when an interactive selection is toggled.

◆ captureViewTriggered

void pqStandardViewFrameActionsImplementation::captureViewTriggered ( )
protectedslot

This slot is called when a capture view action is triggered.

◆ setupEmptyFrame()

virtual void pqStandardViewFrameActionsImplementation::setupEmptyFrame ( QWidget *  frame)
protectedvirtual

called to setup empty frame.

◆ addGenericActions()

virtual void pqStandardViewFrameActionsImplementation::addGenericActions ( pqViewFrame frame,
pqView view 
)
protectedvirtual

called to add view type independent actions first.

◆ addSelectionModifierActions()

virtual QActionGroup* pqStandardViewFrameActionsImplementation::addSelectionModifierActions ( pqViewFrame frame,
pqView view 
)
protectedvirtual

called to add view type independent actions first.

◆ addSeparator()

virtual void pqStandardViewFrameActionsImplementation::addSeparator ( pqViewFrame frame,
pqView view 
)
protectedvirtual

called to add a separator in the action bar

◆ addContextViewActions()

virtual void pqStandardViewFrameActionsImplementation::addContextViewActions ( pqViewFrame frame,
pqContextView chart_view 
)
protectedvirtual

called to add context view actions.

◆ addRenderViewActions()

virtual void pqStandardViewFrameActionsImplementation::addRenderViewActions ( pqViewFrame frame,
pqRenderView view 
)
protectedvirtual

called to add render view actions.

◆ addSpreadSheetViewActions()

virtual void pqStandardViewFrameActionsImplementation::addSpreadSheetViewActions ( pqViewFrame frame,
pqSpreadSheetView view 
)
protectedvirtual

called to add actions/decorator for pqSpreadSheetView.

◆ isButtonVisible()

virtual bool pqStandardViewFrameActionsImplementation::isButtonVisible ( const std::string buttonName,
pqView view 
)
protectedvirtual

check the XML hints to see if a button with the given name should be added to the view frame

◆ availableViewTypes()

virtual QList<ViewType> pqStandardViewFrameActionsImplementation::availableViewTypes ( )
protectedvirtual

Returns available view types in the application.

Used when setting up the "Convert To" menu or when filling up the empty-frame.

◆ handleCreateView()

virtual pqView* pqStandardViewFrameActionsImplementation::handleCreateView ( const ViewType viewType)
protectedvirtual

Called when user clicks "Convert To" or create a view from the empty frame.

◆ invoked()

void pqStandardViewFrameActionsImplementation::invoked ( pqViewFrame ,
const ViewType type,
const QString &  command 
)
protected

This is called either from an action in the "Convert To" menu, or from the buttons on an empty frame.


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