ICSXSPlugPlugEventHandler.h

//========================================================================================
// 
// $File$
// 
// Owner: Gaurav Bhargava
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// ADOBE CONFIDENTIAL
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: All information contained herein is, and remains
// the property of Adobe Systems Incorporated and its suppliers,
// if any. The intellectual and technical concepts contained
// herein are proprietary to Adobe Systems Incorporated and its
// suppliers and may be covered by U.S. and Foreign Patents,
// patents in process, and are protected by trade secret or copyright law.
// Dissemination of this information or reproduction of this material
// is strictly forbidden unless prior written permission is obtained
// from Adobe Systems Incorporated.
// 
//========================================================================================

#ifndef __ICSXSPlugPlugEventHandler__
#define __ICSXSPlugPlugEventHandler__

#include "IPMUnknown.h"
#include "CSXSID.h"

#define kIDEnigmaCode "IDSN"
#define kICEnigmaCode "AICY"

class ICSXSPlugPlugEventHandler : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ICSXSPLUGPLUG } ;

 enum CSXSEventScope
 {
 //kEventScope_Global = 0,

 kEventScope_Application = 1,

 kEventScope_LastValue = 0x7FFFFFFF
 };

 enum CSXSEventErrorCode
 {
 kEventErrorCode_Success = 0,

 kEventErrorCode_OperationFailed,

 kEventErrorCode_Unknown, 
 
 kEventErrorCode_LastValue = 0x7FFFFFFF
 };

 struct CSXSEvent
 {
 const char* type;
 CSXSEventScope scope;
 const char* appId;
 const char* extensionId;
 const char* data;
 CSXSEvent() : data(nil), extensionId(nil), appId(nil), type(nil), scope(kEventScope_Application)
 {}
 CSXSEvent(const CSXSEvent& other) = default;
 };

 typedef void (*EventListenerFn) (const CSXSEvent* const csxsEvent, void* const context);

 virtual CSXSEventErrorCode AddPlugPlugEventListener(const char* type, EventListenerFn eventListener, void* const context ) = 0 ;

 
 virtual CSXSEventErrorCode RemovePlugPlugEventListener(const char* type, EventListenerFn eventListener, void* const context ) = 0 ;

 
 virtual CSXSEventErrorCode DispatchPlugPlugEvent(const CSXSEvent * const csxsEvent) const = 0;

} ;

#endif