Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / pdfium / 690a99c20a0f4cb67a386e64d711023dd8e15bed / . / fpdfsdk / javascript / ijs_context.h
blob: 365533c091cafc30242c2f2c00ef313603dbf499 [file] [log] [blame]
dsinclair64376be2016-03-31 20:03:24 -0700[diff] [blame]1// Copyright 2016 PDFium Authors. All rights reserved.
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]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
dsinclair64376be2016-03-31 20:03:24 -0700[diff] [blame]7#ifndef FPDFSDK_JAVASCRIPT_IJS_CONTEXT_H_
8#define FPDFSDK_JAVASCRIPT_IJS_CONTEXT_H_
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]9
Dan Sinclaira8a28e02016-03-23 15:41:39 -0400[diff] [blame]10#include "core/fxcrt/include/fx_string.h"
11#include "core/fxcrt/include/fx_system.h"
Tom Sepez3a832662015-03-02 12:59:05 -0800[diff] [blame]12
Tom Sepezf4583622015-09-14 15:06:53 -0700[diff] [blame]13class CPDF_Bookmark;
14class CPDF_FormField;
dsinclair64376be2016-03-31 20:03:24 -0700[diff] [blame]15class CPDFSDK_Annot;
16class CPDFSDK_Document;
Tom Sepez3a832662015-03-02 12:59:05 -0800[diff] [blame]17
Tom Sepez33420902015-10-13 15:00:10 -0700[diff] [blame]18// Records the details of an event and triggers JS execution for it.
Tom Sepezba038bc2015-10-08 12:03:00 -0700[diff] [blame]19class IJS_Context {
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]20 public:
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]21 virtual FX_BOOL RunScript(const CFX_WideString& script,
Tom Sepez33420902015-10-13 15:00:10 -0700[diff] [blame]22 CFX_WideString* info) = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]23
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]24 virtual void OnApp_Init() = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]25
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]26 virtual void OnDoc_Open(CPDFSDK_Document* pDoc,
27 const CFX_WideString& strTargetName) = 0;
28 virtual void OnDoc_WillPrint(CPDFSDK_Document* pDoc) = 0;
29 virtual void OnDoc_DidPrint(CPDFSDK_Document* pDoc) = 0;
30 virtual void OnDoc_WillSave(CPDFSDK_Document* pDoc) = 0;
31 virtual void OnDoc_DidSave(CPDFSDK_Document* pDoc) = 0;
32 virtual void OnDoc_WillClose(CPDFSDK_Document* pDoc) = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]33
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]34 virtual void OnPage_Open(CPDFSDK_Document* pTarget) = 0;
35 virtual void OnPage_Close(CPDFSDK_Document* pTarget) = 0;
36 virtual void OnPage_InView(CPDFSDK_Document* pTarget) = 0;
37 virtual void OnPage_OutView(CPDFSDK_Document* pTarget) = 0;
Tom Sepeze5b59ca2015-01-09 11:46:17 -0800[diff] [blame]38
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]39 virtual void OnField_MouseDown(FX_BOOL bModifier,
40 FX_BOOL bShift,
41 CPDF_FormField* pTarget) = 0;
42 virtual void OnField_MouseEnter(FX_BOOL bModifier,
43 FX_BOOL bShift,
44 CPDF_FormField* pTarget) = 0;
45 virtual void OnField_MouseExit(FX_BOOL bModifier,
46 FX_BOOL bShift,
47 CPDF_FormField* pTarget) = 0;
48 virtual void OnField_MouseUp(FX_BOOL bModifier,
49 FX_BOOL bShift,
50 CPDF_FormField* pTarget) = 0;
51 virtual void OnField_Focus(FX_BOOL bModifier,
52 FX_BOOL bShift,
53 CPDF_FormField* pTarget,
54 const CFX_WideString& Value) = 0;
55 virtual void OnField_Blur(FX_BOOL bModifier,
56 FX_BOOL bShift,
57 CPDF_FormField* pTarget,
58 const CFX_WideString& Value) = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]59
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]60 virtual void OnField_Calculate(CPDF_FormField* pSource,
61 CPDF_FormField* pTarget,
62 CFX_WideString& Value,
63 FX_BOOL& bRc) = 0;
64 virtual void OnField_Format(CPDF_FormField* pTarget,
65 CFX_WideString& Value,
66 FX_BOOL bWillCommit) = 0;
67 virtual void OnField_Keystroke(CFX_WideString& strChange,
68 const CFX_WideString& strChangeEx,
69 FX_BOOL KeyDown,
70 FX_BOOL bModifier,
71 int& nSelEnd,
72 int& nSelStart,
73 FX_BOOL bShift,
74 CPDF_FormField* pTarget,
75 CFX_WideString& Value,
76 FX_BOOL bWillCommit,
77 FX_BOOL bFieldFull,
78 FX_BOOL& bRc) = 0;
79 virtual void OnField_Validate(CFX_WideString& strChange,
80 const CFX_WideString& strChangeEx,
81 FX_BOOL bKeyDown,
82 FX_BOOL bModifier,
83 FX_BOOL bShift,
84 CPDF_FormField* pTarget,
85 CFX_WideString& Value,
86 FX_BOOL& bRc) = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]87
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]88 virtual void OnScreen_Focus(FX_BOOL bModifier,
89 FX_BOOL bShift,
90 CPDFSDK_Annot* pScreen) = 0;
91 virtual void OnScreen_Blur(FX_BOOL bModifier,
92 FX_BOOL bShift,
93 CPDFSDK_Annot* pScreen) = 0;
94 virtual void OnScreen_Open(FX_BOOL bModifier,
95 FX_BOOL bShift,
96 CPDFSDK_Annot* pScreen) = 0;
97 virtual void OnScreen_Close(FX_BOOL bModifier,
98 FX_BOOL bShift,
99 CPDFSDK_Annot* pScreen) = 0;
100 virtual void OnScreen_MouseDown(FX_BOOL bModifier,
101 FX_BOOL bShift,
102 CPDFSDK_Annot* pScreen) = 0;
103 virtual void OnScreen_MouseUp(FX_BOOL bModifier,
104 FX_BOOL bShift,
105 CPDFSDK_Annot* pScreen) = 0;
106 virtual void OnScreen_MouseEnter(FX_BOOL bModifier,
107 FX_BOOL bShift,
108 CPDFSDK_Annot* pScreen) = 0;
109 virtual void OnScreen_MouseExit(FX_BOOL bModifier,
110 FX_BOOL bShift,
111 CPDFSDK_Annot* pScreen) = 0;
112 virtual void OnScreen_InView(FX_BOOL bModifier,
113 FX_BOOL bShift,
114 CPDFSDK_Annot* pScreen) = 0;
115 virtual void OnScreen_OutView(FX_BOOL bModifier,
116 FX_BOOL bShift,
117 CPDFSDK_Annot* pScreen) = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]118
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]119 virtual void OnBookmark_MouseUp(CPDF_Bookmark* pBookMark) = 0;
120 virtual void OnLink_MouseUp(CPDFSDK_Document* pTarget) = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]121
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]122 virtual void OnMenu_Exec(CPDFSDK_Document* pTarget,
123 const CFX_WideString&) = 0;
124 virtual void OnBatchExec(CPDFSDK_Document* pTarget) = 0;
125 virtual void OnConsole_Exec() = 0;
126 virtual void OnExternal_Exec() = 0;
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]127
Nico Weber9d8ec5a2015-08-04 13:00:21 -0700[diff] [blame]128 virtual void EnableMessageBox(FX_BOOL bEnable) = 0;
Lei Zhang2b1a2d52015-08-14 22:16:22 -0700[diff] [blame]129
130 protected:
Tom Sepezba038bc2015-10-08 12:03:00 -0700[diff] [blame]131 virtual ~IJS_Context() {}
John Abd-El-Malek3f3b45c2014-05-23 17:28:10 -0700[diff] [blame]132};
133
dsinclair64376be2016-03-31 20:03:24 -0700[diff] [blame]134#endif // FPDFSDK_JAVASCRIPT_IJS_CONTEXT_H_