Line.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2024 by Apryse Software Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.
//---------------------------------------------------------------------------------------
#ifndef PDFTRON_H_CPPPDFAnnotsLine
#define PDFTRON_H_CPPPDFAnnotsLine

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

#ifdef SWIG
#define Line LineAnnot
#endif

namespace pdftron { 
        namespace PDF {
            namespace Annots {
class Line : public Markup
{
public:
    Line(SDF::Obj d=0);
    
    Line(const Annot& ann) : Markup(ann.GetSDFObj()) {} 


    static Line Create(SDF::SDFDoc& doc, const Rect& pos);                  
    static Line CreateAnnot(SDF::SDFDoc& doc, const Rect& pos);

    Point GetStartPoint() const;

    void SetStartPoint(const Point& sp);

    Point GetEndPoint () const;

    void SetEndPoint(const Point& ep);              

    enum EndingStyle
    {
        e_Square,   
        e_Circle,   
        e_Diamond,  
        e_OpenArrow,    
        e_ClosedArrow,  
        e_Butt, 
        e_ROpenArrow,  
        e_RClosedArrow, 
        e_Slash,    
        e_None, 
        e_Unknown   
    };

    EndingStyle GetStartStyle() const;


    void SetStartStyle(EndingStyle sst);

    
    EndingStyle GetEndStyle() const;


    void SetEndStyle(EndingStyle est);



    double GetLeaderLineLength() const;

    void SetLeaderLineLength(const double& length);
    
    double GetLeaderLineExtensionLength() const;

    void SetLeaderLineExtensionLength(const double& length);

    bool GetShowCaption() const;
    
    void SetShowCaption(bool showCaption); 

    enum IntentType
    {
        e_LineArrow,  
        e_LineDimension, 
        e_null
    };
    
    IntentType GetIntentType() const;

    void SetIntentType(IntentType it);

    double GetLeaderLineOffset() const;

    void SetLeaderLineOffset(double length);
    
    enum CapPos
    {
        e_Inline, 
        e_Top 
    };

    CapPos GetCaptionPosition() const;

    void SetCaptionPosition(const CapPos& style);

    double GetTextHOffset() const;

    void SetTextHOffset(double offset);

    double GetTextVOffset() const;

    void SetTextVOffset(double offset);

// @cond PRIVATE_DOC
#ifndef SWIGHIDDEN
    Line(TRN_Annot line);
#endif
// @endcond

};//class Line
            };//namespace Annot
        };//namespace PDF
};//namespace pdftron

#ifdef SWIG
#undef Line
#endif

#include <Impl/Page.inl>

#endif // PDFTRON_H_CPPPDFAnnotsLine