pqSMTKSubtractUI Class Reference

Provide applications a way to remove (and restore) portions of ParaView's UI. More...

#include <pqSMTKSubtractUI.h>

Inheritance diagram for pqSMTKSubtractUI:

Collaboration diagram for pqSMTKSubtractUI:

Public Slots
virtual void	toggleMenuItem (const std::string &itemPath, const std::string &sep="->", bool remove=true)
	Remove (or restore) a menu item (via its QAction) by its text name. More...
virtual void	removeMenuItem (const std::string &itemPath, const std::string &sep="->")
virtual void	restoreMenuItem (const std::string &itemPath, const std::string &sep="->")
virtual void	toggleMenuItemByObjectName (const std::string &itemObjectName, bool remove=true)
	Remove (or restore) a menu item (via its QAction) by its QObject name. More...
virtual void	removeMenuItemByObjectName (const std::string &itemObjectName)
virtual void	restoreMenuItemByObjectName (const std::string &itemObjectName)
virtual void	toggleToolbar (const std::string &toolbar, bool remove=true)
	Remove (or restore) a toolbar button (via its QAction).
virtual void	removeToolbar (const std::string &toolbar)
virtual void	restoreToolbar (const std::string &toolbar)
virtual void	toggleToolbarButton (const std::string &toolbar, const std::string &button, bool remove=true)
	Remove (or restore) a toolbar button (via its QAction).
virtual void	removeToolbarButton (const std::string &toolbar, const std::string &button)
virtual void	restoreToolbarButton (const std::string &toolbar, const std::string &button)
virtual void	toggleActionByObjectName (const std::string &action, bool remove=true)
	Remove (or restore) a QAction by its object name. More...
virtual void	removeActionByObjectName (const std::string &action)
virtual void	restoreActionByObjectName (const std::string &action)
virtual void	togglePanel (const std::string &panel, bool remove=true)
	Remove (or restore) a dock widget (panel) given its title.
virtual void	removePanel (const std::string &panel)
virtual void	restorePanel (const std::string &panel)

Static Public Member Functions
static pqSMTKSubtractUI *	instance (QObject *parent=nullptr)

Protected Member Functions
	pqSMTKSubtractUI (QObject *parent=nullptr)

Detailed Description

Provide applications a way to remove (and restore) portions of ParaView's UI.

Applications may call methods to hide (not just disable) or show (and enable) UI components present in ParaView at startup, including

• menu bars
• menu items
• toolbar buttons
• dock widgets (panels)

Member Function Documentation

toggleActionByObjectName

void pqSMTKSubtractUI::toggleActionByObjectName ( const std::string &  action, bool  remove = true  )

virtualslot

Remove (or restore) a QAction by its object name.

Note that this requires the developer to have assigned the action a name, not just a title.

toggleMenuItem

void pqSMTKSubtractUI::toggleMenuItem ( const std::string &  itemPath, const std::string &  sep = "->", bool  remove = true  )

virtualslot

Remove (or restore) a menu item (via its QAction) by its text name.

This method is often easier but not robust when language translations are enabled.

toggleMenuItemByObjectName

void pqSMTKSubtractUI::toggleMenuItemByObjectName ( const std::string &  itemObjectName, bool  remove = true  )

virtualslot

Remove (or restore) a menu item (via its QAction) by its QObject name.

This method is robust but requires the developer to have assigned the object a name.

---

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/pqSMTKSubtractUI.h
• /home/docs/checkouts/readthedocs.org/user_builds/smtk/checkouts/release/smtk/extension/paraview/appcomponents/pqSMTKSubtractUI.cxx