IScriptEvent.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 __IScriptEvent__
#define __IScriptEvent__

#include "IDTime.h"
#include "ScriptingID.h"

class IScript ;
class IScriptEventTarget ;

class IScriptEvent : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ISCRIPTEVENT } ;

 enum EventPhase
 {
 kNotDispatching = 0 ,
 kAtTarget = 2 ,
 kBubblingPhase = 3,
 kDoneDispatching = -1
 } ;

 virtual void InitEvent( const PMString& eventType, bool16 bubbles, bool16 cancelable ) = 0 ;

 virtual int32 GetID() const = 0 ;

 virtual PMString GetEventType() const = 0 ;

 virtual IScript* QueryTarget() const = 0 ;

 virtual IScript* QueryCurrentTarget() const = 0 ;

 virtual EventPhase GetEventPhase() const = 0 ;

 virtual bool16 GetBubbles() const = 0 ;

 virtual bool16 GetCancelable() const = 0 ;

 virtual IDTime GetTimeStamp() const = 0 ;

 virtual void StopPropagation() = 0 ;

 virtual bool16 GetPropagationStopped() const = 0 ;

 virtual void PreventDefault() = 0 ;

 virtual bool16 GetDefaultPrevented() const = 0 ;

 // ----- FOR INTERNAL USE ONLY -----
 virtual void SetTarget( IScript* target ) = 0 ;

 virtual void SetCurrentTarget( IScript* target ) = 0 ;

 virtual void SetEventPhase( EventPhase phase ) = 0 ;
} ;

typedef K2Vector< InterfacePtr<IScriptEvent> > ScriptEventList ;

#endif