pqServerConnectReaction Class Reference

Reaction for connecting to a server. More...

#include <pqServerConnectReaction.h>

Inheritance diagram for pqServerConnectReaction:

Collaboration diagram for pqServerConnectReaction:

Public Member Functions
	pqServerConnectReaction (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	connectToServerWithWarning ()
	Creates a server connection using the server connection dialog. More...
static void	connectToServer ()
static bool	connectToServerUsingConfigurationName (const char *config_name, bool showConnectionDialog=true)
	ParaView names server configurations (in pvsc files). More...
static bool	connectToServerUsingConfiguration (const pqServerConfiguration &config, bool showConnectionDialog=true)
	To connect to a server given a configuration, use this API. More...
static bool	connectToServer (const pqServerResource &resource, bool showConnectionDialog=true)
	Connect to server using the resource. More...

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

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

Detailed Description

Reaction for connecting to a server.

Definition at line 16 of file pqServerConnectReaction.h.

Constructor & Destructor Documentation

pqServerConnectReaction()

pqServerConnectReaction::pqServerConnectReaction

(

QAction *

parent

)

Constructor.

Parent cannot be nullptr.

Member Function Documentation

connectToServerWithWarning()

static void pqServerConnectReaction::connectToServerWithWarning ( )

static

Creates a server connection using the server connection dialog.

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

connectToServer() [1/2]

static void pqServerConnectReaction::connectToServer ( )

static

connectToServerUsingConfigurationName()

static bool pqServerConnectReaction::connectToServerUsingConfigurationName ( const char *  config_name, bool  showConnectionDialog = true  )

static

ParaView names server configurations (in pvsc files).

To connect to a server using the configuration specified, use this API.

connectToServerUsingConfiguration()

static bool pqServerConnectReaction::connectToServerUsingConfiguration ( const pqServerConfiguration &  config, bool  showConnectionDialog = true  )

static

To connect to a server given a configuration, use this API.

connectToServer() [2/2]

static bool pqServerConnectReaction::connectToServer ( const pqServerResource &  resource, bool  showConnectionDialog = true  )

static

Connect to server using the resource.

This will create a temporary configuration for the resource.

onTriggered()

void pqServerConnectReaction::onTriggered ( )

inlineoverrideprotectedvirtual

Called when the action is triggered.

Reimplemented from pqReaction.

Definition at line 58 of file pqServerConnectReaction.h.

---

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

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