PtlAnnot.h

// PtlAnnot.h
// Copyright (C) 2013-2025 Antenna House,Inc.
// All rights reserved.
#ifndef PDFTK_PTLANNOT_H_
#define PDFTK_PTLANNOT_H_
 
#include "PtlRect.h"
#include "PtlDate.h"
#include "PtlParamString.h"
 
namespace PdfTk {
 
class PtlColor;
class PtlColorDeviceRGB;

 
class PDFTK_API PtlAnnot
{
public:
    enum ANNOT_TYPE {
        TYPE_TEXT              = 1,    
        TYPE_LINK              = 2,    
        TYPE_FREE_TEXT            = 3,    
        TYPE_LINE              = 4,    
        TYPE_SQUARE              = 5,    
        TYPE_CIRCLE              = 6,    
        TYPE_POLYGON            = 7,    
        TYPE_POLYLINE          = 8,    
        TYPE_HIGHLIGHT            = 9,    
        TYPE_UNDERLINE            = 10,   
        TYPE_SQUIGGLY          = 11,   
        TYPE_STRIKEOUT            = 12,   
        TYPE_STAMP                = 13,   
        TYPE_CARET                = 14,   
        TYPE_INK                = 15,   
        TYPE_POPUP                = 16,   
        TYPE_FILE_ATTACHMENT    = 17,   
        TYPE_SOUND                = 18,   
        TYPE_MOVIE                = 19,   
        TYPE_WIDGET              = 20,   
        TYPE_SCREEN              = 21,   
        TYPE_PRINTER_MARK      = 22,   
        TYPE_TRAP_NETWORK      = 23,   
        TYPE_WATERMARK            = 24,   
        TYPE_3D                  = 25,   
        TYPE_REDACT              = 26,   
        TYPE_PROJECTION          = 27,   
        TYPE_RICHMEDIA            = 28,   
        TYPE_UNKNOWN            = 100   
    };

    enum ANNOT_FLAGS {
        FLAG_INVISIBLE            = 0x00000001,   
        FLAG_HIDDEN              = 0x00000002,   
        FLAG_PRINT                = 0x00000004,   
        FLAG_NOZOOM              = 0x00000008,   
        FLAG_NOROTATE          = 0x00000010,   
        FLAG_NOVIEW              = 0x00000020,   
        FLAG_READONLY          = 0x00000040,   
        FLAG_LOCKED              = 0x00000080,   
        FLAG_TOGGLE_NOVIEW        = 0x00000100,   
        FLAG_LOCKED_CONTENTS    = 0x00000200    
    };

    enum BORDER_STYLE {
        BORDER_SOLID        = 1,    
        BORDER_DASHED      = 2,    
        BORDER_BEVELED        = 3,    
        BORDER_INSET        = 4,    
        BORDER_UNDERLINE    = 5     
    };

    enum BORDER_LINE_WIDTH {
        BORDER_WIDTH_NONE      = 0,    
        BORDER_WIDTH_THIN      = 1,    
        BORDER_WIDTH_MIDDLE      = 2,    
        BORDER_WIDTH_THICK        = 3     
    };
 
private:
    int m_dataAnnot;
public:
    int getHandle() const;
 
public:
    PtlAnnot(ANNOT_TYPE type);

    PtlAnnot(const PtlAnnot& obj);

    virtual ~PtlAnnot();
 
public:
    PtlAnnot& operator=(const PtlAnnot& obj);
 
public:
    ANNOT_TYPE getType() const;
 
public:
    bool isMarkup() const;
 
public:
    PtlRect getRect();

    void setRect(const PtlRect& rectMM);
 
public:
    const PtlParamString& getTextContents();

    void setTextContents(const PtlParamString& contents);
 
public:
    PtlDate getDate();

    void setDate(const PtlDate& date);
 
public:
    int getAnnotFlags();

    void setAnnotFlags(int flag);
 
public:
    const PtlColor& getColor();

    void setColor(const PtlColorDeviceRGB& color);

    const PtlColor& getInteriorColor();

    void setInteriorColor(const PtlColor& color);
 
public:
    BORDER_STYLE getBorderStyle();

    void setBorderStyle(BORDER_STYLE style);
 
public:
    BORDER_LINE_WIDTH getBorderWidth();

    void setBorderWidth(BORDER_LINE_WIDTH width);

    float getBorderWidthNative();

    void setBorderWidthNative(float width);
 
public:
    const PtlParamString& getAnnotationName();
};
 
} // namespace PdfTk
 
#endif // PDFTK_PTLANNOT_H_