fs_annotationsummary.h

浏览该文件的文档.

#ifndef FS_ANNOTATIONSUMMARY_H_
#define FS_ANNOTATIONSUMMARY_H_

#include "common/fs_common.h"
#include "pdf/fs_pdfdoc.h"
#include "pdf/annots/fs_annot.h"

namespace foxit {
namespace pdf {
class AnnotationSummaryCallback {
 public:
  typedef enum _AnnotationSummaryStringID {
    e_AnnotationSummaryStringIDAuthor = 0,
    e_AnnotationSummaryStringIDDate = 1,
    e_AnnotationSummaryStringIDPage = 2,
    e_AnnotationSummaryStringIDType = 3,
    e_AnnotationSummaryStringIDDocumentTitle = 4,
    e_AnnotationSummaryStringIDPageTitle = 5,
    e_AnnotationSummaryStringIDNoAnnotations = 6,
    e_AnnotationSummaryStringIDNumber = 7,
    e_AnnotationSummaryStringIDSubject = 8
  } AnnotationSummaryStringID;
  

  virtual void Release() = 0;

  virtual common::LocaleID GetCurrentLocaleID() = 0;

  virtual WString GetLocalFontName() = 0;

  virtual WString LoadString(AnnotationSummaryStringID id) = 0;

 protected:
  ~AnnotationSummaryCallback() {}
};

class AnnotationSummarySettings FS_FINAL : public Base {
 public:
  typedef enum _SummaryLayout {
    e_SummaryLayoutSeparatePagesWithLine = 0,
    e_SummaryLayoutSinglePageWithLine = 1,
    e_SummaryLayoutAnnotationOnly = 2,
    e_SummaryLayoutSeparatePagesWithSequenceNumber = 3,
    e_SummaryLayoutSinglePageWithSequenceNumber = 4
  } SummaryLayout;
  
  typedef enum _SortType {
    e_TypeSortByAuthor = 0,
    e_TypeSortByDate = 1,
    e_TypeSortByPage = 2,
    e_TypeSortByAnnotationType = 3
  } SortType;
  
  typedef enum _FontSizeType {
    e_FontSizeSmall = 0,
    e_FontSizeMedium = 1,
    e_FontSizeLarge = 2
  } FontSizeType;
  

  AnnotationSummarySettings();

  // 强烈建议用户不要使用此方法；否则可能出现未知情况。
  explicit AnnotationSummarySettings(FS_HANDLE handle);

  ~AnnotationSummarySettings();

  AnnotationSummarySettings(const AnnotationSummarySettings& other);

  AnnotationSummarySettings& operator=(const AnnotationSummarySettings& other);

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

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

  bool IsEmpty() const;

  void SetSummaryLayout(SummaryLayout type);

  void SetSortType(SortType type);

  void SetFontSize(FontSizeType type);

  void SetAnnotType(annots::Annot::Type type, bool use_all);

  void SetFileTitle(const wchar_t* title);

  void SetPageRect(const RectF& rect);

  void SetPageMargin(const RectF& margin);

  void SetStartPage(int page_index);

  void SetEndPage(int page_index);

  void EnableOutputNoAnnotationPage(bool enable);

  void SetConnectorLineColor(RGB color);

  void SetConnectorLineOpacity(float opacity);

  void SetAnnotThumbnail(annots::Annot::Type type, const common::Bitmap& thumbnail);
};

class AnnotationSummary FS_FINAL : public Base {
 public:
  AnnotationSummary(const pdf::PDFDoc& document);

  // 强烈建议用户不要使用此方法；否则可能出现未知情况。
  explicit AnnotationSummary(FS_HANDLE handle);

  ~AnnotationSummary();

  AnnotationSummary(const AnnotationSummary& other);

  AnnotationSummary& operator=(const AnnotationSummary& other);

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

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

  bool IsEmpty() const;

  void SetCallback(AnnotationSummaryCallback* callback);

  common::Progressive StartSummarize(const char* dest_file_path, const AnnotationSummarySettings& settings, common::PauseCallback* pause = NULL);

  common::Progressive StartSummarize(const wchar_t* dest_file_path, const AnnotationSummarySettings& settings, common::PauseCallback* pause = NULL);

  common::Progressive StartSummarize(foxit::common::file::WriterCallback* dest_file, const AnnotationSummarySettings& settings, foxit::common::PauseCallback* pause = NULL);
};

}  // namespace pdf
}  // namespace foxit
#endif  // FS_ANNOTATIONSUMMARY_H_