FileAttachment.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_CPPPDFAnnotsFileAttachment
#define PDFTRON_H_CPPPDFAnnotsFileAttachment
 
#include <PDF/Annots/Markup.h>
 
namespace pdftron { 
        namespace PDF {
            namespace Annots {
class FileAttachment : public Markup
{
    public:  
    enum Icon
    {
        e_Graph,      
        e_PushPin,    
        e_Paperclip,  
        e_Tag,        
        e_Unknown     
    };

    FileAttachment(SDF::Obj d = 0);   

    FileAttachment(const Annot& ann) : Markup(ann.GetSDFObj()) {} 
    
    static FileAttachment Create(SDF::SDFDoc& doc, const Rect& pos, FileSpec fs, Icon icon_name = e_PushPin );
    static FileAttachment CreateAnnot(SDF::SDFDoc& doc, const Rect& pos, FileSpec fs, Icon icon_name = e_PushPin);

    static FileAttachment Create(SDF::SDFDoc& doc, const Rect& pos, const UString& path, Icon icon_name = e_PushPin );
    static FileAttachment CreateAnnot(SDF::SDFDoc& doc, const Rect& pos, const UString& path, Icon icon_name = e_PushPin);

    static FileAttachment Create(SDF::SDFDoc& doc, const Rect& pos, const UString& path, const char* icon_name );

    FileSpec GetFileSpec() const;

    void SetFileSpec(const FileSpec& file);

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

    Icon GetIcon() const;

    void SetIcon(Icon type=e_PushPin);

    const char* GetIconName() const; 

    void SetIconName(const char* iname);
 
    // @cond PRIVATE_DOC
    #ifndef SWIGHIDDEN
        FileAttachment(TRN_Annot fileattachment);
    #endif
    // @endcond
 
}; //class file attachment
            }; //namespace Annot
        }; //namespace PDF
}; //namespace pdftron
 
#include <Impl/Page.inl>
 
#endif // PDFTRON_H_CPPPDFAnnotsFileAttachment