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
DeviceDialog Class Reference

DeviceDialog are the collection of dialogs used to edit the devices. More...

Public Member Functions

void setVisible (bool)
 Shows or hides this device dialog widget from view. More...
 
void setWidgetVisible (string, bool)
 Shows or hides the specified child widget. More...
 
void setDisabled (bool)
 Enables or disables input events to this device dialog widget. More...
 
void setWidgetDisable (string, bool)
 Enables or disables the specified child widget. More...
 
void disableCLIImportExport (bool)
 Enable or disable copying and pasting from the CLI. More...
 
void reloadCustomHtmlTab ()
 Reload custom html tab. More...
 
bool hasDesktop ()
 Check if the device dialog has desktop tab. More...
 
bool setTabVisible (QString, bool)
 Shows or hides a tab in the device dialog. More...
 
bool addCustomDesktopApp (QString, QString, QString, QString)
 Add custom desktop app. More...
 
void desktopAppOpened (QString)
 This event is emitted when an app in the desktop tab is opened. More...
 
void tabChanged (QString)
 This event is emitted when the current tab changes. More...
 

Detailed Description

DeviceDialog are the collection of dialogs used to edit the devices.

Remarks
To manipulate the device configuration, use the Device object.

Member Function Documentation

◆ addCustomDesktopApp()

bool DeviceDialog::addCustomDesktopApp ( QString  ,
QString  ,
QString  ,
QString   
)

Add custom desktop app.

Parameters
name,applicationname
description,desktopapp description
iconPath,iconpath
customInterface,customInterface name

◆ desktopAppOpened()

void DeviceDialog::desktopAppOpened ( QString  )

This event is emitted when an app in the desktop tab is opened.

  • appName, name of the desktop app

IPC event.

◆ disableCLIImportExport()

void DeviceDialog::disableCLIImportExport ( bool  )

Enable or disable copying and pasting from the CLI.

Parameters
bDisable,trueto disable copying and pasting from the CLI, false to enable it.

◆ hasDesktop()

bool DeviceDialog::hasDesktop ( )

Check if the device dialog has desktop tab.

Returns
bool, true if it does and false if it does not

◆ reloadCustomHtmlTab()

void DeviceDialog::reloadCustomHtmlTab ( )

Reload custom html tab.

◆ setDisabled()

void DeviceDialog::setDisabled ( bool  )

Enables or disables input events to this device dialog widget.

Parameters
bDisabled,trueto disable this device dialog, false to enable it.

◆ setTabVisible()

bool DeviceDialog::setTabVisible ( QString  ,
bool   
)

Shows or hides a tab in the device dialog.

Parameters
tabName,thename of the tab (case-insensitive) e.g. "physical", "config", "cli", etc.
visible,trueto to show the tab, false to hide it.
Returns
bool, true if the tab was successfully shown or hidden, false otherwise.

◆ setVisible()

void DeviceDialog::setVisible ( bool  )

Shows or hides this device dialog widget from view.

Parameters
bVisible,trueto show this device dialog, false to hide it.

◆ setWidgetDisable()

void DeviceDialog::setWidgetDisable ( string  ,
bool   
)

Enables or disables the specified child widget.

Parameters
namewhere name can be one of the following: IPConfigBtn, IPConfigLbl, DialupBtn, DialupLbl, TerminalBtn, TerminalLbl, CommandPromptBtn, CommandPromptLbl, WebBrowserBtn, WebBrowserLbl, PCWirelessBtn, PCWirelessLbl, VPNBtn, VPNLbl, TrafficGeneratorBtn, TrafficGeneratorLbl, MIBBroswerBtn, MIBBrowserLbl, IPCommunicatorBtn, IPCommunicatorLbl, EmailBtn, EmailLbl, PPPoEDialerBtn, PPPoEDialerLbl, TextEditorBtn, TextEditorLbl, FirewallBtn, FirewallLbl, IPv6FirewallBtn, IPv6FirewallLbl, AAAAccountingBtn, AAAAccountingLbl, NetflowCollectorBtn, NetflowCollectorLbl, IoXSdkBtn, IoXSdkLbl, TftpLbl, TftpBtn, SshClientBtn, SshClientLbl, BluetoothBtn, BluetoothLbl, IoT Monitor_btn, IoT Monitor_lbl, IoT IDE_btn, IoT IDE_lbl, User Apps Manager_btn, User Apps Manager_lbl
bDisabled,trueto disable the child widget, false to enable it.

◆ setWidgetVisible()

void DeviceDialog::setWidgetVisible ( string  ,
bool   
)

Shows or hides the specified child widget.

Parameters
namewhere name can be one of the following: IPConfigBtn, IPConfigLbl, DialupBtn, DialupLbl, TerminalBtn, TerminalLbl, CommandPromptBtn, CommandPromptLbl, WebBrowserBtn, WebBrowserLbl, PCWirelessBtn, PCWirelessLbl, VPNBtn, VPNLbl, TrafficGeneratorBtn, TrafficGeneratorLbl, MIBBroswerBtn, MIBBrowserLbl, IPCommunicatorBtn, IPCommunicatorLbl, EmailBtn, EmailLbl, PPPoEDialerBtn, PPPoEDialerLbl, TextEditorBtn, TextEditorLbl, FirewallBtn, FirewallLbl, IPv6FirewallBtn, IPv6FirewallLbl, AAAAccountingBtn, AAAAccountingLbl, NetflowCollectorBtn, NetflowCollectorLbl, IoXSdkBtn, IoXSdkLbl, TftpLbl, TftpBtn, SshClientBtn, SshClientLbl, BluetoothBtn, BluetoothLbl, IoT Monitor_btn, IoT Monitor_lbl, IoT IDE_btn, IoT IDE_lbl, User Apps Manager_btn, User Apps Manager_lbl
bVisible,trueto show the child widget, false to hide it.

◆ tabChanged()

void DeviceDialog::tabChanged ( QString  )

This event is emitted when the current tab changes.

  • tabName, name of the currently tab

IPC event.


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