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 | |
void | setName (QString) |
Allows to change cluster name to newName. More... | |
QString | getName () |
Returns cluster name. More... | |
void | nameChanged (QString, QString) |
Generated when cluster name changes to a new one. More... | |
QString | getId () |
Returns cluster ID. More... | |
void | idChanged (QString, QString) |
Generated when cluster ID changes to a new one. More... | |
int | getChildClusterCount () |
Returns the number of child cluster objects. More... | |
Cluster | getChildClusterAt (int) |
Returns child cluster object at a given index. More... | |
Cluster | getParentCluster () |
Returns parent cluster object. More... | |
double | getXCoordinate () |
Returns the current x-coordinate position in the Logical workspace for this cluster. More... | |
double | getYCoordinate () |
Returns the current y-coordinate position in the Logical workspace for this cluster. More... | |
double | getCenterXCoordinate () |
Returns the current x-coordinate position in the Logical workspace for this cluster. More... | |
double | getCenterYCoordinate () |
Returns the current y-coordinate position in the Logical workspace for this cluster. More... | |
bool | moveToLocationCentered (int, int) |
Moves this cluster to the specified location for its center in Logical workspace. More... | |
bool | moveToLocation (int, int) |
Moves this cluster to the specified location in Logical workspace. More... | |
void | setIconPath (QString) |
Sets the icon to use for the cluster. More... | |
QString | getIconPath () |
Returns the path to the image to use for the cluster icon. More... | |
\brief Clusters used to group clusters inside logical workspace
double Cluster::getCenterXCoordinate | ( | ) |
Returns the current x-coordinate position in the Logical workspace for this cluster.
double Cluster::getCenterYCoordinate | ( | ) |
Returns the current y-coordinate position in the Logical workspace for this cluster.
Cluster Cluster::getChildClusterAt | ( | int | ) |
Returns child cluster object at a given index.
index,the | index of child cluster to return. |
int Cluster::getChildClusterCount | ( | ) |
Returns the number of child cluster objects.
QString Cluster::getIconPath | ( | ) |
Returns the path to the image to use for the cluster icon.
QString Cluster::getId | ( | ) |
Returns cluster ID.
QString Cluster::getName | ( | ) |
Returns cluster name.
Cluster Cluster::getParentCluster | ( | ) |
Returns parent cluster object.
double Cluster::getXCoordinate | ( | ) |
Returns the current x-coordinate position in the Logical workspace for this cluster.
double Cluster::getYCoordinate | ( | ) |
Returns the current y-coordinate position in the Logical workspace for this cluster.
void Cluster::idChanged | ( | QString | , |
QString | |||
) |
Generated when cluster ID changes to a new one.
IPC event.
bool Cluster::moveToLocation | ( | int | , |
int | |||
) |
Moves this cluster to the specified location in Logical workspace.
x,the | new x-coordinate position. |
y,the | new y-coordinate position. |
bool Cluster::moveToLocationCentered | ( | int | , |
int | |||
) |
Moves this cluster to the specified location for its center in Logical workspace.
x,the | new x-coordinate position. |
y,the | new y-coordinate position. |
void Cluster::nameChanged | ( | QString | , |
QString | |||
) |
Generated when cluster name changes to a new one.
IPC event.
void Cluster::setIconPath | ( | QString | ) |
Sets the icon to use for the cluster.
str,path | to the image to use for the cluster icon. |
void Cluster::setName | ( | QString | ) |
Allows to change cluster name to newName.
newName,name | to use. |