OptionalContentConfig Class Documentation

classOptionalContentConfig

Namespace:datalogics_interface

Detailed Description

The Optional Content Configuration Structure is used to maintain a set of visibility states and other optional values related to layers, or Optional Content Groups, within a PDF file.

These configuration values are stored for future use.

The default configuration for a PDF document is stored in the D entry in the Optional Content Properties dictionary.

An Optional Content Group, or layer, is a set of graphic images that can be made visible or invisible within a PDF file, and the Optional Content Configuration Structure is typically used to set the initial value for these images-On or Off, visible or invisible.

Constructor & Destructor Documentation

OptionalContentConfig

OptionalContentConfig()

Create an OCConfig from an internal source

Internal only.

OptionalContentConfig

OptionalContentConfig(const Document &doc)

Parameters

doc: const Document &

the Document the OCConfig is in

Create an OCConfig from an internal source

Internal only.

~OptionalContentConfig

~OptionalContentConfig()

Member Function Documentation

get_base_state

OptionalContentBaseStateget_base_state()

Returns:

The base state that will be applied to OptionalContentGroups.

Get the base state for this OptionalContentConfig. When this config is applied to an OptionalContentContext, all OptionalContentGroups will be set to according to this base state:

If BaseState is set to BaseStateOff, when this OptionalContentConfig is applied to an OptionalContentContext: All OptionalContentGroups in the document are set to OFF, and Any OptionalContentGroups in this OptionalContentConfig's ON array are then set to on. If BaseState is set to BaseStateOn, when this OptionalContentConfig is applied to an OptionalContentContext: All OptionalContentGroups in the document are set to ON, and Any OptionalContentGroups in this OptionalContentConfig's OFF array are then set to off. If BaseState is set to BaseStateUnchanged, when this OptionalContentConfig is applied to an OptionalContentContext: Any OptionalContentGroups in this OptionalContentConfig's ON array are set to on Any OptionalContentGroups in this OptionalContentConfig's OFF array are set to off Any OptionalContentGroups in neither the ON or OFF array are unaffected

get_intent

std::vector< std::string >get_intent()

Returns:

An array containing intent strings.

Gets the intent list for an OptionalContentConfig. An intent is a string value broadly describing the intended use, either View or Design.

A config's intent is used to set the intent of an OptionalContentContext when this config is applied to the context.

get_name

std::stringget_name()

Returns:

The name of this OptionalContentConfig. Use null to remove the name.

Get the name of the OptionalContentConfig

get_off_array

std::vector< OptionalContentGroup >get_off_array()

Returns:

A list of all OptionalContentGroups in the OFF array

Get the list of OptionalContentGroups in the OFF array.

When this config is applied to an OptionalContentContext, the OptionalContentGroups in this array will be set to OFF.

This list is ignored if the BaseState is BaseStateOff; please see the description of the BaseState property for details.

Note that an OptionalContentGroup should not be in both the ON array and the OFF array.

get_on_array

std::vector< OptionalContentGroup >get_on_array()

Returns:

A list of all OptionalContentGroups in the ON array

Get the list of OptionalContentGroups in the ON array.

When this config is applied to an OptionalContentContext, the OptionalContentGroups in this array will be set to ON.

This list is ignored if the BaseState is BaseStateOn; please see the description of the BaseState property for details.

Note that an OptionalContentGroup should not be in both the ON array and the OFF array.

get_order

std::unique_ptr< OptionalContentOrderArray >get_order()

Returns:

The OptionalContentOrderArray for optional content in this optional content config.

Gets the order list for the optional content in this optional content config.

Note that you can set the Title property on this order list, just as on any other OptionalContentOrderArray, and it will save as a legal PDF. However, the Title property on the top level order array simply appears as an extraneous text label in a PDF Viewer Layers panel, so its use at this level is typically not required.

get_pdf_dict

PDFDictget_pdf_dict()

Returns:

The underlying PDF dictionary for this OptionalContentConfig.

Retrieve the PDFObject representation of this object.

set_base_state

voidset_base_state(OptionalContentBaseStatebase_state)

Parameters

base_state: OptionalContentBaseState

The base state that will be applied to OptionalContentGroups.

Returns:

void

Set the base state for this OptionalContentConfig. When this config is applied to an OptionalContentContext, all OptionalContentGroups will be set to according to this base state:

If BaseState is set to BaseStateOff, when this OptionalContentConfig is applied to an OptionalContentContext: All OptionalContentGroups in the document are set to OFF, and Any OptionalContentGroups in this OptionalContentConfig's ON array are then set to on. If BaseState is set to BaseStateOn, when this OptionalContentConfig is applied to an OptionalContentContext: All OptionalContentGroups in the document are set to ON, and Any OptionalContentGroups in this OptionalContentConfig's OFF array are then set to off. If BaseState is set to BaseStateUnchanged, when this OptionalContentConfig is applied to an OptionalContentContext: Any OptionalContentGroups in this OptionalContentConfig's ON array are set to on Any OptionalContentGroups in this OptionalContentConfig's OFF array are set to off Any OptionalContentGroups in neither the ON or OFF array are unaffected

set_intent

voidset_intent(const std::vector< std::string > &intents)

Parameters

intents: const std::vector< std::string > &

An array of intent strings to assign to this config.

Returns:

void

Sets the intent list for an OptionalContentConfig. An intent is a string value broadly describing the intended use, either View or Design.

A config's intent is used to set the intent of an OptionalContentContext when this config is applied to the context.

set_name

voidset_name(const std::string &name)

Parameters

name: const std::string &

The name of this OptionalContentConfig. Use null to remove the name.

Returns:

void

Set the name of the optional content group

set_off_array

voidset_off_array(std::vector< OptionalContentGroup >ocgs)

Parameters

ocgs: std::vector< OptionalContentGroup >

A list of all OptionalContentGroups to be placed in the OFF array

Returns:

void

Set the list of OptionalContentGroups in the OFF array.

When this config is applied to an OptionalContentContext, the OptionalContentGroups in this array will be set to OFF.

This list is ignored if the BaseState is BaseStateOff; please see the description of the BaseState property for details.

Note that an OptionalContentGroup should not be in both the ON array and the OFF array.

set_on_array

voidset_on_array(std::vector< OptionalContentGroup >ocgs)

Parameters

ocgs: std::vector< OptionalContentGroup >

A list of all OptionalContentGroups to be placed in the ON array

Returns:

void

Set the list of OptionalContentGroups in the ON array.

When this config is applied to an OptionalContentContext, the OptionalContentGroups in this array will be set to ON.

This list is ignored if the BaseState is BaseStateOn; please see the description of the BaseState property for details.

Note that an OptionalContentGroup should not be in both the ON array and the OFF array.