| // Copyright 2014 PDFium Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com |
| |
| #ifndef FPDFSDK_INCLUDE_FSDK_ANNOTHANDLER_H_ |
| #define FPDFSDK_INCLUDE_FSDK_ANNOTHANDLER_H_ |
| |
| #include <map> |
| #include <vector> |
| |
| #include "core/include/fxcrt/fx_basic.h" |
| |
| #ifdef PDF_ENABLE_XFA |
| #define FSDK_XFAWIDGET_TYPENAME "XFAWidget" |
| |
| #endif |
| class CFFL_IFormFiller; |
| class CFX_RenderDevice; |
| class CPDFDoc_Environment; |
| class CPDFSDK_Annot; |
| class CPDFSDK_PageView; |
| class CPDF_Annot; |
| class CPDF_Matrix; |
| class CPDF_Point; |
| class CPDF_Rect; |
| |
| class IPDFSDK_AnnotHandler { |
| public: |
| virtual ~IPDFSDK_AnnotHandler() {} |
| |
| virtual CFX_ByteString GetType() = 0; |
| |
| virtual CFX_ByteString GetName() = 0; |
| |
| virtual FX_BOOL CanAnswer(CPDFSDK_Annot* pAnnot) = 0; |
| |
| virtual CPDFSDK_Annot* NewAnnot(CPDF_Annot* pAnnot, |
| CPDFSDK_PageView* pPage) = 0; |
| |
| #ifdef PDF_ENABLE_XFA |
| virtual CPDFSDK_Annot* NewAnnot(IXFA_Widget* hWidget, |
| CPDFSDK_PageView* pPage) = 0; |
| |
| #endif |
| virtual void ReleaseAnnot(CPDFSDK_Annot* pAnnot) = 0; |
| |
| virtual void DeleteAnnot(CPDFSDK_Annot* pAnnot) = 0; |
| |
| virtual CPDF_Rect GetViewBBox(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot) = 0; |
| |
| virtual FX_BOOL HitTest(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| const CPDF_Point& point) = 0; |
| |
| virtual void OnDraw(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| CFX_RenderDevice* pDevice, |
| CPDF_Matrix* pUser2Device, |
| FX_DWORD dwFlags) = 0; |
| |
| virtual void OnDrawSleep(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| CFX_RenderDevice* pDevice, |
| CPDF_Matrix* pUser2Device, |
| const CPDF_Rect& rcWindow, |
| FX_DWORD dwFlags) = 0; |
| |
| virtual void OnCreate(CPDFSDK_Annot* pAnnot) = 0; |
| |
| virtual void OnLoad(CPDFSDK_Annot* pAnnot) = 0; |
| |
| virtual void OnDelete(CPDFSDK_Annot* pAnnot) = 0; |
| |
| virtual void OnRelease(CPDFSDK_Annot* pAnnot) = 0; |
| |
| virtual void OnMouseEnter(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlag) = 0; |
| virtual void OnMouseExit(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlag) = 0; |
| |
| virtual FX_BOOL OnLButtonDown(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| const CPDF_Point& point) = 0; |
| virtual FX_BOOL OnLButtonUp(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| const CPDF_Point& point) = 0; |
| virtual FX_BOOL OnLButtonDblClk(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| const CPDF_Point& point) = 0; |
| virtual FX_BOOL OnMouseMove(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| const CPDF_Point& point) = 0; |
| virtual FX_BOOL OnMouseWheel(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| short zDelta, |
| const CPDF_Point& point) = 0; |
| virtual FX_BOOL OnRButtonDown(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| const CPDF_Point& point) = 0; |
| virtual FX_BOOL OnRButtonUp(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| const CPDF_Point& point) = 0; |
| virtual FX_BOOL OnRButtonDblClk(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| const CPDF_Point& point) = 0; |
| // by wjm. |
| virtual FX_BOOL OnChar(CPDFSDK_Annot* pAnnot, |
| FX_DWORD nChar, |
| FX_DWORD nFlags) = 0; |
| virtual FX_BOOL OnKeyDown(CPDFSDK_Annot* pAnnot, int nKeyCode, int nFlag) = 0; |
| virtual FX_BOOL OnKeyUp(CPDFSDK_Annot* pAnnot, int nKeyCode, int nFlag) = 0; |
| |
| virtual void OnDeSelected(CPDFSDK_Annot* pAnnot) = 0; |
| virtual void OnSelected(CPDFSDK_Annot* pAnnot) = 0; |
| |
| virtual FX_BOOL OnSetFocus(CPDFSDK_Annot* pAnnot, FX_DWORD nFlag) = 0; |
| virtual FX_BOOL OnKillFocus(CPDFSDK_Annot* pAnnot, FX_DWORD nFlag) = 0; |
| #ifdef PDF_ENABLE_XFA |
| virtual FX_BOOL OnXFAChangedFocus(CPDFSDK_Annot* pOldAnnot, |
| CPDFSDK_Annot* pNewAnnot) = 0; |
| #endif |
| }; |
| |
| class CPDFSDK_BFAnnotHandler : public IPDFSDK_AnnotHandler { |
| public: |
| explicit CPDFSDK_BFAnnotHandler(CPDFDoc_Environment* pApp) |
| : m_pApp(pApp), m_pFormFiller(NULL) {} |
| ~CPDFSDK_BFAnnotHandler() override {} |
| |
| // IPDFSDK_AnnotHandler |
| CFX_ByteString GetType() override { return CFX_ByteString("Widget"); } |
| CFX_ByteString GetName() override { return CFX_ByteString("WidgetHandler"); } |
| FX_BOOL CanAnswer(CPDFSDK_Annot* pAnnot) override; |
| CPDFSDK_Annot* NewAnnot(CPDF_Annot* pAnnot, CPDFSDK_PageView* pPage) override; |
| #ifdef PDF_ENABLE_XFA |
| CPDFSDK_Annot* NewAnnot(IXFA_Widget* hWidget, |
| CPDFSDK_PageView* pPage) override; |
| #endif |
| void ReleaseAnnot(CPDFSDK_Annot* pAnnot) override; |
| void DeleteAnnot(CPDFSDK_Annot* pAnnot) override {} |
| CPDF_Rect GetViewBBox(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot) override; |
| FX_BOOL HitTest(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| const CPDF_Point& point) override; |
| void OnDraw(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| CFX_RenderDevice* pDevice, |
| CPDF_Matrix* pUser2Device, |
| FX_DWORD dwFlags) override; |
| void OnDrawSleep(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| CFX_RenderDevice* pDevice, |
| CPDF_Matrix* pUser2Device, |
| const CPDF_Rect& rcWindow, |
| FX_DWORD dwFlags) override {} |
| void OnCreate(CPDFSDK_Annot* pAnnot) override; |
| void OnLoad(CPDFSDK_Annot* pAnnot) override; |
| void OnDelete(CPDFSDK_Annot* pAnnot) override {} |
| void OnRelease(CPDFSDK_Annot* pAnnot) override {} |
| void OnMouseEnter(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlag) override; |
| void OnMouseExit(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlag) override; |
| FX_BOOL OnLButtonDown(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| const CPDF_Point& point) override; |
| FX_BOOL OnLButtonUp(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| const CPDF_Point& point) override; |
| FX_BOOL OnLButtonDblClk(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| const CPDF_Point& point) override; |
| FX_BOOL OnMouseMove(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| const CPDF_Point& point) override; |
| FX_BOOL OnMouseWheel(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| short zDelta, |
| const CPDF_Point& point) override; |
| FX_BOOL OnRButtonDown(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| const CPDF_Point& point) override; |
| FX_BOOL OnRButtonUp(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| const CPDF_Point& point) override; |
| FX_BOOL OnRButtonDblClk(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| const CPDF_Point& point) override { |
| return FALSE; |
| } |
| FX_BOOL OnChar(CPDFSDK_Annot* pAnnot, |
| FX_DWORD nChar, |
| FX_DWORD nFlags) override; |
| FX_BOOL OnKeyDown(CPDFSDK_Annot* pAnnot, int nKeyCode, int nFlag) override; |
| FX_BOOL OnKeyUp(CPDFSDK_Annot* pAnnot, int nKeyCode, int nFlag) override; |
| void OnDeSelected(CPDFSDK_Annot* pAnnot) override {} |
| void OnSelected(CPDFSDK_Annot* pAnnot) override {} |
| FX_BOOL OnSetFocus(CPDFSDK_Annot* pAnnot, FX_DWORD nFlag) override; |
| FX_BOOL OnKillFocus(CPDFSDK_Annot* pAnnot, FX_DWORD nFlag) override; |
| #ifdef PDF_ENABLE_XFA |
| FX_BOOL OnXFAChangedFocus(CPDFSDK_Annot* pOldAnnot, |
| CPDFSDK_Annot* pNewAnnot) override { |
| return TRUE; |
| } |
| #endif |
| |
| void SetFormFiller(CFFL_IFormFiller* pFiller) { m_pFormFiller = pFiller; } |
| CFFL_IFormFiller* GetFormFiller() { return m_pFormFiller; } |
| |
| private: |
| CPDFDoc_Environment* m_pApp; |
| CFFL_IFormFiller* m_pFormFiller; |
| }; |
| |
| #ifdef PDF_ENABLE_XFA |
| class CPDFSDK_XFAAnnotHandler : public IPDFSDK_AnnotHandler { |
| public: |
| explicit CPDFSDK_XFAAnnotHandler(CPDFDoc_Environment* pApp); |
| ~CPDFSDK_XFAAnnotHandler() {} |
| |
| public: |
| virtual CFX_ByteString GetType() { return FSDK_XFAWIDGET_TYPENAME; } |
| |
| virtual CFX_ByteString GetName() { return "XFAWidgetHandler"; } |
| |
| virtual FX_BOOL CanAnswer(CPDFSDK_Annot* pAnnot); |
| |
| virtual CPDFSDK_Annot* NewAnnot(CPDF_Annot* pAnnot, CPDFSDK_PageView* pPage) { |
| return NULL; |
| } |
| |
| virtual CPDFSDK_Annot* NewAnnot(IXFA_Widget* pAnnot, CPDFSDK_PageView* pPage); |
| |
| virtual void ReleaseAnnot(CPDFSDK_Annot* pAnnot); |
| |
| virtual void DeleteAnnot(CPDFSDK_Annot* pAnnot) {} |
| |
| virtual CPDF_Rect GetViewBBox(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot); |
| |
| virtual FX_BOOL HitTest(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| const CPDF_Point& point); |
| |
| virtual void OnDraw(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| CFX_RenderDevice* pDevice, |
| CPDF_Matrix* pUser2Device, |
| FX_DWORD dwFlags); |
| |
| virtual void OnDrawSleep(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| CFX_RenderDevice* pDevice, |
| CPDF_Matrix* pUser2Device, |
| const CPDF_Rect& rcWindow, |
| FX_DWORD dwFlags) {} |
| |
| virtual void OnCreate(CPDFSDK_Annot* pAnnot) {} |
| |
| virtual void OnLoad(CPDFSDK_Annot* pAnnot) {} |
| |
| virtual void OnDelete(CPDFSDK_Annot* pAnnot) {} |
| |
| virtual void OnRelease(CPDFSDK_Annot* pAnnot) {} |
| |
| virtual void OnMouseEnter(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlag); |
| virtual void OnMouseExit(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlag); |
| |
| virtual FX_BOOL OnLButtonDown(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| const CPDF_Point& point); |
| virtual FX_BOOL OnLButtonUp(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| const CPDF_Point& point); |
| virtual FX_BOOL OnLButtonDblClk(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| const CPDF_Point& point); |
| virtual FX_BOOL OnMouseMove(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| const CPDF_Point& point); |
| virtual FX_BOOL OnMouseWheel(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| short zDelta, |
| const CPDF_Point& point); |
| virtual FX_BOOL OnRButtonDown(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| const CPDF_Point& point); |
| virtual FX_BOOL OnRButtonUp(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| const CPDF_Point& point); |
| virtual FX_BOOL OnRButtonDblClk(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| const CPDF_Point& point); |
| // by wjm. |
| virtual FX_BOOL OnChar(CPDFSDK_Annot* pAnnot, |
| FX_DWORD nChar, |
| FX_DWORD nFlags); |
| virtual FX_BOOL OnKeyDown(CPDFSDK_Annot* pAnnot, int nKeyCode, int nFlag); |
| virtual FX_BOOL OnKeyUp(CPDFSDK_Annot* pAnnot, int nKeyCode, int nFlag); |
| |
| virtual void OnDeSelected(CPDFSDK_Annot* pAnnot) {} |
| virtual void OnSelected(CPDFSDK_Annot* pAnnot) {} |
| |
| virtual FX_BOOL OnSetFocus(CPDFSDK_Annot* pAnnot, FX_DWORD nFlag); |
| virtual FX_BOOL OnKillFocus(CPDFSDK_Annot* pAnnot, FX_DWORD nFlag); |
| virtual FX_BOOL OnXFAChangedFocus(CPDFSDK_Annot* pOldAnnot, |
| CPDFSDK_Annot* pNewAnnot); |
| |
| private: |
| IXFA_WidgetHandler* GetXFAWidgetHandler(CPDFSDK_Annot* pAnnot); |
| FX_DWORD GetFWLFlags(FX_DWORD dwFlag); |
| |
| private: |
| CPDFDoc_Environment* m_pApp; |
| }; |
| |
| #endif |
| #define CBA_AnnotHandlerArray CFX_ArrayTemplate<IPDFSDK_AnnotHandler*> |
| class CPDFSDK_AnnotHandlerMgr { |
| public: |
| // Destroy the handler |
| explicit CPDFSDK_AnnotHandlerMgr(CPDFDoc_Environment* pApp); |
| virtual ~CPDFSDK_AnnotHandlerMgr(); |
| |
| public: |
| void RegisterAnnotHandler(IPDFSDK_AnnotHandler* pAnnotHandler); |
| void UnRegisterAnnotHandler(IPDFSDK_AnnotHandler* pAnnotHandler); |
| |
| virtual CPDFSDK_Annot* NewAnnot(CPDF_Annot* pAnnot, |
| CPDFSDK_PageView* pPageView); |
| #ifdef PDF_ENABLE_XFA |
| virtual CPDFSDK_Annot* NewAnnot(IXFA_Widget* pAnnot, |
| CPDFSDK_PageView* pPageView); |
| #endif |
| virtual void ReleaseAnnot(CPDFSDK_Annot* pAnnot); |
| |
| virtual void Annot_OnCreate(CPDFSDK_Annot* pAnnot); |
| virtual void Annot_OnLoad(CPDFSDK_Annot* pAnnot); |
| |
| public: |
| IPDFSDK_AnnotHandler* GetAnnotHandler(CPDFSDK_Annot* pAnnot) const; |
| virtual void Annot_OnDraw(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| CFX_RenderDevice* pDevice, |
| CPDF_Matrix* pUser2Device, |
| FX_DWORD dwFlags); |
| |
| virtual void Annot_OnMouseEnter(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags); |
| virtual void Annot_OnMouseExit(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags); |
| |
| virtual FX_BOOL Annot_OnLButtonDown(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| const CPDF_Point& point); |
| virtual FX_BOOL Annot_OnLButtonUp(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| const CPDF_Point& point); |
| virtual FX_BOOL Annot_OnLButtonDblClk(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| const CPDF_Point& point); |
| |
| virtual FX_BOOL Annot_OnMouseMove(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| const CPDF_Point& point); |
| virtual FX_BOOL Annot_OnMouseWheel(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| short zDelta, |
| const CPDF_Point& point); |
| virtual FX_BOOL Annot_OnRButtonDown(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| const CPDF_Point& point); |
| virtual FX_BOOL Annot_OnRButtonUp(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| FX_DWORD nFlags, |
| const CPDF_Point& point); |
| |
| virtual FX_BOOL Annot_OnChar(CPDFSDK_Annot* pAnnot, |
| FX_DWORD nChar, |
| FX_DWORD nFlags); |
| virtual FX_BOOL Annot_OnKeyDown(CPDFSDK_Annot* pAnnot, |
| int nKeyCode, |
| int nFlag); |
| virtual FX_BOOL Annot_OnKeyUp(CPDFSDK_Annot* pAnnot, int nKeyCode, int nFlag); |
| |
| virtual FX_BOOL Annot_OnSetFocus(CPDFSDK_Annot* pAnnot, FX_DWORD nFlag); |
| virtual FX_BOOL Annot_OnKillFocus(CPDFSDK_Annot* pAnnot, FX_DWORD nFlag); |
| #ifdef PDF_ENABLE_XFA |
| virtual FX_BOOL Annot_OnChangeFocus(CPDFSDK_Annot* pSetAnnot, |
| CPDFSDK_Annot* pKillAnnot); |
| #endif |
| |
| virtual CPDF_Rect Annot_OnGetViewBBox(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot); |
| virtual FX_BOOL Annot_OnHitTest(CPDFSDK_PageView* pPageView, |
| CPDFSDK_Annot* pAnnot, |
| const CPDF_Point& point); |
| |
| private: |
| IPDFSDK_AnnotHandler* GetAnnotHandler(const CFX_ByteString& sType) const; |
| CPDFSDK_Annot* GetNextAnnot(CPDFSDK_Annot* pSDKAnnot, FX_BOOL bNext); |
| |
| private: |
| CBA_AnnotHandlerArray m_Handlers; |
| std::map<CFX_ByteString, IPDFSDK_AnnotHandler*> m_mapType2Handler; |
| CPDFDoc_Environment* m_pApp; |
| }; |
| |
| class CPDFSDK_AnnotIterator { |
| public: |
| CPDFSDK_AnnotIterator(CPDFSDK_PageView* pPageView, bool bReverse); |
| ~CPDFSDK_AnnotIterator(); |
| |
| CPDFSDK_Annot* Next(); |
| |
| private: |
| CPDFSDK_Annot* NextAnnot(); |
| CPDFSDK_Annot* PrevAnnot(); |
| |
| std::vector<CPDFSDK_Annot*> m_iteratorAnnotList; |
| const bool m_bReverse; |
| size_t m_pos; |
| }; |
| |
| #endif // FPDFSDK_INCLUDE_FSDK_ANNOTHANDLER_H_ |