All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Screen.h
Go to the documentation of this file.
1 //---------------------------------------------------------------------------------------
2 // Copyright (c) 2001-2020 by PDFTron Systems 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 
52  UString GetTitle() const;
53 
60  void SetTitle(const UString& title);
61 
68  Action GetAction() const;
69 
78  void SetAction(const Action& action);
79 
88  int GetBorderColorCompNum() const;
89 
97  ColorPt GetBorderColor() const;
98 
106  void SetBorderColor(const ColorPt& col, int numcomp);
107 
116  int GetBackgroundColorCompNum() const;
117 
125  ColorPt GetBackgroundColor() const;
126 
134  void SetBackgroundColor(const ColorPt& col, int numcomp);
135 
144 
153  void SetStaticCaptionText(const UString& contents);
154 
163 
172  void SetRolloverCaptionText(const UString& contents);
173 
182 
191  void SetMouseDownCaptionText(const UString& contents);
192 
202  SDF::Obj GetStaticIcon() const;
203 
214  void SetStaticIcon(SDF::Obj icon);
215 
226  SDF::Obj GetRolloverIcon() const;
227 
239  void SetRolloverIcon(SDF::Obj icon);
240 
250  SDF::Obj GetMouseDownIcon() const;
251 
262  void SetMouseDownIcon(SDF::Obj icon);
263 
264 
279  {
287  };
288 
297 
308 
322  {
327  };
328 
337 
346 
363  {
366  };
367 
375  ScaleType GetScaleType() const;
376 
385  void SetScaleType(ScaleType st);
386 
387 
400  double GetHIconLeftOver() const;
401 
415  void SetHIconLeftOver(double hl);
416 
432  double GetVIconLeftOver() const;
433 
450  void SetVIconLeftOver(double vl);
451 
462  bool GetFitFull() const;
463 
474  void SetFitFull(bool ff);
475 
476  // @cond PRIVATE_DOC
477  #ifndef SWIGHIDDEN
478  Screen(TRN_Annot screen);
479  #endif
480  // @endcond
481 
482 }; //class Screen
483  }; //namespace Annot
484  }; //namespace PDF
485 }; //namespace pdftron
486 #include <Impl/Screen.inl>
487 
488 #endif // PDFTRON_H_CPPPDFAnnotsScreen
void SetHIconLeftOver(double hl)
SDF::Obj GetSDFObj() const
SDF::Obj GetStaticIcon() const
void SetTitle(const UString &title)
void SetMouseDownCaptionText(const UString &contents)
ScaleCondition GetScaleCondition() const
Scale only when the icon is smaller than the annotation rectangle.
Definition: Screen.h:325
void SetStaticCaptionText(const UString &contents)
void SetIconCaptionRelation(IconCaptionRelation icr)
void SetRolloverIcon(SDF::Obj icon)
ScaleType GetScaleType() const
void SetScaleCondition(ScaleCondition sc)
void SetMouseDownIcon(SDF::Obj icon)
UString GetMouseDownCaptionText() const
int GetBackgroundColorCompNum() const
Screen(const Annot &ann)
Definition: Screen.h:35
void SetScaleType(ScaleType st)
SDF::Obj GetMouseDownIcon() const
void SetStaticIcon(SDF::Obj icon)
static Screen Create(SDF::SDFDoc &doc, const Rect &pos)
SDF::Obj GetRolloverIcon() const
void SetAction(const Action &action)
void SetBorderColor(const ColorPt &col, int numcomp)
ColorPt GetBackgroundColor() const
void SetRolloverCaptionText(const UString &contents)
double GetVIconLeftOver() const
ColorPt GetBorderColor() const
Scale only when the icon is bigger than the annotation rectangle.
Definition: Screen.h:324
void SetBackgroundColor(const ColorPt &col, int numcomp)
UString GetStaticCaptionText() const
void SetVIconLeftOver(double vl)
int GetBorderColorCompNum() const
IconCaptionRelation GetIconCaptionRelation() const
double GetHIconLeftOver() const
UString GetRolloverCaptionText() const