All Frameworks Class Hierarchy This Framework Indexes Previous Next

AfrInterfaces Interface CATInPlaceSite

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

interface CATInPlaceSite

Interface to allow ui-activation of embedded objects implementing the CATIUIActivate interface.
Role: 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 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 path 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 interface implemented by ui-activable objects,
- the CATInPlaceSite interface implemented by site objects,
- the class that manages the current ui-active object.

UI-activation consists of pairs of site / ui-activable objects managed by the CATFrmEditor class. In order to be ui-activated (having its workshop displayed on the screen), an ui-activable object must have a valid site object in its hierarchy. The role of the site is to accept or block the ui-activation requests coming from the subordinates ui-activable objects.
The CATInPlaceSite methods are called by the ui-activation manager with respect to the following sequence:

CanInPlaceActivate : does the site accept the ui-activation request
OnInPlaceActivate : ui-activation initialization notification
OnUIActivate : workshop display notification
...
OnInPlaceDeactivate : workshop removal notification
OnUIDeactivate : ui-deactivation completed

Note: Using a subclass of is mandatory recommended when implementing this 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 CanInPlaceActivate(): Asks the site whether it accepts a subordinates ui-activable object's ui-activation.
o OnInPlaceActivate(): Notifies the site that ui-activation will begin.
o OnInPlaceDeactivate(): Notifies the site that ui-activation will end.
o OnUIActivate(): Notifies the site that the ui-active object's workshop is going to be displayed.
o OnUIDeactivate(): Notifies the site that the ui-active object's workshop is going to be removed.

Methods

o CanInPlaceActivate

public virtual CanInPlaceActivate(

)

Asks the site whether it accepts a subordinates ui-activable object's ui-activation.

Returns:: 1 on accept, 0 on reject.

o OnInPlaceActivate

public virtual OnInPlaceActivate(

)

Notifies the site that ui-activation will begin. Called by the ui-activation manager

Returns:: 0 on failure, 1 otherwise.

o OnInPlaceDeactivate

public virtual OnInPlaceDeactivate(

)

Notifies the site that ui-activation will end. Called by the ui-activation manager .

Returns:: 0 on failure, 1 otherwise.

o OnUIActivate

public virtual OnUIActivate(

)

Notifies the site that the ui-active object's workshop is going to be displayed. Called by the ui-activation manager.

Returns:: 0 on failure, 1 otherwise.

o OnUIDeactivate

public virtual OnUIDeactivate(

)

Notifies the site that the ui-active object's workshop is going to be removed. Called by the ui-activation manager.

Returns:: 0 on failure, 1 otherwise.

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