Annot.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_CPPPDFAnnot
#define PDFTRON_H_CPPPDFAnnot

#include <vector>
#include <SDF/Obj.h>
#include <PDF/Date.h>
#include <SDF/SDFDoc.h>
#include <PDF/Rect.h>
#include <PDF/ColorSpace.h>
#include <PDF/FileSpec.h>
#include <PDF/Page.h>
#include <C/PDF/TRN_Annot.h>
#include <PDF/RefreshOptions.h>

namespace pdftron { 
    namespace PDF {
class BorderStyle;
class Annot
{
public: 
    typedef pdftron::PDF::BorderStyle BorderStyle;
    enum Type
    {
        e_Text,           
        e_Link,           
        e_FreeText,       
        e_Line,           
        e_Square,         
        e_Circle,         
        e_Polygon,        
        e_Polyline,       
        e_Highlight,      
        e_Underline,      
        e_Squiggly,       
        e_StrikeOut,      
        e_Stamp,          
        e_Caret,          
        e_Ink,            
        e_Popup,          
        e_FileAttachment, 
        e_Sound,          
        e_Movie,          
        e_Widget,         
        e_Screen,         
        e_PrinterMark,    
        e_TrapNet,        
        e_Watermark,      
        e_3D,             
        e_Redact,         
        e_Projection,     
        e_RichMedia,      
        e_Unknown         
    };

    static Annot Create(SDF::SDFDoc& doc, Type type, const Rect& pos);

    Annot (SDF::Obj d = 0);

    Annot (const Annot& d);

    Annot& operator=(const Annot& d);

    bool operator==(const Annot& d);

    bool IsValid() const;

    SDF::Obj GetSDFObj () const;    

    Type GetType() const;

    Rect GetRect() const;

    Rect GetVisibleContentBox() const;

    bool IsMarkup() const;

    void SetRect(const Rect& pos);

    Page GetPage() const;

    void SetPage(const Page& page);

    SDF::Obj GetUniqueID() const;

    void SetUniqueID(const char* id, int id_buf_sz = 0);

    Date GetDate() const;

    void SetDate(const Date& date);

    enum Flag
    {
        e_invisible,         // PDF 1.2
        e_hidden,            // PDF 1.2
        e_print,             // PDF 1.2
        e_no_zoom,           // PDF 1.3
        e_no_rotate,         // PDF 1.3
        e_no_view,           // PDF 1.3
        e_read_only,         // PDF 1.3
        e_locked,            // PDF 1.4
        e_toggle_no_view,     // PDF 1.5
        e_locked_contents    // PDF 1.7
    };


    bool GetFlag(Flag flag) const;

    void SetFlag(Flag flag, bool value);

    enum ActionTriggerEvent
    {
        e_action_trigger_activate = 0, //Triggered when the annotation is activated. if present, takes precedence over U entry (e_action_trigger_annot_up)
        e_action_trigger_annot_enter = 1, //Triggered when the cursor enters the annotation's active area
        e_action_trigger_annot_exit = 2, //Triggered when the cursor exits the annotation's active area
        e_action_trigger_annot_down = 3, //Triggered when the mouse button is pressed inside the annotation's active area
        e_action_trigger_annot_up = 4, //Triggered when the mouse button is released inside the annotation's active area
        e_action_trigger_annot_focus = 5, //Triggered when the annotation receives the input focus
        e_action_trigger_annot_blur = 6, //Triggered when the annotation loses the input focus
        e_action_trigger_annot_page_open = 7, //Triggered when the page containing the annotation is opened
        e_action_trigger_annot_page_close = 8, //Triggered when the page containing the annotation is closed 
        e_action_trigger_annot_page_visible = 9, //Triggered when the page containing the annotation becomes visible
        e_action_trigger_annot_page_invisible = 10 //Triggered when the page containing the annotation is no longer visible in the interactive PDF processor's user interface
    };

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



    BorderStyle GetBorderStyle() const;

    void SetBorderStyle( const BorderStyle& bs, bool oldStyleOnly = false );

    enum AnnotationState
    {
        e_normal,
        e_rollover,
        e_down
    };

    SDF::Obj GetAppearance(AnnotationState annot_state = e_normal, const char* app_state = 0);

    void SetAppearance(SDF::Obj app_stream, AnnotationState annot_state = e_normal, const char* app_state = 0);

    void RemoveAppearance(AnnotationState annot_state = e_normal, const char* app_state = 0);

    void Flatten(class Page page);

    const char* GetActiveAppearanceState() const;

    void SetActiveAppearanceState(const char* astate);


    ColorPt GetColorAsRGB() const;

    ColorPt GetColorAsCMYK() const;

    ColorPt GetColorAsGray() const;

    int GetColorCompNum() const;


    void SetColor(const ColorPt& col, int numcomp=3);


    int GetStructParent() const;

    void SetStructParent(const int parkeyval);//The value can be set, should be limited. 


    SDF::Obj GetOptionalContent() const;

    void SetOptionalContent(SDF::Obj content);

    void SetContents(const UString& contents);

    UString GetContents() const;

    int GetRotation() const;

    void SetRotation(int angle);

    void RefreshAppearance();

    void RefreshAppearance(const RefreshOptions& options);

    UString GetCustomData(const UString& key) const;

    void SetCustomData(const UString& key, const UString& value);

    void DeleteCustomData(const UString& key);

    void Resize(const Rect& newrect);

    //for xamarin use only
    static Annot* CreateInternal(ptrdiff_t impl);
    ptrdiff_t GetHandleInternal();

    // @cond PRIVATE_DOC
    #ifndef SWIGHIDDEN
    Annot(TRN_Annot annot);
    TRN_Annot mp_annot;
    #endif
    // @endcond

}; //Class Annot

class BorderStyle
{
public:
    enum Style {
        e_solid,   
        e_dashed,  
        e_beveled, 
        e_inset,   
        e_underline  
    };

    BorderStyle(Style s, double b_width, double b_hr = 0, double b_vr = 0);
    BorderStyle(Style s, double b_width, double b_hr, double b_vr, const std::vector<double>& b_dash);
    BorderStyle(const BorderStyle&);
    ~BorderStyle();

    void Destroy();

    BorderStyle& operator=(const BorderStyle&);
    friend inline bool operator==(const BorderStyle& a, const BorderStyle& b);
    friend inline bool operator!=(const BorderStyle& a, const BorderStyle& b) { return !(a == b); }

    Style GetStyle() const;

    void SetStyle(Style style);

    double GetHR() const;

    void SetHR(double horizontal_radius);

    double GetVR() const;

    void SetVR(double vertical_radius);

    double GetWidth() const;

    void SetWidth(double width);

    std::vector<double> GetDash() const;

    void SetDash(const std::vector<double>& dash);

    BorderStyle(TRN_AnnotBorderStyle impl);
    BorderStyle() : mp_bs(0) {}
private:
    friend class PDF::Annot;
    TRN_AnnotBorderStyle mp_bs;
};
    } //namespace PDF
} //namespace pdftron

#include <Impl/Page.inl>

#endif // PDFTRON_H_CPPPDFAnnot