fs_pdfform.h

浏览该文件的文档.

#ifndef FS_PDFFORM_H_
#define FS_PDFFORM_H_

#include "common/fs_common.h"
#include "fdf/fs_fdfdoc.h"
#include "pdf/interform/fs_formfiller.h"
#include "pdf/objects/fs_pdfobject.h"

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

FSDK_DEFINE_ARRAY(FieldArray,Field)


class ChoiceOption FS_FINAL : public Object {
 public:
  ChoiceOption()
      : option_value(WString())
      , option_label(WString())
      , selected(false)
      , default_selected(false) {}

  ChoiceOption(const wchar_t* option_value, const wchar_t* option_label, bool selected, bool default_selected)
      : option_value(option_value)
      , option_label(option_label)
      , selected(selected)
      , default_selected(default_selected) {}

  ChoiceOption(const ChoiceOption& option)
      : option_value(option.option_value)
      , option_label(option.option_label)
      , selected(option.selected)
      , default_selected(option.default_selected) {}

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

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

  WString option_label;

  bool selected;

  bool default_selected;
};

FSDK_DEFINE_ARRAY(ChoiceOptionArray, ChoiceOption)


class Field : public Base {
 public:
  typedef enum _Type {
    e_TypeUnknown = 0,
    e_TypePushButton = 1,
    e_TypeCheckBox = 2,
    e_TypeRadioButton = 3,
    e_TypeComboBox = 4,
    e_TypeListBox = 5,
    e_TypeTextField = 6,
    e_TypeSignature = 7
  } Type;
  
  typedef enum _Flags {
    e_FlagReadOnly = 0x01,
    e_FlagRequired = 0x02,
    e_FlagNoExport = 0x04,
    e_FlagButtonNoToggleToOff = 0x100,
    e_FlagButtonRadiosInUnison = 0x200,
    e_FlagTextMultiline = 0x100,
    e_FlagTextPassword = 0x200,
    e_FlagTextFileSelect = 0x400,
    e_FlagTextNoSpellCheck = 0x800,
    e_FlagTextDoNotScroll = 0x1000,
    e_FlagTextComb = 0x2000,
    e_FlagComboEdit = 0x100,
    e_FlagChoiceMultiSelect = 0x100,
    e_FlagTextRichText = 0x4000,
    e_FlagChoiceSort = 0x200,
    e_FlagChoiceCommitOnSelChange = 0x400
  } Flags;
  

  Field(const PDFDoc& document, objects::PDFDictionary* field_dict);

  Field(const Field& field);
  Field& operator = (const Field& other);

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

  ~Field();

  bool IsEmpty() const;

  Type GetType() const;

  uint32 GetFlags() const;

  void SetFlags(uint32 flags);

  WString GetName() const;

  WString GetDefaultValue() const;

  void SetDefaultValue(const wchar_t* value);

  WString GetValue() const;

  void SetValue(const wchar_t* value);

  common::Alignment GetAlignment() const;

  void SetAlignment(common::Alignment alignment);

  WString GetAlternateName() const;

  void SetAlternateName(const wchar_t* alternate_name);

  DefaultAppearance GetDefaultAppearance() const;

  void SetDefaultAppearance(const DefaultAppearance& default_ap);

  WString GetMappingName() const;

  void SetMappingName(const wchar_t* name);

  int GetMaxLength() const;

  void SetMaxLength(int max_length);

  ChoiceOptionArray GetOptions() const;

  void SetOptions(const ChoiceOptionArray& option_array);

  int GetTopVisibleIndex();

  void SetTopVisibleIndex(int index);

  int GetControlCount() const;

  Control GetControl(int index);

  int GetControlCount(const foxit::pdf::PDFPage& page) const;

  Control GetControl(const foxit::pdf::PDFPage& page, int index);

  bool Reset();

  objects::PDFDictionary* GetDict() const;

  objects::PDFObject* GetValueObj() const;

  objects::PDFObject* GetDefaultValueObj() const;

  objects::PDFObject* GetInheritedAttribute(const char* attribute_name) const;

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

class Form FS_FINAL : public Base {
 public:
  explicit Form(const pdf::PDFDoc& document);
  Form(const Form& other);
  Form& operator = (const Form& other);

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

  ~Form();

  bool IsEmpty() const;

  common::Alignment GetAlignment() const;

  void SetAlignment(common::Alignment alignment);

  bool NeedConstructAppearances() const;

  void SetConstructAppearances(bool need_construct);

  Control GetControlAtDevicePoint(const PDFPage& page, const PointF& point, float tolerance, Field::Type type,
                                  const Matrix* matrix = NULL);

  Control GetControlAtPoint(const PDFPage& page, const PointF& point, float tolerance, Field::Type type);

  DefaultAppearance GetDefaultAppearance() const;

  void SetDefaultAppearance(const DefaultAppearance& default_ap);

  PDFDoc GetDocument() const;

  FieldArray GetFieldsInCalculationOrder();

  void SetFieldsInCalculationOrder(const FieldArray& field_array);

  bool ValidateFieldName(Field::Type type, const WString& field_name);

  bool RenameField(Field& field, const wchar_t* new_field_name);

  Control AddControl(const PDFPage& page, const wchar_t* field_name, Field::Type field_type, const RectF& rect);

  bool MoveControl(Control& control, const wchar_t* field_name);

  void RemoveField(Field& field);

  void RemoveControl(Control& control);

  int GetFieldCount(const wchar_t* filter = NULL) const;
          
  Field GetField(int index, const wchar_t* filter = NULL);

  int GetControlCount(const PDFPage& page) const;

  Control GetControl(const PDFPage& page, int index);

#ifndef _FX_NO_JSE_

  Filler GetFormFiller() const;
#endif  // #ifndef _FX_NO_JSE_

  bool Reset();

  bool ExportToXML(const char* file_path);

  bool ExportToXML(const wchar_t* file_path, const FieldArray& field_array, bool is_include);

  bool ExportToXML(foxit::common::file::WriterCallback* xml_file, const FieldArray& field_array, bool is_include);

  bool ImportFromXML(const char* file_path);

  bool ExportToCSV(const wchar_t* csv_file_path, const wchar_t* pdf_file_name, bool is_append);

  bool ExportToCSV(foxit::common::file::StreamCallback* csv_file, const wchar_t* pdf_file_name, bool is_append);

  bool ExportToHTML(const wchar_t* html_file_path, const FieldArray& field_array, bool is_include);

  bool ExportToHTML(foxit::common::file::WriterCallback* html_file, const FieldArray& field_array, bool is_include);

  bool ExportToTXT(const wchar_t* txt_file_path, const FieldArray& field_array, bool is_include);

  bool ExportToTXT(foxit::common::file::WriterCallback* txt_file, const FieldArray& field_array, bool is_include);

  objects::PDFDictionary* GetDict() const;

  void FixPageFields(int page_index);

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

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

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

  ~Control();

  bool IsEmpty() const;

  Field GetField() const;

  objects::PDFDictionary* GetWidgetDict() const;

  annots::Widget GetWidget() const;

  int GetIndex() const;

  WString GetExportValue() const;

  void SetExportValue(const wchar_t* value);

  bool IsChecked() const;

  void SetChecked(bool checked_status);

  bool IsDefaultChecked() const;

  void SetDefaultChecked(bool checked_status);

  DefaultAppearance GetDefaultAppearance() const;

  void SetDefaultAppearance(const DefaultAppearance& default_ap);

  common::Alignment GetAlignment();

  void SetAlignment(common::Alignment alignment);

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

};
}  // namespace interform
}  // namespace pdf
}  // namespace foxit
#endif  // FS_PDFFORM_H_