Foxit PDF SDK

fs_formfiller.h
Go to the documentation of this file.
1
15 #ifndef FS_FORMFILLER_H_
16 #define FS_FORMFILLER_H_
17
18 #include "common/fs_common.h"
19 #include "common/fs_render.h"
20
26 namespace foxit {
30 namespace pdf {
31 class PDFPage;
35 namespace interform {
36 // forward declaration
37 class Form;
38 class Control;
39
44 class TimerCallback {
45 public:
53 virtual void OnTimer(int timer) = 0;
54
55 protected:
56 ~TimerCallback() {}
57 };
58
63 class FillerAssistCallback {
64 public:
70 typedef enum _PopupMenuItem {
72 e_PopupMenuItemNone = 0,
74 e_PopupMenuItemCut = 1,
76 e_PopupMenuItemCopy = 2,
78 e_PopupMenuItemPaste = 3,
80 e_PopupMenuItemDelete = 4,
82 e_PopupMenuItemSelectAll = 5
83 } PopupMenuItem;
84
90 virtual void Release() = 0;
91
97 virtual int GetVersion() {return 1;}
98
108 virtual void Refresh(const PDFPage& page, const RectF* rect) = 0;
109
126 virtual bool SetTimerCallback(int elapse, TimerCallback* timer, int* out_timer_id) = 0;
127
136 virtual bool KillTimer(int timer_id) = 0;
137
150 virtual void FocusGotOnControl(const Control& control, const char* value) = 0;
151
164 virtual void FocusLostFromControl(const Control& control, const char* value) = 0;
165
173 virtual void* CreatePopupMenu() = 0;
174
187 virtual bool AppendPopupMenuItem(const void* h_popup_menu, PopupMenuItem popup_menu_item, const wchar_t* default_string) = 0;
188
201 virtual bool EnablePopupMenuItem(const void* h_popup_menu, PopupMenuItem popup_menu_item, bool is_enabled) = 0;
202
213 virtual bool ShowPopupMenu(const void* h_popup_menu, const PointF& point) = 0;
214
224 virtual void DestroyPopupMenu(const void* h_popup_menu) = 0;
225
235 virtual void SetClipboardText(const wchar_t* text) = 0;
236
244 virtual WString GetClipboardText() = 0;
245
256 virtual void ReportInvalidValue(const wchar_t* form_field_name, const wchar_t* invalid_value) = 0;
257
258 protected:
259 ~FillerAssistCallback() {}
260 };
261
271 class Filler FS_FINAL : public Base {
272 public:
278 typedef enum _VirtualKeyCode {
280 e_VkeyUnknown = 0x00,
282 e_VkeyBack = 0x08,
284 e_VkeyTab = 0x09,
286 e_VkeyReturn = 0x0D,
288 e_VkeyShift = 0x10,
290 e_VkeyControl = 0x11,
292 e_VkeyMenu = 0x12,
294 e_VkeyPause = 0x13,
296 e_VkeyEscape = 0x1B,
298 e_VkeySpace = 0x20,
300 e_VkeyPrior = 0x21,
302 e_VkeyNext = 0x22,
304 e_VkeyEnd = 0x23,
306 e_VkeyHome = 0x24,
308 e_VkeyLeft = 0x25,
310 e_VkeyUp = 0x26,
312 e_VkeyRight = 0x27,
314 e_VkeyDown = 0x28,
316 e_VkeyPrint = 0x2A,
318 e_VkeySnapshot = 0x2C,
320 e_VkeyInsert = 0x2D,
322 e_VkeyDelete = 0x2E,
324 e_VkeyHelp = 0x2F,
326 e_Vkey0 = 0x30,
328 e_Vkey1 = 0x31,
330 e_Vkey2 = 0x32,
332 e_Vkey3 = 0x33,
334 e_Vkey4 = 0x34,
336 e_Vkey5 = 0x35,
338 e_Vkey6 = 0x36,
340 e_Vkey7 = 0x37,
342 e_Vkey8 = 0x38,
344 e_Vkey9 = 0x39,
346 e_VkeyA = 0x41,
348 e_VkeyB = 0x42,
350 e_VkeyC = 0x43,
352 e_VkeyD = 0x44,
354 e_VkeyE = 0x45,
356 e_VkeyF = 0x46,
358 e_VkeyG = 0x47,
360 e_VkeyH = 0x48,
362 e_VkeyI = 0x49,
364 e_VkeyJ = 0x4A,
366 e_VkeyK = 0x4B,
368 e_VkeyL = 0x4C,
370 e_VkeyM = 0x4D,
372 e_VkeyN = 0x4E,
374 e_VkeyO = 0x4F,
376 e_VkeyP = 0x50,
378 e_VkeyQ = 0x51,
380 e_VkeyR = 0x52,
382 e_VkeyS = 0x53,
384 e_VkeyT = 0x54,
386 e_VkeyU = 0x55,
388 e_VkeyV = 0x56,
390 e_VkeyW = 0x57,
392 e_VkeyX = 0x58,
394 e_VkeyY = 0x59,
396 e_VkeyZ = 0x5A,
398 e_VkeyNumpad0 = 0x60,
400 e_VkeyNumpad1 = 0x61,
402 e_VkeyNumpad2 = 0x62,
404 e_VkeyNumpad3 = 0x63,
406 e_VkeyNumpad4 = 0x64,
408 e_VkeyNumpad5 = 0x65,
410 e_VkeyNumpad6 = 0x66,
412 e_VkeyNumpad7 = 0x67,
414 e_VkeyNumpad8 = 0x68,
416 e_VkeyNumpad9 = 0x69,
418 e_VkeyMultiply = 0x6A,
420 e_VkeyAdd = 0x6B,
422 e_VkeySeparator = 0x6C,
424 e_VkeySubtract = 0x6D,
426 e_VkeyDecimal = 0x6E,
428 e_VkeyDivide = 0x6F,
430 e_VkeyF1 = 0x70,
432 e_VkeyF2 = 0x71,
434 e_VkeyF3 = 0x72,
436 e_VkeyF4 = 0x73,
438 e_VkeyF5 = 0x74,
440 e_VkeyF6 = 0x75,
442 e_VkeyF7 = 0x76,
444 e_VkeyF8 = 0x77,
446 e_VkeyF9 = 0x78,
448 e_VkeyF10 = 0x79,
450 e_VkeyF11 = 0x7A,
452 e_VkeyF12 = 0x7B
453 } VirtualKeyCode;
454
460 typedef enum _EventFlags {
462 e_EventFlagShiftKey = 0x0001,
464 e_EventFlagControlKey = 0x0002,
466 e_EventFlagAltKey = 0x0004,
468 e_EventFlagMetaKey = 0x0008,
470 e_EventFlagKeyPad = 0x0010,
472 e_EventFlagAutoRepeat = 0x0020,
474 e_EventFlagLeftButtonDown = 0x0040,
476 e_EventFlagMiddleButtonDown = 0x0080,
478 e_EventFlagRightButtonDown = 0x0100,
480 e_EventFlagCommand = 0x0200
481 } EventFlags;
482
483
493 explicit Filler(const Form& form, FillerAssistCallback* assist);
494
496 ~Filler();
497
503 Filler(const Filler& other);
511 Filler& operator = (const Filler& other);
512
520 bool operator == (const Filler& other) const;
528 bool operator != (const Filler& other) const;
529
537 bool IsEmpty() const;
538
555 void Render(const PDFPage& page, const Matrix& matrix,const common::Renderer& renderer);
556
567 bool OnLButtonDown(const PDFPage& page, const PointF& point, uint32 flags);
568
579 bool OnLButtonUp(const PDFPage& page, const PointF& point, uint32 flags);
580
591 bool OnLButtonDoubleClick(const PDFPage& page, const PointF& point, uint32 flags);
592
603 bool OnMouseMove(const PDFPage& page, const PointF& point, uint32 flags);
604
616 bool OnMouseEnter(const PDFPage& page, const PointF& point, uint32 flags);
617
629 bool OnMouseHover(const PDFPage& page, const PointF& point, uint32 flags);
630
642 bool OnMouseLeave(const PDFPage& page, const PointF& point, uint32 flags);
643
657 bool OnMouseWheel(const PDFPage& page, const PointF& point, int32 delta, uint32 flags);
658
670 bool OnRButtonDown(const PDFPage& page, const PointF& point, uint32 flags);
671
683 bool OnRButtonUp(const PDFPage& page, const PointF& point, uint32 flags);
684
696 bool OnRButtonDoubleClick(const PDFPage& page, const PointF& point, uint32 flags);
697
709 bool OnWheelButtonDown(const PDFPage& page, const PointF& point, uint32 flags);
710
722 bool OnWheelButtonUp(const PDFPage& page, const PointF& point, uint32 flags);
723
735 bool OnWheelButtonDoubleClick(const PDFPage& page, const PointF& point, uint32 flags);
736
748 bool OnKeyDown(uint32 key_code, uint32 flags);
749
761 bool OnKeyUp(uint32 key_code, uint32 flags);
762
772 bool OnChar(uint32 char_code, uint32 flags);
773
782 bool SetFocus(const Control& control);
783
789 bool KillFocus();
790
803 void HighlightFormFields(bool is_highlight);
804
821 void HighlightFormFields(bool is_highlight, bool is_sign_highlight);
822
833 void SetHighlightColor(ARGB color);
834
845 void ShowOverflowIndicator(bool is_show_overflow_indicator);
846
852 bool OnCut();
853
859 bool OnCopy();
860
866 bool OnPaste();
867
873 bool OnSelectAll();
874
880 bool OnDelete();
881
890 PointF GetEditingTextCaretPosition(Matrix matrix);
891
892 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
893 explicit Filler(FS_HANDLE handle = NULL);
894 };
895 } // namespace interform
896 } // namespace pdf
897 } // namespace foxit
898 #endif // FS_FORMFILLER_H_
899
foxit::pdf::interform::Filler::e_EventFlagCommand
Event flag: the command key.
Definition: fs_formfiller.h:480
foxit::pdf::interform::Filler::OnMouseEnter
bool OnMouseEnter(const PDFPage &page, const PointF &point, uint32 flags)
(Reserved, unsupported yet) Call this function when mouse enters somewhere.
foxit::pdf::interform::FillerAssistCallback::e_PopupMenuItemSelectAll
Popup menu item: "Select All".
Definition: fs_formfiller.h:82
foxit::pdf::interform::Filler::OnWheelButtonDown
bool OnWheelButtonDown(const PDFPage &page, const PointF &point, uint32 flags)
(Reserved, unsupported yet) Call this function when mouse wheel button is down.
foxit::pdf::interform::FillerAssistCallback::SetClipboardText
virtual void SetClipboardText(const wchar_t *text)=0
A callback function which is triggered when need to set clipboard text.
foxit::pdf::interform::Filler::e_VkeyH
H key.
Definition: fs_formfiller.h:360
foxit::pdf::interform::Filler::e_VkeyMenu
Menu key.
Definition: fs_formfiller.h:292
foxit::pdf::interform::Control
Definition: fs_pdfform.h:1235
foxit::pdf::interform::Filler::e_VkeyF9
F9 key.
Definition: fs_formfiller.h:446
foxit::pdf::interform::Filler::e_VkeyAdd
Plus key in the numeric keypad.
Definition: fs_formfiller.h:420
foxit::pdf::interform::Filler::OnKeyUp
bool OnKeyUp(uint32 key_code, uint32 flags)
Call this function when key on the keyboard is up.
foxit::FS_HANDLE
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:213
foxit::pdf::interform::Filler::e_VkeyShift
Shift key.
Definition: fs_formfiller.h:288
foxit::pdf::interform::Filler::OnSelectAll
bool OnSelectAll()
Call this function when the popup menu item "Select All" is down.
foxit::pdf::interform::Filler::e_VkeyNext
Page Down key.
Definition: fs_formfiller.h:302
foxit::pdf::interform::Filler::e_VkeyNumpad2
2 key in the numeric keypad.
Definition: fs_formfiller.h:402
foxit::pdf::interform::Filler::OnWheelButtonUp
bool OnWheelButtonUp(const PDFPage &page, const PointF &point, uint32 flags)
(Reserved, unsupported yet) Call this function when mouse wheel button is up.
foxit::pdf::interform::Filler::e_Vkey3
3 key.
Definition: fs_formfiller.h:332
foxit::pdf::interform::Filler::e_VkeyX
X key.
Definition: fs_formfiller.h:392
foxit::pdf::interform::Filler::e_VkeyNumpad3
3 key in the numeric keypad.
Definition: fs_formfiller.h:404
foxit::pdf::interform::Filler::OnMouseMove
bool OnMouseMove(const PDFPage &page, const PointF &point, uint32 flags)
Call this function when mouse moves.
foxit::pdf::interform::Filler::e_VkeyG
G key.
Definition: fs_formfiller.h:358
foxit::pdf::interform::Filler::ShowOverflowIndicator
void ShowOverflowIndicator(bool is_show_overflow_indicator)
Decide whether to show the overflow indicator when the text in text field overflow.
foxit::pdf::interform::Filler::e_EventFlagRightButtonDown
Event flag: the right button of the mouse is down.
Definition: fs_formfiller.h:478
foxit::pdf::interform::Filler::OnRButtonDoubleClick
bool OnRButtonDoubleClick(const PDFPage &page, const PointF &point, uint32 flags)
(Reserved, unsupported yet) Call this function when right mouse button is double clicked.
foxit::pdf::interform::Filler::e_VkeyMultiply
Multiply key in the numeric keypad.
Definition: fs_formfiller.h:418
foxit::pdf::interform::Filler::e_EventFlagKeyPad
Event flag: key pad.
Definition: fs_formfiller.h:470
foxit::pdf::interform::Filler::e_VkeyV
V key.
Definition: fs_formfiller.h:388
foxit::pdf::interform::Filler::e_EventFlagControlKey
Event flag: "Ctrl" key.
Definition: fs_formfiller.h:464
foxit::pdf::interform::FillerAssistCallback
Definition: fs_formfiller.h:63
foxit::pdf::interform::Filler::e_Vkey5
5 key.
Definition: fs_formfiller.h:336
foxit::pdf::interform::Filler::e_VkeyF
F key.
Definition: fs_formfiller.h:356
foxit::pdf::interform::Filler::OnMouseHover
bool OnMouseHover(const PDFPage &page, const PointF &point, uint32 flags)
(Reserved, unsupported yet) Call this function when mouse hovers somewhere.
foxit::pdf::interform::Filler::e_VkeyL
L key.
Definition: fs_formfiller.h:368
foxit::pdf::interform::Filler::e_VkeyY
Y key.
Definition: fs_formfiller.h:394
fs_common.h
Header file for common definitions and classes.
foxit::pdf::interform::Filler::e_EventFlagAltKey
Event flag: "Alt" key.
Definition: fs_formfiller.h:466
foxit::pdf::interform::Filler::e_VkeyF5
F5 key.
Definition: fs_formfiller.h:438
foxit::pdf::interform::Filler::e_VkeySubtract
Minus key in the numeric keypad.
Definition: fs_formfiller.h:424
foxit::pdf::interform::Filler::e_VkeyNumpad8
8 key in the numeric keypad.
Definition: fs_formfiller.h:414
foxit::pdf::interform::Filler::e_Vkey6
6 key.
Definition: fs_formfiller.h:338
foxit::pdf::interform::Filler::e_Vkey2
2 key.
Definition: fs_formfiller.h:330
foxit::pdf::interform::Filler::OnCopy
bool OnCopy()
Call this function when the popup menu item "Copy" is down.
foxit::pdf::interform::FillerAssistCallback::EnablePopupMenuItem
virtual bool EnablePopupMenuItem(const void *h_popup_menu, PopupMenuItem popup_menu_item, bool is_enabled)=0
A callback function which is triggered when need to enable specified popup menu item in popup menu.
foxit::pdf::interform::Filler::e_VkeyW
W key.
Definition: fs_formfiller.h:390
foxit::pdf::interform::Filler::e_VkeyNumpad9
9 key in the numeric keypad.
Definition: fs_formfiller.h:416
foxit::pdf::interform::Filler::e_Vkey7
7 key.
Definition: fs_formfiller.h:340
foxit::pdf::interform::Filler::e_VkeyDelete
Delete key.
Definition: fs_formfiller.h:322
foxit::pdf::interform::Filler::e_VkeyF2
F2 key.
Definition: fs_formfiller.h:432
foxit::pdf::interform::Filler::e_Vkey0
0 key.
Definition: fs_formfiller.h:326
foxit::pdf::interform::FillerAssistCallback::e_PopupMenuItemDelete
Popup menu item: "Delete".
Definition: fs_formfiller.h:80
foxit::ARGB
uint32 ARGB
ARGB color type, 32 bits, ((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)
Definition: fs_basictypes.h:209
foxit::pdf::interform::Filler::OnKeyDown
bool OnKeyDown(uint32 key_code, uint32 flags)
Call this function when key on the keyboard is down.
foxit::pdf::interform::Filler::e_Vkey4
4 key.
Definition: fs_formfiller.h:334
foxit::pdf::interform::Filler::e_VkeyN
N key.
Definition: fs_formfiller.h:372
foxit::pdf::interform::Filler::e_VkeyF4
F4 key.
Definition: fs_formfiller.h:436
foxit::pdf::interform::Filler::e_VkeyEnd
End key.
Definition: fs_formfiller.h:304
foxit::pdf::interform::Filler::e_VkeySeparator
Enter key in the numeric keypad.
Definition: fs_formfiller.h:422
foxit::pdf::interform::FillerAssistCallback::CreatePopupMenu
virtual void * CreatePopupMenu()=0
A callback function which is triggered when need to create a popup menu.
foxit::pdf::interform::Filler::e_EventFlagMetaKey
Event flag: meta key.
Definition: fs_formfiller.h:468
foxit::pdf::interform::Filler::e_VkeyC
C key.
Definition: fs_formfiller.h:350
foxit::pdf::interform::Filler::e_VkeyBack
Backspace key.
Definition: fs_formfiller.h:282
foxit::pdf::interform::Filler::e_EventFlagMiddleButtonDown
Event flag: the middle button of the mouse is down.
Definition: fs_formfiller.h:476
foxit::pdf::interform::Filler::e_VkeyJ
J key.
Definition: fs_formfiller.h:364
foxit::pdf::interform::Filler::e_VkeyT
T key.
Definition: fs_formfiller.h:384
foxit::pdf::interform::FillerAssistCallback::GetVersion
virtual int GetVersion()
Get the version of derived implementation, for compatibility reason.
Definition: fs_formfiller.h:97
foxit::pdf::interform::Filler::e_VkeyR
R key.
Definition: fs_formfiller.h:380
foxit::pdf::interform::Filler::e_VkeyQ
Q key.
Definition: fs_formfiller.h:378
foxit::pdf::interform::FillerAssistCallback::e_PopupMenuItemCut
Popup menu item: "Cut".
Definition: fs_formfiller.h:74
foxit::pdf::interform::FillerAssistCallback::AppendPopupMenuItem
virtual bool AppendPopupMenuItem(const void *h_popup_menu, PopupMenuItem popup_menu_item, const wchar_t *default_string)=0
A callback function which is triggered when need to append popup menu item to popup menu.
foxit::pdf::interform::Filler::e_VkeyI
I key.
Definition: fs_formfiller.h:362
foxit::pdf::interform::Filler::e_VkeyNumpad4
4 key in the numeric keypad.
Definition: fs_formfiller.h:406
foxit::pdf::interform::Filler::e_EventFlagLeftButtonDown
Event flag: the left button of the mouse is down.
Definition: fs_formfiller.h:474
foxit::pdf::interform::Filler::e_VkeyF6
F6 key.
Definition: fs_formfiller.h:440
foxit::pdf::interform::FillerAssistCallback::e_PopupMenuItemCopy
Popup menu item: "Copy".
Definition: fs_formfiller.h:76
foxit::pdf::interform::Filler::e_VkeyNumpad5
5 key in the numeric keypad.
Definition: fs_formfiller.h:408
foxit::pdf::interform::Filler::e_VkeyF3
F3 key.
Definition: fs_formfiller.h:434
foxit::pdf::interform::Filler::e_VkeyF7
F7 key.
Definition: fs_formfiller.h:442
CFX_PSVTemplate
Definition: fx_coordinates.h:30
foxit::pdf::interform::Filler::e_EventFlagShiftKey
Event flag: "Shift" key.
Definition: fs_formfiller.h:462
foxit::pdf::interform::FillerAssistCallback::FocusGotOnControl
virtual void FocusGotOnControl(const Control &control, const char *value)=0
A callback function which is triggered when the focus is set to a form control.
foxit::pdf::interform::Filler::OnChar
bool OnChar(uint32 char_code, uint32 flags)
Call this function when a character code is about to be inputted to a form field.
foxit::pdf::interform::Filler::e_VkeyE
E key.
Definition: fs_formfiller.h:354
foxit::pdf::interform::Filler::OnDelete
bool OnDelete()
Call this function when the popup menu item "Delete" is down.
foxit::pdf::interform::Filler::e_VkeyF11
F11 key.
Definition: fs_formfiller.h:450
foxit::pdf::interform::Filler::e_VkeyInsert
Insert key.
Definition: fs_formfiller.h:320
fs_render.h
Header file for rendering related definitions and classes.
foxit::pdf::interform::Filler::OnCut
bool OnCut()
Call this function when the popup menu item "Cut" is down.
foxit::pdf::interform::Filler::e_VkeyF1
F1 key.
Definition: fs_formfiller.h:430
foxit::pdf::interform::Filler::HighlightFormFields
void HighlightFormFields(bool is_highlight)
Decide whether to highlight form fields (including signature fields) or not.
foxit::pdf::interform::Filler::e_VkeyReturn
Enter key.
Definition: fs_formfiller.h:286
foxit
Foxit namespace.
Definition: fs_taggedpdf.h:27
foxit::pdf::interform::Filler::e_VkeyZ
Z key.
Definition: fs_formfiller.h:396
foxit::pdf::interform::Filler::e_VkeyS
S key.
Definition: fs_formfiller.h:382
foxit::pdf::interform::Filler::Render
void Render(const PDFPage &page, const Matrix &matrix, const common::Renderer &renderer)
Draw the currently focused form control on the page.
foxit::pdf::interform::Filler::e_VkeyRight
Right arrow key.
Definition: fs_formfiller.h:312
foxit::pdf::interform::Filler::Filler
Filler(const Form &form, FillerAssistCallback *assist)
Constructor.
foxit::pdf::interform::Filler::e_VkeyUp
Up arrow key.
Definition: fs_formfiller.h:310
foxit::pdf::interform::Filler::OnLButtonDown
bool OnLButtonDown(const PDFPage &page, const PointF &point, uint32 flags)
Call this function when left mouse button is down.
foxit::pdf::interform::Filler::e_VkeyA
A key.
Definition: fs_formfiller.h:346
foxit::pdf::interform::Filler::operator=
Filler & operator=(const Filler &other)
Assign operator.
foxit::pdf::interform::Filler::e_VkeyF10
F10 key.
Definition: fs_formfiller.h:448
foxit::pdf::interform::FillerAssistCallback::Refresh
virtual void Refresh(const PDFPage &page, const RectF *rect)=0
A callback function used to refresh the specified area on a specified page.
foxit::pdf::interform::Filler
Definition: fs_formfiller.h:271
foxit::pdf::interform::Filler::SetHighlightColor
void SetHighlightColor(ARGB color)
Set the highlight color used for highlighting form fields.
foxit::pdf::interform::Filler::e_VkeyTab
Tab key.
Definition: fs_formfiller.h:284
foxit::pdf::interform::FillerAssistCallback::PopupMenuItem
PopupMenuItem
Enumeration for popup menu item.
Definition: fs_formfiller.h:70
foxit::pdf::interform::TimerCallback
Definition: fs_formfiller.h:44
foxit::pdf::interform::Filler::e_Vkey1
1 key.
Definition: fs_formfiller.h:328
foxit::pdf::interform::Filler::GetEditingTextCaretPosition
PointF GetEditingTextCaretPosition(Matrix matrix)
Get the text caret position when the text field or combo box is in the editing state.
foxit::pdf::interform::Filler::OnMouseWheel
bool OnMouseWheel(const PDFPage &page, const PointF &point, int32 delta, uint32 flags)
(Reserved, unsupported yet) Call this function when mouse wheel moves.
foxit::pdf::interform::Filler::e_VkeyPause
Pause Break key.
Definition: fs_formfiller.h:294
foxit::pdf::interform::Filler::e_Vkey8
8 key.
Definition: fs_formfiller.h:342
foxit::pdf::interform::FillerAssistCallback::DestroyPopupMenu
virtual void DestroyPopupMenu(const void *h_popup_menu)=0
A callback function which is triggered when need to destroy popup menu.
foxit::pdf::interform::Filler::operator==
bool operator==(const Filler &other) const
Equal operator.
NULL
#define NULL
The null-pointer value.
Definition: fx_system.h:792
CFX_FloatRect
Definition: fx_coordinates.h:771
foxit::pdf::interform::Filler::e_VkeyControl
Ctrl key.
Definition: fs_formfiller.h:290
foxit::pdf::interform::Filler::e_VkeyD
D key.
Definition: fs_formfiller.h:352
foxit::pdf::interform::Filler::e_EventFlagAutoRepeat
Event flag: auto repeat.
Definition: fs_formfiller.h:472
foxit::pdf::interform::Filler::KillFocus
bool KillFocus()
Kill focus from form.
foxit::pdf::interform::FillerAssistCallback::Release
virtual void Release()=0
A callback function used to release current callback object itself.
foxit::pdf::interform::Filler::e_VkeyF8
F8 key.
Definition: fs_formfiller.h:444
foxit::pdf::interform::Filler::e_VkeyM
M key.
Definition: fs_formfiller.h:370
foxit::pdf::interform::FillerAssistCallback::GetClipboardText
virtual WString GetClipboardText()=0
A callback function which is triggered when need to get the text on clipboard.
foxit::pdf::interform::Filler::e_VkeyPrint
Print key.
Definition: fs_formfiller.h:316
foxit::pdf::interform::Filler::IsEmpty
bool IsEmpty() const
Check whether current object is empty or not.
foxit::pdf::interform::FillerAssistCallback::ReportInvalidValue
virtual void ReportInvalidValue(const wchar_t *form_field_name, const wchar_t *invalid_value)=0
A callback function which is triggered when user entered an invalid value.
foxit::pdf::interform::Filler::OnRButtonDown
bool OnRButtonDown(const PDFPage &page, const PointF &point, uint32 flags)
Call this function when right mouse button is down.
foxit::pdf::PDFPage
Definition: fs_pdfpage.h:412
foxit::pdf::interform::Filler::VirtualKeyCode
VirtualKeyCode
Enumeration for virtual key code.
Definition: fs_formfiller.h:278
foxit::pdf::interform::Filler::e_VkeyNumpad1
1 key in the numeric keypad.
Definition: fs_formfiller.h:400
foxit::pdf::interform::FillerAssistCallback::FocusLostFromControl
virtual void FocusLostFromControl(const Control &control, const char *value)=0
A callback function which is triggered when the focus is lost from a form control.
foxit::pdf::interform::Filler::OnLButtonUp
bool OnLButtonUp(const PDFPage &page, const PointF &point, uint32 flags)
Call this function when left mouse button is up.
foxit::int32
FX_INT32 int32
32-bit signed integer.
Definition: fs_basictypes.h:193
foxit::pdf::interform::Filler::e_VkeyK
K key.
Definition: fs_formfiller.h:366
foxit::pdf::interform::Filler::e_VkeyHelp
Help key.
Definition: fs_formfiller.h:324
foxit::pdf::interform::Filler::e_VkeyHome
Home key.
Definition: fs_formfiller.h:306
foxit::pdf::interform::Filler::e_VkeyUnknown
An unknown key.
Definition: fs_formfiller.h:280
foxit::pdf::interform::Filler::OnLButtonDoubleClick
bool OnLButtonDoubleClick(const PDFPage &page, const PointF &point, uint32 flags)
Call this function when left mouse button is double clicked.
foxit::pdf::interform::Filler::e_VkeyPrior
Page Up key.
Definition: fs_formfiller.h:300
foxit::pdf::interform::Filler::e_VkeyDown
Down arrow key.
Definition: fs_formfiller.h:314
foxit::pdf::interform::Filler::~Filler
~Filler()
Destructor.
foxit::pdf::interform::FillerAssistCallback::SetTimerCallback
virtual bool SetTimerCallback(int elapse, TimerCallback *timer, int *out_timer_id)=0
A callback function used to set a system timer.
foxit::pdf::interform::Filler::OnRButtonUp
bool OnRButtonUp(const PDFPage &page, const PointF &point, uint32 flags)
Call this function when right mouse button is up.
foxit::pdf::interform::Filler::e_VkeyF12
F12 key.
Definition: fs_formfiller.h:452
foxit::pdf::interform::Filler::e_VkeyLeft
Left arrow key.
Definition: fs_formfiller.h:308
foxit::pdf::interform::Filler::e_VkeySnapshot
Print Screen key.
Definition: fs_formfiller.h:318
foxit::pdf::interform::Filler::operator!=
bool operator!=(const Filler &other) const
Not equal operator.
foxit::pdf::interform::Filler::e_VkeyDecimal
Dot key in the numeric keypad.
Definition: fs_formfiller.h:426
CFX_Matrix
Definition: fx_coordinates.h:1076
foxit::pdf::interform::Filler::EventFlags
EventFlags
Enumeration for key event flags.
Definition: fs_formfiller.h:460
foxit::pdf::interform::Filler::e_VkeyNumpad7
7 key in the numeric keypad.
Definition: fs_formfiller.h:412
foxit::pdf::interform::FillerAssistCallback::e_PopupMenuItemNone
No popup menu item.
Definition: fs_formfiller.h:72
foxit::pdf::interform::Filler::e_VkeyP
P key.
Definition: fs_formfiller.h:376
foxit::pdf::interform::Filler::e_VkeyO
O key.
Definition: fs_formfiller.h:374
CFX_WideString
WIDE STRING CLASS.
Definition: fx_string.h:1461
foxit::pdf::interform::FillerAssistCallback::KillTimer
virtual bool KillTimer(int timer_id)=0
A callback function used to kill the timer event by timer identifier.
foxit::pdf::interform::Filler::e_VkeyDivide
Slash key in the numeric keypad.
Definition: fs_formfiller.h:428
foxit::pdf::interform::Filler::SetFocus
bool SetFocus(const Control &control)
Set focus on a form control.
foxit::pdf::interform::Filler::OnMouseLeave
bool OnMouseLeave(const PDFPage &page, const PointF &point, uint32 flags)
(Reserved, unsupported yet) Call this function when mouse leaves somewhere.
foxit::pdf::interform::FillerAssistCallback::ShowPopupMenu
virtual bool ShowPopupMenu(const void *h_popup_menu, const PointF &point)=0
A callback function which is triggered when need to show popup menu.
foxit::pdf::interform::Filler::e_VkeyU
U key.
Definition: fs_formfiller.h:386
foxit::pdf::interform::Filler::OnWheelButtonDoubleClick
bool OnWheelButtonDoubleClick(const PDFPage &page, const PointF &point, uint32 flags)
(Reserved, unsupported yet) Call this function when mouse wheel button is double clicked.
foxit::pdf::interform::TimerCallback::OnTimer
virtual void OnTimer(int timer)=0
A callback function used as a timer on every time interval.
foxit::pdf::interform::Filler::e_VkeyNumpad0
0 key in the numeric keypad.
Definition: fs_formfiller.h:398
foxit::uint32
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:195
foxit::pdf::interform::Filler::e_VkeyNumpad6
6 key in the numeric keypad.
Definition: fs_formfiller.h:410
foxit::pdf::interform::FillerAssistCallback::e_PopupMenuItemPaste
Popup menu item: "Paste".
Definition: fs_formfiller.h:78
foxit::pdf::interform::Filler::e_Vkey9
9 key.
Definition: fs_formfiller.h:344
foxit::common::Renderer
Definition: fs_render.h:197
foxit::Base
Definition: fs_basictypes.h:451
foxit::pdf::interform::Filler::e_VkeyB
B key.
Definition: fs_formfiller.h:348
foxit::pdf::interform::Filler::OnPaste
bool OnPaste()
Call this function when the popup menu item "Paste" is down.
foxit::pdf::interform::Filler::e_VkeySpace
Space key.
Definition: fs_formfiller.h:298
foxit::pdf::interform::Form
Definition: fs_pdfform.h:684
foxit::pdf::interform::Filler::e_VkeyEscape
ESC key.
Definition: fs_formfiller.h:296