Loading...
Searching...
No Matches
Screen.h
Go to the documentation of this file.
1//---------------------------------------------------------------------------------------
2// Copyright (c) 2001-2025 by Apryse Software Inc. All Rights Reserved.
3// Consult legal.txt regarding legal and license information.
4//---------------------------------------------------------------------------------------
5#ifndef PDFTRON_H_CPPPDFAnnotsScreen
6#define PDFTRON_H_CPPPDFAnnotsScreen
7
8#include <PDF/Annot.h>
9
10 namespace pdftron {
11 namespace PDF {
12 namespace Annots {
18 class Screen : public Annot
19{
20 public:
27 Screen(SDF::Obj d = 0);
28
35 Screen(const Annot& ann) : Annot(ann.GetSDFObj()) {}
36
45 static Screen Create(SDF::SDFDoc& doc, const Rect& pos);
46 static Screen CreateAnnot(SDF::SDFDoc& doc, const Rect& pos);
47
53 UString GetTitle() const;
54
61 void SetTitle(const UString& title);
62
69 Action GetAction() const;
70
79 void SetAction(const Action& action);
80
89 int GetBorderColorCompNum() const;
90
98 ColorPt GetBorderColor() const;
99
107 void SetBorderColor(const ColorPt& col, int numcomp);
108
117 int GetBackgroundColorCompNum() const;
118
126 ColorPt GetBackgroundColor() const;
127
135 void SetBackgroundColor(const ColorPt& col, int numcomp);
136
144 UString GetStaticCaptionText() const;
145
154 void SetStaticCaptionText(const UString& contents);
155
163 UString GetRolloverCaptionText() const;
164
173 void SetRolloverCaptionText(const UString& contents);
174
182 UString GetMouseDownCaptionText() const;
183
192 void SetMouseDownCaptionText(const UString& contents);
193
203 SDF::Obj GetStaticIcon() const;
204
215 void SetStaticIcon(SDF::Obj icon);
216
227 SDF::Obj GetRolloverIcon() const;
228
240 void SetRolloverIcon(SDF::Obj icon);
241
251 SDF::Obj GetMouseDownIcon() const;
252
263 void SetMouseDownIcon(SDF::Obj icon);
264
265
279 enum IconCaptionRelation
280 {
281 e_NoIcon,
282 e_NoCaption,
283 e_CBelowI,
284 e_CAboveI,
285 e_CRightILeft,
286 e_CLeftIRight,
287 e_COverlayI
288 };
289
297 IconCaptionRelation GetIconCaptionRelation() const;
298
307
308 void SetIconCaptionRelation(IconCaptionRelation icr);
309
316
317
322 enum ScaleCondition
323 {
324 e_Always,
325 e_WhenBigger,
326 e_WhenSmaller,
327 e_Never
328 };
329
337 ScaleCondition GetScaleCondition() const;
338
346 void SetScaleCondition(ScaleCondition sc);
347
363 enum ScaleType
364 {
365 e_Anamorphic,
366 e_Proportional
367 };
368
376 ScaleType GetScaleType() const;
377
386 void SetScaleType(ScaleType st);
387
388
401 double GetHIconLeftOver() const;
402
416 void SetHIconLeftOver(double hl);
417
433 double GetVIconLeftOver() const;
434
451 void SetVIconLeftOver(double vl);
452
463 bool GetFitFull() const;
464
475 void SetFitFull(bool ff);
476
477 // @cond PRIVATE_DOC
478 #ifndef SWIGHIDDEN
479 Screen(TRN_Annot screen);
480 #endif
481 // @endcond
482
483}; //class Screen
484 }; //namespace Annot
485 }; //namespace PDF
486}; //namespace pdftron
487#include <Impl/Screen.inl>
488
489#endif // PDFTRON_H_CPPPDFAnnotsScreen
Annot.h
pdftron::PDF::Action
Definition Action.h:32
pdftron::PDF::Annot::Annot
Annot(SDF::Obj d=0)
pdftron::PDF::Annot::GetSDFObj
SDF::Obj GetSDFObj() const
pdftron::PDF::Annots::Screen::SetRolloverCaptionText
void SetRolloverCaptionText(const UString &contents)
pdftron::PDF::Annots::Screen::SetStaticCaptionText
void SetStaticCaptionText(const UString &contents)
pdftron::PDF::Annots::Screen::GetBorderColor
ColorPt GetBorderColor() const
pdftron::PDF::Annots::Screen::SetScaleType
void SetScaleType(ScaleType st)
pdftron::PDF::Annots::Screen::SetIconCaptionRelation
void SetIconCaptionRelation(IconCaptionRelation icr)
pdftron::PDF::Annots::Screen::GetVIconLeftOver
double GetVIconLeftOver() const
pdftron::PDF::Annots::Screen::GetRolloverIcon
SDF::Obj GetRolloverIcon() const
pdftron::PDF::Annots::Screen::SetHIconLeftOver
void SetHIconLeftOver(double hl)
pdftron::PDF::Annots::Screen::Screen
Screen(const Annot &ann)
Definition Screen.h:35
pdftron::PDF::Annots::Screen::SetBackgroundColor
void SetBackgroundColor(const ColorPt &col, int numcomp)
pdftron::PDF::Annots::Screen::SetAction
void SetAction(const Action &action)
pdftron::PDF::Annots::Screen::SetMouseDownIcon
void SetMouseDownIcon(SDF::Obj icon)
pdftron::PDF::Annots::Screen::GetRolloverCaptionText
UString GetRolloverCaptionText() const
pdftron::PDF::Annots::Screen::SetBorderColor
void SetBorderColor(const ColorPt &col, int numcomp)
pdftron::PDF::Annots::Screen::Screen
Screen(SDF::Obj d=0)
pdftron::PDF::Annots::Screen::SetTitle
void SetTitle(const UString &title)
pdftron::PDF::Annots::Screen::GetStaticCaptionText
UString GetStaticCaptionText() const
pdftron::PDF::Annots::Screen::GetScaleType
ScaleType GetScaleType() const
pdftron::PDF::Annots::Screen::SetMouseDownCaptionText
void SetMouseDownCaptionText(const UString &contents)
pdftron::PDF::Annots::Screen::SetFitFull
void SetFitFull(bool ff)
pdftron::PDF::Annots::Screen::SetScaleCondition
void SetScaleCondition(ScaleCondition sc)
pdftron::PDF::Annots::Screen::SetStaticIcon
void SetStaticIcon(SDF::Obj icon)
pdftron::PDF::Annots::Screen::GetFitFull
bool GetFitFull() const
pdftron::PDF::Annots::Screen::GetStaticIcon
SDF::Obj GetStaticIcon() const
pdftron::PDF::Annots::Screen::GetBackgroundColor
ColorPt GetBackgroundColor() const
pdftron::PDF::Annots::Screen::ScaleType
ScaleType
Definition Screen.h:364
pdftron::PDF::Annots::Screen::e_Proportional
@ e_Proportional
Definition Screen.h:366
pdftron::PDF::Annots::Screen::e_Anamorphic
@ e_Anamorphic
Definition Screen.h:365
pdftron::PDF::Annots::Screen::GetMouseDownCaptionText
UString GetMouseDownCaptionText() const
pdftron::PDF::Annots::Screen::GetAction
Action GetAction() const
pdftron::PDF::Annots::Screen::ScaleCondition
ScaleCondition
Definition Screen.h:323
pdftron::PDF::Annots::Screen::e_Never
@ e_Never
Never scale.
Definition Screen.h:327
pdftron::PDF::Annots::Screen::e_WhenSmaller
@ e_WhenSmaller
Scale only when the icon is smaller than the annotation rectangle.
Definition Screen.h:326
pdftron::PDF::Annots::Screen::e_Always
@ e_Always
Always scale.
Definition Screen.h:324
pdftron::PDF::Annots::Screen::e_WhenBigger
@ e_WhenBigger
Scale only when the icon is bigger than the annotation rectangle.
Definition Screen.h:325
pdftron::PDF::Annots::Screen::CreateAnnot
static Screen CreateAnnot(SDF::SDFDoc &doc, const Rect &pos)
pdftron::PDF::Annots::Screen::SetVIconLeftOver
void SetVIconLeftOver(double vl)
pdftron::PDF::Annots::Screen::GetScaleCondition
ScaleCondition GetScaleCondition() const
pdftron::PDF::Annots::Screen::GetBackgroundColorCompNum
int GetBackgroundColorCompNum() const
pdftron::PDF::Annots::Screen::GetMouseDownIcon
SDF::Obj GetMouseDownIcon() const
pdftron::PDF::Annots::Screen::GetIconCaptionRelation
IconCaptionRelation GetIconCaptionRelation() const
pdftron::PDF::Annots::Screen::GetHIconLeftOver
double GetHIconLeftOver() const
pdftron::PDF::Annots::Screen::GetBorderColorCompNum
int GetBorderColorCompNum() const
pdftron::PDF::Annots::Screen::Create
static Screen Create(SDF::SDFDoc &doc, const Rect &pos)
pdftron::PDF::Annots::Screen::SetRolloverIcon
void SetRolloverIcon(SDF::Obj icon)
pdftron::PDF::Annots::Screen::GetTitle
UString GetTitle() const
pdftron::PDF::Annots::Screen::IconCaptionRelation
IconCaptionRelation
Definition Screen.h:280
pdftron::PDF::Annots::Screen::e_NoCaption
@ e_NoCaption
Definition Screen.h:282
pdftron::PDF::Annots::Screen::e_NoIcon
@ e_NoIcon
Definition Screen.h:281
pdftron::PDF::Annots::Screen::e_COverlayI
@ e_COverlayI
Definition Screen.h:287
pdftron::PDF::Annots::Screen::e_CAboveI
@ e_CAboveI
Definition Screen.h:284
pdftron::PDF::Annots::Screen::e_CRightILeft
@ e_CRightILeft
Definition Screen.h:285
pdftron::PDF::Annots::Screen::e_CBelowI
@ e_CBelowI
Definition Screen.h:283
pdftron::PDF::Annots::Screen::e_CLeftIRight
@ e_CLeftIRight
Definition Screen.h:286
pdftron::PDF::ColorPt
Definition ColorSpace.h:21
pdftron::PDF::Rect
Definition Rect.h:29
pdftron::SDF::Obj
Definition Obj.h:41
pdftron::SDF::SDFDoc
Definition SDFDoc.h:68
pdftron::UString
Definition UString.h:28
pdftron::PDF::Annots
Definition Caret.h:12
pdftron::PDF
Definition Action.h:15
pdftron
Definition BasicTypes.h:10