Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / pdfium / 452b4f3f0ce1411350d57373528ccde77e40727d / . / fpdfsdk / include / javascript / IJavaScript.h
blob: f78ee527933d75555168474691337846e00eb781 [file] [log] [blame]
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]1// Copyright 2014 PDFium Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
Lei Zhanga6d9f0e2015-06-13 00:48:38 -0700[diff] [blame]4
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]5// Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
6
Tom Sepez19922bb2015-05-28 13:23:12 -0700[diff] [blame]7#ifndef FPDFSDK_INCLUDE_JAVASCRIPT_IJAVASCRIPT_H_
8#define FPDFSDK_INCLUDE_JAVASCRIPT_IJAVASCRIPT_H_
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]9
Lei Zhange5b0bd12015-06-19 17:15:41 -0700[diff] [blame]10#include "../../../core/include/fxcrt/fx_string.h"
11#include "../../../core/include/fxcrt/fx_system.h"
Tom Sepez3a832662015-03-02 12:59:05 -0800[diff] [blame]12#include "../../../xfa/include/fxjse/fxjse.h"
13
Tom Sepezf4583622015-09-14 15:06:53 -0700[diff] [blame]14class CPDFDoc_Environment;
Tom Sepez3a832662015-03-02 12:59:05 -0800[diff] [blame]15class CPDFSDK_Annot;
16class CPDFSDK_Document;
Tom Sepezf4583622015-09-14 15:06:53 -0700[diff] [blame]17class CPDF_Bookmark;
18class CPDF_FormField;
Tom Sepez3a832662015-03-02 12:59:05 -0800[diff] [blame]19
Tom Sepezba038bc2015-10-08 12:03:00 -0700[diff] [blame]20class IJS_Context {
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]21 public:
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]22 virtual FX_BOOL RunScript(const CFX_WideString& script,
23 CFX_WideString& info) = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]24
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]25 virtual void OnApp_Init() = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]26
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]27 virtual void OnDoc_Open(CPDFSDK_Document* pDoc,
28 const CFX_WideString& strTargetName) = 0;
29 virtual void OnDoc_WillPrint(CPDFSDK_Document* pDoc) = 0;
30 virtual void OnDoc_DidPrint(CPDFSDK_Document* pDoc) = 0;
31 virtual void OnDoc_WillSave(CPDFSDK_Document* pDoc) = 0;
32 virtual void OnDoc_DidSave(CPDFSDK_Document* pDoc) = 0;
33 virtual void OnDoc_WillClose(CPDFSDK_Document* pDoc) = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]34
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]35 virtual void OnPage_Open(CPDFSDK_Document* pTarget) = 0;
36 virtual void OnPage_Close(CPDFSDK_Document* pTarget) = 0;
37 virtual void OnPage_InView(CPDFSDK_Document* pTarget) = 0;
38 virtual void OnPage_OutView(CPDFSDK_Document* pTarget) = 0;
Tom Sepeze5b59ca2015-01-09 11:46:17 -0800[diff] [blame]39
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]40 virtual void OnField_MouseDown(FX_BOOL bModifier,
41 FX_BOOL bShift,
42 CPDF_FormField* pTarget) = 0;
43 virtual void OnField_MouseEnter(FX_BOOL bModifier,
44 FX_BOOL bShift,
45 CPDF_FormField* pTarget) = 0;
46 virtual void OnField_MouseExit(FX_BOOL bModifier,
47 FX_BOOL bShift,
48 CPDF_FormField* pTarget) = 0;
49 virtual void OnField_MouseUp(FX_BOOL bModifier,
50 FX_BOOL bShift,
51 CPDF_FormField* pTarget) = 0;
52 virtual void OnField_Focus(FX_BOOL bModifier,
53 FX_BOOL bShift,
54 CPDF_FormField* pTarget,
55 const CFX_WideString& Value) = 0;
56 virtual void OnField_Blur(FX_BOOL bModifier,
57 FX_BOOL bShift,
58 CPDF_FormField* pTarget,
59 const CFX_WideString& Value) = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]60
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]61 virtual void OnField_Calculate(CPDF_FormField* pSource,
62 CPDF_FormField* pTarget,
63 CFX_WideString& Value,
64 FX_BOOL& bRc) = 0;
65 virtual void OnField_Format(CPDF_FormField* pTarget,
66 CFX_WideString& Value,
67 FX_BOOL bWillCommit) = 0;
68 virtual void OnField_Keystroke(CFX_WideString& strChange,
69 const CFX_WideString& strChangeEx,
70 FX_BOOL KeyDown,
71 FX_BOOL bModifier,
72 int& nSelEnd,
73 int& nSelStart,
74 FX_BOOL bShift,
75 CPDF_FormField* pTarget,
76 CFX_WideString& Value,
77 FX_BOOL bWillCommit,
78 FX_BOOL bFieldFull,
79 FX_BOOL& bRc) = 0;
80 virtual void OnField_Validate(CFX_WideString& strChange,
81 const CFX_WideString& strChangeEx,
82 FX_BOOL bKeyDown,
83 FX_BOOL bModifier,
84 FX_BOOL bShift,
85 CPDF_FormField* pTarget,
86 CFX_WideString& Value,
87 FX_BOOL& bRc) = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]88
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]89 virtual void OnScreen_Focus(FX_BOOL bModifier,
90 FX_BOOL bShift,
91 CPDFSDK_Annot* pScreen) = 0;
92 virtual void OnScreen_Blur(FX_BOOL bModifier,
93 FX_BOOL bShift,
94 CPDFSDK_Annot* pScreen) = 0;
95 virtual void OnScreen_Open(FX_BOOL bModifier,
96 FX_BOOL bShift,
97 CPDFSDK_Annot* pScreen) = 0;
98 virtual void OnScreen_Close(FX_BOOL bModifier,
99 FX_BOOL bShift,
100 CPDFSDK_Annot* pScreen) = 0;
101 virtual void OnScreen_MouseDown(FX_BOOL bModifier,
102 FX_BOOL bShift,
103 CPDFSDK_Annot* pScreen) = 0;
104 virtual void OnScreen_MouseUp(FX_BOOL bModifier,
105 FX_BOOL bShift,
106 CPDFSDK_Annot* pScreen) = 0;
107 virtual void OnScreen_MouseEnter(FX_BOOL bModifier,
108 FX_BOOL bShift,
109 CPDFSDK_Annot* pScreen) = 0;
110 virtual void OnScreen_MouseExit(FX_BOOL bModifier,
111 FX_BOOL bShift,
112 CPDFSDK_Annot* pScreen) = 0;
113 virtual void OnScreen_InView(FX_BOOL bModifier,
114 FX_BOOL bShift,
115 CPDFSDK_Annot* pScreen) = 0;
116 virtual void OnScreen_OutView(FX_BOOL bModifier,
117 FX_BOOL bShift,
118 CPDFSDK_Annot* pScreen) = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]119
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]120 virtual void OnBookmark_MouseUp(CPDF_Bookmark* pBookMark) = 0;
121 virtual void OnLink_MouseUp(CPDFSDK_Document* pTarget) = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]122
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]123 virtual void OnMenu_Exec(CPDFSDK_Document* pTarget,
124 const CFX_WideString&) = 0;
125 virtual void OnBatchExec(CPDFSDK_Document* pTarget) = 0;
126 virtual void OnConsole_Exec() = 0;
127 virtual void OnExternal_Exec() = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]128
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]129 virtual void EnableMessageBox(FX_BOOL bEnable) = 0;
Lei Zhang2b1a2d52015-08-14 22:16:22 -0700[diff] [blame]130
131 protected:
Tom Sepezba038bc2015-10-08 12:03:00 -0700[diff] [blame]132 virtual ~IJS_Context() {}
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]133};
134
Tom Sepezba038bc2015-10-08 12:03:00 -0700[diff] [blame]135class IJS_Runtime {
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]136 public:
Tom Sepez452b4f32015-10-13 09:27:27 -0700[diff] [blame^]137 static void Initialize(unsigned int slot, void* isolate);
Tom Sepezba038bc2015-10-08 12:03:00 -0700[diff] [blame]138 static IJS_Runtime* Create(CPDFDoc_Environment* pEnv);
139 virtual ~IJS_Runtime() {}
Tom Sepez854a7f62015-09-21 17:07:49 -0700[diff] [blame]140
Tom Sepezba038bc2015-10-08 12:03:00 -0700[diff] [blame]141 virtual IJS_Context* NewContext() = 0;
142 virtual void ReleaseContext(IJS_Context* pContext) = 0;
143 virtual IJS_Context* GetCurrentContext() = 0;
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]144 virtual void SetReaderDocument(CPDFSDK_Document* pReaderDoc) = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]145
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]146 virtual CPDFSDK_Document* GetReaderDocument() = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]147
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]148 virtual FX_BOOL GetHValueByName(const CFX_ByteStringC& utf8Name,
149 FXJSE_HVALUE hValue) = 0;
150 virtual FX_BOOL SetHValueByName(const CFX_ByteStringC& utf8Name,
151 FXJSE_HVALUE hValue) = 0;
Tom Sepez37458412015-10-06 11:33:46 -0700[diff] [blame]152
153 protected:
Tom Sepezba038bc2015-10-08 12:03:00 -0700[diff] [blame]154 IJS_Runtime() {}
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]155};
156
Tom Sepez19922bb2015-05-28 13:23:12 -0700[diff] [blame]157#endif // FPDFSDK_INCLUDE_JAVASCRIPT_IJAVASCRIPT_H_