fs_pdfstructtree.h

Go to the documentation of this file.

#ifndef FS_PDFSSTRUCTTREE_H_
#define FS_PDFSSTRUCTTREE_H_

#include "common/fs_common.h"
#include "pdf/objects/fs_pdfobject.h"

namespace foxit {
namespace pdf {
  // forward declaration
  class PDFPage;

namespace objects { 
class StructTreeEntity : public Base {
 public:
  typedef enum _StructTreeEntityType {
    e_UnknownType = -1,
    e_StructTreeEntityTypeElement = 0,
    e_StructTreeEntityTypeMarkedContent = 1,
    e_StructTreeEntityTypeObjectContent = 2
  } StructTreeEntityType;
  
  
  StructTreeEntity() {}

  ~StructTreeEntity();

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

  StructTreeEntity(const StructTreeEntity& other);

  StructTreeEntity& operator = (const StructTreeEntity& other);

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

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

  bool IsEmpty() const;

  StructTreeEntityType GetType() const;

  PDFPage GetPage() const;
};

class StructElement FS_FINAL : public StructTreeEntity {
 public:
  typedef enum _ElementInfoType {
    e_ElementInfoTypeTitle = 0,
    e_ElementInfoTypeLanguage = 1,
    e_ElementInfoTypeAltDescription = 2,
    e_ElementInfoTypeExpandedForm = 3,
    e_ElementInfoTypeActualText = 4
  } ElementInfoType;
  
   
  StructElement() {}

  StructElement(const StructElement& other);

  StructElement(const StructTreeEntity& other);

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

  ~StructElement() {}

  String GetStructureTypeName() const;

  int GetChildCount() const;

  StructTreeEntity GetChild(int index);

  void RemoveChild(int index);

  bool HasElementInfo(ElementInfoType type) const;

  WString GetElementInfo(ElementInfoType type) const;

  StructElement GetParentElement();
 };

class StructMarkedContent FS_FINAL : public StructTreeEntity {
 public:
  StructMarkedContent() {}

  StructMarkedContent(const StructMarkedContent& other);

  StructMarkedContent(const StructTreeEntity& other);

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

  ~StructMarkedContent() {}

  StructElement GetParentElement();

  uint32 GetMCID() const;

  pdf::objects::PDFDictionary* GetStmDict() const;

  pdf::objects::PDFDictionary* GetStmOwnerDict() const;
};

class StructObjectContent FS_FINAL : public StructTreeEntity {
 public:
  typedef enum _StructObjectType {
    e_UnknownType = -1,
    e_StructObjectTypeInvalid = 0,
    e_StructObjectTypeImage = 1,
    e_StructObjectTypeForm = 2,
    e_StructObjectTypeAnnot = 3
  } StructObjectType;
  

  StructObjectContent() {}

  StructObjectContent(const StructObjectContent& other);

  StructObjectContent(const StructTreeEntity& other);

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

  ~StructObjectContent() {}

  StructElement GetParentElement();

  StructObjectType GetObjectType() const;

  pdf::objects::PDFDictionary* GetDict() const;
};

class PDFStructTree FS_FINAL : public Base {
 public:
  PDFStructTree(const PDFDoc& document);
  
  ~PDFStructTree();

  PDFStructTree(const PDFStructTree& other);

  PDFStructTree& operator = (const PDFStructTree& other);

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

  bool IsEmpty() const;

  int GetChildCount() const;

  StructElement GetChild(int index) const;

  void RemoveChild(int index);

   // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
   explicit PDFStructTree(FS_HANDLE handle);
};
}  // namespace objects
}  // namespace pdf
}  // namespace foxit
#endif  // FS_PDFSTRUCTTREE_H_