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

CommonToolbar allows UI manipulation of the right most vertical toolbar. 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 changeState (string)
 Changes the state of the common toolbar. More...
 

Detailed Description

CommonToolbar allows UI manipulation of the right most vertical toolbar.

Member Function Documentation

◆ changeState()

void CommonToolbar::changeState ( string  )

Changes the state of the common toolbar.

Parameters
state,thenew state for the Common Toolbar. Allowed states: select, move, note, delete, inspect, drawpolygon, addsimple, addcomplex

◆ setDisabled()

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

Shows or hides this widget from view.

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

◆ setWidgetDisable()

void CommonToolbar::setWidgetDisable ( string  ,
bool   
)

Enables or disables the specified child widget.

Parameters
widgetName,wherewidgetName can be one of the following: SelectBtn, MoveBtn, NoteBtn, DeleteBtn, InspectBtn, DrawPolyBtn, AddSimpleBtn, AddComplexPDUBtn.
bDisabled,trueto disable input events to this child widget, false to enable input events.

◆ setWidgetVisible()

void CommonToolbar::setWidgetVisible ( string  ,
bool   
)

Shows or hides the specified child widget.

Parameters
widgetName,wherewidgetName can be one of the following: SelectBtn, MoveBtn, NoteBtn, DeleteBtn, InspectBtn, DrawPolyBtn, AddSimpleBtn, AddComplexPDUBtn.
bVisible,trueto show this child widget, false to hide it.

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