Widget.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_CPPPDFAnnotsWidget
#define PDFTRON_H_CPPPDFAnnotsWidget
 
#include <PDF/PDFDoc.h>
#include <PDF/Annot.h>
#include <PDF/Font.h>
 
namespace pdftron { 
        namespace PDF {
            namespace Annots {
 

class Widget : public Annot
{
    public:

    Widget(SDF::Obj d = 0);   

    Widget(const Annot& ann) : Annot(ann.GetSDFObj()) {} 

    static Widget Create(SDF::SDFDoc& doc, const Rect& pos, Field field);

    Field GetField() const;

    enum HighlightingMode
    {
        e_none,     
        e_invert,   
        e_outline,  
        e_push,     
        e_toggle    
    };

    HighlightingMode GetHighlightingMode() const;

    void SetHighlightingMode(HighlightingMode mode=e_invert);

    Action GetAction() const;

    void SetAction(const Action& action);
    
    int GetBorderColorCompNum() const;

    ColorPt GetBorderColor() const;

    void SetBorderColor(const ColorPt& col, int compnum);

    int GetBackgroundColorCompNum() const;

    ColorPt GetBackgroundColor() const;

    void SetBackgroundColor(const ColorPt& c, int compnum);

    UString GetStaticCaptionText() const;

    void SetStaticCaptionText(const UString& contents);

    UString GetRolloverCaptionText() const;

    void SetRolloverCaptionText(const UString& contents);

    UString GetMouseDownCaptionText() const;

    void SetMouseDownCaptionText(const UString& contents);

    SDF::Obj GetStaticIcon() const;

    void SetStaticIcon(SDF::Obj icon);

    SDF::Obj GetRolloverIcon() const;

    void SetRolloverIcon(SDF::Obj icon);

    SDF::Obj GetMouseDownIcon() const;

    void SetMouseDownIcon(SDF::Obj icon);
 

    enum IconCaptionRelation
    {
        e_NoIcon,
        e_NoCaption,
        e_CBelowI,
        e_CAboveI,
        e_CRightILeft,
        e_CLeftIRight,
        e_COverlayI
    };
    
    IconCaptionRelation GetIconCaptionRelation() const;

 
    void SetIconCaptionRelation(IconCaptionRelation icr);

 

    enum ScaleCondition
    {
        e_Always, 
        e_WhenBigger,  
        e_WhenSmaller, 
        e_Never 
    };

    ScaleCondition GetScaleCondition() const;

    void SetScaleCondition(ScaleCondition sd);

    enum ScaleType
    {
        e_Anamorphic,
        e_Proportional
    };
    
    ScaleType GetScaleType() const;

    void SetScaleType(ScaleType st);
 
    
    double GetHIconLeftOver() const;

    void SetHIconLeftOver(double hl);

    double GetVIconLeftOver() const;

    void SetVIconLeftOver(double vl);

    bool GetFitFull() const;

    void SetFitFull(bool ff);

    ColorPt GetTextColor(); 

    int GetTextColorCompNum();

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

    double GetFontSize() const;

    void SetFontSize(double font_size);

    Font GetFont() const;

    void SetFont(const Font& font);
 
    // @cond PRIVATE_DOC
    #ifndef SWIGHIDDEN
    Widget(TRN_Annot widget);
    #endif
    // @endcond
 
}; //class Widget
            }; //namespace Annot
        }; //namespace PDF
}; //namespace pdftron
#include <Impl/Widget.inl>
 
#endif // PDFTRON_H_CPPPDFAnnotsWidget