FreeText.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_CPPPDFAnnotsFreeText
#define PDFTRON_H_CPPPDFAnnotsFreeText

#include <PDF/Annots/Line.h>
#include <PDF/QuadPoint.h>

#ifdef SWIG
#define Line LineAnnot
#endif

namespace pdftron { 
        namespace PDF {
            namespace Annots {
class FreeText : public Markup
{
    public: 
        FreeText(SDF::Obj d = 0);

        FreeText(const Annot& ann) : Markup(ann.GetSDFObj()) {} 
        
        static FreeText Create(SDF::SDFDoc& doc, const Rect& pos);
        static FreeText CreateAnnot(SDF::SDFDoc& doc, const Rect& pos);

        UString GetDefaultAppearance() const;

        void SetDefaultAppearance(const char* app_str);

        int GetQuaddingFormat() const;

        void SetQuaddingFormat(const int format);

        Point GetCalloutLinePoint1() const;
        Point GetCalloutLinePoint2() const;
        Point GetCalloutLinePoint3() const;

#ifndef SWIG

        void GetCalloutLinePoints(Point& p1, Point& p2, Point& p3) const;
#endif
        
        void SetCalloutLinePoints(const Point& p1, const Point& p2, const Point& p3); 

        void SetCalloutLinePoints(const Point& p1, const Point& p2);


        enum IntentName
        {
            e_FreeText,             
            e_FreeTextCallout,      
            e_FreeTextTypeWriter,   
            e_Unknown               
        };

        IntentName GetIntentName() const;

        void SetIntentName(IntentName mode=e_FreeText);

        Line::EndingStyle GetEndingStyle() const;

        void SetEndingStyle( Line::EndingStyle style);

        void SetEndingStyle(const char* est);

        void SetTextColor( const ColorPt& color, int col_comp );
        
        ColorPt GetTextColor();

        int GetTextColorCompNum();

#ifndef SWIG

        void GetTextColor( ColorPt& color, int& col_comp );
#endif

        void SetLineColor( const ColorPt& color, int col_comp );

        ColorPt GetLineColor();
        int GetLineColorCompNum();

#ifndef SWIG

        void GetLineColor(  ColorPt& color, int& col_comp );
#endif

        void SetFontName(const char* fontName);

        void SetFontSize(double font_size);

        double GetFontSize();

    // @cond PRIVATE_DOC
    #ifndef SWIGHIDDEN
        FreeText(TRN_Annot freetext);
    #endif
    // @endcond

};//class FreeText

            } //namespace Annot
        } //namespace PDF
} //namespace pdftron

#ifdef SWIG
#undef Line
#endif

#include <Impl/Page.inl>

#endif // PDFTRON_H_CPPPDFAnnotsFreeText