All Frameworks Class Hierarchy This Framework Indexes Previous Next

AfrInterfaces Interface CATIUIActivate

Usage: you can reimplement this interface by deriving the supplied CATExtIUIActivate adapter class.

interface CATIUIActivate

Interface that enables the activation of a workshop when double- clicking an object.
A document contains a hierarchical structure of objects. Some of these objects are able to provide a set of commands, called a workshop. Such objects get this ability by implementing the CATIUIActivate interface, and these objects are then said to be ui-activable. An ui-activable object whose workshop is displayed is the ui-active object. UI-activation operates on objects which are paths from the document's root to an object in the document's tree structure. The basis of the ui-activation mechanisms lay on three actors :

- the CATIUIActivate interface implemented by ui-activable objects,
- the interface implemented by site objects,
- the class that manages the current ui-active object.

The role of the ui-activable object is to provide a workshop, a contextual menu and a default command upon activation.
Note : Using a subclass of is mandatory when implementing the CATIUIActivate interface.

BOA information: this interface CANNOT be implemented using the BOA (Basic Object Adapter). To know more about the BOA, refer to the CAA Encyclopedia home page. Click Middleware at the bottom left, then click the Object Modeler tab page. Several articles deal with the BOA.

Method Index

o GetDefaultCommand(): Returns the name of the default command to start for this ui-activable object.
o GetWorkshop(): Returns the name of the workshop associated with this ui-activable object.

Methods

o GetDefaultCommand

public virtual GetDefaultCommand(

)

Returns the name of the default command to start for this ui-activable object. The default command is the command that is started when there is no started command.

Returns:: The name of the default command

o GetWorkshop

public virtual GetWorkshop(

)

Returns the name of the workshop associated with this ui-activable object.

Returns:: The ui-activable object's workshop name.

This object is included in the file: CATIUIActivate.h
If needed, your Imakefile.mk should include the module: CATAfrItf