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

RSSwitch allows for manipulation of the Realtime and Simulation 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 showRealtimeMode ()
 Switches to Realtime mode. More...
 
void showSimulationMode ()
 Switches to Simulation mode. More...
 
void modeSwitched (bool)
 This event is emitted when the mode is switched between Realtime and Simulation. More...
 

Detailed Description

RSSwitch allows for manipulation of the Realtime and Simulation toggle switches.

Member Function Documentation

◆ modeSwitched()

void RSSwitch::modeSwitched ( bool  )

This event is emitted when the mode is switched between Realtime and Simulation.

  • isRealtime, true if the mode is switched to Realtime mode, otherwise false.

IPC event.

◆ setDisabled()

void RSSwitch::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 RSSwitch::setVisible ( bool  )

Shows or hides this widget from view.

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

◆ setWidgetDisable()

void RSSwitch::setWidgetDisable ( string  ,
bool   
)

Enables or disables the specified child widget.

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

◆ setWidgetVisible()

void RSSwitch::setWidgetVisible ( string  ,
bool   
)

Shows or hides the specified child widget.

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

◆ showRealtimeMode()

void RSSwitch::showRealtimeMode ( )

Switches to Realtime mode.

◆ showSimulationMode()

void RSSwitch::showSimulationMode ( )

Switches to Simulation mode.


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