Public Member Functions | List of all members
pqBlockContextMenu Class Reference

add context menu items to control block appearance properties. More...

#include <pqBlockContextMenu.h>

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

Public Member Functions

 pqBlockContextMenu (QObject *parent=nullptr)
 
 ~pqBlockContextMenu () override
 
bool contextMenu (QMenu *menu, pqView *viewContext, const QPoint &viewPoint, pqRepresentation *dataContext, const QStringList &dataBlockContext) const override
 This is a newer variant of the contextMenu where the dataBlockContext is provided as selectors instead of composite ids. More...
 
int priority () const override
 This method's return value is used to set the precedence of the interface. More...
 
- Public Member Functions inherited from pqContextMenuInterface
 pqContextMenuInterface ()
 
virtual ~pqContextMenuInterface ()
 
virtual bool contextMenu (QMenu *menu, pqView *viewContext, const QPoint &viewPoint, pqRepresentation *dataContext, const QList< unsigned int > &dataBlockContext) const
 This method is called when a context menu is requested, usually by a right click in a pqView instance. More...
 

Detailed Description

add context menu items to control block appearance properties.

pqBlockContextMenu is a concrete implementation of the pqContextMenuInterface that add context-menu actions to control display properties for chosen blocks. This is currently only supported for render view.

Definition at line 19 of file pqBlockContextMenu.h.

Constructor & Destructor Documentation

◆ pqBlockContextMenu()

pqBlockContextMenu::pqBlockContextMenu ( QObject *  parent = nullptr)

◆ ~pqBlockContextMenu()

pqBlockContextMenu::~pqBlockContextMenu ( )
override

Member Function Documentation

◆ contextMenu()

bool pqBlockContextMenu::contextMenu ( QMenu *  menu,
pqView viewContext,
const QPoint &  viewPoint,
pqRepresentation dataContext,
const QStringList &  dataBlockContext 
) const
overridevirtual

This is a newer variant of the contextMenu where the dataBlockContext is provided as selectors instead of composite ids.

Selectors are more reliable especially when dealing with partitioned datasets and their collections in distributed mode and hence should be preferred.

Reimplemented from pqContextMenuInterface.

◆ priority()

int pqBlockContextMenu::priority ( ) const
inlineoverridevirtual

This method's return value is used to set the precedence of the interface.

Interfaces with greater priority are invoked before others and may cause menu-building to terminate early. ParaView's default context-menu interface uses a priority of 0 and returns false.

If you wish to modify the default menu, assign a negative priority to your interface. If you wish to override the default menu, assign a positive priority to your interface and have contextMenu() return true.

Reimplemented from pqContextMenuInterface.

Definition at line 35 of file pqBlockContextMenu.h.


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