blob: b88f61312ce5d8d44718d873d1944fe37c3ad8d2 [file] [log] [blame]
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -07001// 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_CPDFSDK_ANNOTHANDLERMGR_H_
8#define FPDFSDK_CPDFSDK_ANNOTHANDLERMGR_H_
9
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -070010#include <memory>
11
12#include "core/fpdfdoc/cpdf_annot.h"
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -070013#include "core/fxcrt/fx_coordinates.h"
14#include "fpdfsdk/cpdfsdk_annot.h"
15
16class CFX_Matrix;
17class CFX_RenderDevice;
18class CPDFSDK_FormFillEnvironment;
19class CPDFSDK_BAAnnotHandler;
20class CPDFSDK_WidgetHandler;
21class CPDFSDK_PageView;
22class IPDFSDK_AnnotHandler;
23
24#ifdef PDF_ENABLE_XFA
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -070025class CXFA_FFWidget;
26#endif // PDF_ENABLE_XFA
27
28class CPDFSDK_AnnotHandlerMgr {
29 public:
Haibo Huang49cc9302020-04-27 16:14:24 -070030 CPDFSDK_AnnotHandlerMgr(
31 std::unique_ptr<CPDFSDK_BAAnnotHandler> pBAAnnotHandler,
32 std::unique_ptr<CPDFSDK_WidgetHandler> pWidgetHandler,
33 std::unique_ptr<IPDFSDK_AnnotHandler> pXFAWidgetHandler);
34
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -070035 ~CPDFSDK_AnnotHandlerMgr();
36
Haibo Huang49cc9302020-04-27 16:14:24 -070037 void SetFormFillEnv(CPDFSDK_FormFillEnvironment* pFormFillEnv);
38
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -070039 CPDFSDK_Annot* NewAnnot(CPDF_Annot* pAnnot, CPDFSDK_PageView* pPageView);
40#ifdef PDF_ENABLE_XFA
Haibo Huang49cc9302020-04-27 16:14:24 -070041 std::unique_ptr<CPDFSDK_Annot> NewXFAAnnot(CXFA_FFWidget* pAnnot,
42 CPDFSDK_PageView* pPageView);
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -070043#endif // PDF_ENABLE_XFA
Haibo Huang49cc9302020-04-27 16:14:24 -070044 void ReleaseAnnot(std::unique_ptr<CPDFSDK_Annot> pAnnot);
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -070045
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -070046 void Annot_OnLoad(CPDFSDK_Annot* pAnnot);
47
Haibo Huang49cc9302020-04-27 16:14:24 -070048 WideString Annot_GetText(CPDFSDK_Annot* pAnnot);
Philip P. Moltmannd904c1e2018-03-19 09:26:45 -070049 WideString Annot_GetSelectedText(CPDFSDK_Annot* pAnnot);
50 void Annot_ReplaceSelection(CPDFSDK_Annot* pAnnot, const WideString& text);
51
Haibo Huang49cc9302020-04-27 16:14:24 -070052 bool Annot_CanUndo(CPDFSDK_Annot* pAnnot);
53 bool Annot_CanRedo(CPDFSDK_Annot* pAnnot);
54 bool Annot_Undo(CPDFSDK_Annot* pAnnot);
55 bool Annot_Redo(CPDFSDK_Annot* pAnnot);
56
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -070057 void Annot_OnDraw(CPDFSDK_PageView* pPageView,
58 CPDFSDK_Annot* pAnnot,
59 CFX_RenderDevice* pDevice,
Haibo Huang49cc9302020-04-27 16:14:24 -070060 const CFX_Matrix& mtUser2Device,
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -070061 bool bDrawAnnots);
62
63 void Annot_OnMouseEnter(CPDFSDK_PageView* pPageView,
Haibo Huang49cc9302020-04-27 16:14:24 -070064 ObservedPtr<CPDFSDK_Annot>* pAnnot,
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -070065 uint32_t nFlags);
66 void Annot_OnMouseExit(CPDFSDK_PageView* pPageView,
Haibo Huang49cc9302020-04-27 16:14:24 -070067 ObservedPtr<CPDFSDK_Annot>* pAnnot,
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -070068 uint32_t nFlags);
69 bool Annot_OnLButtonDown(CPDFSDK_PageView* pPageView,
Haibo Huang49cc9302020-04-27 16:14:24 -070070 ObservedPtr<CPDFSDK_Annot>* pAnnot,
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -070071 uint32_t nFlags,
Philip P. Moltmann33357ca2017-05-11 09:25:13 -070072 const CFX_PointF& point);
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -070073 bool Annot_OnLButtonUp(CPDFSDK_PageView* pPageView,
Haibo Huang49cc9302020-04-27 16:14:24 -070074 ObservedPtr<CPDFSDK_Annot>* pAnnot,
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -070075 uint32_t nFlags,
Philip P. Moltmann33357ca2017-05-11 09:25:13 -070076 const CFX_PointF& point);
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -070077 bool Annot_OnLButtonDblClk(CPDFSDK_PageView* pPageView,
Haibo Huang49cc9302020-04-27 16:14:24 -070078 ObservedPtr<CPDFSDK_Annot>* pAnnot,
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -070079 uint32_t nFlags,
Philip P. Moltmann33357ca2017-05-11 09:25:13 -070080 const CFX_PointF& point);
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -070081 bool Annot_OnMouseMove(CPDFSDK_PageView* pPageView,
Haibo Huang49cc9302020-04-27 16:14:24 -070082 ObservedPtr<CPDFSDK_Annot>* pAnnot,
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -070083 uint32_t nFlags,
Philip P. Moltmann33357ca2017-05-11 09:25:13 -070084 const CFX_PointF& point);
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -070085 bool Annot_OnMouseWheel(CPDFSDK_PageView* pPageView,
Haibo Huang49cc9302020-04-27 16:14:24 -070086 ObservedPtr<CPDFSDK_Annot>* pAnnot,
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -070087 uint32_t nFlags,
88 short zDelta,
Philip P. Moltmann33357ca2017-05-11 09:25:13 -070089 const CFX_PointF& point);
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -070090 bool Annot_OnRButtonDown(CPDFSDK_PageView* pPageView,
Haibo Huang49cc9302020-04-27 16:14:24 -070091 ObservedPtr<CPDFSDK_Annot>* pAnnot,
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -070092 uint32_t nFlags,
Philip P. Moltmann33357ca2017-05-11 09:25:13 -070093 const CFX_PointF& point);
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -070094 bool Annot_OnRButtonUp(CPDFSDK_PageView* pPageView,
Haibo Huang49cc9302020-04-27 16:14:24 -070095 ObservedPtr<CPDFSDK_Annot>* pAnnot,
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -070096 uint32_t nFlags,
Philip P. Moltmann33357ca2017-05-11 09:25:13 -070097 const CFX_PointF& point);
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -070098 bool Annot_OnChar(CPDFSDK_Annot* pAnnot, uint32_t nChar, uint32_t nFlags);
99 bool Annot_OnKeyDown(CPDFSDK_Annot* pAnnot, int nKeyCode, int nFlag);
Haibo Huang49cc9302020-04-27 16:14:24 -0700100 bool Annot_OnSetFocus(ObservedPtr<CPDFSDK_Annot>* pAnnot, uint32_t nFlag);
101 bool Annot_OnKillFocus(ObservedPtr<CPDFSDK_Annot>* pAnnot, uint32_t nFlag);
102 bool Annot_SetIndexSelected(ObservedPtr<CPDFSDK_Annot>* pAnnot,
103 int index,
104 bool selected);
105 bool Annot_IsIndexSelected(ObservedPtr<CPDFSDK_Annot>* pAnnot, int index);
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700106
107#ifdef PDF_ENABLE_XFA
Haibo Huang49cc9302020-04-27 16:14:24 -0700108 bool Annot_OnChangeFocus(ObservedPtr<CPDFSDK_Annot>* pSetAnnot,
109 ObservedPtr<CPDFSDK_Annot>* pKillAnnot);
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700110#endif // PDF_ENABLE_XFA
111
112 CFX_FloatRect Annot_OnGetViewBBox(CPDFSDK_PageView* pPageView,
113 CPDFSDK_Annot* pAnnot);
114 bool Annot_OnHitTest(CPDFSDK_PageView* pPageView,
115 CPDFSDK_Annot* pAnnot,
Philip P. Moltmann33357ca2017-05-11 09:25:13 -0700116 const CFX_PointF& point);
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700117
118 private:
Haibo Huang49cc9302020-04-27 16:14:24 -0700119 friend class CPDFSDK_BAAnnotHandlerTest;
120
121 IPDFSDK_AnnotHandler* GetAnnotHandler(CPDFSDK_Annot* pAnnot) const;
122 IPDFSDK_AnnotHandler* GetAnnotHandlerOfType(
123 CPDF_Annot::Subtype nAnnotSubtype) const;
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700124 CPDFSDK_Annot* GetNextAnnot(CPDFSDK_Annot* pSDKAnnot, bool bNext);
125
Haibo Huang49cc9302020-04-27 16:14:24 -0700126 // |m_pBAAnnotHandler| and |m_pWidgetHandler| are always present, but
127 // |m_pXFAWidgetHandler| is only present in XFA mode.
128 std::unique_ptr<CPDFSDK_BAAnnotHandler> const m_pBAAnnotHandler;
129 std::unique_ptr<CPDFSDK_WidgetHandler> const m_pWidgetHandler;
130 std::unique_ptr<IPDFSDK_AnnotHandler> const m_pXFAWidgetHandler;
Philip P. Moltmann4d3acf42017-03-20 11:05:52 -0700131};
132
133#endif // FPDFSDK_CPDFSDK_ANNOTHANDLERMGR_H_