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

PhysicalToolbar allows for UI manipulation of the Physical 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 showPhysicalLocationDialog ()
 Simulates clicking on the Navigation button. More...
 
void physicalLocationDialogShown ()
 This event is emitted when the physical location dialog is shown. More...
 
void switchToHomeRack ()
 Simulates clicking on the Working Closet button. More...
 
void switchToTopView ()
 Simulates clicking on the Intercity button. More...
 
void moveObject ()
 Simulates clicking on the Move Object button. More...
 
void addCity ()
 Simulates clicking on the New City button. More...
 
void addCloset ()
 Simulates clicking on the New Closet button. More...
 
void setBGImage ()
 Simulates clicking on the Set Background button. More...
 
void addGrid ()
 Simulates clicking on the Grid button. More...
 

Detailed Description

PhysicalToolbar allows for UI manipulation of the Physical toolbar.

Member Function Documentation

◆ addCity()

void PhysicalToolbar::addCity ( )

Simulates clicking on the New City button.

◆ addCloset()

void PhysicalToolbar::addCloset ( )

Simulates clicking on the New Closet button.

◆ addGrid()

void PhysicalToolbar::addGrid ( )

Simulates clicking on the Grid button.

◆ moveObject()

void PhysicalToolbar::moveObject ( )

Simulates clicking on the Move Object button.

◆ physicalLocationDialogShown()

void PhysicalToolbar::physicalLocationDialogShown ( )

This event is emitted when the physical location dialog is shown.

IPC event.

◆ setBGImage()

void PhysicalToolbar::setBGImage ( )

Simulates clicking on the Set Background button.

◆ setDisabled()

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

Shows or hides this widget from view.

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

◆ setWidgetDisable()

void PhysicalToolbar::setWidgetDisable ( string  ,
bool   
)

Enables or disables the specified child widget.

Parameters
widgetName,wherewidgetName can be one of the following: NavigationBtn, GotoTopBtn, GotoCityBtn, GotoBuildingBtn, GotoClosetBtn, NewCityBtn, NewBuildingBtn, NewRackBtn, MoveObjBtn, SetBGImageBtn, GridBtn, HomeBtn.
bDisabled,trueto disable input events to this child widget, false to enable input events.

◆ setWidgetVisible()

void PhysicalToolbar::setWidgetVisible ( string  ,
bool   
)

Shows or hides the specified child widget.

Parameters
widgetName,wherewidgetName can be one of the following: NavigationBtn, GotoTopBtn, GotoCityBtn, GotoBuildingBtn, GotoClosetBtn, NewCityBtn, NewBuildingBtn, NewRackBtn, MoveObjBtn, SetBGImageBtn, GridBtn, HomeBtn.
bVisible,trueto show this child widget, false to hide it.

◆ showPhysicalLocationDialog()

void PhysicalToolbar::showPhysicalLocationDialog ( )

Simulates clicking on the Navigation button.

◆ switchToHomeRack()

void PhysicalToolbar::switchToHomeRack ( )

Simulates clicking on the Working Closet button.

◆ switchToTopView()

void PhysicalToolbar::switchToTopView ( )

Simulates clicking on the Intercity button.


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