InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IUxpScriptUtils.h
1 /*************************************************************************
2  * ADOBE CONFIDENTIAL
3  * ___________________
4  *
5  * Copyright 2022 Adobe
6  * All Rights Reserved.
7  *
8  * NOTICE: All information contained herein is, and remains
9  * the property of Adobe and its suppliers, if any. The intellectual
10  * and technical concepts contained herein are proprietary to Adobe
11  * and its suppliers and are protected by all applicable intellectual
12  * property laws, including trade secret and copyright laws.
13  * Dissemination of this information or reproduction of this material
14  * is strictly forbidden unless prior written permission is obtained
15  * from Adobe.
16 **************************************************************************/
17 
18 #ifndef __IUxpScriptUtils__
19 #define __IUxpScriptUtils__
20 
21 #include "IPMUnknown.h"
22 #include "JavaScriptID.h"
23 #include "IScriptRunner.h"
24 #include "Utils.h"
25 
27 {
28 public:
29  enum { kDefaultIID = IID_IUXPSCRIPTUTILS } ;
30 
39  virtual ErrorCode CreateUxpScriptEngine( const PMString& engineName, bool16 isResettable, bool16 isDebuggable ) const = 0 ;
40 
47  virtual ErrorCode DeleteUxpScriptEngine( const PMString& engineName ) const = 0 ;
48 
57  virtual ErrorCode RunFileInEngine( const PMString& engineName, const IDFile& idFile,
58  bool16 showErrorAlert = kTrue, bool16 invokeDebugger = kFalse ) const = 0 ;
59 
68  virtual ErrorCode RunScriptInEngine( const PMString& engineName, const PMString& scriptText,
69  bool16 showErrorAlert = kTrue, bool16 invokeDebugger = kFalse ) const = 0 ;
70 
84  virtual ErrorCode RunScriptInEngine( const PMString& engineName, const ScriptData& script,
85  const ScriptRecordData& arguments, ScriptData& result, PMString& errorString,
86  bool16 showErrorAlert = kTrue, bool16 invokeDebugger = kFalse,
88  const PMString& undoName = PMString() ) const = 0 ;
89 
90 
106  virtual ErrorCode RunScriptInEngine( const PMString& engineName, const ScriptData& script, bool16 evalStringAsFilePath,
107  const ScriptRecordData& arguments, ScriptData& result, PMString& errorString,
108  bool16 showErrorAlert = kTrue, bool16 invokeDebugger = kFalse,
110  const PMString& undoName = PMString() ) const = 0 ;
111 } ;
112 
113 #endif