IScriptEventTarget.h

//========================================================================================
// 
// $File$
// 
// Owner: Jonathan W. Brown
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// ADOBE CONFIDENTIAL
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __IScriptEventTarget__
#define __IScriptEventTarget__

#include "IPMUnknown.h"

#include "IScriptEventListener.h"

class IScriptEvent ;

class IScriptEventTarget : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ISCRIPTEVENTTARGET };

 typedef enum { kPreDispatch, kPostDispatch } InitCallbackType ; 
 typedef void (*InitEventCallback)( IScriptEvent* e, InitCallbackType t, void* privateData ) ;
 virtual void DispatchScriptEvent( ScriptElementID eventID, InitEventCallback initCallback = nil, void* privateData = nil ) = 0 ;

 //------------------------------------------------------------------------------------------------------
 // EventListeners
 //------------------------------------------------------------------------------------------------------

 virtual bool16 WillTriggerEventListeners( const PMString& eventType, bool16 bubbles ) const = 0 ;

 virtual int32 GetNumEventListeners() const = 0 ;

 virtual int32 GetNumEventListeners( const PMString& eventType ) const = 0 ;

 virtual IScriptEventListener* QueryNthEventListener( int32 n ) const = 0 ;

 virtual IScriptEventListener* QueryNthEventListener( int32 n, const PMString& eventType ) const = 0 ;

 virtual void GetEventListeners( ScriptEventListenerList& eventListeners ) const = 0 ;

 virtual void GetEventListeners( ScriptEventListenerList& eventListeners, const PMString& eventType ) const = 0 ;

 virtual bool16 AddEventListener( IScriptEventListener* eventListener ) = 0 ;

 virtual bool16 RemoveEventListener( IScriptEventListener* eventListener ) = 0 ;

 virtual IScriptEventListener* QueryMatchingEventListener( const PMString& eventType, const ScriptData& handler ) const = 0 ;

 virtual void SetBusy( const PMString& eventType, bool16 bBusy ) = 0 ;

 virtual bool16 IsBusy() const = 0 ;

 //------------------------------------------------------------------------------------------------------
 // Events
 //------------------------------------------------------------------------------------------------------

 virtual int32 GetNumEvents( const ScriptID& type, const RequestContext& context ) const = 0 ;

 virtual IScriptEvent* QueryNthEvent( int32 n, const ScriptID& type, const RequestContext& context ) const = 0 ;

 virtual void PushEvent( IScriptEvent* e ) = 0 ;

 virtual IScriptEvent* PopEvent() = 0 ;
};

#endif