Screen.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_CPPPDFAnnotsScreen
#define PDFTRON_H_CPPPDFAnnotsScreen
 
#include <PDF/Annot.h>
 
namespace pdftron { 
        namespace PDF {
            namespace Annots {
class Screen : public Annot
{
    public:
    Screen(SDF::Obj d = 0);

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

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

    UString GetTitle() const;

    void SetTitle(const UString& title);

    Action GetAction() const;

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

    ColorPt GetBorderColor() const;

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

    int GetBackgroundColorCompNum() const;

    ColorPt GetBackgroundColor() const;

    void SetBackgroundColor(const ColorPt& col, int numcomp);

    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 sc);

    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);
 
    // @cond PRIVATE_DOC
    #ifndef SWIGHIDDEN
        Screen(TRN_Annot screen);
    #endif
    // @endcond
 
}; //class Screen
            }; //namespace Annot
        }; //namespace PDF
}; //namespace pdftron
#include <Impl/Screen.inl>
 
#endif // PDFTRON_H_CPPPDFAnnotsScreen