All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMInterfaces Interface ENOVICutEvent
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---ENOVICutEvent
Usage: you can freely reimplement this interface.
interface ENOVICutEvent
Class to be implemented by a client who wants to subscribe to event Cut which may be raised .
CallBack Interface : when the publisher raises an event Cut, the subscriber is called back on methods
of this interface.
Role: the Subscriber gives a pointer on the implementation of this interface for subscription.
Method Index
- o
onAfterCut(ENOVIEvent_var&,HRESULT&)
- Method called after a Cut action was done.
- o
onBeforeCut(ENOVIEvent_var&,HRESULT&)
- Method called before a Cut action is done .
- o
onKo(ENOVIEvent_var&,HRESULT&)
- CallBack method when something was wrong for another subscriber.
Methods
o onAfterCut
public virtual HRESULT onAfterCut( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called after a Cut action was done.
Role: to call back clients which subscribed to Cut event -step after -
- Parameters:
-
- iRaisedEvent
- the instance of event which is currently raised.
- ioNotifyReturnCode
- the status to be returned by the method :
E_FAIL if there was a problem
S_OK if everything was right
- See also:
- ENOVIEvent
o onBeforeCut
public virtual HRESULT onBeforeCut( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
Method called before a Cut action is done .
Role: to call back clients which subscribed to Cut event - step before -
- Parameters:
-
- iRaisedEvent
- the instance of event which is currently raised.
- ioNotifyReturnCode
- the status to be returned by the method :
E_FAIL if there was a problem
E_ACCESSDENIED if the subscriber wants to put a veto . This code will be taken into account
only if the event on the object type was declared veto able.
S_OK if everything was right
- See also:
- ENOVIEvent
o onKo
public virtual HRESULT onKo( | const ENOVIEvent_var& | iRaisedEvent, |
| HRESULT& | ioNotifyReturnCode) = 0 |
-
CallBack method when something was wrong for another subscriber.
Role: this method is called by the event manager
when a next subscriber returns a failure code from it's callback method.
In that case, all the previous subscribers are called on their onKo() method.
- Parameters:
-
- iEvent
- the instance of event which is currently raised
- ioNotifyReturnCode
- the status of the onKo callback action
- See also:
- ENOVIEvent
This object is included in the file: ENOVICutEvent.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces