fs_ofdpage.h

#ifndef FS_OFD_PAGE_H_
#define FS_OFD_PAGE_H_

#include "common/fs_common.h"
#include "fs_ofdlayer.h"
#include "annots/fs_ofdannot.h"

namespace foxit {
namespace ofd {
namespace graphics {
class OFDBlockObject;
}
class Actions;
class TextSearchCharInfo;
class TextSearch;
class Annot;

class OFDPage : public Base {
 public:
  typedef enum _PageBoxType {
    e_BleedBox = 0,
    e_PhysicalBox = 1,
    e_ApplicationBox = 2,
    e_ContentBox = 3,
    e_CropBox = 4
  } PageBoxType;
  

  ~OFDPage();

  OFDPage(const OFDPage& other);

  OFDPage& operator = (const OFDPage& other);

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

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

  bool IsEmpty() const;

  bool IsTemplatePage() const;

  int GetIndex() const;

  int GetID() const;

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

  bool SetPageBox(PageBoxType box_type, const RectF& rect);

  bool SetRotation(common::Rotation rotate);

  common::Rotation GetRotation() const;

  RectF GetPageBox(PageBoxType box_type) const;

  Actions GetActions() const;

  bool SetTemplatePage(OFDPage template_page, foxit::ofd::OFDLayer::LayerType order = foxit::ofd::OFDLayer::e_LayerTypeBody);

  bool SetTemplatePageByID(int template_id, foxit::ofd::OFDLayer::LayerType order = foxit::ofd::OFDLayer::e_LayerTypeBody);

  int GetTemplatePageCount() const;

  OFDLayer AddLayer();

  OFDLayer InsertLayer(int index);

  bool RemoveLayer(int index);

  int GetLayerCount() const;

  OFDLayer GetLayer(int index) const;

  foxit::ofd::graphics::OFDBlockObject AddPageBlock();

  foxit::ofd::graphics::OFDBlockObject InsertPageBlock(int index);

  bool RemovePageBlock(int index);

  bool ReplaceCharacterBySearch(TextSearchCharInfo char_info, foxit::uint8 character = 'X');

  bool ReplaceCharacterInRect(const RectF& rect, bool recover = true, foxit::uint8 character = 'X');

  bool MaskCharacterWithBlack(const RectF& rect, int shape);

  bool MaskCharacterWithBlur(const RectF& rect, int shape, int horz_blur, int vert_blur);

  bool MaskCharacterWithMosaic(const RectF& rect, int shape, int vector_length);

  bool PreMaskCharacterByRect(const RectF& rect, foxit::ARGB color);

  bool FillRect(const RectF& rect, foxit::RGB color);

  int GetTextLineCount();

  WString GetTextByLineIndex(int index);

  int GetAnnotCount();

  Annot GetAnnot(int index);

  Annot GetAnnotByID(foxit::uint32 id);

  bool RemoveAnnot(int index);

  Annot AddAnnot(Annot::AnnotType type);

  bool IsDoubleLayer();

  explicit OFDPage(FS_HANDLE handle);
};

class OFDTemplatePage FS_FINAL : public OFDPage {
 public:
  ~OFDTemplatePage();

  bool SetName(const WString& name);

  explicit OFDTemplatePage(FS_HANDLE handle);
};

}  // namespace ofd
}  // namespace foxit

#endif  // FS_OFD_PAGE_H_