fs_ofdsign.h

#ifndef FS_OFD_SIGN_H_
#define FS_OFD_SIGN_H_

#include "common/fs_common.h"

namespace foxit {
namespace ofd {
class OFDDoc;
namespace ofdseal {
class Oes;

class ImagePosition FS_FINAL : public Object {
 public:
  ImagePosition(int page_index, float x, float y, bool is_centered = true, float width = -1.0f, float height = -1.0f) :
    page_index(page_index),
    x(x),
    y(y),
    is_centered(is_centered),
    width(width),
    height(height) {
  }

  ImagePosition(const ImagePosition& other) {
    this->page_index = other.page_index;
    this->x = other.x;
    this->y = other.y;
    this->is_centered = other.is_centered;
    this->width = other.width;
    this->height = other.height;
  }

  ImagePosition& operator=(const ImagePosition& other) {
    this->page_index = other.page_index;
    this->x = other.x;
    this->y = other.y;
    this->is_centered = other.is_centered;
    this->width = other.width;
    this->height = other.height;
    return *this;
  }

  void Set(int page_index, float x, float y, bool is_centered = true, float width = -1.0f, float height = -1.0f) {
    this->page_index = page_index;
    this->x = x;
    this->y = y;
    this->is_centered = is_centered;
    this->width = width;
    this->height = height;
  }

  int page_index;

  float x;

  float y;

  bool is_centered;

  float width;

  float height;
};

FSDK_DEFINE_ARRAY(ImagePositionArray, ImagePosition)


class StraddlePosition FS_FINAL : public Object {
 public:
  typedef enum _StraddlePositionType {
    e_StraddlePositionTypeLeft  =  0,
    e_StraddlePositionTypeTop  =  1,
    e_StraddlePositionTypeRight  =  2,
    e_StraddlePositionTypeBottom  =  3
  } StraddlePositionType;
  
  typedef enum _StraddleProportionType {
    e_StraddleProportionOneFifth  =  1,
    e_StraddleProportionTwoFifth  =  2,
    e_StraddleProportionThreeFifth  =  3,
    e_StraddleProportionFourFifth  =  4
  } StraddleProportionType;
  

  StraddlePosition(StraddlePositionType position, StraddleProportionType proportion, float first_page_percent, int start_page_index, int page_count) :
    position(position),
    proportion(proportion),
    first_page_percent(first_page_percent),
    start_page_index(start_page_index),
    page_count(page_count) {
  }

  StraddlePosition(const StraddlePosition& other) {
    this->position = other.position;
    this->proportion = other.proportion;
    this->first_page_percent = other.first_page_percent;
    this->start_page_index = other.start_page_index;
    this->page_count = other.page_count;
  }

  StraddlePosition& operator=(const StraddlePosition& other) {
    this->position = other.position;
    this->proportion = other.proportion;
    this->first_page_percent = other.first_page_percent;
    this->start_page_index = other.start_page_index;
    this->page_count = other.page_count;
    return *this;
  }

  void Set(StraddlePositionType position, StraddleProportionType proportion, float first_page_percent, int start_page_index, int page_count) {
    this->position = position;
    this->proportion = proportion;
    this->first_page_percent = first_page_percent;
    this->start_page_index = start_page_index;
    this->page_count = page_count;
  }

  StraddlePositionType position;

  StraddleProportionType proportion;

  float first_page_percent;

  int start_page_index;

  int page_count;
};

class PublicProperties FS_FINAL : public Object {
 public:
  typedef enum _LockType {
    e_SealSignLockTypeNone   =  0,
    e_SealSignLockTypeSignatureXml  =  1,
    e_SealSignLockTypSignatureXmlAndOFDXml  =  2
  } LockType;
  

  PublicProperties(bool image_visible = true, LockType lock_type = e_SealSignLockTypeNone, bool protect_annotations = false, bool protect_attachments = false, const String& directory_name = "") :
    image_visible(image_visible),
    lock_type(lock_type),
    protect_annotations(protect_annotations),
    protect_attachments(protect_attachments),
    directory_name(directory_name) {
  }

  PublicProperties(const PublicProperties& other) {
    this->image_visible = other.image_visible;
    this->lock_type = other.lock_type;
    this->protect_annotations = other.protect_annotations;
    this->protect_attachments = other.protect_attachments;
    this->directory_name = other.directory_name;
  }

  PublicProperties& operator = (const PublicProperties& other) {
    this->image_visible = other.image_visible;
    this->lock_type = other.lock_type;
    this->protect_annotations = other.protect_annotations;
    this->protect_attachments = other.protect_attachments;
    this->directory_name = other.directory_name;
    return *this;
  }

  void Set(bool image_visible, LockType lock_type, bool protect_annotations, bool protect_attachments, const String& dir_name) {
    this->image_visible = image_visible;
    this->lock_type = lock_type;
    this->protect_annotations = protect_annotations;
    this->protect_attachments = protect_attachments;
    this->directory_name = dir_name;
  }

  bool image_visible;

  LockType lock_type;

  bool protect_annotations;

  bool protect_attachments;

  String directory_name;
};

class SealDoc FS_FINAL : public Base {
 public:
  explicit SealDoc(OFDDoc doc);

  ~SealDoc();

  SealDoc(const SealDoc& other);

  SealDoc& operator = (const SealDoc& other);

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

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

  bool IsEmpty() const;

  bool SignWithPage(const Seal& seal, const ImagePosition& position, const String& dest_file, const PublicProperties& properties = PublicProperties());

  bool SignWithPage(const Seal& seal, const ImagePosition& position, const WString& dest_file, const PublicProperties& properties = PublicProperties());

  bool SignWithPage(const Seal& seal, const ImagePosition& position, foxit::common::file::WriterCallback* writer_callback, const PublicProperties& properties = PublicProperties());

  bool SignWithMultiPage(const Seal& seal, const foxit::Int32Array& page_index_array, const ImagePosition& position, const String& dest_file, const PublicProperties& properties = PublicProperties());

  bool SignWithMultiPage(const Seal& seal, const foxit::Int32Array& page_index_array, const ImagePosition& position, const WString& dest_file, const PublicProperties& properties = PublicProperties());

  bool SignWithMultiPage(const Seal& seal, const foxit::Int32Array& page_index_array, const ImagePosition& position, foxit::common::file::WriterCallback* writer_callback, const PublicProperties& properties = PublicProperties());

  bool SignWithMultiPage(const Seal& seal, const String& page_scope, const ImagePosition& position, const String& dest_file, const PublicProperties& properties = PublicProperties());

  bool SignWithMultiPage(const Seal& seal, const String& page_scope, const ImagePosition& position, const WString& dest_file, const PublicProperties& properties = PublicProperties());

  bool SignWithMultiPage(const Seal& seal, const String& page_scope, const ImagePosition& position, foxit::common::file::WriterCallback* writer_callback, const PublicProperties& properties = PublicProperties());

  bool SignWithStraddle(const Seal& seal, const StraddlePosition& position, const String& dest_file, const PublicProperties& properties = PublicProperties());

  bool SignWithStraddle(const Seal& seal, const StraddlePosition& position, const WString& dest_file, const PublicProperties& properties = PublicProperties());

  bool SignWithStraddle(const Seal& seal, const StraddlePosition& position, foxit::common::file::WriterCallback* writer_callback, const PublicProperties& properties = PublicProperties());

  bool SignWithMultiPosition(const Seal& seal, const ImagePositionArray& position_array, const String& dest_file, const PublicProperties& properties = PublicProperties());

  bool SignWithMultiPosition(const Seal& seal, const ImagePositionArray& position_array, const WString& dest_file, const PublicProperties& properties = PublicProperties());

  bool SignWithMultiPosition(const Seal& seal, const ImagePositionArray& position_array, foxit::common::file::WriterCallback* writer_callback, const PublicProperties& properties = PublicProperties());

  explicit SealDoc(FS_HANDLE handle);
};

class SignatureProperties FS_FINAL : public Object {
 public:
  SignatureProperties(const String& company = String(), const String& provider_name = String(), const String& version = String()) :
    company(company),
    provider_name(provider_name),
    version(version) {
  }

  SignatureProperties(SignatureProperties& other) {
    this->company = other.company;
    this->provider_name = other.provider_name;
    this->version = other.version;
  }

  SignatureProperties& operator=(const SignatureProperties& other) {
    this->company = other.company;
    this->provider_name = other.provider_name;
    this->version = other.version;
    return *this;
  }

  void Set(const String& company, const String& provider_name, const String& version) {
    this->company = company;
    this->provider_name = provider_name;
    this->version = version;
  }

  String company;

  String provider_name;

  String version;
};

class CertificateSignDoc FS_FINAL : public Base {
 public:
  explicit CertificateSignDoc(OFDDoc doc, const String& cert_file, const String& cert_password);

  explicit CertificateSignDoc(OFDDoc doc, const WString& cert_file, const String& cert_password);

  ~CertificateSignDoc();

  CertificateSignDoc(const CertificateSignDoc& other);

  CertificateSignDoc& operator = (const CertificateSignDoc& other);

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

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

  bool IsEmpty() const;

  bool SignWithNone(const String& dest_file, const SignatureProperties& signature_properties = SignatureProperties(), const PublicProperties& properties = PublicProperties());

  bool SignWithNone(const WString& dest_file, const SignatureProperties& signature_properties = SignatureProperties(), const PublicProperties& properties = PublicProperties());

  bool SignWithNone(foxit::common::file::WriterCallback* writer_callback, const SignatureProperties& signature_properties = SignatureProperties(), const PublicProperties& properties = PublicProperties());

  bool SignWithImage(const String& image_file, const ImagePosition& position, const String& dest_file, const SignatureProperties& signature_properties = SignatureProperties(), const PublicProperties& properties = PublicProperties());

  bool SignWithImage(const WString& image_file, const ImagePosition& position, const WString& dest_file, const SignatureProperties& signature_properties = SignatureProperties(), const PublicProperties& properties = PublicProperties());

  bool SignWithImage(const String& image_file, const ImagePosition& position, foxit::common::file::WriterCallback* writer_callback, const SignatureProperties& signature_properties = SignatureProperties(), const PublicProperties& properties = PublicProperties());

  bool SignWithStraddle(const String& image_file, float image_width, float image_height, const StraddlePosition& position, const String& dest_file, const SignatureProperties& signature_properties = SignatureProperties(), const PublicProperties& properties = PublicProperties());

  bool SignWithStraddle(const WString& image_file, float image_width, float image_height, const StraddlePosition& position, const WString& dest_file, const SignatureProperties& signature_properties = SignatureProperties(), const PublicProperties& properties = PublicProperties());

  bool SignWithStraddle(const String& image_file, float image_width, float image_height, const StraddlePosition& position, foxit::common::file::WriterCallback* writer_callback, const SignatureProperties& signature_properties = SignatureProperties(), const PublicProperties& properties = PublicProperties());

  explicit CertificateSignDoc(FS_HANDLE handle);
};

}  // namespace ofdseal
}  // namespace ofd
}  // namespace foxit

#endif  // _BUILD_OFDSDK_