Merge to XFA: Fix ALL the include guards.
[pdfium.git] / fpdfsdk / include / pdfwindow / PWL_Edit.h
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.
4  
5 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
6
7 #ifndef FPDFSDK_INCLUDE_PDFWINDOW_PWL_EDIT_H_
8 #define FPDFSDK_INCLUDE_PDFWINDOW_PWL_EDIT_H_
9
10 #include "../../../core/include/fxcrt/fx_basic.h"
11 #include "PWL_EditCtrl.h"
12 #include "PWL_Wnd.h"
13
14 class CPWL_Edit;
15 class IPWL_Filler_Notify;
16 class IPWL_SpellCheck;
17
18 class IPWL_Filler_Notify
19 {
20 public:
21         virtual ~IPWL_Filler_Notify() { }
22         virtual void                                    QueryWherePopup(void* pPrivateData, FX_FLOAT fPopupMin,FX_FLOAT fPopupMax, 
23                                                                                 FX_INT32 & nRet, FX_FLOAT & fPopupRet) = 0; //nRet: (0:bottom 1:top)
24         virtual void                                    OnBeforeKeyStroke(FX_BOOL bEditOrList, void* pPrivateData, FX_INT32 nKeyCode,
25                                                                                 CFX_WideString & strChange, const CFX_WideString& strChangeEx, 
26                                                                                 int nSelStart, int nSelEnd,
27                                                                                 FX_BOOL bKeyDown, FX_BOOL & bRC, FX_BOOL & bExit, FX_DWORD nFlag) = 0;
28         virtual void                                    OnAfterKeyStroke(FX_BOOL bEditOrList, void* pPrivateData, FX_BOOL & bExit, FX_DWORD nFlag) = 0;
29
30         virtual void                                    OnPopupPreOpen(void* pPrivateData, FX_BOOL& bExit, FX_DWORD nFlag) = 0;
31         virtual void                                    OnPopupPostOpen(void* pPrivateData, FX_BOOL& bExit, FX_DWORD nFlag) = 0;
32 };
33
34 class PWL_CLASS CPWL_Edit : public CPWL_EditCtrl, public IFX_Edit_OprNotify
35 {
36 public:
37         CPWL_Edit();
38         virtual ~CPWL_Edit();
39
40 public:
41         virtual CFX_ByteString                  GetClassName() const;
42         virtual void                                    OnDestroy();
43         virtual void                                    OnCreated();
44         virtual void                                    RePosChildWnd();
45         virtual CPDF_Rect                               GetClientRect() const;
46
47         virtual void                                    GetThisAppearanceStream(CFX_ByteTextBuf & sAppStream);
48         virtual void                                    DrawThisAppearance(CFX_RenderDevice* pDevice, CPDF_Matrix* pUser2Device);
49
50         virtual FX_BOOL                                 OnLButtonDown(const CPDF_Point & point, FX_DWORD nFlag);
51         virtual FX_BOOL                                 OnLButtonDblClk(const CPDF_Point & point, FX_DWORD nFlag);
52         virtual FX_BOOL                                 OnRButtonUp(const CPDF_Point & point, FX_DWORD nFlag);
53         virtual FX_BOOL                                 OnMouseWheel(short zDelta, const CPDF_Point & point, FX_DWORD nFlag);
54
55         virtual FX_BOOL                                 OnKeyDown(FX_WORD nChar, FX_DWORD nFlag);
56         virtual FX_BOOL                                 OnChar(FX_WORD nChar, FX_DWORD nFlag);
57
58         virtual CPDF_Rect                               GetFocusRect() const;
59
60 public:         
61         void                                                    SetAlignFormatH(PWL_EDIT_ALIGNFORMAT_H nFormat = PEAH_LEFT, FX_BOOL bPaint = TRUE);     //0:left 1:right 2:middle 
62         void                                                    SetAlignFormatV(PWL_EDIT_ALIGNFORMAT_V nFormat = PEAV_TOP, FX_BOOL bPaint = TRUE);      //0:top 1:bottom 2:center
63
64         void                                                    SetCharArray(FX_INT32 nCharArray);
65         void                                                    SetLimitChar(FX_INT32 nLimitChar);
66
67         void                                                    SetHorzScale(FX_INT32 nHorzScale, FX_BOOL bPaint = TRUE);
68         void                                                    SetCharSpace(FX_FLOAT fCharSpace, FX_BOOL bPaint = TRUE);
69
70         void                                                    SetLineLeading(FX_FLOAT fLineLeading, FX_BOOL bPaint = TRUE);
71
72         void                                                    EnableSpellCheck(FX_BOOL bEnabled);
73
74         FX_BOOL                                                 CanSelectAll() const;
75         FX_BOOL                                                 CanClear() const;
76         FX_BOOL                                                 CanCopy() const;
77         FX_BOOL                                                 CanCut() const;
78         FX_BOOL                                                 CanPaste() const;
79
80         virtual void                                    CopyText();
81         virtual void                                    PasteText();
82         virtual void                                    CutText();
83
84         virtual void                                    SetText(FX_LPCWSTR csText);
85         void                                                    ReplaceSel(FX_LPCWSTR csText);
86
87         CFX_ByteString                                  GetTextAppearanceStream(const CPDF_Point & ptOffset) const;
88         CFX_ByteString                                  GetCaretAppearanceStream(const CPDF_Point & ptOffset) const;    
89         CFX_ByteString                                  GetSelectAppearanceStream(const CPDF_Point & ptOffset) const;
90
91         FX_BOOL                                                 IsTextFull() const;     
92
93         static FX_FLOAT                                 GetCharArrayAutoFontSize(CPDF_Font* pFont, const CPDF_Rect& rcPlate, FX_INT32 nCharArray);
94
95         void                                                    SetFillerNotify(IPWL_Filler_Notify* pNotify) {m_pFillerNotify = pNotify;}
96
97         void                                                    GeneratePageObjects(CPDF_PageObjects* pPageObjects, 
98                                                                                 const CPDF_Point& ptOffset, CFX_ArrayTemplate<CPDF_TextObject*>& ObjArray);
99         void                                                    GeneratePageObjects(CPDF_PageObjects* pPageObjects, 
100                                                                                 const CPDF_Point& ptOffset);
101
102 protected:
103         virtual void                                    OnSetFocus();
104         virtual void                                    OnKillFocus();
105
106 protected:
107         virtual void                                    OnInsertWord(const CPVT_WordPlace& place, const CPVT_WordPlace& oldplace);
108         virtual void                                    OnInsertReturn(const CPVT_WordPlace& place, const CPVT_WordPlace& oldplace);
109         virtual void                                    OnBackSpace(const CPVT_WordPlace& place, const CPVT_WordPlace& oldplace);
110         virtual void                                    OnDelete(const CPVT_WordPlace& place, const CPVT_WordPlace& oldplace);
111         virtual void                                    OnClear(const CPVT_WordPlace& place, const CPVT_WordPlace& oldplace);
112         virtual void                                    OnSetText(const CPVT_WordPlace& place, const CPVT_WordPlace& oldplace);
113         virtual void                                    OnInsertText(const CPVT_WordPlace& place, const CPVT_WordPlace& oldplace);
114         virtual void                                    OnAddUndo(IFX_Edit_UndoItem* pUndoItem);
115
116 private:        
117         CPVT_WordRange                                  GetSelectWordRange() const;
118         virtual void                                    ShowVScrollBar(FX_BOOL bShow);
119         FX_BOOL                                                 IsVScrollBarVisible() const;
120         void                                                    SetParamByFlag();
121
122         FX_FLOAT                                                GetCharArrayAutoFontSize(FX_INT32 nCharArray);
123         CPDF_Point                                              GetWordRightBottomPoint(const CPVT_WordPlace& wpWord);
124
125         CPVT_WordRange                                  CombineWordRange(const CPVT_WordRange& wr1, const CPVT_WordRange& wr2);
126         CPVT_WordRange                                  GetLatinWordsRange(const CPDF_Point & point) const;
127         CPVT_WordRange                                  GetLatinWordsRange(const CPVT_WordPlace & place) const;
128         CPVT_WordRange                                  GetArabicWordsRange(const CPVT_WordPlace & place) const;
129         CPVT_WordRange                                  GetSameWordsRange(const CPVT_WordPlace & place, FX_BOOL bLatin, FX_BOOL bArabic) const;
130
131         void                                                    AjustArabicWords(const CPVT_WordRange& wr);
132 public:
133         FX_BOOL                                                 IsProceedtoOnChar(FX_WORD nKeyCode, FX_DWORD nFlag);
134 private:
135         IPWL_Filler_Notify*                             m_pFillerNotify;
136         IPWL_SpellCheck*                                m_pSpellCheck;
137         FX_BOOL                                                 m_bFocus;
138         CPDF_Rect                                               m_rcOldWindow;
139 public:
140         void                                                    AttachFFLData(void* pData) {m_pFormFiller = pData;}
141 private:
142         void*                                                   m_pFormFiller;
143 };
144
145 #endif  // FPDFSDK_INCLUDE_PDFWINDOW_PWL_EDIT_H_