Other Enumerations

The following enumerations are available globally.

  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTResultState {  e_ptrs_failure,
    e_ptrs_success,
    e_ptrs_security_error,
    e_ptrs_cancel,
    e_ptrs_package_error,
    e_ptrs_previous_crash,
    e_ptrs_not_found,
    e_ptrs_fetch,
    e_ptrs_render,
    e_ptrs_postponed}

    Swift

    struct PTResultState : Equatable, RawRepresentable
  • Provides the fields that represent reference points in streams for seeking.

    See more

    Declaration

    Objective-C

    enum PTReferencePos {}

    Swift

    struct PTReferencePos : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTOverloadedFunction {
    pthas_CloneProc         = 0x01,
    pthas_AuthProc          = 0x02,
    pthas_AuthFailedProc    = 0x04,
    pthas_GetAuthDataProc   = 0x08,
    pthas_EditSecurDataProc = 0x10,
    pthas_FillEncDictProc   = 0x20
    }

    Swift

    struct PTOverloadedFunction : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTFunctionType
    {
    /// uses a table of sample values to define the function.
    e_ptsampled     = 0,
    /// defines a set of coefficients for an exponential function.
    e_ptexponential = 2,
    /// a combination of other functions, partitioned across a domain.
    e_ptstitching   = 3,
    /// A PostScript calculator function.
    e_ptpostscript  = 4
    }

    Swift

    struct PTFunctionType : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTGeometryCollectionSnappingMode {
    e_ptDefaultSnapMode = 14,
    e_ptPointOnLine = 1,
    e_ptLineMidpoint = 2,
    e_ptLineIntersection = 4,
    e_ptPathEndpoint = 8
    }

    Swift

    struct PTGeometryCollectionSnappingMode : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTColorSpaceType
    {
    e_ptdevice_gray,
    e_ptdevice_rgb,
    e_ptdevice_cmyk,
    e_ptcal_gray,
    e_ptcal_rgb,
    e_ptlab,
    e_pticc,
    e_ptindexed,
    e_ptpattern,
    e_ptseparation,
    e_ptdevice_n,
    e_ptc_null
    }

    Swift

    struct PTColorSpaceType : Equatable, RawRepresentable
  • PDF page can define as many as five separate boundaries to control various aspects of the imaging process (for more details please refer to Section 10.10.1 ‘Page Boundaries’ in PDF Reference Manual):

    • The media box defines the boundaries of the physical medium on which the page is to be printed. It may include any extended area surrounding the finished page for bleed, printing marks, or other such purposes. It may also include areas close to the edges of the medium that cannot be marked because of physical limitations of the output device. Content falling outside this boundary can safely be discarded without affecting the meaning of the PDF file.

    • The crop box defines the region to which the contents of the page are to be clipped (cropped) when displayed or printed. Unlike the other boxes, the crop box has no defined meaning in terms of physical page geometry or intended use; it merely imposes clipping on the page contents. The default value is the page’s media box.

    • The bleed box defines the region to which the contents of the page should be clipped when output in a production environment. This may include any extra bleed area needed to accommodate the physical limitations of cutting, folding, and trimming equipment. The default value is the page’s crop box.

    • The trim box defines the intended dimensions of the finished page after trimming. It may be smaller than the media box to allow for production related content, such as printing instructions, cut marks, or color bars. The default value is the page’s crop box.

    • The art box defines the extent of the page’s meaningful content (including potential white space) as intended by the page’s creator. The default value is the page’s crop box.

    See more

    Declaration

    Objective-C

    enum PTBox {}

    Swift

    struct PTBox : Equatable, RawRepresentable
  • Specifies page rotation, in degrees.

    See more

    Declaration

    Objective-C

    enum PTRotate {}

    Swift

    struct PTRotate : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTPageActionTriggerEvent
    {
    e_ptaction_trigger_page_open = 11, //Triggered when the page is opened and shall be executed after such an action
    e_ptaction_trigger_page_close = 12 //Triggered when the page is closed, This action applies to the page being closed and shall be executed before any other page is opened
    }

    Swift

    struct PTPageActionTriggerEvent : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTGStateAttribute
    {
    /// General graphics state attributes
    e_pttransform = 0,
    e_ptrendering_intent,
    
    e_ptstroke_cs,
    e_ptstroke_color,
    e_ptfill_cs,
    e_ptfill_color,
    
    /// Path attributes
    e_ptline_width,
    e_ptline_cap,
    e_ptline_join,
    e_ptflatness,
    e_ptmiter_limit,
    e_ptdash_pattern,
    
    /// Text attributes
    e_ptchar_spacing,
    e_ptword_spacing,
    e_pthorizontal_scale,
    e_ptleading,
    e_ptfont,
    e_ptfont_size,
    e_pttext_render_mode,
    e_pttext_rise,
    e_pttext_knockout,
    
    // Adjusts the text position by a given amount. The attribute can be
    // accessed through Element interface
    e_pttext_pos_offset,
    
    /// Extended graphics state attributes
    e_ptblend_mode,
    e_ptopacity_fill,
    e_ptopacity_stroke,
    e_ptalpha_is_shape,
    e_ptsoft_mask,
    e_ptsmoothnes,
    e_ptauto_stoke_adjust,
    e_ptstroke_overprint,
    e_ptfill_overprint,
    e_ptoverprint_mode,
    e_pttransfer_funct,
    e_ptBG_funct,
    e_ptUCR_funct,
    e_pthalftone,
    
    // null attribute
    e_ptg_null
    }

    Swift

    struct PTGStateAttribute : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTLineCap
    {
    /// The stroke is squared off at the endpoint of the path.
    e_ptbutt_cap = 0,
    /// A semicircular arc with a diameter equal to the line width.
    e_ptround_cap,
    /// squared off stroke continues beyond the endpoint of the path.
    e_ptsquare_cap
    }

    Swift

    struct PTLineCap : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTLineJoin
    {
    /// The two segments are extended until they meet
    e_ptmiter_join = 0,
    /// A circle with a diameter equal to the line width
    e_ptround_join,
    /// The two segments are finished with butt caps
    e_ptbevel_join
    }

    Swift

    struct PTLineJoin : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTTextRenderingMode
    {
    /// Fill text.
    e_ptfill_text = 0,
    /// Stroke text.
    e_ptstroke_text,
    /// Fill, then stroke text.
    e_ptfill_stroke_text,
    /// Neither fill nor stroke text (invisible).
    e_ptinvisible_text,
    /// Fill text and add to path for clipping (see above).
    e_ptfill_clip_text,
    /// Stroke text and add to path for clipping.
    e_ptstroke_ptclip_text,
    /// Fill, then stroke text and add to path for clipping.
    e_ptfill_stroke_ptclip_text,
    /// Add text to path for clipping.
    e_ptclip_text
    }

    Swift

    struct PTTextRenderingMode : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTRenderingIntent
    {
    e_ptabsolute_colorimetric,
    e_ptrelative_colorimetric,
    e_ptsaturation,
    e_ptperceptual
    }

    Swift

    struct PTRenderingIntent : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTBlendMode
    {
    e_ptbl_compatible = 0,
    e_ptbl_normal,
    e_ptbl_multiply,
    e_ptbl_screen,
    e_ptbl_difference,
    e_ptbl_darken,
    e_ptbl_lighten,
    e_ptbl_color_dodge,
    e_ptbl_color_burn,
    e_ptbl_exclusion,
    e_ptbl_hard_light,
    e_ptbl_overlay,
    e_ptbl_soft_light,
    e_ptbl_luminosity,
    e_ptbl_hue,
    e_ptbl_saturation,
    e_ptbl_color
    }

    Swift

    struct PTBlendMode : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTInputFilter
    {
    /// Input stream is not compressed
    e_pti_none,
    /// Input image is a JPEG image
    e_pti_jpeg,
    /// Input image is a JP2 (JPEG2000) image
    e_ptjp2,
    /// Input image is a Flate compressed
    e_pti_flate,
    /// Input image is a G3 stream
    e_ptg3,
    /// Input image is a G4 stream
    e_ptg4,
    /// Input image stream compressed using ASCIIHexDecode filter
    e_ptascii_hex
    }

    Swift

    struct PTInputFilter : Equatable, RawRepresentable
  • Enumeration specifying the form of quadding (justification) to be used in displaying the text fields.

    See more

    Declaration

    Objective-C

    enum PTTextJustification {}

    Swift

    struct PTTextJustification : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTDigestAlgorithmType {
    e_ptsha1 = 0,
    e_ptsha256 = 1,
    e_ptsha384 = 2,
    e_ptsha512 = 3,
    e_ptripemd160 = 4,
    e_ptunknown_digest_algorithm = 5
    }

    Swift

    struct PTDigestAlgorithmType : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTDisallowedChangeType {
    e_ptform_filled = 0,
    e_ptdigital_signature_signed = 1,
    e_ptpage_template_instantiated = 2,
    e_ptannotation_created_or_updated_or_deleted = 3,
    e_ptother = 4,
    e_ptdct_unknown = 5
    }

    Swift

    struct PTDisallowedChangeType : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTVerificationOptionsSecurityLevel {
    e_ptcompatibility_and_archiving = 0,
    e_ptmaximum = 1
    }

    Swift

    struct PTVerificationOptionsSecurityLevel : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTVerificationOptionsTimeMode {
    e_ptsigning = 0,
    e_pttimestamp = 1,
    e_ptcurrent = 2
    }

    Swift

    struct PTVerificationOptionsTimeMode : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTVerificationResultDocumentStatus {
    e_ptno_error = 0,
    e_ptcorrupt_file = 1,
    e_ptunsigned = 2,
    e_ptbad_byteranges = 3,
    e_ptcorrupt_cryptographic_contents = 4
    }

    Swift

    struct PTVerificationResultDocumentStatus : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTVerificationResultDigestStatus {
    e_ptdigest_invalid = 0,
    e_ptdigest_verified = 1,
    e_ptdigest_verification_disabled = 2,
    e_ptweak_digest_algorithm_but_digest_verifiable = 3,
    e_ptno_digest_status = 4,
    e_ptunsupported_encoding = 5
    }

    Swift

    struct PTVerificationResultDigestStatus : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTVerificationResultTrustStatus {
    e_pttrust_verified = 0,
    e_ptuntrusted = 1,
    e_pttrust_verification_disabled = 2,
    e_ptno_trust_status = 3
    }

    Swift

    struct PTVerificationResultTrustStatus : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTVerificationResultModificationPermissionsStatus {
    e_ptinvalidated_by_disallowed_changes = 0,
    e_pthas_allowed_changes = 1,
    e_ptunmodified = 2,
    e_ptpermissions_verification_disabled = 3,
    e_ptno_permissions_status = 4
    }

    Swift

    struct PTVerificationResultModificationPermissionsStatus : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTDigitalSignatureFieldSubFilterType {
    e_ptadbe_x509_rsa_sha1 = 0,
    e_ptadbe_pkcs7_detached = 1,
    e_ptadbe_pkcs7_sha1 = 2,
    e_ptETSI_CAdES_detached = 3,
    e_ptETSI_RFC3161 = 4,
    e_ptunknown = 5,
    e_ptabsent = 6
    }

    Swift

    struct PTDigitalSignatureFieldSubFilterType : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTDigitalSignatureFieldDocumentPermissions {
    // No changes to the document shall be permitted; any change to the document shall invalidate the signature.
    e_ptno_changes_allowed = 1,
    // Permitted changes shall be filling in forms, instantiating page templates, and signing; other changes shall invalidate the signature.
    e_ptformfilling_signing_allowed = 2,
    // Permitted changes shall be the same as for 2, as well as annotation creation, deletion, and modification; other changes shall invalidate the signature.
    e_ptannotating_formfilling_signing_allowed = 3,
    // Represents the absence of any document permissions during retrieval; not to be used during setting
    e_ptunrestricted = 4
    }

    Swift

    struct PTDigitalSignatureFieldDocumentPermissions : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTDigitalSignatureFieldFieldPermissions {
    // Locks all form fields.
    e_ptdigsig_permission_lock_all = 0,
    // Locks only those form fields specified.
    e_ptdigsig_permission_include = 1,
    // Locks only those form fields not specified.
    e_ptdigsig_permission_exclude = 2
    }

    Swift

    struct PTDigitalSignatureFieldFieldPermissions : Equatable, RawRepresentable
  • PTAnnotFlags specifying various characteristics of the annotation.

    • If e_ptinvisible is set, do not display the annotation if it does not belong to one of the standard annotation types and no annotation handler is available. If clear, display such an unknown annotation using an appearance stream specified by its appearance dictionary, if any.

    • If e_pthidden is set, do not display or print the annotation or allow it to interact with the user, regardless of its annotation type or whether an annotation handler is available.

    • If e_ptprint_annot is set, print the annotation when the page is printed. If clear, never print the annotation, regardless of whether it is displayed on the screen. This can be useful, for example, for annotations representing interactive pushbuttons, which would serve no meaningful purpose on the printed page.

    • If e_ptno_zoom is set, do not scale the annotation’s appearance to match the magnification of the page.

    • If e_ptno_rotate is set, do not rotate the annotation’s appearance to match the rotation of the page.

    • If e_ptno_view is set, do not display the annotation on the screen or allow it to interact with the user. The annotation may be printed (depending on the setting of the Print flag) but should be considered hidden for purposes of on-screen display and user interaction.

    • If e_ptannot_read_only is set, do not allow the annotation to interact with the user. The annotation may be displayed or printed (depending on the settings of the NoView and Print flags) but should not respond to mouse clicks or change its appearance in response to mouse motions.

    • If e_ptlocked is set, do not allow the annotation to be deleted or its properties (including position and size) to be modified by the user. However, this flag does not restrict changes to the annotation’s contents, such as the value of a form field.

    • If e_pttoggle_ptno_view is set, invert the interpretation of the NoView flag for certain events. A typical use is to have an annotation that appears only when a mouse cursor is held over it.

    • If e_ptlocked_contents is set, do not allow the contents of the annotation to be modified by the user. This flag does not restrict deletion of the annotation or changes to other annotation properties, such as position and size.

    See more

    Declaration

    Objective-C

    enum PTAnnotFlag {}

    Swift

    struct PTAnnotFlag : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTAnnotActionTriggerEvent
    {
    e_ptaction_trigger_activate = 0, //Triggered when the annotation is activated. if present, takes precedence over U entry (e_ptaction_trigger_annot_up)
    e_ptaction_trigger_annot_enter = 1, //Triggered when the cursor enters the annotation's active area
    e_ptaction_trigger_annot_exit = 2, //Triggered when the cursor exits the annotation's active area
    e_ptaction_trigger_annot_down = 3, //Triggered when the mouse button is pressed inside the annotations active area
    e_ptaction_trigger_annot_up = 4, //Triggered when the mouse button is released inside the annotations active area
    e_ptaction_trigger_annot_focus = 5, //Triggered when the annotation receives the input focus
    e_ptaction_trigger_annot_blur = 6, //Triggered when the annotation loses the input focus
    e_ptaction_trigger_annot_page_open = 7, //Triggered when the page containing the annotation is opened
    e_ptaction_trigger_annot_page_close = 8, //Triggered when the page containing the annotation is closed
    e_ptaction_trigger_annot_page_visible = 9, //Triggered when the page containing the annotation becomes visible
    e_action_trigger_annot_page_ptinvisible = 10 //Triggered when the page containing the annotation is no longer visible in the interactive PDF processors user interface
    }

    Swift

    struct PTAnnotActionTriggerEvent : Equatable, RawRepresentable
  • An annotation can define as many as three separate appearances:

    • The normal appearance is used when the annotation is not interacting with the user. This appearance is also used for printing the annotation.

    • The rollover appearance is used when the user moves the cursor into the annotation’s active area without pressing the mouse button.

    • The down appearance is used when the mouse button is pressed or held down within the annotation’s active area.

    See more

    Declaration

    Objective-C

    enum PTAnnotationState {}

    Swift

    struct PTAnnotationState : Equatable, RawRepresentable
  • The border style

    See more

    Declaration

    Objective-C

    enum PTBdStyle {}

    Swift

    struct PTBdStyle : Equatable, RawRepresentable
  • View Destination Fit Types:

    XYZ - Destination specified as upper-left corner point and a zoom factor. Fit - Fits the page into the window FitH - Fits the widths of the page into the window FitV - Fits the height of the page into a window. FitR - Fits the rectangle specified by its upper-left and lower-right corner points into the window. FitB - Fits the rectangle containing all visible elements on the page into the window. FitBH - Fits the width of the bounding box into the window. FitBV - Fits the height of the bounding box into the window.

    See more

    Declaration

    Objective-C

    enum PTFitType {}

    Swift

    struct PTFitType : Equatable, RawRepresentable
  • PDF supports the standard action types listed in the following table. Plug-in extensions may add new action types.

    See more

    Declaration

    Objective-C

    enum PTActionType {}

    Swift

    struct PTActionType : Equatable, RawRepresentable
  • Flags used by submit form actions. Exclude flag is also used by reset form action. No other action types use flags in the current version of PDF standard (ISO 2300).

    See more

    Declaration

    Objective-C

    enum PTFormActionFlag {}

    Swift

    struct PTFormActionFlag : Equatable, RawRepresentable
  • Enumeration used to indicate operator type.

    See more

    Declaration

    Objective-C

    enum PTPathSegmentType {}

    Swift

    struct PTPathSegmentType : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTStandardType1Font {  e_pttimes_roman = 0,
    e_pttimes_bold,
    e_pttimes_italic,
    e_pttimes_bold_italic,
    e_pthelvetica,
    e_pthelvetica_bold,
    e_pthelvetica_oblique,
    e_pthelvetica_bold_oblique,
    e_ptcourier,
    e_ptcourier_bold,
    e_ptcourier_oblique,
    e_ptcourier_bold_oblique,
    e_ptsymbol,
    e_ptzapf_dingbats,
    e_ptft_null}

    Swift

    struct PTStandardType1Font : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTEncoding
    {
    e_ptIdentityH=0,
    e_ptIndices
    }

    Swift

    struct PTEncoding : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTFontType
    {
    e_PTFontType1,			// PTFontType 1 PostScript font
    e_TruePTFontType,			// TruePTFontType font
    e_MMPTFontType1,			// PTFontType 1 multiple master PostScript font
    e_PTFontType3,			// PTFontType 3 PostScript font
    e_PTFontType0,			// PTFontType 0 PostScript composite (CID) font
    e_CIDPTFontType0,			// PTFontType 0 CID font
    e_CIDPTFontType2,			// PTFontType 2 CID font
    }

    Swift

    struct PTFontType : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTShadingType
    {
    e_ptfunction_shading,
    e_ptaxial_shading,
    e_ptradial_shading,
    e_ptfree_gouraud_shading,
    e_ptlattice_gouraud_shading,
    e_ptcoons_shading,
    e_pttensor_shading,
    e_pts_null
    }

    Swift

    struct PTShadingType : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTPatternColorType
    {
    e_ptuncolored_tiling_pattern,
    e_ptcolored_tiling_pattern,
    e_ptshading,
    e_ptp_null
    }

    Swift

    struct PTPatternColorType : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTTilingType {  e_ptconstant_spacing,
    e_ptno_distortion,
    e_ptconstant_spacing_fast_fill}

    Swift

    struct PTTilingType : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTElementType
    {
    /// undefined element type
    e_pte_null,
    /// path object
    e_ptpath,
    /// marks the beginning of a text container
    e_pttext_begin,
    /// text object within a text container
    e_pttext_obj,
    /// indicates the start of the new text line
    e_pttext_new_line,
    /// marks the end of text container
    e_pttext_end,
    /// image XObject
    e_ptimage,
    /// inline image object
    e_ptinline_ptimage,
    /// shading object
    e_pte_shading,
    /// a form XObject
    e_ptform,
    /// push graphics state operator (q)
    e_ptgroup_begin,
    /// pop graphics state operator (Q)
    e_ptgroup_end,
    /// marks the beginning of marked content sequence (BMC, BDC)
    e_ptmarked_content_begin,
    /// marks the end of marked content sequence (EMC)
    e_ptmarked_content_end,
    /// designate a marked-content point (MP, DP)
    e_ptmarked_content_point
    }

    Swift

    struct PTElementType : Equatable, RawRepresentable
  • Enumeration describing the placement of the element written to a page.

    See more

    Declaration

    Objective-C

    enum PTWriteMode {}

    Swift

    struct PTWriteMode : Equatable, RawRepresentable
  • Undocumented

    Declaration

    Objective-C

    enum PTThreshold
    {
    /// SWIG
    
    }

    Swift

    struct PTThreshold : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTFlattenMode
    {
    /**
    * Feature reduce PDF to a simple two layer representation consisting
    * of a single background RGB image and a simple top text layer.
    */
    e_ptsimple,
    /**
    * Feature reduce PDF while trying to preserve some
    * complex PDF features (such as vector figures, transparency, shadings,
    * blend modes, Type3 fonts etc.) for pages that are already fast to render.
    * This option can also result in smaller & faster files compared to e_ptsimple,
    * but the pages may have more complex structure.
    */
    e_ptfast
    }

    Swift

    struct PTFlattenMode : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTCompressionMode
    {
    e_ptretain,
    e_ptflate,
    e_ptjpeg,
    e_ptjpeg2000,
    e_ptnone
    }

    Swift

    struct PTCompressionMode : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTDownsampleMode
    {
    e_ptoff,
    e_ptds_default
    }

    Swift

    struct PTDownsampleMode : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTMonoCompressionMode
    {
    e_ptmn_jbig2,
    e_ptmn_flate,
    e_ptmn_none
    }

    Swift

    struct PTMonoCompressionMode : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTMonoDownsampleMode
    {
    e_ptmn_off,
    e_ptmn_default
    }

    Swift

    struct PTMonoDownsampleMode : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTPageLabelStyle
    {
    ///  Decimal Arabic numerals
    e_ptdecimal,
    ///  Uppercase Roman numerals
    e_ptroman_uppercase,
    ///  Lowercase Roman numerals
    e_ptroman_lowercase,
    ///  Uppercase letters (A to Z for the first 26 pages, AA to ZZ for the next 26, and so on)
    e_ptalphabetic_uppercase,
    ///  Lowercase letters (a to z for the first 26 pages, aa to zz for the next 26, and so on)
    e_ptalphabetic_lowercase,
    ///  No numeric portion in the label
    e_ptpg_none
    }

    Swift

    struct PTPageLabelStyle : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTPageSetFilter
    {
    e_ptall,
    e_pteven,
    e_ptodd
    }

    Swift

    struct PTPageSetFilter : Equatable, RawRepresentable
  • PTPageMode specifies how the document should be displayed when opened:

    • e_ptUseNone Displays document, but neither thumbnails nor bookmarks.
    • e_ptUseThumbs Displays document plus thumbnails.
    • e_ptUseBookmarks Displays document plus bookmarks.
    • e_ptFullScreen Displays document in full-screen viewing mode.
    • e_ptUseOC Displays Optional Content (OC) group panel.
    • e_ptUseAttachments - Displays attachments panel.
    See more

    Declaration

    Objective-C

    enum PTPageMode {}

    Swift

    struct PTPageMode : Equatable, RawRepresentable
  • PTPageLayout specifies the page layout to be used when the document is opened:

    • e_ptDefault PTPageLayout is not explicitly specified, use user defined preferred layout.

    • e_ptSinglePage Display one page at a time.

    • e_ptOneColumn Display the pages in one-column mode.

    • e_ptTwoColumnLeft Display the pages in two-column continuous mode with first page on left (i.e. all odd numbered pages on the left).

    • e_ptTwoColumnRight Display the pages in two-column continuous mode with first page on right (i.e. all odd numbered pages on the right).

    • e_ptTwoPageLeft Display the pages two at a time, with odd-numbered pages on the left.

    • e_ptTwoPageRight Display the pages two at a time, with odd-numbered pages on the right.

    See more

    Declaration

    Objective-C

    enum PTPageLayout {}

    Swift

    struct PTPageLayout : Equatable, RawRepresentable
  • PTViewerPref enumeration specifies how various GUI elements should behave when the document is opened.

    • e_ptHideToolbar A flag specifying whether to hide the viewer application’s toolbars when the document is active. Default value: false.

    • e_ptHideMenubar A flag specifying whether to hide the viewer application’s menu bar when the document is active. Default value: false.

    • e_ptHideWindowUI A flag specifying whether to hide user interface elements in the document’s window (such as scroll bars and navigation controls), leaving only the document’s contents displayed. Default value: false.

    • e_ptFitWindow A flag specifying whether to resize the document’s window to fit the size of the first displayed page. Default value: false.

    • e_ptCenterWindow A flag specifying whether to position the document’s window in the center of the screen. Default value: false.

    • e_ptDisplayDocTitle A flag specifying whether the window’s title bar should display the document title taken from the Title entry of the document information dictionary. If false, the title bar should instead display the name of the PDF file containing the document. Default value: false.

    See more

    Declaration

    Objective-C

    enum PTViewerPref {}

    Swift

    struct PTViewerPref : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTDownloadedType {  e_ptdownloadedtype_page = 0,
    e_ptdownloadedtype_thumb,
    e_ptdownloadedtype_named_dests,
    e_ptdownloadedtype_outline,
    e_ptdownloadedtype_finished,
    e_ptdownloadedtype_failed,
    e_ptdownloadedtype_opened}

    Swift

    struct PTDownloadedType : Equatable, RawRepresentable
  • PDFNet includes two separate rasterizer implementations utilizing different graphics libraries.

    The default rasterizer is ‘e_ptBuiltIn’ which is a high-quality, anti-aliased and platform independent rasterizer. This rasterizer is available on all supported platforms.

    On Windows platforms, PDFNet also includes GDI+ based rasterizer. (deprecated and will be removed in a future version of PDFNet) This rasterizer is included mainly to provide vector output for printing, for EMF/WMF export, etc. For plain image rasterization we recommend using the built-in rasterizer.

    See more

    Declaration

    Objective-C

    enum PTRasterizerType {}

    Swift

    struct PTRasterizerType : Equatable, RawRepresentable
  • Determines if overprint is used. e_ptop_on: overprint is always on; e_ptop_off: overprint is always off. e_ptop_pdfx_on: overprint is on only for PDF/X files.

    See more

    Declaration

    Objective-C

    enum PTOverprintPreviewMode {}

    Swift

    struct PTOverprintPreviewMode : Equatable, RawRepresentable
  • PTColorPostProcessMode is used to modify colors after rendering.

    See more

    Declaration

    Objective-C

    enum PTColorPostProcessMode {}

    Swift

    struct PTColorPostProcessMode : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTPDFDocActionTriggerEvent
    {
    e_ptaction_trigger_doc_will_close = 17, //Triggered before closing a document
    e_ptaction_trigger_doc_will_save = 18, //Triggered before saving a document
    e_ptaction_trigger_doc_did_save = 19, //Triggered after saving a document
    e_ptaction_trigger_doc_will_print = 20, //Triggered before printing a document
    e_ptaction_trigger_doc_did_print = 21 //Triggered after printing a document
    }

    Swift

    struct PTPDFDocActionTriggerEvent : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTInsertFlag {
    e_ptinsert_none,				//default, do not insert bookmarks
    e_ptinsert_bookmark,	//insert bookmarks (use this option when inserting many pages in a single call)
    /// same as e_ptinsert_bookmark, but ignore GoToR and URI links, while still retaining bookmark hierarchy (use this option when inserting one page at a time)
    e_insert_goto_bookmark
    }

    Swift

    struct PTInsertFlag : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTExtractFlag {
    e_ptforms_only,				// default, only extract form fields to FDF
    e_ptannots_only,				// only extract annots
    /// extract both form fields and annots
    e_ptboth,
    /// same as e_ptannots_only but no url links get converted
    e_ptannots_only_no_links = 5
    }

    Swift

    struct PTExtractFlag : Equatable, RawRepresentable
  • Pixel format type.

    See more

    Declaration

    Objective-C

    enum PTPixelFormat {}

    Swift

    struct PTPixelFormat : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTResult {
    e_ptSuccess = 0,
    e_ptIncomplete = 1,
    e_ptFailure = 2
    }

    Swift

    struct PTResult : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTFlattenThresholdFlag {
    /** Render (flatten) any text that is clipped or occluded. */
    e_ptvery_strict,
    /** Render text that are marginally clipped or occluded. */
    e_ptstrict,
    /** Render text that are somewhat clipped or occluded. */
    e_ptdefault,
    /** Only render text that are seriously clipped or occluded. */
    e_ptkeep_most,
    /** Only render text that are completely occluded, or used as a clipping path. */
    e_ptkeep_all
    }

    Swift

    struct PTFlattenThresholdFlag : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTFlattenFlag {
    /**
    * Disable flattening and convert all content as is.
    */
    e_ptflatten_off,
    /**
    * Feature reduce PDF to a simple two layer representation consisting
    * of a single background RGB image and a simple top text layer.
    */
    e_ptflatten_simple,
    /**
    * Feature reduce PDF while trying to preserve some
    * complex PDF features (such as vector figures, transparency, shadings,
    * blend modes, Type3 fonts etc.) for pages that are already fast to render.
    * This option can also result in smaller & faster files compared to e_ptflatten_simple,
    * but the pages may have more complex structure.
    */
    e_ptflatten_fast,
    
    /**
    * Preserve vector content where possible. In particular only feature reduce
    * PDF files containing overprint or very complex vector content. Currently this
    * option can only be used with XODOutputOptions.
    */
    e_pthigh_quality
    }

    Swift

    struct PTFlattenFlag : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTXPSOverprintPreviewMode
    {
    e_ptxps_op_off = 0,
    e_ptxps_op_on,
    e_ptcps_op_pdfx_on
    }

    Swift

    struct PTXPSOverprintPreviewMode : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTAnnotationOutputFlag {
    e_ptinternal_xfdf,				// include the annotation file in the XOD output. This is the default option
    e_ptexternal_xfdf,				// output the annotation file externally to the same output path with extension .xfdf.
    // This is not available when using streaming conversion
    /// flatten all annotations that are not link annotations
    e_ptflatten
    }

    Swift

    struct PTAnnotationOutputFlag : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTCMSType
    {
    ///< Use LittleCMS (available on all supported platforms).
    e_ptlcms,
    ///< Use Windows ICM2 (available only on Windows platforms).
    e_pticm,
    ///  No ICC color management.
    e_ptno_cms
    }

    Swift

    struct PTCMSType : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTFlateCompressionLevel {  e_ptZ_DEFAULT_COMPRESSION = -1,
    e_ptZ_NO_COMPRESSION = 0,
    e_ptZ_BEST_SPEED = 1,
    e_ptZ_BEST_COMPRESSION = 9}

    Swift

    struct PTFlateCompressionLevel : Equatable, RawRepresentable
  • Standard character orderings. PDFNet.AddFontSubst() can be used to associate a specific font with a given character ordering and to override default font mapping algorithm.

    See more

    Declaration

    Objective-C

    enum PTCharacterOrdering {}

    Swift

    struct PTCharacterOrdering : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTLogLevel {  e_ptLogLevel_Off = -1,
    e_ptLogLevel_Fatal = 5,
    e_ptLogLevel_Error = 4,
    e_ptLogLevel_Warning = 3,
    e_ptLogLevel_Info = 2,
    e_ptLogLevel_Trace = 1,
    e_ptLogLevel_Debug = 0}

    Swift

    struct PTLogLevel : Equatable, RawRepresentable
  • PTPagePresentationMode lists common modes of presenting PDF pages.

    See more

    Declaration

    Objective-C

    enum PTPagePresentationMode {}

    Swift

    struct PTPagePresentationMode : Equatable, RawRepresentable
  • PTTextSelectionMode lists different text selection modes that can be used to highlight text. PDFView currently supports the following text selection modes:

    • e_ptstructural - Selects text based on the logical structure of the page. This type of selection is similar to HTML like selection in web-browsers.
    • e_ptrectangular - Selects all words that intersect the given selection rectangle.
    • e_ptstructural_algorithm_2 - Similar to e_ptstructural but use different algorithm when the start point is not inside a block (not being too smart).

    PTTextSelectionMode lists different text selection modes that can be used to highlight text. PDFView currently supports the following text selection modes:

    • e_ptstructural - Selects text based on the logical structure of the page. This type of selection is similar to HTML like selection in web-browsers.
    • e_ptrectangular - Selects all words that intersect the given selection rectangle.
    • e_ptstructural_algorithm_2 - Similar to e_ptstructural but use different algorithm when the start point is not inside a block (not being too smart).
    See more

    Declaration

    Objective-C

    enum PTTextSelectionMode {}

    Swift

    struct PTTextSelectionMode : Equatable, RawRepresentable
  • PTPageViewMode lists common modes of viewing PDF pages. PDFView currently supports the following viewing modes:

    • e_ptfit_page - page zoom is automatically adjusted so that entire page fits into available space.
    • e_ptfit_width - page zoom is automatically adjusted so that page width fits into available space.
    • e_ptfit_height - page zoom is automatically adjusted so that page height fits into available space.
    • e_ptzoom - page is zoomed. The zoom ratio is specified using SetZoom() function.
    • PTPVM_SIZE - the size of the enum, should always stay as the last element
    See more

    Declaration

    Objective-C

    enum PTPageViewMode {}

    Swift

    struct PTPageViewMode : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTAnnotBitmapFlags
    {
    e_ptnormal_annot_bitmap = 1,
    e_ptmult_blend_annot_bitmap = 2,
    e_ptnormal_annot_vector = 3,
    e_ptmult_blend_annot_vector = 4,
    e_ptresize_annot_bitmap = 128,
    e_ptremove_annot_bitmap = 129,
    e_ptclear_all_annot_bitmaps = 130,
    e_ptannot_renders_complete = 131
    }

    Swift

    struct PTAnnotBitmapFlags : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTAnnotVectorMode
    {
    e_ptno_vector_annots,
    e_ptpdftron_vector_annots
    }

    Swift

    struct PTAnnotVectorMode : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTSizeType
    {
    e_ptrelative_scale = 1,
    e_ptabsolute_size = 2,
    e_pts_font_size = 3
    }

    Swift

    struct PTSizeType : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTHorizontalAlignment
    {
    e_pthorizontal_left = -1,
    e_pthorizontal_center = 0,
    e_pthorizontal_right = 1
    }

    Swift

    struct PTHorizontalAlignment : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTVerticalAlignment
    {
    e_ptvertical_bottom = -1,
    e_ptvertical_center = 0,
    e_ptvertical_top = 1
    }

    Swift

    struct PTVerticalAlignment : Equatable, RawRepresentable
  • Undocumented

    See more

    Declaration

    Objective-C

    enum PTTextAlignment
    {
    e_ptalign_left = -1,
    e_ptalign_center = 0,
    e_ptalign_right = 1
    }

    Swift

    struct PTTextAlignment : Equatable, RawRepresentable
  • Processing options that can be passed in Begin() method to direct the flow of content recognition algorithms

    See more

    Declaration

    Objective-C

    enum PTProcessingFlags {}

    Swift

    struct PTProcessingFlags : Equatable, RawRepresentable
  • Flags controlling the structure of XML output in a call to GetAsXML().

    See more

    Declaration

    Objective-C

    enum PTXMLOutputFlags {}

    Swift

    struct PTXMLOutputFlags : Equatable, RawRepresentable
  • Annotation types, including those of PTAnnotType, and extra types that are determined based on an annotation’s properties.

    See more

    Declaration

    Objective-C

    enum PTExtendedAnnotType {}

    Swift

    enum PTExtendedAnnotType : UInt
  • Constants to identify different page template styles

    See more

    Declaration

    Objective-C

    enum PTPageTemplateStyle {}

    Swift

    struct PTPageTemplateStyle : OptionSet
  • The scrolling direction of a reflow view controller.

    See more

    Declaration

    Objective-C

    enum PTReflowViewControllerScrollingDirection {}

    Swift

    enum PTReflowViewControllerScrollingDirection : UInt
  • Algorithm to use for reflow

    See more

    Declaration

    Objective-C

    enum PTReflowMode {}

    Swift

    enum PTReflowMode : Int