NDEVR
API Documentation
SerialConnectionDialog

A ConnectionDialog that allows the user to modify a Serial port connection. More...

Inheritance diagram for SerialConnectionDialog:
[legend]
Collaboration diagram for SerialConnectionDialog:
[legend]

Classes

struct  Settings
 Stores the current serial port configuration parameters. More...

Public Member Functions

 SerialConnectionDialog (QWidget *parent=nullptr)
 Constructs a SerialConnectionDialog.
void apply ()
 Applies the current dialog settings and closes the dialog.
void cancel ()
 Cancels changes and closes the dialog.
void checkCustomBaudRatePolicy (int idx)
 Handles custom baud rate entry when the user selects the custom option.
void checkCustomDevicePathPolicy (int idx)
 Handles custom device path entry when the user selects the custom option.
virtual void clear () override
 Clears all dialog fields and resets to defaults.
virtual ConnectionInfo connectionInfo () const override
 Returns connection information derived from the current dialog settings.
QSerialPort * createSerialPort () const
 Creates and configures a new QSerialPort based on the current dialog settings.
virtual bool handlesConnection (const ConnectionInfo &connection) override
 Checks whether this dialog can handle the given connection type.
virtual void setConnectionInfo (const ConnectionInfo &connection) override
 Populates the dialog fields from the given connection information.
Settings settings () const
 Returns the current serial port settings configured in the dialog.
void showPortInfo (int idx)
 Displays detailed port information for the selected port index.
Public Member Functions inherited from ConnectionDialog
 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 ConnectioncreateConnection (const Model &model) const
 Creates a Connection object from the current dialog settings and associates it with a model.

Detailed Description

A ConnectionDialog that allows the user to modify a Serial port connection.


Definition at line 51 of file SerialConnectionDialog.h.

Constructor & Destructor Documentation

◆ SerialConnectionDialog()

SerialConnectionDialog::SerialConnectionDialog ( QWidget * parent = nullptr)
explicit

Constructs a SerialConnectionDialog.

Parameters
[in]parentThe parent widget.

References SerialConnectionDialog().

Referenced by SerialConnectionDialog().

Member Function Documentation

◆ checkCustomBaudRatePolicy()

void SerialConnectionDialog::checkCustomBaudRatePolicy ( int idx)

Handles custom baud rate entry when the user selects the custom option.

Parameters
[in]idxThe index of the selected baud rate option.

◆ checkCustomDevicePathPolicy()

void SerialConnectionDialog::checkCustomDevicePathPolicy ( int idx)

Handles custom device path entry when the user selects the custom option.

Parameters
[in]idxThe index of the selected device path option.

◆ connectionInfo()

virtual ConnectionInfo SerialConnectionDialog::connectionInfo ( ) const
overridevirtual

Returns connection information derived from the current dialog settings.

Returns
The ConnectionInfo describing the configured serial connection.

Implements ConnectionDialog.

◆ createSerialPort()

QSerialPort * SerialConnectionDialog::createSerialPort ( ) const

Creates and configures a new QSerialPort based on the current dialog settings.

Returns
A new QSerialPort instance configured with the current settings. Caller takes ownership.

◆ handlesConnection()

virtual bool SerialConnectionDialog::handlesConnection ( const ConnectionInfo & connection)
overridevirtual

Checks whether this dialog can handle the given connection type.

Parameters
[in]connectionThe connection information to check.
Returns
True if this dialog handles the specified connection.

Implements ConnectionDialog.

◆ setConnectionInfo()

virtual void SerialConnectionDialog::setConnectionInfo ( const ConnectionInfo & connection)
overridevirtual

Populates the dialog fields from the given connection information.

Parameters
[in]connectionThe connection information to apply.

Implements ConnectionDialog.

◆ settings()

Settings SerialConnectionDialog::settings ( ) const

Returns the current serial port settings configured in the dialog.

Returns
The current Settings struct.

◆ showPortInfo()

void SerialConnectionDialog::showPortInfo ( int idx)

Displays detailed port information for the selected port index.

Parameters
[in]idxThe index of the selected port in the combo box.

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