pqServerConnectDialog is a dialog that can be used to show the user a selection of server configurations to connect to a server. More...

#include <pqServerConnectDialog.h>

Inherits QDialog.

Signals
void	serverAdded ()
	Emitted when a server is added. More...

void	serverDeleted ()
	Emitted when a server is deleted. More...

Public Member Functions
	pqServerConnectDialog (QWidget *parent=nullptr, const pqServerResource &selector=pqServerResource())
	If `selector` is specified, only those server-configurations that match the selector's scheme and hostname are shown. More...

	~pqServerConnectDialog () override

const pqServerConfiguration &	configurationToConnect () const
	returns the configuration to connect to. More...

Static Public Member Functions
static bool	selectServer (pqServerConfiguration &selected_configuration, QWidget *dialogParent=nullptr, const pqServerResource &selector=pqServerResource())
	convenience method to determine which server to connect. More...

Protected Slots
void	updateConfigurations ()
	called to update the shown server configurations. More...

void	onServerSelected ()
	called when user selects a server. More...

void	editServer ()
	called when user clicks "edit-server" More...

void	addServer ()
	called when user clicks "add-server" More...

void	updateButtons ()
	Called when a server has been added or deleted. More...

void	updateServerType ()
	called when user changes the server-type. More...

void	goToFirstPage ()
	called to cancel . More...

void	acceptConfigurationPage1 ()
	called when user accepts the configuration page #1. More...

void	acceptConfigurationPage2 ()
	called when user accepts the configuration page #2. More...

void	editServerStartup ()
	called to proceed to page that allows the user to edit the startup. More...

void	onNameChanged ()

void	deleteServer ()
	called to delete one or all servers. More...

void	deleteAllServers ()

void	loadServers ()
	called to load/save servers. More...

void	saveServers ()

void	connect ()
	called to connect to selected server. More...

void	updateDialogTitle (int page_number)
	called when the main-stacked widget's active page changes. More...

void	fetchServers ()
	called when user clicks "Fetch Servers". More...

void	authenticationRequired (QNetworkReply , QAuthenticator )
	called when the importer needs authentication from the user. More...

void	updateImportableConfigurations ()
	called update importable configs. More...

void	importError (const QString &message)
	called to report error from importer. More...

void	importServersSelectionChanged ()
	called when user selects some servers to import. More...

void	importServers ()
	called to import selected configurations. More...

void	editSources ()
	called to edit the sources url. More...

void	saveSourcesList ()

void	cancelEditSources ()

Protected Member Functions
void	editConfiguration (const pqServerConfiguration &)

bool	serverNameExists (const QString &name)

Detailed Description

pqServerConnectDialog is a dialog that can be used to show the user a selection of server configurations to connect to a server.

This dialog can show all the server-configurations known to pqApplicationCore or show only a subset of those depending on whether a selector was specified in the constructor.

On successful completion, this dialog provides access to the server-configuration selected by the user. It does not make an real attempts to connect to that server.

Definition at line 29 of file pqServerConnectDialog.h.

Constructor & Destructor Documentation

◆ pqServerConnectDialog()

pqServerConnectDialog::pqServerConnectDialog	(	QWidget *	parent = `nullptr`,
		const pqServerResource &	selector = `pqServerResource()`
	)

If selector is specified, only those server-configurations that match the selector's scheme and hostname are shown.

◆ ~pqServerConnectDialog()

pqServerConnectDialog::~pqServerConnectDialog ( )

override

Member Function Documentation

◆ configurationToConnect()

const pqServerConfiguration& pqServerConnectDialog::configurationToConnect ( ) const

returns the configuration to connect to.

This returns a valid response only when pqServerConnectDialog::exec() returns QDialog::Accepted.

◆ selectServer()

static bool pqServerConnectDialog::selectServer	(	pqServerConfiguration &	selected_configuration,
		QWidget *	dialogParent = `nullptr`,
		const pqServerResource &	selector = `pqServerResource()`
	)

static

convenience method to determine which server to connect.

If the selector is specified and matches a single server, then the user is not presented with a dialog, otherwise the user can choose the configuration to use to connect to the server. When the method returns true, selected_configuration will be set to the chosen configuration.

◆ serverAdded

void pqServerConnectDialog::serverAdded ( )

signal

Emitted when a server is added.

◆ serverDeleted

void pqServerConnectDialog::serverDeleted ( )

signal

Emitted when a server is deleted.

◆ updateConfigurations

void pqServerConnectDialog::updateConfigurations ( )

protectedslot

called to update the shown server configurations.

◆ onServerSelected

void pqServerConnectDialog::onServerSelected ( )

protectedslot

called when user selects a server.

◆ editServer

void pqServerConnectDialog::editServer ( )

protectedslot

called when user clicks "edit-server"

◆ addServer

void pqServerConnectDialog::addServer ( )

protectedslot

called when user clicks "add-server"

◆ updateButtons

void pqServerConnectDialog::updateButtons ( )

protectedslot

Called when a server has been added or deleted.

◆ updateServerType

void pqServerConnectDialog::updateServerType ( )

protectedslot

called when user changes the server-type.

◆ goToFirstPage

void pqServerConnectDialog::goToFirstPage ( )

protectedslot

called to cancel .

◆ acceptConfigurationPage1

void pqServerConnectDialog::acceptConfigurationPage1 ( )

protectedslot

called when user accepts the configuration page #1.

◆ acceptConfigurationPage2

void pqServerConnectDialog::acceptConfigurationPage2 ( )

protectedslot

called when user accepts the configuration page #2.

◆ editServerStartup

void pqServerConnectDialog::editServerStartup ( )

protectedslot

called to proceed to page that allows the user to edit the startup.

◆ onNameChanged

void pqServerConnectDialog::onNameChanged ( )

protectedslot

◆ deleteServer

void pqServerConnectDialog::deleteServer ( )

protectedslot

called to delete one or all servers.

◆ deleteAllServers

void pqServerConnectDialog::deleteAllServers ( )

protectedslot

◆ loadServers

void pqServerConnectDialog::loadServers ( )

protectedslot

called to load/save servers.

◆ saveServers

void pqServerConnectDialog::saveServers ( )

protectedslot

◆ connect

void pqServerConnectDialog::connect ( )

protectedslot

called to connect to selected server.

◆ updateDialogTitle

void pqServerConnectDialog::updateDialogTitle ( int page_number )

protectedslot

called when the main-stacked widget's active page changes.

We update the dialog;s title text to match the page being displayed.

◆ fetchServers

void pqServerConnectDialog::fetchServers ( )

protectedslot

called when user clicks "Fetch Servers".

◆ authenticationRequired

void pqServerConnectDialog::authenticationRequired	(	QNetworkReply *	,
		QAuthenticator *
	)

protectedslot

called when the importer needs authentication from the user.

◆ updateImportableConfigurations

void pqServerConnectDialog::updateImportableConfigurations ( )

protectedslot

called update importable configs.

◆ importError

void pqServerConnectDialog::importError ( const QString & message )

protectedslot

called to report error from importer.

◆ importServersSelectionChanged

void pqServerConnectDialog::importServersSelectionChanged ( )

protectedslot

called when user selects some servers to import.

◆ importServers

void pqServerConnectDialog::importServers ( )

protectedslot

called to import selected configurations.

◆ editSources

void pqServerConnectDialog::editSources ( )

protectedslot

called to edit the sources url.

◆ saveSourcesList

void pqServerConnectDialog::saveSourcesList ( )

protectedslot

◆ cancelEditSources

void pqServerConnectDialog::cancelEditSources ( )

protectedslot

◆ editConfiguration()

void pqServerConnectDialog::editConfiguration ( const pqServerConfiguration & )

protected

◆ serverNameExists()

bool pqServerConnectDialog::serverNameExists ( const QString & name )

protected

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

/builds/gitlab-kitware-sciviz-ci/Qt/Components/pqServerConnectDialog.h

Signals

Public Member Functions

Static Public Member Functions

Protected Slots

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ pqServerConnectDialog()

◆ ~pqServerConnectDialog()

Member Function Documentation

◆ configurationToConnect()

◆ selectServer()

◆ serverAdded

◆ serverDeleted

◆ updateConfigurations

◆ onServerSelected

◆ editServer

◆ addServer

◆ updateButtons

◆ updateServerType

◆ goToFirstPage

◆ acceptConfigurationPage1

◆ acceptConfigurationPage2

◆ editServerStartup

◆ onNameChanged

◆ deleteServer

◆ deleteAllServers

◆ loadServers

◆ saveServers

◆ connect

◆ updateDialogTitle

◆ fetchServers

◆ authenticationRequired

◆ updateImportableConfigurations

◆ importError

◆ importServersSelectionChanged

◆ importServers

◆ editSources

◆ saveSourcesList

◆ cancelEditSources

◆ editConfiguration()

◆ serverNameExists()