AfrInterfaces Interface CATIAfrUIActivation

Usage: you cannot implement this base interface directly. You must first derive it and then implement the derived interface.


interface CATIAfrUIActivation

Base interface to add behavior to ui-activable types.
Role: This interface must never be implemented. Each ui-activable type provides an interface derived from this one which can be implemented to execute any code when the user ui-activates or ui-deactivates an object of this type. For a given ui-activable type, the derived interface name is built as follows : CATIIsA()>UIActivated.

For instance, for sketches, the interface name is CATIPRTSketchUIActivated. Each late type which implements CATIPRTSketchUIActivated will be called on the UIActivation method when any sketch is ui-activated and on the UIDeactivation method when any sketch is ui-deactivated.


Method Index


o UIActivation()
Method to call when ui-activating.
o UIDeactivation()
Method to call when ui-deactivating.

Methods


o UIActivation
public virtual UIActivation()
Method to call when ui-activating.
Role: This method is called when the user ui-activates an object which has the type contained in the interface name. When this method is called, the current ui-active object has already been changed.
Returns:
Return code. Not used at this time.
o UIDeactivation
public virtual UIDeactivation()
Method to call when ui-deactivating.
Role: This method is called when the user ui-deactivates an object which has the type contained in the interface name. When this method is called, the current ui-active object has not been changed yet.
Returns:
Return code. If this code is not S_OK, the ui-deactivation will be cancelled.

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

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.