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

ToolBar is the QDocWindow instatiated in QMainWindow. More...

Public Member Functions

void setVisible (bool)
 Shows or hides this widget from view. More...
 
int count ()
 Returns the number of action items in this toolbar. More...
 
void setItemAtVisible (int, bool)
 Shows or hides the action item at the specified index. More...
 
void setItemAtEnabled (int, bool)
 Enables or disables the action item at the specified index. More...
 
void setItemVisible (string, bool)
 Shows or hides the specified action item. More...
 
void setItemEnabled (string, bool)
 Enables or disables the specified action item. More...
 
uuid addItem (QString, QString)
 Adds a action button item at the end of the toolbar. More...
 
void removeItemUuid (uuid)
 Removes the action button item with the specified UUID. More...
 
MenuItem getItemByUuid (uuid)
 Returns the action button item with the specified UUID. More...
 
void setItemObjectEnabled (string, bool)
 Enables or disables the specified action item by using object name. More...
 
uuid addItemWithName (QString, QString, QString)
 Adds a action button item at the end of the toolbar. More...
 

Detailed Description

ToolBar is the QDocWindow instatiated in QMainWindow.

Member Function Documentation

◆ addItem()

uuid ToolBar::addItem ( QString  ,
QString   
)

Adds a action button item at the end of the toolbar.

Parameters
text,thename of the button.
iconPath,thefull path of the image to use in the button.
Returns
uuid, the UUID of the action button item that was added.

◆ addItemWithName()

uuid ToolBar::addItemWithName ( QString  ,
QString  ,
QString   
)

Adds a action button item at the end of the toolbar.

Parameters
text,thename of the button.
iconPath,thefull path of the image to use in the button.
name,theobject name assigned to the button action.
Returns
uuid, the UUID of the action button item that was added.

◆ count()

int ToolBar::count ( )

Returns the number of action items in this toolbar.

Returns
int, the number of action items in this toolbar.

◆ getItemByUuid()

MenuItem ToolBar::getItemByUuid ( uuid  )

Returns the action button item with the specified UUID.

Parameters
id,theUUID of the action button item of interest.
Returns
MenuItem, the action button item object with the specified UUID.

◆ removeItemUuid()

void ToolBar::removeItemUuid ( uuid  )

Removes the action button item with the specified UUID.

Parameters
id,theUUID of the action button item of interest.

◆ setItemAtEnabled()

void ToolBar::setItemAtEnabled ( int  ,
bool   
)

Enables or disables the action item at the specified index.

Parameters
index,theindex of the action item.
bEnabled,trueto enable the action item, false to disable it.

◆ setItemAtVisible()

void ToolBar::setItemAtVisible ( int  ,
bool   
)

Shows or hides the action item at the specified index.

Parameters
index,theindex of the action item.
bVisible,trueto show the action item, false to hide it.

◆ setItemEnabled()

void ToolBar::setItemEnabled ( string  ,
bool   
)

Enables or disables the specified action item.

Parameters
name,thename of the action item.
bEnabled,trueto enable the action item, false to disable it.

◆ setItemObjectEnabled()

void ToolBar::setItemObjectEnabled ( string  ,
bool   
)

Enables or disables the specified action item by using object name.

Parameters
name,theobject name of the action item.
bEnabled,trueto enable the action item, false to disable it.

◆ setItemVisible()

void ToolBar::setItemVisible ( string  ,
bool   
)

Shows or hides the specified action item.

Parameters
name,thename of the action item.
bVisible,trueto show the action item, false to hide it.

◆ setVisible()

void ToolBar::setVisible ( bool  )

Shows or hides this widget from view.

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

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