pqPVApplicationCore is the application code used by ParaView-based applications that use more of ParaView's functionality than that provided by pqApplicationCore such as the the selection manager, animation manager etc. More...

#include <pqPVApplicationCore.h>

Inheritance diagram for pqPVApplicationCore:

[legend]

Collaboration diagram for pqPVApplicationCore:

[legend]

Public Slots
void	quickLaunch ()
	Pops-up the quick launch dialog. More...

void	startSearch ()
	Pops-up the search dialog if the focused widget is QAsbstractItemView type. More...

Public Slots inherited from pqApplicationCore
void	prepareForQuit ()
	Applications calls this to ensure that any cleanup is performed correctly. More...

void	quit ()
	Calls QCoreApplication::quit(). More...

void	loadConfiguration (const QString &filename)
	Load configuration xml. More...

void	loadConfigurationXML (const char *xmldata)

void	render ()
	Renders all windows. More...

Signals
void	aboutToShowQuickLaunch ()
	Emitted whenever the quickLaunch dialog is about to show. More...

Signals inherited from pqApplicationCore
void	aboutToLoadState (vtkPVXMLElement *root)
	Fired before a state xml is being loaded. More...

void	stateLoaded (vtkPVXMLElement root, vtkSMProxyLocator locator)
	Fired when a state file is loaded successfully. More...

void	stateSaved (vtkPVXMLElement *root)
	Fired to save state xml. More...

void	undoStackChanged (pqUndoStack *)
	Fired when the undo stack is set. More...

void	loadXML (vtkPVXMLElement *)
	Fired on loadConfiguration(). More...

void	forceFilterMenuRefresh ()
	Fired when the filter menu state needs to be manually updated. More...

void	updateMasterEnableState (bool)
	Fired when master changed. More...

void	clientEnvironmentDone ()
	Fired when the ParaView Client infrastructure has completed setting up the environment. More...

Public Member Functions
	pqPVApplicationCore (int &argc, char *argv, pqOptions options=0)

	~pqPVApplicationCore () override

pqSelectionManager *	selectionManager () const
	Provides access to the selection manager. More...

pqAnimationManager *	animationManager () const
	Provides access to the animation manager. More...

pqTestUtility *	testUtility () override
	Provides access to the test utility. More...

pqPythonManager *	pythonManager () const
	Provides access to the python manager. More...

virtual void	registerForQuicklaunch (QWidget *)
	ParaView provides a mechanism to trigger menu actions using a quick-launch dialog. More...

void	loadStateFromPythonFile (const QString &filename, pqServer *server)

Public Member Functions inherited from pqApplicationCore
	pqApplicationCore (int &argc, char *argv, pqOptions options=0, QObject *parent=0)
	Preferred constructor. More...

pqOptions *	getOptions () const
	Provides access to the command line options object. More...

pqObjectBuilder *	getObjectBuilder () const
	Get the Object Builder. More...

void	setUndoStack (pqUndoStack *stack)
	Set/Get the application's central undo stack. More...

pqUndoStack *	getUndoStack () const

void	registerManager (const QString &function, QObject *manager)
	Custom Applications may need use various "managers" All such manager can be registered with the pqApplicationCore so that that can be used by other components of the application. More...

QObject *	manager (const QString &function)
	Returns a manager for a particular function, if any. More...

void	unRegisterManager (const QString &function)
	Unregisters a manager for a particular function, if any. More...

void	registerDocumentation (const QString &filename)
	QHelpEngine doesn't like filenames in resource space. More...

pqServerManagerObserver *	getServerManagerObserver ()
	ServerManagerObserver observer the vtkSMProxyManager for changes to the server manager and fires signals on certain actions such as registeration/unregistration of proxies etc. More...

pqServerManagerModel *	getServerManagerModel () const
	ServerManagerModel is the representation of the ServerManager using pqServerManagerModelItem subclasses. More...

pqInterfaceTracker *	interfaceTracker () const
	Locates the interface tracker for the application. More...

pqLinksModel *	getLinksModel () const
	pqLinksModel is the model used to keep track of proxy/property links maintained by vtkSMProxyManager. More...

pqMainWindowEventManager *	getMainWindowEventManager () const
	pqMainWindowManager manages signals called for main window events. More...

pqPluginManager *	getPluginManager () const
	pqPluginManager manages all functionality associated with loading plugins. More...

pqProgressManager *	getProgressManager () const
	ProgressManager is the manager that streamlines progress. More...

pqRecentlyUsedResourcesList &	recentlyUsedResources ()
	Returns the set of recently-used resources i.e. More...

pqServerConfigurationCollection &	serverConfigurations ()
	Returns the collection of server configurations known. More...

pqSettings *	settings ()
	Get the application settings. More...

void	clearSettings ()
	Clears the settings. More...

vtkPVXMLElement *	saveState ()
	Save the ServerManager state to a XML element. More...

bool	saveState (const QString &filename)
	Save the ServerManager state to a file. More...

void	loadState (vtkPVXMLElement root, pqServer server, vtkSMStateLoader *loader=NULL)
	Loads the ServerManager state. More...

void	loadState (const char filename, pqServer server, vtkSMStateLoader *loader=NULL)
	Load state xml from a file. More...

void	loadStateFromString (const char xmlcontents, pqServer server, vtkSMStateLoader *loader=NULL)
	Loads state from an in-memory buffer. More...

void	clearViewsForLoadingState (pqServer *server)

void	loadStateIncremental (vtkPVXMLElement root, pqServer server, vtkSMStateLoader *loader=NULL)
	Same as loadState() except that it doesn't clear the current visualization state. More...

void	loadStateIncremental (const QString &filename, pqServer server, vtkSMStateLoader loader=NULL)

void	setLoadingState (bool value)
	Set the loading state flag. More...

bool	isLoadingState ()
	Check to see if its in the process of loading a state Reliance on this flag is chimerical since we cannot set this ivar when state file is being loaded from python shell. More...

pqServer *	getActiveServer () const
	returns the active server is any. More...

	~pqApplicationCore () override
	Destructor. More...

void	_paraview_client_environment_complete ()
	INTERNAL. More...

Static Public Member Functions
static pqPVApplicationCore *	instance ()
	Returns the pqPVApplicationCore instance. More...

Static Public Member Functions inherited from pqApplicationCore
static pqApplicationCore *	instance ()

Protected Member Functions
bool	eventFilter (QObject obj, QEvent event) override
	Override event filter in order to catch file association mechanism. More...

Protected Attributes
QPointer< pqSelectionManager >	SelectionManager

QPointer< pqAnimationManager >	AnimationManager

pqPythonManager *	PythonManager

QList< QPointer< QWidget > >	QuickLaunchMenus

Protected Attributes inherited from pqApplicationCore
bool	LoadingState

pqOptions *	Options

pqLinksModel *	LinksModel

pqObjectBuilder *	ObjectBuilder

pqInterfaceTracker *	InterfaceTracker

pqMainWindowEventManager *	MainWindowEventManager

pqPluginManager *	PluginManager

pqProgressManager *	ProgressManager

pqServerManagerModel *	ServerManagerModel

pqServerManagerObserver *	ServerManagerObserver

pqUndoStack *	UndoStack

pqRecentlyUsedResourcesList *	RecentlyUsedResourcesList

pqServerConfigurationCollection *	ServerConfigurations

pqSettings *	Settings

QPointer< pqTestUtility >	TestUtility

Additional Inherited Members
Protected Slots inherited from pqApplicationCore
void	onStateLoaded (vtkPVXMLElement root, vtkSMProxyLocator locator)

void	onStateSaved (vtkPVXMLElement *root)

void	onHelpEngineWarning (const QString &)

Detailed Description

pqPVApplicationCore is the application code used by ParaView-based applications that use more of ParaView's functionality than that provided by pqApplicationCore such as the the selection manager, animation manager etc.

Definition at line 53 of file pqPVApplicationCore.h.

Constructor & Destructor Documentation

◆ pqPVApplicationCore()

pqPVApplicationCore::pqPVApplicationCore	(	int &	argc,
		char **	argv,
		pqOptions *	options = `0`
	)

◆ ~pqPVApplicationCore()

pqPVApplicationCore::~pqPVApplicationCore ( )

override

Member Function Documentation

◆ instance()

static pqPVApplicationCore* pqPVApplicationCore::instance ( )

inlinestatic

Returns the pqPVApplicationCore instance.

If no pqPVApplicationCore has been created then return NULL.

Definition at line 66 of file pqPVApplicationCore.h.

◆ selectionManager()

pqSelectionManager* pqPVApplicationCore::selectionManager ( ) const

Provides access to the selection manager.

Selection manager provides access to the ParaView wide data selection mechanism. This must not be confused with the active-object selection.

◆ animationManager()

pqAnimationManager* pqPVApplicationCore::animationManager ( ) const

Provides access to the animation manager.

Animation manager helps with the

◆ testUtility()

pqTestUtility* pqPVApplicationCore::testUtility ( )

overridevirtual

Provides access to the test utility.

Reimplemented from pqApplicationCore.

◆ pythonManager()

pqPythonManager* pqPVApplicationCore::pythonManager ( ) const

Provides access to the python manager.

This is non-null only when paraview is compiled with python support i.e. PARAVIEW_USE_PYTHON is ON.

◆ registerForQuicklaunch()

virtual void pqPVApplicationCore::registerForQuicklaunch ( QWidget * )

virtual

ParaView provides a mechanism to trigger menu actions using a quick-launch dialog.

Applications can register menus action from which should be launch-able from the quick-launch dialog. Typical candidates are the sources menu, filters menu etc.

◆ loadStateFromPythonFile()

void pqPVApplicationCore::loadStateFromPythonFile	(	const QString &	filename,
		pqServer *	server
	)

◆ quickLaunch

void pqPVApplicationCore::quickLaunch ( )

slot

Pops-up the quick launch dialog.

◆ startSearch

void pqPVApplicationCore::startSearch ( )

slot

Pops-up the search dialog if the focused widget is QAsbstractItemView type.

◆ aboutToShowQuickLaunch

void pqPVApplicationCore::aboutToShowQuickLaunch ( )

signal

Emitted whenever the quickLaunch dialog is about to show.

This can be used to update the menu items (QActions) that will be shown in the quick-launch dialog.

◆ eventFilter()

bool pqPVApplicationCore::eventFilter	(	QObject *	obj,
		QEvent *	event
	)

overrideprotected

Override event filter in order to catch file association mechanism.

Member Data Documentation

◆ SelectionManager

QPointer<pqSelectionManager> pqPVApplicationCore::SelectionManager

protected

Definition at line 130 of file pqPVApplicationCore.h.

◆ AnimationManager

QPointer<pqAnimationManager> pqPVApplicationCore::AnimationManager

protected

Definition at line 131 of file pqPVApplicationCore.h.

◆ PythonManager

pqPythonManager* pqPVApplicationCore::PythonManager

protected

Definition at line 133 of file pqPVApplicationCore.h.

◆ QuickLaunchMenus

QList<QPointer<QWidget> > pqPVApplicationCore::QuickLaunchMenus

protected

Definition at line 134 of file pqPVApplicationCore.h.

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

/builds/gitlab-kitware-sciviz-ci/Qt/ApplicationComponents/pqPVApplicationCore.h

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ pqPVApplicationCore()

◆ ~pqPVApplicationCore()

Member Function Documentation

◆ instance()

◆ selectionManager()

◆ animationManager()

◆ testUtility()

◆ pythonManager()

◆ registerForQuicklaunch()

◆ loadStateFromPythonFile()

◆ quickLaunch

◆ startSearch

◆ aboutToShowQuickLaunch

◆ eventFilter()

Member Data Documentation

◆ SelectionManager

◆ AnimationManager

◆ PythonManager

◆ QuickLaunchMenus