pqSMTKOperationPanel Class Reference

A panel that displays operation parameters for entry by the user. More...

#include <pqSMTKOperationPanel.h>

Inheritance diagram for pqSMTKOperationPanel:

Collaboration diagram for pqSMTKOperationPanel:

Classes
class	Internal

Public Slots
virtual void	observeWrapper (pqSMTKWrapper *, pqServer *)
	Called when a new client-server connection is added.
virtual void	unobserveWrapper (pqSMTKWrapper *, pqServer *)
	Called when a client-server connection is removed.
virtual bool	editOperation (smtk::operation::Operation::Index index)
	Populate the operation editor panel with the given operation index. More...
virtual bool	editOperation (smtk::operation::OperationPtr operation)
	Populate the operation panel with the given operation. More...
virtual void	runOperation ()
	Queue the (potentially asynchronous) operation whose parameters are shown to be run.
virtual void	runOperation (smtk::operation::OperationPtr operation)
	Queue the (potentially asynchronous) operation to be run immediately with default parameters.
virtual void	cancelEditing ()
	Abort editing operation parameters and reset the operation panel. More...

Signals
void	titleChanged (QString title)

Public Member Functions
	pqSMTKOperationPanel (QWidget *parent=nullptr)
smtk::extension::qtUIManager *	attributeUIManager () const
smtk::view::AvailableOperationsPtr	availableOperations () const

Protected Slots
virtual void	toggleFilterBySelection (bool)
virtual void	operationListClicked (QListWidgetItem *item)
virtual void	operationListDoubleClicked (QListWidgetItem *item)
virtual void	operationListActivated (QListWidgetItem *item)
virtual void	operationListCurrentItemChanged (QListWidgetItem *item, QListWidgetItem *prev)

Protected Member Functions
virtual void	displayDocumentation (const smtk::operation::Operation::Index &index)
	Show documentation for the given operation.

Protected Attributes
Internal *	m_p { nullptr }
pqSMTKWrapper *	m_wrapper
smtk::operation::OperationPtr	m_editing
smtk::extension::qtUIManager *	m_attrUIMgr { nullptr }
std::weak_ptr< smtk::resource::Resource >	m_rsrc
smtk::view::AvailableOperationsPtr	m_availableOperations
smtk::resource::Observers::Key	m_observer

Detailed Description

A panel that displays operation parameters for entry by the user.

This panel is composed of vertical segments:

• a list of available operations given the current selection;
• a panel showing operation parameters if the user indicates he wants to edit default parameters or there are parameters with no default on a requested operation;
• help for the operation parameters being displayed.

Segments may be hidden depending on the context.

This panel will create a new SMTK attribute UI manager each time the operation to be displayed is switched for a different resource.

Member Function Documentation

cancelEditing

void pqSMTKOperationPanel::cancelEditing ( )

virtualslot

Abort editing operation parameters and reset the operation panel.

This will not cancel any running operations.

editOperation [1/2]

bool pqSMTKOperationPanel::editOperation ( smtk::operation::Operation::Index  index )

virtualslot

Populate the operation editor panel with the given operation index.

If the operation editor is hidden and this method returns true, it will be shown.

editOperation [2/2]

virtual bool pqSMTKOperationPanel::editOperation ( smtk::operation::OperationPtr  operation )

virtualslot

Populate the operation panel with the given operation.

If the operation editor is hidden and this method returns true, it will be shown.

Member Data Documentation

m_wrapper

pqSMTKWrapper* pqSMTKOperationPanel::m_wrapper

protected

Initial value:

{
    nullptr
  }

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/release/smtk/extension/paraview/appcomponents/pqSMTKOperationPanel.h
• /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/release/smtk/extension/paraview/appcomponents/pqSMTKOperationPanel.cxx