Cisco Packet Tracer Extensions API 8.1.0
API for communication between Cisco Packet Tracer application and its extension applications and modules.
Public Member Functions | List of all members
DialogManager Class Reference

DialogManager manages all the device dialogs. More...

Public Member Functions

void closeAll ()
 Closes all the device dialogs. More...
 
DeviceDialog getCurrentDialog ()
 Returns the currently focused dialog. More...
 
DeviceDialog getDialog (string)
 Returns the device dialog with the specified device name. More...
 
void dialogOpened (QString)
 This event is emitted when the dialog for the specified device is opened. More...
 
void dialogClosed (QString)
 This event is emitted when the dialog for the specified device is closed. More...
 
void dialogFocused (QString)
 This event is emitted when a dialog gets focused. More...
 
QString getFocusedDialogName ()
 Returns the device name of the dialog that is currently in focus. More...
 

Detailed Description

DialogManager manages all the device dialogs.

Member Function Documentation

◆ closeAll()

void DialogManager::closeAll ( )

Closes all the device dialogs.

◆ dialogClosed()

void DialogManager::dialogClosed ( QString  )

This event is emitted when the dialog for the specified device is closed.

  • deviceName, name of the device the event is for.

IPC event.

◆ dialogFocused()

void DialogManager::dialogFocused ( QString  )

This event is emitted when a dialog gets focused.

  • deviceName, name of the device

IPC event.

◆ dialogOpened()

void DialogManager::dialogOpened ( QString  )

This event is emitted when the dialog for the specified device is opened.

  • deviceName, name of the device the event is for..

IPC event.

◆ getCurrentDialog()

DeviceDialog DialogManager::getCurrentDialog ( )

Returns the currently focused dialog.

Returns
DeviceDialog, the DeviceDialog object of the currently focused dialog.

◆ getDialog()

DeviceDialog DialogManager::getDialog ( string  )

Returns the device dialog with the specified device name.

Parameters
deviceName,thename of the device of interest.
Returns
DeviceDialog, the DeviceDialog object with the specified device name.

◆ getFocusedDialogName()

QString DialogManager::getFocusedDialogName ( )

Returns the device name of the dialog that is currently in focus.

Returns
QString, the name of the device

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