fs_xfa.h

Go to the documentation of this file.

#ifndef FS_XFA_H_
#define FS_XFA_H_

#include "common/fs_common.h"
#include "common/fs_image.h"

namespace foxit {
namespace common {
  class Bitmap;
}

namespace pdf{
class Signature;
class PDFDoc;
}

namespace addon {
namespace xfa {
class XFADoc;
class XFAPage;
class XFAWidget;

class WidgetChoiceOption FS_FINAL : public Object {
 public:
  WidgetChoiceOption()
      : option_label(WString())
      , selected(false){}

  WidgetChoiceOption(const wchar_t* option_label, bool selected)
      : option_label(option_label)
      , selected(selected){}

  WidgetChoiceOption(const WidgetChoiceOption& option)
      : option_label(option.option_label)
      , selected(option.selected){}

  WidgetChoiceOption& operator = (const WidgetChoiceOption& option) {
    option_label = option.option_label;
    selected = option.selected;
    return *this;
  }

  void Set( const wchar_t* option_label, bool selected) {
    this->option_label = option_label;
    this->selected = selected;
  }

  WString option_label;

  bool selected;
};

FSDK_DEFINE_ARRAY(WidgetChoiceOptionArray, WidgetChoiceOption);

class AppProviderCallback {
 public:
  typedef enum _AppInfo {
    e_AppInfoVersion = 0x0,
    e_AppInfoLanguage = 0x01,
    e_AppInfoPlatform= 0x02,
    e_AppInfoVariation= 0x03,
    e_AppInfoName = 0x04,
    e_AppInfoType = 0x05
  } AppInfo;
  
  typedef enum _BeepType {
    e_BeepTypeError = 0,
    e_BeepTypeWarning = 1,
    e_BeepTypeQuestion = 2,
    e_BeepTypeStatus = 3,
    e_BeepTypeDefault = 4
  } BeepType;
  
  typedef enum _StringID {
    e_StringIDValidateFailed = 1,
    e_StringIDCalcOverride = 2,
    e_StringIDModifyField = 3,
    e_StringIDNotModifyField = 4,
    e_StringIDAppName = 5,
    e_StringIDImageFilter = 6,
    e_StringIDUnknownCaught = 7,
    e_StringIDUnableToSet = 8,
    e_StringIDValueExcalmatory = 9,
    e_StringIDInvalidEnumValue = 10,
    e_StringIDUnsupportMethod = 11,
    e_StringIDUnsupportProperty = 12,
    e_StringIDInvalidPropertySetOperation = 13,
    e_StringIDNotDefaultValue = 14,
    e_StringIDUnableSetLanguage = 15,
    e_StringIDUnableSetNumPages = 16,
    e_StringIDUnableSetPlatformValue = 17,
    e_StringIDUnableSetValidationsEnabledValue = 18,
    e_StringIDUnableSetValidationsValue = 19,
    e_StringIDUnableSetVersion = 20,
    e_StringIDUnableSetReady = 21,
    e_StringIDNumberOfOccur = 22,
    e_StringIDUnableSetClassName = 23,
    e_StringIDUnableSetLengthValue = 24,
    e_StringIDUnsupportChar = 25,
    e_StringIDBadSuffix = 26,
    e_StringIDExpectedIdent = 27,
    e_StringIDExpectedString = 28,
    e_StringIDInvalidateChar = 29,
    e_StringIDRedefinition = 30,
    e_StringIDInvalidToken = 31,
    e_StringIDInvalidExpression = 32,
    e_StringIDUndefineIdentifier = 33,
    e_StringIDInvalidateLeftValue = 34,
    e_StringIDCompilerError= 35,
    e_StringIDCannotModifyValue = 36,
    e_StringIDParametersError = 37,
    e_StringIDExpectedEndIf = 38,
    e_StringIDUnexpectedExpression = 39,
    e_StringIDConditionIsNull = 40,
    e_StringIDIllegalBreak = 41,
    e_StringIDIllegalContinue = 42,
    e_StringIDExpectedOperator = 43,
    e_StringIDDivideZero = 44,
    e_StringIDCannotCovertToObject = 45,
    e_StringIDNotFoundContainer = 46,
    e_StringIDNotFoundProperty = 47,
    e_StringIDNotFoundMethod = 48,
    e_StringIDNotFoundConst = 49,
    e_StringIDNotAssignObject= 50,
    e_StringIDInvalidateInstruction= 51,
    e_StringIDExpectedNumber = 52,
    e_StringIDValidateOutOfArray= 53,
    e_StringIDCannotAssign = 54,
    e_StringIDNotFoundFunction = 55,
    e_StringIDIsNotArray = 56,
    e_StringIDOutOfArrayRange = 57,
    e_StringIDNotSupportArrayCalculate = 58,
    e_StringIDArgumentNotArray = 59,
    e_StringIDArgumentExpectContainer = 60,
    e_StringIDAccessProertyInNotObject = 61,
    e_StringIDFunctionBuildIn = 62,
    e_StringIDErrorMessage = 63,
    e_StringIDIndexValueOutOfBounds = 64,
    e_StringIDIncorrectNumberOfMethod = 65,
    e_StringIDArgumentMismatch  = 66,
    e_StringIDInvalidEnumerate = 67,
    e_StringIDInvalidAppend = 68,
    e_StringIDSOMExpectedList = 69,
    e_StringIDNotHaveProperty = 70,
    e_StringIDInvalidNodeType = 71,
    e_StringIDViolateBoundary = 72,
    e_StringIDServerDeny = 73,
    e_StringIDWeekDaySun = 74,
    e_StringIDWeekDayMon = 75,
    e_StringIDWeekDayTue = 76,
    e_StringIDWeekDayWed = 77,
    e_StringIDWeekDayThu = 78,
    e_StringIDWeekDayFri = 79,
    e_StringIDWeekDaySat = 80,
    e_StringIDMonthJan = 81,
    e_StringIDMonthFeb = 82,
    e_StringIDMonthMarch = 83,
    e_StringIDMonthApril = 84,
    e_StringIDMonthMay = 85,
    e_StringIDMonthJune = 86,
    e_StringIDMonthJuly = 87,
    e_StringIDMonthAug = 88,
    e_StringIDMonthSep = 89,
    e_StringIDMonthOct = 90,
    e_StringIDMonthNov = 91,
    e_StringIDMonthDec = 92,
    e_StringIDToday = 93,
    e_StringIDValidateLimit = 94,
    e_StringIDValidateNullWarning = 95,
    e_StringIDValidateNullError = 96,
    e_StringIDValidateWarning = 97,
    e_StringIDValidateError = 98,
    e_StringIDValidateNumberError = 99,
    e_StringIDScriptFailedError = 100,
    e_StringIDScriptInvalidValue = 101,
    e_StringIDSubmitValidateNullError = 102,
    e_StringIDInvalidBarcodeValue = 103,
    e_StringIDScriptArgumentMismatch = 104
  } StringID;
  
  typedef enum _MsgBoxIconType {
    e_MsgBoxIconError = 0,
    e_MsgBoxIconWarning = 1,
    e_MsgBoxIconQuestion = 2,
    e_MsgBoxIconStatus = 3
  } MsgBoxIconType;
  
  typedef enum _MsgBoxButtonType {
    e_MsgBtnTypeOK = 0,
    e_MsgBtnTypeOKCancel = 1,
    e_MsgBtnTypeYesNo = 2,
    e_MsgBtnTypeYesNoCancel = 3
  } MsgBoxButtonType;
  
  typedef enum _MsgBoxButtonID {
    e_MsgBtnIDOK = 1,
    e_MsgBtnIDCancel = 2,
    e_MsgBtnIDNo = 3,
    e_MsgBtnIDYes = 4
  } MsgBoxButtonID;
  

  virtual void Release() = 0;

  virtual WString GetAppInfo(AppInfo app_info) = 0;

  virtual void Beep(BeepType type) = 0;

  virtual MsgBoxButtonID MsgBox(const wchar_t* message, const wchar_t* title, MsgBoxIconType icon_type,
                                MsgBoxButtonType button_type) = 0;

  virtual WString Response(const wchar_t* question, const wchar_t* title, const wchar_t* default_answer,
                           bool is_mask) = 0;

  virtual common::file::ReaderCallback* DownLoadUrl(const wchar_t* url) = 0;

  virtual WString PostRequestURL(const wchar_t* url, const wchar_t* data, const wchar_t* content_type,
                                 const wchar_t* encode, const wchar_t* header) = 0;

  virtual bool PutRequestURL(const wchar_t* url, const wchar_t* data, const wchar_t* encode) = 0;

  virtual WString LoadString(StringID string_id) = 0;

  virtual WStringArray ShowFileDialog(const wchar_t* string_title, const wchar_t* string_filter,
                                      bool is_openfile_dialog) = 0;

 protected:
  ~AppProviderCallback() {}
};

class XFAWidgetModifyInfo;
class DocProviderCallback {
 public:
  typedef enum _InvalidateFlag {
    e_InvalidateFlagAllPages = 0,
    e_InvalidateFlagCurrentPage = 1
  } InvalidateFlag;
  
  typedef enum _PrintOption {
    e_PrintOptionShowDialog = 0x00000001,
    e_PrintOptionCanCancel = 0x00000002,
    e_PrintOptionShrinkPage = 0x00000004,
    e_PrintOptionAsImage = 0x00000008,
    e_PrintOptionReverseOrder = 0x00000010,
    e_PrintOptionPrintAnnot = 0x00000020
  } PrintOption;
  
  typedef enum _SubmitFormat {
    e_SubmitInXDP = 0,
    e_SubmitInPDF = 1,
    e_SubmitInUrlEncoded = 2,
    e_SubmitInXFD= 3,
    e_SubmitInXML = 4
  } SubmitFormat;
  
  typedef enum _TextEncoding {
    e_TextEncodingNone = 0,
    e_TextEncodingBig5 = 1,
    e_TextEncodingFontSpecific = 2,
    e_TextEncodingGBK = 3,
    e_TextEncodingGB18030 = 4,
    e_TextEncodingGB2312 = 5,
    e_TextEncodingISO8859NN = 6,
    e_TextEncodingKSC5601 = 7,
    e_TextEncodingShiftJIS = 8,
    e_TextEncodingUCS2 = 9,
    e_TextEncodingUTF16 = 10,
    e_TextEncodingUTF8 = 11
  } TextEncoding;
  
  typedef enum _PageViewEventType {
    e_PageViewEventTypeAdded = 0,
    e_PageViewEventTypeRemoved = 1,
    e_PageViewEventTypeAllRemoved = 2
  } PageViewEventType;
  
  typedef enum _WidgetEventType {
    e_WidgetEventTypeAdded = 0,
    e_WidgetEventTypeBeforeRemoved = 1
  } WidgetEventType;
  

  virtual void Release() = 0;

  virtual void InvalidateRect(int page_index, const RectF& rect, InvalidateFlag flag) = 0;

  virtual void DisplayCaret(int page_index, bool is_visible, const RectF& rect) = 0;

  virtual bool GetPopupPos(int page_index, float min_popup, float max_popup,
                           const RectF& rect_widget, RectF& inout_rect_popup) = 0;

  virtual bool PopupMenu(int page_index, const PointF& rect_popup) = 0;

  virtual int GetCurrentPage(const XFADoc& doc) = 0;

  virtual void SetCurrentPage(const XFADoc& doc, int current_page_index) = 0;

  virtual void SetChangeMark(const XFADoc& doc) = 0;

  virtual WString GetTitle(const XFADoc& doc) = 0;

  virtual void SetFocus(XFAWidget& xfa_widget, bool is_relayout) = 0;

  virtual void ExportData(const XFADoc& doc, const WString& file_path) = 0;

  virtual void ImportData(const XFADoc& doc, const WString& file_path) = 0;

  virtual void GotoURL(const XFADoc& doc, const WString& url) = 0;

  virtual void Print(const XFADoc& doc, int start_page_index, int end_page_index, uint32 options) = 0;

  virtual ARGB GetHighlightColor(const XFADoc& doc) = 0;

  virtual bool SubmitData(const XFADoc& doc, const WString& target, SubmitFormat format, TextEncoding text_encoding,
                          const WString& content) = 0;

  virtual void PageViewEvent(int page_index, PageViewEventType page_view_event_type) = 0;

  virtual void WidgetEvent(const XFAWidget& xfa_widget,WidgetEventType widget_event_type) = 0;

  virtual void NotifyWidgetChangeInfo(const XFADoc& doc, XFAWidgetModifyInfo change_info) = 0;
 protected:
  ~DocProviderCallback() {}
};

class XFADoc FS_FINAL : public Base{
 public:
  typedef enum _EventType {
    e_EventTypeUnknown = 0,
    e_EventTypePostPrint = 1,
    e_EventTypePrePrint = 2,
    e_EventTypeClick = 3,
    e_EventTypeChange = 4,
    e_EventTypeDocClose = 5,
    e_EventTypeDocReady = 6,
    e_EventTypeEnter = 7,
    e_EventTypeExit = 8,
    e_EventTypeFull = 9,
    e_EventTypeIndexChange = 10,
    e_EventTypeInitialize = 11,
    e_EventTypeMouseDown = 12,
    e_EventTypeMouseEnter = 13,
    e_EventTypeMouseExit = 14,
    e_EventTypeMouseUp = 15,
    e_EventTypePostExecute = 16,
    e_EventTypePostOpen = 17,
    e_EventTypePostSave = 18,
    e_EventTypePostSign = 19,
    e_EventTypePostSubmit = 20,
    e_EventTypePreExecute = 21,
    e_EventTypePreOpen = 22,
    e_EventTypePreSave = 23,
    e_EventTypePreSign = 24,
    e_EventTypePreSubmit = 25,
    e_EventTypeReady = 26,
    e_EventTypeValidationState = 27,
    e_EventTypeInitCalculate = 28,
    e_EventTypeInitVariables = 29,
    e_EventTypeCalculate = 30,
    e_EventTypeValidate = 31
  } EventType;
  
  typedef enum _Type {
    e_Dynamic = 0,
    e_Static = 1,
    e_XDP = 2
  } Type;
  
  typedef enum _ExportDataType {
    e_ExportDataTypeXML = 0,
    e_ExportDataTypeStaticXDP = 1,
    e_ExportDataTypeXDP = 2
  } ExportDataType;
  

  XFADoc(const pdf::PDFDoc& document, DocProviderCallback* xfa_doc_provider_handler);

  XFADoc(const foxit::pdf::PDFDoc& document);

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

  bool operator == (const XFADoc& other) const;

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

  bool IsEmpty() const;

  ~XFADoc();

  common::Progressive StartLoad(common::PauseCallback* pause = NULL);

  void SetDocProviderCallback(foxit::addon::xfa::DocProviderCallback* doc_provider_callback);

  Type GetType() const;

  int GetPageCount() const;

  XFAPage GetPage(int page_index);

  bool ExportData(const char* output_file_path, ExportDataType export_type);

  bool ExportData(const wchar_t* output_file_path, ExportDataType export_type);
  
  bool ExportData(foxit::common::file::WriterCallback* stream, ExportDataType export_type);

  void SetPDFPath(const char* pdf_file_path);

  void SetPDFPath(const wchar_t* pdf_file_path);

  bool ImportData(const char* file_path);

  bool ImportData(const wchar_t* file_path);

  bool ImportData(foxit::common::file::ReaderCallback* file_reader);

  void ResetForm();

  void FlattenTo(const char* output_file_path);

  void FlattenTo(const wchar_t* output_file_path);

  void FlattenTo(foxit::common::file::StreamCallback* stream);

  void ProcessEvent(EventType event_type);

  void SetFocus(XFAWidget xfa_widget);

  void KillFocus();

  XFAWidget GetWidgetByFullName(const WString& full_name);

  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
  explicit XFADoc(FS_HANDLE handle =  NULL);

};

class XFAPage FS_FINAL : public Base{
 public:
  XFAPage(const XFAPage& other);
  XFAPage& operator = (const XFAPage& other);

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

  ~XFAPage();

  bool IsEmpty() const;

  Matrix GetDisplayMatrix(int left, int top, int width, int height, common::Rotation rotate);

  float GetWidth() const;

  float GetHeight() const;

  XFAWidget GetWidgetAtDevicePoint(const Matrix& matrix, const PointF& device_point, float tolerance);

  int GetIndex() const;

  int GetWidgetCount() const;

  XFAWidget GetWidget(int widget_index) const;

  XFAWidget GetWidgetByFullName(const WString& full_name);

  XFAWidget GetFirstWidget();

  XFAWidget GetLastWidget();

  XFAWidget GetNextWidget(const XFAWidget& widget);

  XFAWidget GetPrevWidget(const XFAWidget& widget);

  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
  explicit XFAPage(FS_HANDLE handle =  NULL);
};

class XFAWidgetModifyInfo : public Object {
 public:
  typedef enum _WidgetElement {
    e_WidgetElementPs = 0,
    e_WidgetElementTo = 1,
    e_WidgetElementUi = 2,
    e_WidgetElementRecordSet = 3,
    e_WidgetElementSubsetBelow = 4,
    e_WidgetElementSubformSet = 5,
    e_WidgetElementAdobeExtensionLevel = 6,
    e_WidgetElementTypeface = 7,
    e_WidgetElementBreak = 8,
    e_WidgetElementFontInfo = 9,
    e_WidgetElementNumberPattern = 10,
    e_WidgetElementDynamicRender = 11,
    e_WidgetElementPrintScaling = 12,
    e_WidgetElementCheckButton = 13,
    e_WidgetElementDatePatterns = 14,
    e_WidgetElementSourceSet = 15,
    e_WidgetElementAmd = 16,
    e_WidgetElementArc = 17,
    e_WidgetElementDay = 18,
    e_WidgetElementEra = 19,
    e_WidgetElementJog= 20,
    e_WidgetElementLog = 21,
    e_WidgetElementMap = 22,
    e_WidgetElementMdp = 23,
    e_WidgetElementBreakBefore = 24,
    e_WidgetElementOid = 25,
    e_WidgetElementPcl = 26,
    e_WidgetElementPdf = 27,
    e_WidgetElementRef = 28,
    e_WidgetElementUri = 29,
    e_WidgetElementXdc = 30,
    e_WidgetElementXdp = 31,
    e_WidgetElementXfa = 32,
    e_WidgetElementXsl = 33,
    e_WidgetElementZpl = 34,
    e_WidgetElementCache = 35,
    e_WidgetElementMargin = 36,
    e_WidgetElementKeyUsage = 37,
    e_WidgetElementExclude = 38,
    e_WidgetElementChoiceList = 39,
    e_WidgetElementLevel = 40,
    e_WidgetElementLabelPrinter = 41,
    e_WidgetElementCalendarSymbols = 42,
    e_WidgetElementPara = 43,
    e_WidgetElementPart = 44,
    e_WidgetElementPdfa = 45,
    e_WidgetElementFilter = 46,
    e_WidgetElementPresent = 47,
    e_WidgetElementPagination = 48,
    e_WidgetElementEncoding = 49,
    e_WidgetElementEvent = 50,
    e_WidgetElementWhitespace = 51,
    e_WidgetElementDefaultUi = 52,
    e_WidgetElementDataModel = 53,
    e_WidgetElementBarcode = 54,
    e_WidgetElementTimePattern = 55,
    e_WidgetElementBatchOutput = 56,
    e_WidgetElementEnforce = 57,
    e_WidgetElementCurrencySymbols = 58,
    e_WidgetElementAddSilentPrint = 59,
    e_WidgetElementRename = 60,
    e_WidgetElementOperation = 61,
    e_WidgetElementTypefaces = 62,
    e_WidgetElementSubjectDNs = 63,
    e_WidgetElementIssuers = 64,
    e_WidgetElementSignaturePseudoModel = 65,
    e_WidgetElementWsdlConnection = 66,
    e_WidgetElementDebug = 67,
    e_WidgetElementDelta = 68,
    e_WidgetElementEraNames = 69,
    e_WidgetElementModifyAnnots = 70,
    e_WidgetElementStartNode = 71,
    e_WidgetElementButton = 72,
    e_WidgetElementFormat = 73,
    e_WidgetElementBorder = 74,
    e_WidgetElementArea = 75,
    e_WidgetElementHyphenation = 76,
    e_WidgetElementText = 77,
    e_WidgetElementTime = 78,
    e_WidgetElementType = 79,
    e_WidgetElementOverprint = 80,
    e_WidgetElementCertificates = 81,
    e_WidgetElementEncryptionMethods = 82,
    e_WidgetElementSetProperty = 83,
    e_WidgetElementPrinterName = 84,
    e_WidgetElementStartPage = 85,
    e_WidgetElementPageOffset = 86,
    e_WidgetElementDateTime = 87,
    e_WidgetElementComb = 88,
    e_WidgetElementPattern = 89,
    e_WidgetElementIfEmpty = 90,
    e_WidgetElementSuppressBanner = 91,
    e_WidgetElementOutputBin = 92,
    e_WidgetElementField = 93,
    e_WidgetElementAgent = 94,
    e_WidgetElementOutputXSL = 95,
    e_WidgetElementAdjustData = 96,
    e_WidgetElementAutoSave = 97,
    e_WidgetElementContentArea = 98,
    e_WidgetElementEventPseudoModel = 99,
    e_WidgetElementWsdlAddress = 100,
    e_WidgetElementSolid = 101,
    e_WidgetElementDateTimeSymbols = 102,
    e_WidgetElementEncryptionLevel = 103,
    e_WidgetElementEdge = 104,
    e_WidgetElementStipple = 105,
    e_WidgetElementAttributes = 106,
    e_WidgetElementVersionControl = 107,
    e_WidgetElementMeridiem = 108,
    e_WidgetElementExclGroup = 109,
    e_WidgetElementToolTip = 110,
    e_WidgetElementCompress = 111,
    e_WidgetElementReason = 112,
    e_WidgetElementExecute = 113,
    e_WidgetElementContentCopy = 114,
    e_WidgetElementDateTimeEdit = 115,
    e_WidgetElementConfig = 116,
    e_WidgetElementImage = 117,
    e_WidgetElementSharpxHTML = 118,
    e_WidgetElementNumberOfCopies = 119,
    e_WidgetElementBehaviorOverride = 120,
    e_WidgetElementTimeStamp = 121,
    e_WidgetElementMonth = 122,
    e_WidgetElementViewerPreferences = 123,
    e_WidgetElementScriptModel = 124,
    e_WidgetElementDecimal = 125,
    e_WidgetElementSubform = 126,
    e_WidgetElementSelect = 127,
    e_WidgetElementWindow = 128,
    e_WidgetElementLocaleSet = 129,
    e_WidgetElementHandler = 130,
    e_WidgetElementHostPseudoModel = 131,
    e_WidgetElementPresence = 132,
    e_WidgetElementRecord = 133,
    e_WidgetElementEmbed = 134,
    e_WidgetElementVersion = 135,
    e_WidgetElementCommand = 136,
    e_WidgetElementCopies = 137,
    e_WidgetElementStaple = 138,
    e_WidgetElementSubmitFormat = 139,
    e_WidgetElementBoolean = 140,
    e_WidgetElementMessage = 141,
    e_WidgetElementOutput = 142,
    e_WidgetElementPsMap = 143,
    e_WidgetElementExcludeNS = 144,
    e_WidgetElementAssist = 145,
    e_WidgetElementPicture = 146,
    e_WidgetElementTraversal = 147,
    e_WidgetElementSilentPrint = 148,
    e_WidgetElementWebClient = 149,
    e_WidgetElementLayoutPseudoModel = 150,
    e_WidgetElementProducer =151,
    e_WidgetElementCorner = 152,
    e_WidgetElementMsgId = 153,
    e_WidgetElementColor = 154,
    e_WidgetElementKeep = 155,
    e_WidgetElementQuery = 156,
    e_WidgetElementInsert = 157,
    e_WidgetElementImageEdit = 158,
    e_WidgetElementValidate = 159,
    e_WidgetElementDigestMethods = 160,
    e_WidgetElementNumberPatterns = 161,
    e_WidgetElementPageSet = 162,
    e_WidgetElementInteger = 163,
    e_WidgetElementSoapAddress = 164,
    e_WidgetElementEquate = 165,
    e_WidgetElementFormFieldFilling = 166,
    e_WidgetElementPageRange = 167,
    e_WidgetElementUpdate = 168,
    e_WidgetElementConnectString = 169,
    e_WidgetElementMode = 170,
    e_WidgetElementLayout = 171,
    e_WidgetElementSharpxml = 172,
    e_WidgetElementXsdConnection = 173,
    e_WidgetElementTraverse = 174,
    e_WidgetElementEncodings = 175,
    e_WidgetElementTemplate = 176,
    e_WidgetElementAcrobat = 177,
    e_WidgetElementValidationMessaging = 178,
    e_WidgetElementSigning = 179,
    e_WidgetElementDataWindow = 180,
    e_WidgetElementScript = 181,
    e_WidgetElementAddViewerPreferences = 182,
    e_WidgetElementAlwaysEmbed = 183,
    e_WidgetElementPasswordEdit = 184,
    e_WidgetElementNumericEdit = 185,
    e_WidgetElementEncryptionMethod = 186,
    e_WidgetElementChange = 187,
    e_WidgetElementPageArea = 188,
    e_WidgetElementSubmitUrl = 189,
    e_WidgetElementOids = 190,
    e_WidgetElementSignature = 191,
    e_WidgetElementADBE_JSConsole = 192,
    e_WidgetElementCaption = 193,
    e_WidgetElementRelevant = 194,
    e_WidgetElementFlipLabel = 195,
    e_WidgetElementExData = 196,
    e_WidgetElementDayNames = 197,
    e_WidgetElementSoapAction = 198,
    e_WidgetElementDefaultTypeface = 199,
    e_WidgetElementManifest = 200,
    e_WidgetElementOverflow = 201,
    e_WidgetElementLinear = 202,
    e_WidgetElementCurrencySymbol = 203,
    e_WidgetElementDelete = 204,
    e_WidgetElementDeltas = 205,
    e_WidgetElementDigestMethod = 206,
    e_WidgetElementInstanceManager = 207,
    e_WidgetElementEquateRange = 208,
    e_WidgetElementMedium = 209,
    e_WidgetElementTextEdit = 210,
    e_WidgetElementTemplateCache = 211,
    e_WidgetElementCompressObjectStream = 212,
    e_WidgetElementDataValue = 213,
    e_WidgetElementAccessibleContent = 214,
    e_WidgetElementNodeList = 215,
    e_WidgetElementIncludeXDPContent = 216,
    e_WidgetElementXmlConnection = 217,
    e_WidgetElementValidateApprovalSignatures = 218,
    e_WidgetElementSignData = 219,
    e_WidgetElementPackets = 220,
    e_WidgetElementDatePattern = 221,
    e_WidgetElementDuplexOption = 222,
    e_WidgetElementBase = 223,
    e_WidgetElementBind = 224,
    e_WidgetElementCompression = 225,
    e_WidgetElementUser = 226,
    e_WidgetElementRectangle = 227,
    e_WidgetElementEffectiveOutputPolicy = 228,
    e_WidgetElementADBE_JSDebugger = 229,
    e_WidgetElementAcrobat7 = 230,
    e_WidgetElementInteractive = 231,
    e_WidgetElementLocale = 232,
    e_WidgetElementCurrentPage = 233,
    e_WidgetElementData = 234,
    e_WidgetElementDate = 235,
    e_WidgetElementDesc = 236,
    e_WidgetElementEncrypt = 237,
    e_WidgetElementDraw = 238,
    e_WidgetElementEncryption = 239,
    e_WidgetElementMeridiemNames = 240,
    e_WidgetElementMessaging = 241,
    e_WidgetElementSpeak = 242,
    e_WidgetElementDataGroup = 243,
    e_WidgetElementCommon = 244,
    e_WidgetElementSharptext = 245,
    e_WidgetElementPaginationOverride = 246,
    e_WidgetElementReasons = 247,
    e_WidgetElementSignatureProperties = 248,
    e_WidgetElementThreshold = 249,
    e_WidgetElementAppearanceFilter = 250,
    e_WidgetElementFill = 251,
    e_WidgetElementFont = 252,
    e_WidgetElementForm = 253,
    e_WidgetElementMediumInfo = 254,
    e_WidgetElementCertificate = 255,
    e_WidgetElementPassword = 256,
    e_WidgetElementRunScripts = 257,
    e_WidgetElementTrace = 258,
    e_WidgetElementFloat = 259,
    e_WidgetElementRenderPolicy = 260,
    e_WidgetElementLogPseudoModel = 261,
    e_WidgetElementDestination = 262,
    e_WidgetElementValue = 263,
    e_WidgetElementBookend = 264,
    e_WidgetElementExObject = 265,
    e_WidgetElementXMLData = 266,
    e_WidgetElementOpenAction = 267,
    e_WidgetElementNeverEmbed = 268,
    e_WidgetElementBindItems = 269,
    e_WidgetElementCalculate = 270,
    e_WidgetElementPrint = 271,
    e_WidgetElementExtras = 272,
    e_WidgetElementProto = 273,
    e_WidgetElementDSigData = 274,
    e_WidgetElementCreator = 275,
    e_WidgetElementConnect = 276,
    e_WidgetElementPermissions = 277,
    e_WidgetElementConnectionSet = 278,
    e_WidgetElementSubmit = 279,
    e_WidgetElementRange = 280,
    e_WidgetElementLinearized = 281,
    e_WidgetElementPacket = 282,
    e_WidgetElementRootElement = 283,
    e_WidgetElementPlaintextMetadata = 284,
    e_WidgetElementNumberSymbols = 285,
    e_WidgetElementPrintHighQuality = 286,
    e_WidgetElementDriver = 287,
    e_WidgetElementIncrementalLoad = 288,
    e_WidgetElementSubjectDN = 289,
    e_WidgetElementCompressLogicalStructure = 290,
    e_WidgetElementIncrementalMerge = 291,
    e_WidgetElementRadial = 292,
    e_WidgetElementVariables = 293,
    e_WidgetElementTimePatterns = 294,
    e_WidgetElementEffectiveInputPolicy = 295,
    e_WidgetElementNameAttr = 296,
    e_WidgetElementConformance = 297,
    e_WidgetElementTransform = 298,
    e_WidgetElementLockDocument = 299,
    e_WidgetElementBreakAfter = 300,
    e_WidgetElementLine = 301,
    e_WidgetElementList = 302,
    e_WidgetElementSource = 303,
    e_WidgetElementOccur = 304,
    e_WidgetElementPickTrayByPDFSize = 305,
    e_WidgetElementMonthNames = 306,
    e_WidgetElementSeverity = 307,
    e_WidgetElementGroupParent = 308,
    e_WidgetElementEncryptData = 309,
    e_WidgetElementDocumentAssembly = 310,
    e_WidgetElementNumberSymbol = 311,
    e_WidgetElementTagged = 312,
    e_WidgetElementItems = 313
  } WidgetElement;
  
  typedef enum _WidgetAttributeType {
    e_WidgetAttributeTypeH = 0,
    e_WidgetAttributeTypeW = 1,
    e_WidgetAttributeTypeX = 2,
    e_WidgetAttributeTypeY = 3,
    e_WidgetAttributeTypeLineThrough = 4,
    e_WidgetAttributeTypeLineHAlign = 5,
    e_WidgetAttributeTypeTypeface = 6,
    e_WidgetAttributeTypeFontHorizontalScale = 7,
    e_WidgetAttributeTypeTextIndent = 8,
    e_WidgetAttributeTypeLeftInset = 9,
    e_WidgetAttributeTypeBottomInset = 10,
    e_WidgetAttributeTypeAllowRichText = 11,
    e_WidgetAttributeTypeTopInset = 12,
    e_WidgetAttributeTypeAccess = 13,
    e_WidgetAttributeTypeMarginRight = 14,
    e_WidgetAttributeTypeRotate = 15,
    e_WidgetAttributeTypeUnderline = 16,
    e_WidgetAttributeTypeBaselineShift = 17,
    e_WidgetAttributeTypeOverlinePeriod = 18,
    e_WidgetAttributeTypeFracDigits = 19,
    e_WidgetAttributeTypeMarginLeft = 20,
    e_WidgetAttributeTypeStroke = 21,
    e_WidgetAttributeTypePresence = 22,
    e_WidgetAttributeTypeMultiLine = 23,
    e_WidgetAttributeTypeSpaceBelow = 24,
    e_WidgetAttributeTypeNumberOfCells = 25,
    e_WidgetAttributeTypeLetterSpacing = 26,
    e_WidgetAttributeTypePasswordChar = 27,
    e_WidgetAttributeTypeVAlign = 28,
    e_WidgetAttributeTypeMaxH = 29,
    e_WidgetAttributeTypeMaxW = 30,
    e_WidgetAttributeTypeMinH = 31,
    e_WidgetAttributeTypeMinW = 32,
    e_WidgetAttributeTypeLayout = 33,
    e_WidgetAttributeTypeRightInset = 34,
    e_WidgetAttributeTypeLineThroughPeriod = 35,
    e_WidgetAttributeTypeShape = 36,
    e_WidgetAttributeTypeBorderWidth = 37,
    e_WidgetAttributeTypeLocale = 38,
    e_WidgetAttributeTypeWeight = 39,
    e_WidgetAttributeTypeUnderlinePeriod = 40,
    e_WidgetAttributeTypeOverline = 42,
    e_WidgetAttributeTypeLineHeight = 43,
    e_WidgetAttributeTypeValue = 44,
    e_WidgetAttributeTypeTextEncoding = 45,
    e_WidgetAttributeTypeLeadDigits = 46,
    e_WidgetAttributeTypeSpaceAbove = 47,
    e_WidgetAttributeTypePlacement = 48,
    e_WidgetAttributeTypeBorderColor = 49,
    e_WidgetAttributeTypeFillColor = 50,
    e_WidgetAttributeTypeFontColor = 51,
    e_WidgetAttributeTypeUnknown = 52
  } WidgetAttributeType;
  

  XFAWidgetModifyInfo() 
    : event_type(XFADoc::e_EventTypeUnknown)
    , page_index(-1)
    , element(e_WidgetElementPs)
    , attribute_type(e_WidgetAttributeTypeUnknown)
    , old_value(L"")
    , new_value(L"")
    , widget_name(L"") {}

  XFAWidgetModifyInfo(const XFAWidgetModifyInfo& other) {
    event_type = other.event_type;
    page_index = other.page_index;
    element = other.element;
    attribute_type = other.attribute_type;
    old_value = other.old_value;
    new_value = other.new_value;
    widget_name = other.widget_name;
  }

  XFAWidgetModifyInfo& operator=(const XFAWidgetModifyInfo& other) {
    if (this != &other) {
      event_type = other.event_type;
      page_index = other.page_index;
      element = other.element;
      attribute_type = other.attribute_type;
      old_value = other.old_value;
      new_value = other.new_value;
      widget_name = other.widget_name;
    }
    return *this;
  }

  XFAWidgetModifyInfo(XFADoc::EventType event_type,
      int page_index, WidgetElement element, 
      WidgetAttributeType attribute_type, WString old_value,
      WString new_value, WString widget_name)
      : event_type(event_type)
      , page_index(page_index)
      , element(element)
      , attribute_type(attribute_type)
      , old_value(old_value)
      , new_value(new_value)
      , widget_name(widget_name) 
     {}

  XFADoc::EventType event_type;

  int page_index;

  WidgetElement element;

  WidgetAttributeType attribute_type;

  WString old_value;

  WString new_value;

  WString widget_name;
};

class XFAWidget FS_FINAL : public Base {
 public:
  typedef enum _HitTestArea {
    e_HitTestAreaUnknown = 0,
    e_HitTestAreaClient = 1,
    e_HitTestAreaTitleBar = 2,
    e_HitTestAreaHyperLink = 3
  } HitTestArea;
  
  typedef enum _WidgetType {
    e_WidgetTypeBarcode = 0,
    e_WidgetTypePushButton = 1,
    e_WidgetTypeCheckButton = 2,
    e_WidgetTypeArc = 3,
    e_WidgetTypeDateTimeEdit = 4,
    e_WidgetTypeNumericEdit = 5,
    e_WidgetTypeSignature = 6,
    e_WidgetTypeChoiceList = 7,
    e_WidgetTypeImageEdit = 8,
    e_WidgetTypeLine = 9,
    e_WidgetTypePasswordEdit = 10,
    e_WidgetTypeRadioButton = 11,
    e_WidgetTypeRectangle = 12,
    e_WidgetTypeTextEdit = 13,
    e_WidgetTypeUnknown = 14,
    e_WidgetTypeExclGroup = 15,
    e_WidgetTypeImage = 16
  } WidgetType;
  
  typedef enum _PresenceProperty {
    e_PresenceUnknown = 0,
    e_PresenceVisible = 1,
    e_PresenceHidden = 2,
    e_PresenceInactive = 3,
    e_PresenceInvisible = 4
  } PresenceProperty;
  
  typedef enum _WidgetNameType {
    e_WidgetNameTypeField = 0,
    e_WidgetNameTypeCaption = 1,
    e_WidgetNameTypeFullName = 2
  } WidgetNameType;
  
  typedef enum _WidgetHAlignType {
    e_WidgethAlignTypeCenter = 128,
    e_WidgethAlignTypeJustify = 156,
    e_WidgethAlignTypeJustifyAll = 61,
    e_WidgethAlignTypeLeft = 252,
    e_WidgethAlignTypeRadix = 231,
    e_WidgethAlignTypeRight = 54
  } WidgetHAlignType;
  
  typedef enum _WidgetVAlignType {
    e_WidgetvAlignTypeTop = 33,
    e_WidgetvAlignTypeBottom = 85,
    e_WidgetvAlignTypeMiddle = 161
  } WidgetVAlignType;
  
  typedef enum _WidgetEdgePosition {
    e_WidgetEdgePositionTop = 0,
    e_WidgetEdgePositionRight = 1,
    e_WidgetEdgePositionBottom = 2,
    e_WidgetEdgePositionLeft = 3
  } WidgetEdgePosition;
  

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

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

  bool IsEmpty() const;

  ~XFAWidget();

  XFAPage GetXFAPage();

  int GetIndex() const;

  void ResetData();

  RectF GetRect();

  WString GetValue();

  void SetValue(const wchar_t* value);

  WString GetDefaultValue();

  void SetDefaultValue(const wchar_t* value);

  WString GetName(WidgetNameType type);

  addon::xfa::WidgetChoiceOptionArray GetOptions() const;

  bool SetOptions(const addon::xfa::WidgetChoiceOptionArray& option_array);

  bool IsChecked() const;

  void SetCheckState(bool is_checked);

  bool IsListBox();

  bool IsSupportMultiline();

  bool IsSupportMultiSelect();

  PresenceProperty GetPresence();

  bool OnMouseEnter();

  bool OnMouseExit();

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

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

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

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

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

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

  bool OnKeyDown(uint32 key_code, uint32 flags);

  bool OnKeyUp(uint32 key_code, uint32 flags);

  bool OnChar(int input_char, uint32 flags);

  HitTestArea OnHitTest(const PointF& point);

  WidgetType GetType();

  WidgetHAlignType GetHAlign();

  WidgetVAlignType GetVAlign();

  bool HasEdge(WidgetEdgePosition edge_pos);

  foxit::pdf::Signature GetSignature();

  WString GetToolTip();

  foxit::common::Bitmap GetBitmap();

  void SetImage(const foxit::common::Image& image);

  bool IsAllowRichText();

  bool IsReadOnly();

  bool IsRequired();

  bool ValidateValue(const wchar_t* value, WString& format);

  WString GetJavaScript();

  String GetXMLContent();

  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
  explicit XFAWidget(FS_HANDLE handle =  NULL);
};

class WidgetMenu FS_FINAL : public Base {
 public:
  explicit WidgetMenu(const XFAWidget& xfa_widget);

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

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

  ~WidgetMenu();

  bool IsEmpty() const;

  bool CanCopy();

  bool CanCut();

  bool CanPaste();

  bool CanSelectAll();

  bool CanDelete();

  bool CanDeSelect();

  WString Copy();

  WString Cut();

  bool Paste(const wchar_t* text);

  bool SelectAll();

  bool Delete();

  bool DeSelect();

  bool CanUndo();

  bool CanRedo();

  bool Undo();

  bool Redo();

  bool Bold();

  bool Italic();

  bool Underline();

  bool Superscript();

  bool Subscript();

  bool ClearStyle();

  // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
  explicit WidgetMenu(FS_HANDLE handle =  NULL);
};

}  // namespace XFA
}  // namespace addon
}  // namespace foxit
#endif  // namespace foxit