ConnectionDialog

A virtual dialog that provides an interface that allows the user to adjust certain parameters for a Connection. More...

Inheritance diagram for ConnectionDialog:

Public Member Functions
	ConnectionDialog (QWidget *parent=nullptr)
	Constructs a ConnectionDialog.
void	acceptedSignal ()
	Emitted when the user accepts the connection configuration.
void	cancelSignal ()
	Emitted when the user cancels the dialog.
virtual void	clear ()=0
	Clears all user-entered connection parameters in the dialog.
virtual ConnectionInfo	connectionInfo () const =0
	Returns the connection info configured by the user in this dialog.
virtual Connection *	createConnection (const Model &model) const
	Creates a Connection object from the current dialog settings and associates it with a model.
virtual bool	handlesConnection (const ConnectionInfo &connection)=0
	Checks whether this dialog can handle the given connection type.
virtual void	setConnectionInfo (const ConnectionInfo &connection)=0
	Populates the dialog fields from the given connection info.

Detailed Description

A virtual dialog that provides an interface that allows the user to adjust certain parameters for a Connection.

---

Definition at line 12 of file ConnectionDialog.h.

Constructor & Destructor Documentation

ConnectionDialog()

ConnectionDialog::ConnectionDialog

(

QWidget *

parent = nullptr

)

Constructs a ConnectionDialog.

Parameters

[in]

parent

The parent widget.

Member Function Documentation

connectionInfo()

virtual ConnectionInfo ConnectionDialog::connectionInfo ( ) const

pure virtual

Returns the connection info configured by the user in this dialog.

Returns

The current ConnectionInfo.

Implemented in SerialConnectionDialog, and WebSocketConnectionDialog.

createConnection()

virtual Connection * ConnectionDialog::createConnection ( const Model & model ) const

virtual

Creates a Connection object from the current dialog settings and associates it with a model.

Parameters

[in]

model

The model to associate the connection with.

Returns

A newly created Connection, or nullptr if creation fails.

handlesConnection()

virtual bool ConnectionDialog::handlesConnection ( const ConnectionInfo & connection )

pure virtual

Checks whether this dialog can handle the given connection type.

Parameters

[in]

connection

The connection info to check.

Returns

Whether this dialog supports the connection.

Implemented in SerialConnectionDialog, and WebSocketConnectionDialog.

setConnectionInfo()

virtual void ConnectionDialog::setConnectionInfo ( const ConnectionInfo & connection )

pure virtual

Populates the dialog fields from the given connection info.

Parameters

[in]

connection

The connection info to display.

Implemented in SerialConnectionDialog, and WebSocketConnectionDialog.

---

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

• HardwareWidgets/Headers/ConnectionDialog.h