InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
CScriptEngine.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: Jonathan W. Brown
6 //
7 // $Author$
8 //
9 // $DateTime$
10 //
11 // $Revision$
12 //
13 // $Change$
14 //
15 // Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
16 //
17 // NOTICE: Adobe permits you to use, modify, and distribute this file in accordance
18 // with the terms of the Adobe license agreement accompanying it. If you have received
19 // this file from a source other than Adobe, then your use, modification, or
20 // distribution of it requires the prior written permission of Adobe.
21 //
22 //========================================================================================
23 
24 #ifndef __CSCRIPTENGINE__
25 #define __CSCRIPTENGINE__
26 
27 #include "CPMUnknown.h"
28 #include "IScriptEngine.h"
29 
37 class CScriptEngine : public CPMUnknown<IScriptEngine>
38 {
39  typedef CPMUnknown<IScriptEngine> Inherited ;
40 
41 public:
47  CScriptEngine( IPMUnknown* boss, ClassID requestDataBoss = kCScriptRequestDataBoss ) ;
51  virtual ~CScriptEngine() {}
52 
56  virtual ErrorCode Install() ;
60  virtual ErrorCode UnInstall() ;
61 
65  virtual EngineContext GetRequestContext() const ;
69  virtual IScriptManager* QueryScriptManager() const ;
73  virtual IScriptRequestData* CreateScriptRequestData() /*const*/ ;
74 
78  virtual PMString GetName() const ;
79 
83  virtual bool16 IsScriptActive() const ;
87  virtual void IncrementActiveScriptCount() ;
91  virtual void DecrementActiveScriptCount() ;
92 
96  virtual bool16 GetShowAlerts() const ;
100  virtual bool16 GetShowDialogs() const ;
101 
102 protected:
108  virtual void ResetScriptRequestData( IScriptRequestData* scriptRequestData ) const ;
109 
110 private:
111  /* The ClassID of the IScriptRequestData boss used to handle requests for this client */
112  ClassID fRequestDataBoss ;
113  /* The number of active scripts in this engine */
114  int32 fActiveScripts ;
115  /* A cache of IScriptRequestData bosses created for this engine; maintained for performance reasons */
116  K2Vector<InterfacePtr<IScriptRequestData> > fSEDCache ;
117 } ;
118 
119 #endif