PTContext

@interface PTContext : NSObject

The OCG::Context object represents an optional-content context in a document, within which document objects such as words or annotations are visible or hidden. The context keeps track of the ON-OFF states of all of the optional-content groups (OCGs) in a document. Content is or is not visible with respect to the OCG states stored in a specific context. Unlike other objects in OCG namespace, the OCG::Context does not correspond to any explicit PDF structure.

Each PDFView has a default context (PDF::GetOCGContext()) that it uses for on-screen drawing and that determines the default state for any drawing. The context has flags that control whether to draw content that is marked as optional, and whether to draw content that is not marked as optional.

When enumerating page content, OCG::Context can be passed as a parameter in ElementReader.Begin() method. When using PDFDraw, PDFRasterizer, or PDFView class to render PDF pages use PDFDraw::SetOCGContext() method to select an OC context.

There can be more than one Context object, representing different combinations of OCG states. You can change the states of OCGs within any context. You can build contexts with your own combination of OCG states, and issue drawing or enumeration commands using that context. For example, you can pass an optional-content context to ElementReader.Begin(). You can save the resulting state information as part of the configuration (e.g. using Config::SetInit methods), but the context itself has no corresponding PDF representation, and is not saved.

  • Create a context object that represents an optional-content state of the document from a given configuration.

    Declaration

    Objective-C

    - (instancetype)initWithConfig:(PTConfig *)config;

    Swift

    init!(config: PTConfig!)

    Parameters

    config

    A configuration from which to take initial OCG states.

  • Declaration

    Objective-C

    - (BOOL)IsValid;

    Swift

    func isValid() -> Bool

    Return Value

    true is this is a valid (non-null) context, false otherwise.

  • Declaration

    Objective-C

    - (BOOL)GetState:(PTGroup *)group;

    Swift

    func getState(_ group: PTGroup!) -> Bool

    Parameters

    group

    The optional-content group (OCG) that is queried.

    Return Value

    the ON-OFF states (true or false) for the given optional-content group (OCG) in this OC context.

  • Sets the ON-OFF states for the given optional-content group (OCG) in this context.

    Declaration

    Objective-C

    - (void)SetState:(PTGroup *)group state:(BOOL)state;

    Swift

    func setState(_ group: PTGroup!, state: Bool)

    Parameters

    group

    The optional-content group (OCG) that is queried.
    state

    true for ‘ON’ and false for ‘OFF’.

  • Sets the sates of all OCGs in the context to ON or OFF.

    Declaration

    Objective-C

    - (void)ResetStates:(BOOL)all_on;

    Swift

    func resetStates(_ all_on: Bool)

    Parameters

    all_on

    A flag used to specify whether the OCG states should be set to ON (if true), or OFF (if false).

  • Sets the non-OC status for this context. Content that is not marked as optional content is drawn (or element.IsOCVisible()) when ‘draw_non_OC’ is true, and not drawn/visible otherwise.

    Declaration

    Objective-C

    - (void)SetNonOCDrawing:(BOOL)draw_non_OC;

    Swift

    func setNonOCDrawing(_ draw_non_OC: Bool)

    Parameters

    draw_non_OC

    A flag specifying whether the content that is not marked as optional should be treated as visible.

  • Declaration

    Objective-C

    - (BOOL)GetNonOCDrawing;

    Swift

    func getNonOCDrawing() -> Bool

    Return Value

    the non-OC status for this context. The flag indicates whether the content that is not marked as optional should be treated as visible. For more information, please see SetNonOCDrawing().

  • Sets the drawing and enumeration type for this context. This type, together with the visibility determined by the OCG and OCMD states, controls whether content that is marked as optional content is drawn or enumerated.

    Declaration

    Objective-C

    - (void)SetOCDrawMode:(PTOCDrawMode)oc_draw_mode;

    Swift

    func setOCDrawMode(_ oc_draw_mode: PTOCDrawMode)

    Parameters

    oc_draw_mode

    A flag specifying the visibility of optional content.

  • Declaration

    Objective-C

    - (PTOCDrawMode)GetOCMode;

    Swift

    func getOCMode() -> PTOCDrawMode

    Return Value

    the drawing and enumeration type for this context. For more information, please see SetOCMode() and OCG::Context::OCDrawMode.

  • Undocumented

    Declaration

    Objective-C

    + (PTContext*)CreateInternal: (unsigned long long)impl;

    Swift

    class func createInternal(_ impl: UInt64) -> PTContext!

  • Undocumented

    Declaration

    Objective-C

    - (unsigned long long)GetHandleInternal;

    Swift

    func getHandleInternal() -> UInt64