Annot.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2008 by PDFTron Systems Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.
//---------------------------------------------------------------------------------------

#ifndef   H_CPPPDFAnnot
#define   H_CPPPDFAnnot

#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 <C/PDF/TRN_Annot.h>
#include <vector>

namespace pdftron { 
        namespace PDF {

class Annot
{
public:

        // Common Methods ---------------------------------------------------------------
        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_Unknown         
        };

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

         static Annot CreateLink(SDF::SDFDoc& doc, const Rect& pos, const class Action& action);

         static Annot CreateText(SDF::SDFDoc& doc, const Rect& pos, const UString& contents);

         static Annot CreateStamp(SDF::SDFDoc& doc, const Rect& pos, const char* name = "Draft");

         static Annot CreateWidget(SDF::SDFDoc& doc, const Rect& pos, class Field field);

         static Annot CreateFileAttachment(SDF::SDFDoc& doc, const Rect& pos, const char* path, const char* icon_name = "PushPin");

         Annot (SDF::Obj d = 0);

         Annot (const Annot& d);

         Annot& operator=(const Annot& d);

         bool operator==(const Annot& d);

         bool IsValid() const;

         Type GetType() const;

         SDF::Obj GetSDFObj () const;

         Rect GetRect() const;

         void SetRect(const Rect& pos);

        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
        };

         bool GetFlag(Flag flag) const;

         void SetFlag(Flag flag, bool value);

         Date GetDate() const;

         void SetDate(const Date& date);

         SDF::Obj GetUniqueID() const;

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

         ColorPt GetColor() const;

         void SetColor(const ColorPt& rgb);

        class BorderStyle
        {
        public: 

                // The border style:
                enum Style {
                        e_solid,   
                        e_dashed,  
                        e_beveled, 
                        e_inset,   
                        e_underline  
                };

                 BorderStyle(Style s, int b_width, int b_hr, int b_vr);
                 BorderStyle(Style s, int b_width, int b_hr, int b_vr, const std::vector<double>& b_dash);
                 BorderStyle(const BorderStyle&);
                 ~BorderStyle();
                
                 Style GetStyle(); // the border style.
                 void SetStyle(Style style);
                
                 int GetHR();   // horizontal corner radius.
                 void SetHR(int hr);

                 int GetVR();   // vertical corner radius.
                 void SetVR(int vr);    
                
                 int GetWidth();                // the border width.
                 void SetWidth(int width);

                 std::vector<double> GetDash(); // the border dash pattern.
                 void SetDash(std::vector<double> dash);  

                 BorderStyle(TRN_AnnotBorderStyle impl);
        private: 
                friend class PDF::Annot;
                BorderStyle& operator=(const BorderStyle&);
                TRN_AnnotBorderStyle mp_bs;
        };

         BorderStyle GetBorderStyle() const;

         void SetBorderStyle(const BorderStyle& bs);

        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);


        // Methods specific to Link Annotations --------------------------------------------

         class Action GetLinkAction() const;

         void SetLinkAction(const class Action& action);

         void RemoveLinkAction();


        // Methods specific to Text Annotations --------------------------------------------

         void SetTextContents(const UString& contents);

         SDF::Obj GetTextContents() const;

         const char* GetTextIcon() const;
        
        void SetTextIcon(const char* icon_name);

        bool IsTextAnnotOpen() const;

        void SetTextAnnotOpen(bool is_open);


        // Methods specific to Stamp Annotations -------------------------------------------

        const char* GetStampName() const;
        
        void SetStampName(const char* name);


        // Methods specific to Field Annotations -------------------------------------------

        class Field GetWidgetField() const;


        // Methods specific to File Attachment Annotations ---------------------------------

        FileSpec GetFileAttachment() const;

        void SetFileAttachment(const FileSpec& file);

        bool FileAttachmentExport(const UString& save_as = "") const;

        Annot(TRN_Annot annot);
        TRN_Annot mp_annot;
};

        };      // namespace PDF
};      // namespace pdftron



#include <Impl/Page.inl>
#endif

---

© 2002-2008 PDFTron Systems Inc.