![]() |
#include <Screen.h>
Public Types | |
enum | IconCaptionRelation { e_NoIcon, e_NoCaption, e_CBelowI, e_CAboveI, e_CRightILeft, e_CLeftIRight, e_COverlayI } |
An enumeration indicating where to position the text of the annotation’s caption relative to its icon. More... | |
enum | ScaleCondition { e_Always, e_WhenBigger, e_WhenSmaller, e_Never } |
This enum represents the circumstances under which the icon shall be scaled inside the annotation rectangle. More... | |
enum | ScaleType { e_Anamorphic, e_Proportional } |
This enum represents the scale type of the annotation. More... | |
Public Member Functions | |
Screen (SDF::Obj d=0) | |
Creates a Screen annotation and initializes it using given Cos/SDF object. | |
Screen (const Annot &ann) | |
Creates a Screen annotation and initializes it using given annotation object. | |
UString | GetTitle () const |
Returns the title of the annotation. | |
void | SetTitle (const UString &title) |
Sets the title of the Annotation. | |
Action | GetAction () const |
Returns the action of the Screen annotation. | |
void | SetAction (const Action &action) |
Sets the action of the Screen annotation (Optional; PDF 1.1 ). | |
SDF::Obj | GetTriggerAction () const |
Returns the additional actions of the annotation. | |
void | SetTriggerAction (SDF::Obj action) |
Assigns additional actions to the annotation (Optional; PDF 1.1 ). | |
int | GetRotation () const |
Returns the rotation value of the annotation. | |
void | SetRotation (int rot) |
Sets the rotation value of the annotation. | |
int | GetBorderColorCompNum () const |
Returns the number indicating border color space of the annotation. | |
ColorPt | GetBorderColor () const |
Returns the border color of the annotation. | |
void | SetBorderColor (const ColorPt &c, int CompNum) |
Sets the border color of the annotation. | |
int | GetBackgroundColorCompNum () const |
Returns the number indicating background color space of the annotation. | |
ColorPt | GetBackgroundColor () const |
Returns the background color of the annotation. | |
void | SetBackgroundColor (const ColorPt &c, int CompNum) |
Sets the background color of the annotation. | |
UString | GetStaticCaptionText () const |
Returns static caption text of the annotation. | |
void | SetStaticCaptionText (const UString &ct) |
Sets static caption text of the annotation. | |
UString | GetRolloverCaptionText () const |
Returns the rollover caption text of the annotation. | |
void | SetRolloverCaptionText (const UString &ct) |
Sets the roll over caption text of the annotation. | |
UString | GetMouseDownCaptionText () const |
Returns the button down caption text of the annotation. | |
void | SetMouseDownCaptionText (const UString &ct) |
Sets the button down caption text of the annotation. | |
SDF::Obj | GetStaticIcon () const |
Returns the static icon associated with the annotation. | |
void | SetStaticIcon (SDF::Obj ic) |
Sets the static icon associated with the annotation. | |
SDF::Obj | GetRolloverIcon () const |
Returns the rollover icon associated with the annotation. | |
void | SetRolloverIcon (SDF::Obj ic) |
Sets the rollover icon associated with the annotation. | |
SDF::Obj | GetMouseDownIcon () const |
Returns the Mouse Down icon associated with the annotation. | |
void | SetMouseDownIcon (SDF::Obj ic) |
Sets the Mouse Down icon associated with the annotation. | |
IconCaptionRelation | GetIconCaptionRelation () const |
Returns the Icon and caption relationship of the annotation. | |
void | SetIconCaptionRelation (IconCaptionRelation icr) |
Sets the Icon and caption relationship of the annotation. | |
ScaleCondition | GetScaleCondition () const |
Returns the condition under which the icon should be scaled. | |
void | SetScaleCondition (ScaleCondition sd) |
Sets the condition under which the icon should be scaled. | |
ScaleType | GetScaleType () const |
Returns the Scale Type of the annotation. | |
void | SetScaleType (ScaleType st) |
Sets the Scale Type of the annotation. | |
double | GetHIconLeftOver () const |
Returns the horizontal leftover space of the icon within the annotation. | |
void | SetHIconLeftOver (double hl) |
Sets the horizontal leftover space of the icon within the annotation. | |
double | GetVIconLeftOver () const |
Returns the vertical leftover space of the icon within the annotation. | |
void | SetVIconLeftOver (double vl) |
Sets the vertical leftover space of the icon within the annotation. | |
bool | GetFitFull () const |
Returns the "fit full" flag. | |
void | SetFitFull (bool ff) |
Sets the "fit full" flag. | |
Static Public Member Functions | |
static Screen | Create (SDF::SDFDoc &doc, const Rect &pos) |
Creates a new Screen annotation in the specified document. |
It also serves as an object from which actions can be triggered.
An enumeration indicating where to position the text of the annotation’s caption relative to its icon.
e_NoIcon - No icon; caption only e_NoCaption - No caption; icon only e_CBelowI - Caption below the icon e_CAboveI - Caption above the icon e_CRightILeft - Caption to the right of the icon e_CLeftIRight - Caption to the left of the icon e_COverlayI - Caption overlaid directly on the icon Default value: e_NoIcon.
This enum represents the circumstances under which the icon shall be scaled inside the annotation rectangle.
This enum represents the scale type of the annotation.
e_Anamorphic - Scale the icon to fill the annotation rectangle exactly, without regard to its original aspect ratio (ratio of width to height). e_Proportional - Scale the icon to fit the width or height of the annotation rectangle while maintaining the icon’s original aspect ratio. If the required horizontal and vertical scaling factors are different, use the smaller of the two, centering the icon within the annotation rectangle in the other dimension. Default value: e_Proportional.
pdftron::PDF::Annots::Screen::Screen | ( | SDF::Obj | d = 0 |
) |
Creates a Screen annotation and initializes it using given Cos/SDF object.
pdftron::PDF::Annots::Screen::Screen | ( | const Annot & | ann | ) | [inline] |
Creates a Screen annotation and initializes it using given annotation object.
static Screen pdftron::PDF::Annots::Screen::Create | ( | SDF::SDFDoc & | doc, | |
const Rect & | pos | |||
) | [static] |
UString pdftron::PDF::Annots::Screen::GetTitle | ( | ) | const |
Returns the title of the annotation.
void pdftron::PDF::Annots::Screen::SetTitle | ( | const UString & | title | ) |
Sets the title of the Annotation.
(Optional)
title | A string representing the title of the annotation. |
Action pdftron::PDF::Annots::Screen::GetAction | ( | ) | const |
Returns the action of the Screen annotation.
void pdftron::PDF::Annots::Screen::SetAction | ( | const Action & | action | ) |
Sets the action of the Screen annotation (Optional; PDF 1.1 ).
action | An action object representing the action of the annotation. |
SDF::Obj pdftron::PDF::Annots::Screen::GetTriggerAction | ( | ) | const |
Returns the additional actions of the annotation.
void pdftron::PDF::Annots::Screen::SetTriggerAction | ( | SDF::Obj | action | ) |
Assigns additional actions to the annotation (Optional; PDF 1.1 ).
action | An SDF dictionary object representing the actions of the annotation. |
int pdftron::PDF::Annots::Screen::GetRotation | ( | ) | const |
Returns the rotation value of the annotation.
void pdftron::PDF::Annots::Screen::SetRotation | ( | int | rot | ) |
Sets the rotation value of the annotation.
(Optional)
rot | An integer representing the rotation value of the annotation. |
int pdftron::PDF::Annots::Screen::GetBorderColorCompNum | ( | ) | const |
Returns the number indicating border color space of the annotation.
ColorPt pdftron::PDF::Annots::Screen::GetBorderColor | ( | ) | const |
Returns the border color of the annotation.
void pdftron::PDF::Annots::Screen::SetBorderColor | ( | const ColorPt & | c, | |
int | CompNum | |||
) |
Sets the border color of the annotation.
(Optional)
c | A color object that denotes the color of the screen border. | |
CompNum | An integer which value indicates the color space used for the parameter c. |
int pdftron::PDF::Annots::Screen::GetBackgroundColorCompNum | ( | ) | const |
Returns the number indicating background color space of the annotation.
ColorPt pdftron::PDF::Annots::Screen::GetBackgroundColor | ( | ) | const |
Returns the background color of the annotation.
void pdftron::PDF::Annots::Screen::SetBackgroundColor | ( | const ColorPt & | c, | |
int | CompNum | |||
) |
Sets the background color of the annotation.
(Optional)
c | A color point that denotes the color of the screen background. | |
CompNum | An integer which value indicates the color space used for the parameter c. |
UString pdftron::PDF::Annots::Screen::GetStaticCaptionText | ( | ) | const |
Returns static caption text of the annotation.
void pdftron::PDF::Annots::Screen::SetStaticCaptionText | ( | const UString & | ct | ) |
Sets static caption text of the annotation.
(Optional; button fields only)
ct | A string containing the static caption text of the annotation. |
UString pdftron::PDF::Annots::Screen::GetRolloverCaptionText | ( | ) | const |
Returns the rollover caption text of the annotation.
void pdftron::PDF::Annots::Screen::SetRolloverCaptionText | ( | const UString & | ct | ) |
Sets the roll over caption text of the annotation.
(Optional; button fields only)
ct | A string containing the roll over caption text of the annotation. |
UString pdftron::PDF::Annots::Screen::GetMouseDownCaptionText | ( | ) | const |
Returns the button down caption text of the annotation.
void pdftron::PDF::Annots::Screen::SetMouseDownCaptionText | ( | const UString & | ct | ) |
Sets the button down caption text of the annotation.
(Optional; button fields only)
ct | A string containing the button down text of the annotation. |
SDF::Obj pdftron::PDF::Annots::Screen::GetStaticIcon | ( | ) | const |
Returns the static icon associated with the annotation.
void pdftron::PDF::Annots::Screen::SetStaticIcon | ( | SDF::Obj | ic | ) |
Sets the static icon associated with the annotation.
(Optional; button fields only)
ic | An SDF object that represents the static icon associated with the annotation. |
SDF::Obj pdftron::PDF::Annots::Screen::GetRolloverIcon | ( | ) | const |
Returns the rollover icon associated with the annotation.
void pdftron::PDF::Annots::Screen::SetRolloverIcon | ( | SDF::Obj | ic | ) |
Sets the rollover icon associated with the annotation.
(Optional; button fields only)
ic | An SDF object that represents the rollover icon associated with the annotation. |
SDF::Obj pdftron::PDF::Annots::Screen::GetMouseDownIcon | ( | ) | const |
Returns the Mouse Down icon associated with the annotation.
void pdftron::PDF::Annots::Screen::SetMouseDownIcon | ( | SDF::Obj | ic | ) |
Sets the Mouse Down icon associated with the annotation.
(Optional; button fields only)
ic | An SDF object that represents the Mouse Down icon associated with the annotation. |
IconCaptionRelation pdftron::PDF::Annots::Screen::GetIconCaptionRelation | ( | ) | const |
Returns the Icon and caption relationship of the annotation.
void pdftron::PDF::Annots::Screen::SetIconCaptionRelation | ( | IconCaptionRelation | icr | ) |
Sets the Icon and caption relationship of the annotation.
(Optional; pushbutton fields only)
icr | A value of the "IconCaptionRelation" enum type. Default value: e_NoIcon. |
ScaleCondition pdftron::PDF::Annots::Screen::GetScaleCondition | ( | ) | const |
Returns the condition under which the icon should be scaled.
void pdftron::PDF::Annots::Screen::SetScaleCondition | ( | ScaleCondition | sd | ) |
Sets the condition under which the icon should be scaled.
(Optional)
sd | A value of the "ScaleCondition" enum type. Default value: e_Always. |
ScaleType pdftron::PDF::Annots::Screen::GetScaleType | ( | ) | const |
Returns the Scale Type of the annotation.
void pdftron::PDF::Annots::Screen::SetScaleType | ( | ScaleType | st | ) |
Sets the Scale Type of the annotation.
(Optional)
st | An entry of the "ScaleType" enum which represents the Scale Type of the annotation. Default value: P. |
double pdftron::PDF::Annots::Screen::GetHIconLeftOver | ( | ) | const |
Returns the horizontal leftover space of the icon within the annotation.
void pdftron::PDF::Annots::Screen::SetHIconLeftOver | ( | double | hl | ) |
Sets the horizontal leftover space of the icon within the annotation.
(Optional)
hl | A number indicating the horizontal leftover space of the icon within the annotation. |
double pdftron::PDF::Annots::Screen::GetVIconLeftOver | ( | ) | const |
Returns the vertical leftover space of the icon within the annotation.
void pdftron::PDF::Annots::Screen::SetVIconLeftOver | ( | double | vl | ) |
Sets the vertical leftover space of the icon within the annotation.
(Optional)
vl | A number indicating the vertical leftover space of the icon within the annotation. |
bool pdftron::PDF::Annots::Screen::GetFitFull | ( | ) | const |
Returns the "fit full" flag.
void pdftron::PDF::Annots::Screen::SetFitFull | ( | bool | ff | ) |
Sets the "fit full" flag.
(Optional)
ff | A boolean value indicating the "fit full" flag value. |