fs_formfiller.h

浏览该文件的文档.

#ifndef FS_FORMFILLER_H_
#define FS_FORMFILLER_H_

#include "common/fs_common.h"
#include "common/fs_render.h"
//#include "pdf/fs_pdfpage.h"
//#include "pdf/fs_pdfpage.h"

namespace foxit {
namespace pdf {
  class PDFPage;
namespace interform {
// forward declaration
class Form;
class Control;

class TimerCallback {
 public:
  virtual void OnTimer(int timer) = 0;

 protected:
  ~TimerCallback() {}
};

class FillerAssistCallback {
 public:
  typedef enum _PopupMenuItem {
    e_PopupMenuItemNone = 0,
    e_PopupMenuItemCut  = 1,
    e_PopupMenuItemCopy = 2,
    e_PopupMenuItemPaste = 3,
    e_PopupMenuItemDelete = 4,
    e_PopupMenuItemSelectAll = 5
  } PopupMenuItem;
  
  virtual void Release() = 0;

  virtual int GetVersion() {return 1;}

  virtual void Refresh(const PDFPage& page, const RectF* rect) = 0;

  virtual bool SetTimerCallback(int elapse, TimerCallback* timer, int* out_timer_id) = 0;

  virtual bool KillTimer(int timer_id) = 0;

  virtual void FocusGotOnControl(const Control& control, const char* value) = 0;

  virtual void FocusLostFromControl(const Control& control, const char* value) = 0;
  
  virtual void* CreatePopupMenu() = 0;

  virtual bool AppendPopupMenuItem(const void* h_popup_menu, PopupMenuItem popup_menu_item, const wchar_t* default_string) = 0;

  virtual bool EnablePopupMenuItem(const void* h_popup_menu, PopupMenuItem popup_menu_item, bool is_enabled) = 0;

  virtual bool ShowPopupMenu(const void* h_popup_menu, const PointF& point) = 0;

  virtual void DestroyPopupMenu(const void* h_popup_menu) = 0;

  virtual void SetClipboardText(const wchar_t* text) = 0;

  virtual WString GetClipboardText() = 0;

  virtual void ReportInvalidValue(const wchar_t* form_field_name, const wchar_t* invalid_value) = 0;
 protected:
  ~FillerAssistCallback() {}
};

class Filler FS_FINAL : public Base {
 public:
   typedef enum _VirtualKeyCode {
     e_VkeyUnknown  = 0x00,
     e_VkeyBack = 0x08,
     e_VkeyTab = 0x09,
     e_VkeyReturn = 0x0D,
     e_VkeyShift = 0x10,
     e_VkeyControl = 0x11,
     e_VkeyMenu = 0x12,
     e_VkeyPause = 0x13,
     e_VkeyEscape = 0x1B,
     e_VkeySpace = 0x20,
     e_VkeyPrior = 0x21,
     e_VkeyNext = 0x22,
     e_VkeyEnd =   0x23,
     e_VkeyHome = 0x24,
     e_VkeyLeft = 0x25,
     e_VkeyUp =   0x26,
     e_VkeyRight = 0x27,
     e_VkeyDown = 0x28,
     e_VkeyPrint = 0x2A,
     e_VkeySnapshot = 0x2C,
     e_VkeyInsert = 0x2D,
     e_VkeyDelete = 0x2E,
     e_VkeyHelp = 0x2F,
     e_Vkey0 = 0x30,
     e_Vkey1 = 0x31,
     e_Vkey2 = 0x32,
     e_Vkey3 = 0x33,
     e_Vkey4 = 0x34,
     e_Vkey5 = 0x35,
     e_Vkey6 = 0x36,
     e_Vkey7 = 0x37,
     e_Vkey8 = 0x38,
     e_Vkey9 = 0x39,
     e_VkeyA = 0x41,
     e_VkeyB = 0x42,
     e_VkeyC = 0x43,
     e_VkeyD = 0x44,
     e_VkeyE = 0x45,
     e_VkeyF = 0x46,
     e_VkeyG = 0x47,
     e_VkeyH = 0x48,
     e_VkeyI = 0x49,
     e_VkeyJ = 0x4A,
     e_VkeyK = 0x4B,
     e_VkeyL = 0x4C,
     e_VkeyM = 0x4D,
     e_VkeyN = 0x4E,
     e_VkeyO = 0x4F,
     e_VkeyP = 0x50,
     e_VkeyQ = 0x51,
     e_VkeyR = 0x52,
     e_VkeyS = 0x53,
     e_VkeyT = 0x54,
     e_VkeyU = 0x55,
     e_VkeyV = 0x56,
     e_VkeyW = 0x57,
     e_VkeyX = 0x58,
     e_VkeyY = 0x59,
     e_VkeyZ = 0x5A,
     e_VkeyNumpad0 = 0x60,
     e_VkeyNumpad1 = 0x61,
     e_VkeyNumpad2 = 0x62,
     e_VkeyNumpad3 = 0x63,
     e_VkeyNumpad4 = 0x64,
     e_VkeyNumpad5 = 0x65,
     e_VkeyNumpad6 = 0x66,
     e_VkeyNumpad7 = 0x67,
     e_VkeyNumpad8 = 0x68,
     e_VkeyNumpad9 = 0x69,
     e_VkeyMultiply = 0x6A,
     e_VkeyAdd = 0x6B,
     e_VkeySeparator =  0x6C,
     e_VkeySubtract =  0x6D,
     e_VkeyDecimal = 0x6E,
     e_VkeyDivide = 0x6F,
     e_VkeyF1 = 0x70,
     e_VkeyF2 = 0x71,
     e_VkeyF3 = 0x72,
     e_VkeyF4 = 0x73,
     e_VkeyF5 = 0x74,
     e_VkeyF6 = 0x75,
     e_VkeyF7 = 0x76,
     e_VkeyF8 = 0x77,
     e_VkeyF9 = 0x78,
     e_VkeyF10 = 0x79,
     e_VkeyF11 = 0x7A,
     e_VkeyF12 = 0x7B
   } VirtualKeyCode;
   
   typedef enum _EventFlags {
     e_EventFlagShiftKey =  0x0001,
     e_EventFlagControlKey  = 0x0002,
     e_EventFlagAltKey  = 0x0004,
     e_EventFlagMetaKey = 0x0008,
     e_EventFlagKeyPad = 0x0010,
     e_EventFlagAutoRepeat = 0x0020,
     e_EventFlagLeftButtonDown = 0x0040,
     e_EventFlagMiddleButtonDown = 0x0080,
     e_EventFlagRightButtonDown = 0x0100,
     e_EventFlagCommand = 0x0200
   } EventFlags;
   

  explicit Filler(const Form& form, FillerAssistCallback* assist);

  ~Filler();

  Filler(const Filler& other);
  Filler& operator = (const Filler& other);

  bool operator == (const Filler& other) const;
  bool operator != (const Filler& other) const;

  bool IsEmpty() const;

  void Render(const PDFPage& page, const Matrix& matrix,const common::Renderer& renderer);

  bool OnLButtonDown(const PDFPage& page, const PointF& point, uint32 flags);

  bool OnLButtonUp(const PDFPage& page, const PointF& point, uint32 flags);

  bool OnLButtonDoubleClick(const PDFPage& page, const PointF& point, uint32 flags);

  bool OnMouseMove(const PDFPage& page, const PointF& point, uint32 flags);

  bool OnMouseEnter(const PDFPage& page, const PointF& point, uint32 flags);

  bool OnMouseHover(const PDFPage& page, const PointF& point, uint32 flags);

  bool OnMouseLeave(const PDFPage& page, const PointF& point, uint32 flags);

  bool OnMouseWheel(const PDFPage& page, const PointF& point, int32 delta, uint32 flags);

  bool OnRButtonDown(const PDFPage& page, const PointF& point, uint32 flags);

  bool OnRButtonUp(const PDFPage& page, const PointF& point, uint32 flags);

  bool OnRButtonDoubleClick(const PDFPage& page, const PointF& point, uint32 flags);

  bool OnWheelButtonDown(const PDFPage& page, const PointF& point, uint32 flags);

  bool OnWheelButtonUp(const PDFPage& page, const PointF& point, uint32 flags);

  bool OnWheelButtonDoubleClick(const PDFPage& page, const PointF& point, uint32 flags);

  bool OnKeyDown(uint32 key_code, uint32 flags);

  bool OnKeyUp(uint32 key_code, uint32 flags);

  bool OnChar(uint32 char_code, uint32 flags);

  bool SetFocus(const Control& control);

  bool KillFocus();

  void HighlightFormFields(bool is_highlight);

  void HighlightFormFields(bool is_highlight, bool is_sign_highlight);

  void SetHighlightColor(ARGB color);

  void ShowOverflowIndicator(bool is_show_overflow_indicator);

  bool OnCut();

  bool OnCopy();

  bool OnPaste();

  bool OnSelectAll();

  bool OnDelete();

  PointF GetEditingTextCaretPosition(Matrix matrix);

  // 强烈建议用户不要使用此方法；否则可能出现未知情况。
  explicit Filler(FS_HANDLE handle =  NULL);
};
}  // namespace interform
}  // namespace pdf
}  // namespace foxit
#endif  // FS_FORMFILLER_H_