OptionalContentContext Class

class OptionalContentContext

Namespace:datalogics_interface

Detailed Description

Defines the context for optional content in a PDF.

An Optional Content Context is a status object that defines the context for optional content within a document.

The context tracks the On/Off status for Optional Content Groups (layers) within a document. It contains flags that control whether to display content that is marked as optional.

Referenced by

DrawParams OptionalContentContext

Uses types

OCDrawingPolicy OptionalContentContext OptionalContentGroup

Constructor & Destructor Documentation

OptionalContentContext(const Document & document)

Parameters

document: const Document &: The document for which to create a context.

Creates a context object that represents an optional-content state of the document, using the current state as the initial state for each group (OCG), as determined by the document's optional-content configuration.

OptionalContentContext(OptionalContentContext && )

Parameters

: OptionalContentContext &&

~OptionalContentContext()

Member Function Documentation

std::unique_ptr< OptionalContentContext > clone()

Returns:

std::unique_ptr< OptionalContentContext >

A copy of the original optional content context.

Makes a copy of the optional content context.

OCDrawingPolicy get_draw_optional_content()

Returns:

OCDrawingPolicy

The drawing policy for optional content in this optional content context.

Gets the drawing policy for the optional content in this optional content context.

std::vector< bool > get_ocg_states(const std::vector< OptionalContentGroup > & ocgs)

Parameters

ocgs: const std::vector< OptionalContentGroup > &: A list of optional-content groups whose states are obtained.

Returns:

std::vector< bool >

An array of OCG states corresponding to the array of OCGs, true for ON and false for OFF.

Gets the ON-OFF states for the given optional-content groups (OCGs) in the given optional-content context.

bool get_state_of_ocg(OptionalContentGroup & ocg)

Parameters

ocg: OptionalContentGroup &: The optional content group whose state will be retrieved.

Returns:

bool

true if the OCG is ON, false if it is OFF.

Gets the ON-OFF state for the given optional content group (OCG) in this optional content context.

OptionalContentContext & operator=(OptionalContentContext && )

Parameters

: OptionalContentContext &&

Returns:

OptionalContentContext &

bool operator==(const OptionalContentContext & other)

Parameters

other: const OptionalContentContext &: The OptionalContentContext to compare with.

Returns:

bool

true if the two objects refer to the same context, false otherwise.

Determines whether this OptionalContentContext is equal to another.

Two OptionalContentContexts are considered equal if they refer to the same underlying optional content context object.

void set_draw_optional_content(OCDrawingPolicy policy)

Parameters

policy: OCDrawingPolicy: The new drawing policy for optional content in this optional content context.

Returns:

void

Sets the drawing policy for the optional content in this optional content context.

void set_ocg_states(const std::vector< OptionalContentGroup > & ocgs, const std::vector< bool > & new_states)

Parameters

ocgs: const std::vector< OptionalContentGroup > &: A list of optional-content groups.
new_states: const std::vector< bool > &: A list of new OCG states corresponding to the list of OCGs, true for ON and false for OFF. The list must contain as many states as there are non-NULL OCGs in the pdocgs list.

Returns:

void

Sets the ON-OFF states for the given optional-content groups (OCGs) in the given optional-content context. The newStates vector must be large enough to hold as many Boolean values as there are OCGs.

void set_state_of_ocg(OptionalContentGroup & ocg, bool new_value)

Parameters

ocg: OptionalContentGroup &: The optional content group whose state will be set.
new_value: bool: The new ON-OFF state for the optional content group.

Returns:

void

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

std::string to_string()

Returns:

std::string

A string describing the state of all optional content groups in this context.

Returns a string representation of this OptionalContentContext.

The string lists all optional content groups in the document along with their ON/OFF states in this context.