Page.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2025 by Apryse Software Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.
//---------------------------------------------------------------------------------------
#ifndef PDFTRON_H_CPPPDFPage
#define PDFTRON_H_CPPPDFPage

#include <PDF/Rect.h>
#include <SDF/Obj.h>
#include <C/PDF/TRN_Page.h>
#include <Common/Matrix2D.h>

namespace pdftron { 
    namespace PDF {

class Annot;  // Forward declaration
class Field;
class TaggingOptions;

class Page
{
public: 

     Page (SDF::Obj page_dict = 0);
    
     Page (const Page& p);
     Page& operator= (const Page& p);

     bool IsValid() const;

     int GetIndex() const;

    enum Box
    {
        e_media,
        e_crop,
        e_bleed,
        e_trim,
        e_art,
        e_user_crop
    };

     Rect GetBox(Box type) const;

     void SetBox(Box type, const Rect& box) const;

     Rect GetCropBox() const;

     void SetCropBox(const Rect& box);

     Rect GetMediaBox() const;

     void SetMediaBox(const Rect& box);

    Rect GetVisibleContentBox() const;

    enum Rotate 
    {
        e_0,
        e_90,
        e_180,
        e_270
    };

    static Rotate AddRotations(Rotate r0, Rotate r1);

    static Rotate SubtractRotations(Rotate r0, Rotate r1);

    static int RotationToDegree(Rotate r);

    static Rotate DegreeToRotation(int r);

     Rotate GetRotation() const;

     void SetRotation(Rotate angle);

     double GetPageWidth(Box box_type = e_crop);

     double GetPageHeight(Box box_type = e_crop);

     Common::Matrix2D GetDefaultMatrix(bool flip_y = false, Box box_type = e_crop, Rotate angle = e_0) const;

     SDF::Obj GetAnnots() const;

     UInt32 GetNumAnnots() const;

     Annot GetAnnot(UInt32 index) const;

     enum ActionTriggerEvent
     {
         e_action_trigger_page_open = 11, //Triggered when the page is opened and shall be executed after such an action
         e_action_trigger_page_close = 12 //Triggered when the page is closed, This action applies to the page being closed and shall be executed before any other page is opened
     };

     SDF::Obj GetTriggerAction(Page::ActionTriggerEvent trigger);

     void AnnotInsert(UInt32 pos, Annot& annot);

     void AnnotInsertWithTagging(UInt32 pos, Annot& annot, SDF::Obj& tag_parent, const TaggingOptions& options);


     void AnnotPushBack(Annot& annot);

     void AnnotPushFront(Annot& annot);

     void AnnotRemove(Annot& annot);

     void AnnotRemove(UInt32 index);

     void Scale(double scale);

     void FlattenField(class Field field_to_flatten);

     bool HasTransition() const;

     double GetUserUnitSize() const;

     void SetUserUnitSize(double unit_size);

     SDF::Obj GetResourceDict () const;

     SDF::Obj GetContents () const;
    
     SDF::Obj GetSDFObj () const;

     SDF::Obj FindInheritedAttribute (const char* attrib) const;


     operator bool () { return IsValid();}

     SDF::Obj GetThumb() const;


// @cond PRIVATE_DOC
#ifndef SWIGHIDDEN
    Page(TRN_Page impl);
    TRN_Page mp_page;
#endif
// @endcond
};


    };  // namespace PDF
};  // namespace pdftron
#include <Impl/Page.inl>

#endif // PDFTRON_H_CPPPDFPage