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

PLSwitch allows for UI manipulation of the Physical and Logical workspace toggle switches. More...

Public Member Functions

void setVisible (bool)
 Shows or hides this 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 widget. More...
 
void setWidgetDisable (string, bool)
 Enables or disables the specified child widget. More...
 
void showLogicalMode ()
 Shows the Logical workspace. More...
 
void showPhysicalMode ()
 Shows the Physical workspace. More...
 
void modeSwitched (bool)
 This event is emitted when the workspace is changed to either Logical or Physical. More...
 

Detailed Description

PLSwitch allows for UI manipulation of the Physical and Logical workspace toggle switches.

Member Function Documentation

◆ modeSwitched()

void PLSwitch::modeSwitched ( bool  )

This event is emitted when the workspace is changed to either Logical or Physical.

  • isLogical, true if the new workspace is Logical, false if the new workspace is Physical.

IPC event.

◆ setDisabled()

void PLSwitch::setDisabled ( bool  )

Enables or disables input events to this widget.

Parameters
bDisabled,trueto disable input events to this widget, false to enable input events.

◆ setVisible()

void PLSwitch::setVisible ( bool  )

Shows or hides this widget from view.

Parameters
bVisible,trueto show this widget, false to hide it.

◆ setWidgetDisable()

void PLSwitch::setWidgetDisable ( string  ,
bool   
)

Enables or disables the specified child widget.

Parameters
widgetName,wherewidgetName can be one of the following: LogicalBtn, PhysicalBtn.
bDisabled,trueto disable input events to this child widget, false to enable input events.

◆ setWidgetVisible()

void PLSwitch::setWidgetVisible ( string  ,
bool   
)

Shows or hides the specified child widget.

Parameters
widgetName,wherewidgetName can be one of the following: LogicalBtn, PhysicalBtn.
bVisible,trueto show this child widget, false to hide it.

◆ showLogicalMode()

void PLSwitch::showLogicalMode ( )

Shows the Logical workspace.

◆ showPhysicalMode()

void PLSwitch::showPhysicalMode ( )

Shows the Physical workspace.


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