Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / pdfium / 079b233774bb3977d3713cf24a5b5bb8a4b99b7f / . / fpdfsdk / ipdfsdk_annothandler.h
blob: 24b6ff044ea65c5c7b8389e525e60da402765298 [file] [log] [blame]
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]1// Copyright 2016 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.
4
5// Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
6
7#ifndef FPDFSDK_IPDFSDK_ANNOTHANDLER_H_
8#define FPDFSDK_IPDFSDK_ANNOTHANDLER_H_
9
Haibo Huang49cc9302020-04-27 16:14:24 -0700[diff] [blame]10#include <memory>
11
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]12#include "core/fxcrt/fx_coordinates.h"
13#include "fpdfsdk/cpdfsdk_annot.h"
14
15class CFX_Matrix;
16class CFX_RenderDevice;
17class CPDF_Annot;
Haibo Huang49cc9302020-04-27 16:14:24 -0700[diff] [blame]18class CPDFSDK_FormFillEnvironment;
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]19class CPDFSDK_PageView;
20
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]21class IPDFSDK_AnnotHandler {
22 public:
Haibo Huang49cc9302020-04-27 16:14:24 -0700[diff] [blame]23 virtual ~IPDFSDK_AnnotHandler() = default;
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]24
Haibo Huang49cc9302020-04-27 16:14:24 -0700[diff] [blame]25 virtual void SetFormFillEnvironment(
26 CPDFSDK_FormFillEnvironment* pFormFillEnv) = 0;
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]27 virtual bool CanAnswer(CPDFSDK_Annot* pAnnot) = 0;
28 virtual CPDFSDK_Annot* NewAnnot(CPDF_Annot* pAnnot,
29 CPDFSDK_PageView* pPage) = 0;
Haibo Huang49cc9302020-04-27 16:14:24 -0700[diff] [blame]30 virtual void ReleaseAnnot(std::unique_ptr<CPDFSDK_Annot> pAnnot) = 0;
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]31 virtual CFX_FloatRect GetViewBBox(CPDFSDK_PageView* pPageView,
32 CPDFSDK_Annot* pAnnot) = 0;
Haibo Huang49cc9302020-04-27 16:14:24 -0700[diff] [blame]33 virtual WideString GetText(CPDFSDK_Annot* pAnnot) = 0;
Philip P. Moltmannd904c1e2018-03-19 09:26:45 -0700[diff] [blame]34 virtual WideString GetSelectedText(CPDFSDK_Annot* pAnnot) = 0;
35 virtual void ReplaceSelection(CPDFSDK_Annot* pAnnot,
36 const WideString& text) = 0;
Haibo Huang49cc9302020-04-27 16:14:24 -0700[diff] [blame]37 virtual bool CanUndo(CPDFSDK_Annot* pAnnot) = 0;
38 virtual bool CanRedo(CPDFSDK_Annot* pAnnot) = 0;
39 virtual bool Undo(CPDFSDK_Annot* pAnnot) = 0;
40 virtual bool Redo(CPDFSDK_Annot* pAnnot) = 0;
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]41 virtual bool HitTest(CPDFSDK_PageView* pPageView,
42 CPDFSDK_Annot* pAnnot,
Philip P. Moltmann33357ca2017-05-11 09:25:13 -0700[diff] [blame]43 const CFX_PointF& point) = 0;
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]44 virtual void OnDraw(CPDFSDK_PageView* pPageView,
45 CPDFSDK_Annot* pAnnot,
46 CFX_RenderDevice* pDevice,
Haibo Huang49cc9302020-04-27 16:14:24 -0700[diff] [blame]47 const CFX_Matrix& mtUser2Device,
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]48 bool bDrawAnnots) = 0;
49 virtual void OnLoad(CPDFSDK_Annot* pAnnot) = 0;
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]50 virtual void OnMouseEnter(CPDFSDK_PageView* pPageView,
Haibo Huang49cc9302020-04-27 16:14:24 -0700[diff] [blame]51 ObservedPtr<CPDFSDK_Annot>* pAnnot,
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]52 uint32_t nFlag) = 0;
53 virtual void OnMouseExit(CPDFSDK_PageView* pPageView,
Haibo Huang49cc9302020-04-27 16:14:24 -0700[diff] [blame]54 ObservedPtr<CPDFSDK_Annot>* pAnnot,
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]55 uint32_t nFlag) = 0;
56 virtual bool OnLButtonDown(CPDFSDK_PageView* pPageView,
Haibo Huang49cc9302020-04-27 16:14:24 -0700[diff] [blame]57 ObservedPtr<CPDFSDK_Annot>* pAnnot,
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]58 uint32_t nFlags,
Philip P. Moltmann33357ca2017-05-11 09:25:13 -0700[diff] [blame]59 const CFX_PointF& point) = 0;
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]60 virtual bool OnLButtonUp(CPDFSDK_PageView* pPageView,
Haibo Huang49cc9302020-04-27 16:14:24 -0700[diff] [blame]61 ObservedPtr<CPDFSDK_Annot>* pAnnot,
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]62 uint32_t nFlags,
Philip P. Moltmann33357ca2017-05-11 09:25:13 -0700[diff] [blame]63 const CFX_PointF& point) = 0;
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]64 virtual bool OnLButtonDblClk(CPDFSDK_PageView* pPageView,
Haibo Huang49cc9302020-04-27 16:14:24 -0700[diff] [blame]65 ObservedPtr<CPDFSDK_Annot>* pAnnot,
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]66 uint32_t nFlags,
Philip P. Moltmann33357ca2017-05-11 09:25:13 -0700[diff] [blame]67 const CFX_PointF& point) = 0;
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]68 virtual bool OnMouseMove(CPDFSDK_PageView* pPageView,
Haibo Huang49cc9302020-04-27 16:14:24 -0700[diff] [blame]69 ObservedPtr<CPDFSDK_Annot>* pAnnot,
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]70 uint32_t nFlags,
Philip P. Moltmann33357ca2017-05-11 09:25:13 -0700[diff] [blame]71 const CFX_PointF& point) = 0;
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]72 virtual bool OnMouseWheel(CPDFSDK_PageView* pPageView,
Haibo Huang49cc9302020-04-27 16:14:24 -0700[diff] [blame]73 ObservedPtr<CPDFSDK_Annot>* pAnnot,
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]74 uint32_t nFlags,
75 short zDelta,
Philip P. Moltmann33357ca2017-05-11 09:25:13 -0700[diff] [blame]76 const CFX_PointF& point) = 0;
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]77 virtual bool OnRButtonDown(CPDFSDK_PageView* pPageView,
Haibo Huang49cc9302020-04-27 16:14:24 -0700[diff] [blame]78 ObservedPtr<CPDFSDK_Annot>* pAnnot,
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]79 uint32_t nFlags,
Philip P. Moltmann33357ca2017-05-11 09:25:13 -0700[diff] [blame]80 const CFX_PointF& point) = 0;
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]81 virtual bool OnRButtonUp(CPDFSDK_PageView* pPageView,
Haibo Huang49cc9302020-04-27 16:14:24 -0700[diff] [blame]82 ObservedPtr<CPDFSDK_Annot>* pAnnot,
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]83 uint32_t nFlags,
Philip P. Moltmann33357ca2017-05-11 09:25:13 -0700[diff] [blame]84 const CFX_PointF& point) = 0;
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]85 virtual bool OnRButtonDblClk(CPDFSDK_PageView* pPageView,
Haibo Huang49cc9302020-04-27 16:14:24 -0700[diff] [blame]86 ObservedPtr<CPDFSDK_Annot>* pAnnot,
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]87 uint32_t nFlags,
Philip P. Moltmann33357ca2017-05-11 09:25:13 -0700[diff] [blame]88 const CFX_PointF& point) = 0;
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]89 virtual bool OnChar(CPDFSDK_Annot* pAnnot,
90 uint32_t nChar,
91 uint32_t nFlags) = 0;
92 virtual bool OnKeyDown(CPDFSDK_Annot* pAnnot, int nKeyCode, int nFlag) = 0;
93 virtual bool OnKeyUp(CPDFSDK_Annot* pAnnot, int nKeyCode, int nFlag) = 0;
Haibo Huang49cc9302020-04-27 16:14:24 -0700[diff] [blame]94 virtual bool OnSetFocus(ObservedPtr<CPDFSDK_Annot>* pAnnot,
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]95 uint32_t nFlag) = 0;
Haibo Huang49cc9302020-04-27 16:14:24 -0700[diff] [blame]96 virtual bool OnKillFocus(ObservedPtr<CPDFSDK_Annot>* pAnnot,
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]97 uint32_t nFlag) = 0;
Haibo Huang49cc9302020-04-27 16:14:24 -0700[diff] [blame]98 virtual bool SetIndexSelected(ObservedPtr<CPDFSDK_Annot>* pAnnot,
99 int index,
100 bool selected) = 0;
101 virtual bool IsIndexSelected(ObservedPtr<CPDFSDK_Annot>* pAnnot,
102 int index) = 0;
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700[diff] [blame]103};
104
105#endif // FPDFSDK_IPDFSDK_ANNOTHANDLER_H_