pqServerDisconnectReaction Class Reference

Reaction to disconnect from a server. More...

#include <pqServerDisconnectReaction.h>

Inheritance diagram for pqServerDisconnectReaction:

Collaboration diagram for pqServerDisconnectReaction:

Public Member Functions
	pqServerDisconnectReaction (QAction *parent)
	Constructor. More...
Public Member Functions inherited from pqReaction
	pqReaction (QAction *parent, Qt::ConnectionType type=Qt::AutoConnection)
	Constructor. More...
	~pqReaction () override
QAction *	parentAction () const
	Provides access to the parent action. More...

Static Public Member Functions
static void	disconnectFromServer ()
	Disconnects from active server. More...
static bool	disconnectFromServerWithWarning ()
	Disconnects from active server with a warning message to the user to confirm that active proxies will be destroyed, if any. More...

Protected Member Functions
void	onTriggered () override
	Called when the action is triggered. More...

Protected Attributes
pqTimer	UpdateTimer
Protected Attributes inherited from pqReaction
bool	IsMaster

Additional Inherited Members
Protected Slots inherited from pqReaction
virtual void	updateEnableState ()
virtual void	updateMasterEnableState (bool)

Detailed Description

Reaction to disconnect from a server.

Definition at line 14 of file pqServerDisconnectReaction.h.

Constructor & Destructor Documentation

pqServerDisconnectReaction()

pqServerDisconnectReaction::pqServerDisconnectReaction

(

QAction *

parent

)

Constructor.

Parent cannot be nullptr.

Member Function Documentation

disconnectFromServer()

static void pqServerDisconnectReaction::disconnectFromServer ( )

static

Disconnects from active server.

Note that this method is static. Applications can simply use this without having to create a reaction instance.

disconnectFromServerWithWarning()

static bool pqServerDisconnectReaction::disconnectFromServerWithWarning ( )

static

Disconnects from active server with a warning message to the user to confirm that active proxies will be destroyed, if any.

Returns true if disconnect happened, false if not i.e. the user cancelled the operation.

onTriggered()

void pqServerDisconnectReaction::onTriggered ( )

overrideprotectedvirtual

Called when the action is triggered.

Reimplemented from pqReaction.

Member Data Documentation

UpdateTimer

pqTimer pqServerDisconnectReaction::UpdateTimer

protected

Definition at line 47 of file pqServerDisconnectReaction.h.

---

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

• /builds/gitlab-kitware-sciviz-ci/Qt/ApplicationComponents/pqServerDisconnectReaction.h