Annotation Enumerations

  • PDF supports the standard annotation types listed in the following enumeration (plug-in extensions may add new annotation types):

    See more

    Declaration

    Objective-C

    enum PTAnnotType {}

    Swift

    struct PTAnnotType : Equatable, RawRepresentable
  • Border Effect Style

    See more

    Declaration

    Objective-C

    enum PTBorderEffect {}

    Swift

    struct PTBorderEffect : Equatable, RawRepresentable
  • Enumeration type describing the annotation’s caption positioning. Valid values are e_ptInline, meaning the caption shall be centered inside the line, and e_ptTop, meaning the caption shall be on top of the line.

    See more

    Declaration

    Objective-C

    enum PTCapPos {}

    Swift

    struct PTCapPos : Equatable, RawRepresentable
  • For each line, one can choose a separate style for the start and the end of the line. The styles are defined by the “PTEndingStyle” enumeration.

    See more

    Declaration

    Objective-C

    enum PTEndingStyle {}

    Swift

    struct PTEndingStyle : Equatable, RawRepresentable
  • PTFileIcon style

    See more

    Declaration

    Objective-C

    enum PTFileIcon {}

    Swift

    struct PTFileIcon : Equatable, RawRepresentable
  • This enum defines the intention of the FreeText annotation

    See more

    Declaration

    Objective-C

    enum PTIntentName {}

    Swift

    struct PTIntentName : Equatable, RawRepresentable
  • This enum represents the intent of the LineAnnot annotation. For each line, one can specify the purpose of the line by choosing its intent defined by the “PTLineIntentType” enum.

    See more

    Declaration

    Objective-C

    enum PTLineIntentType {}

    Swift

    struct PTLineIntentType : Equatable, RawRepresentable
  • This enum specifies the highlighting mode of the Link Annotation. The annotation’s highlighting mode is the visual effect that shall be used when the mouse button is pressed or held down inside its active area, possible values as follows:

    e_ptl_none - No highlighting. e_ptinvert - Invert the contents of the annotation rectangle. e_pthighlight_outline - Invert the annotation’s border. e_ptpush - Display the annotation as if it were being pushed below the surface of the page.

    See more

    Declaration

    Objective-C

    enum PTLinkHighlightingMode {}

    Swift

    struct PTLinkHighlightingMode : Equatable, RawRepresentable
  • This enum specifies the intention of the PolyLine annotation, it used for the purposes of generating the appearance of the annotation.

    See more

    Declaration

    Objective-C

    enum PTPolyLineIntentType {}

    Swift

    struct PTPolyLineIntentType : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTQuadForm {  e_ptLeftJustified,
    e_ptCentered,
    e_ptRightJustified,
    e_ptr_None}

    Swift

    struct PTQuadForm : Equatable, RawRepresentable
  • This enum represents the PTRubberStampIcon type of the RubberStamp annotation

    See more

    Declaration

    Objective-C

    enum PTRubberStampIcon {}

    Swift

    struct PTRubberStampIcon : Equatable, RawRepresentable
  • An enumeration indicating where to position the text of the annotation’s caption relative to its icon.

    e_ptNoIcon - No icon; caption only e_ptNoCaption - No caption; icon only e_ptCBelowI - Caption below the icon e_ptCAboveI - Caption above the icon e_ptCRightILeft - Caption to the right of the icon e_ptCLeftIRight - Caption to the left of the icon e_ptCOverlayI - Caption overlaid directly on the icon Default value: e_ptNoIcon.

    See more

    Declaration

    Objective-C

    enum PTScreenIconCaptionRelation {}

    Swift

    struct PTScreenIconCaptionRelation : Equatable, RawRepresentable
  • This enum represents the circumstances under which the icon shall be scaled inside the annotation rectangle.

    See more

    Declaration

    Objective-C

    enum PTScreenScaleCondition {}

    Swift

    struct PTScreenScaleCondition : Equatable, RawRepresentable
  • This enum represents the scale type of the annotation.

    e_ptAnamorphic - Scale the icon to fill the annotation rectangle exactly, without regard to its original aspect ratio (ratio of width to height). e_ptProportional - 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_ptProportional.

    See more

    Declaration

    Objective-C

    enum PTScreenScaleType {}

    Swift

    struct PTScreenScaleType : Equatable, RawRepresentable
  • The PTSoundIcon of the Sound annotation.

    See more

    Declaration

    Objective-C

    enum PTSoundIcon {}

    Swift

    struct PTSoundIcon : Equatable, RawRepresentable
  • PTTextIcon enumeration defines the type of icon associated with the Text annotation.

    See more

    Declaration

    Objective-C

    enum PTTextIcon {}

    Swift

    struct PTTextIcon : Equatable, RawRepresentable
  • This enum specifies the Highlighting mode of the widget annotation

    See more

    Declaration

    Objective-C

    enum PTWidgetHighlightingMode {}

    Swift

    struct PTWidgetHighlightingMode : Equatable, RawRepresentable
  • An enumeration indicating where to position the text of the annotation’s caption relative to its icon.

    e_ptw_NoIcon - No icon; caption only e_ptw_NoCaption - No caption; icon only e_ptw_CBelowI - Caption below the icon e_ptw_CAboveI - Caption above the icon e_ptw_CRightILeft - Caption to the right of the icon e_ptw_CLeftIRight - Caption to the left of the icon e_ptw_COverlayI - Caption overlaid directly on the icon Default value: e_ptw_NoIcon.

    See more

    Declaration

    Objective-C

    enum PTWidgetIconCaptionRelation {}

    Swift

    struct PTWidgetIconCaptionRelation : Equatable, RawRepresentable
  • This enum represents the circumstances under which the icon shall be scaled inside the annotation rectangle .

    See more

    Declaration

    Objective-C

    enum PTWidgetScaleCondition {}

    Swift

    struct PTWidgetScaleCondition : Equatable, RawRepresentable
  • This enum represents the scale type of the annotation.

    e_ptw_Anamorphic - Scale the icon to fill the annotation rectangle exactly, without regard to its original aspect ratio (ratio of width to height). e_ptw_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_ptw_Proportional.

    See more

    Declaration

    Objective-C

    enum PTWidgetScaleType {}

    Swift

    struct PTWidgetScaleType : Equatable, RawRepresentable