OptionalContentMembershipDict Class

class OptionalContentMembershipDict

Namespace:datalogics_interface

Detailed Description

Attaches content to one or more optional content groups.

Form, container, and annotation objects can be associated with one or more optional content groups. By associating them with an optional content group, they become part of that 'layer', and the user can control the visibility of the content.

Note that by placing other element objects in a container, they can also be associated with an optional content group.

An OptionalContentMembershipDict connects content to the OptionalContentGroup; it contains a list of OptionalContentGroups, and rules for determining visibility when the OptionalContentGroups have conflicting on/off states in the active OptionalContentContext.

An OptionalContentMembershipDict cannot be changed once created; you must create a new OptionalContentMembershipDict and change the objects to point to it.

Referenced by

Container Form

Uses types

OptionalContentGroup PDFArray VisibilityPolicy

Constructor & Destructor Documentation

OptionalContentMembershipDict(const Document & doc, const std::vector< OptionalContentGroup > & ocgs, VisibilityPolicy vp)

Parameters

doc: const Document &: The document that the new OptionalContentMembershipDict will belong to.
ocgs: const std::vector< OptionalContentGroup > &: The list of OptionalContentGroups this MembershipDict refers to.
vp: VisibilityPolicy: The VisibilityPolicy of this MembershipDict.

Create a new OptionalContentMembershipDict.

OptionalContentMembershipDict(const Document & doc, const std::vector< OptionalContentGroup > & ocgs, VisibilityPolicy vp, const PDFArray & visibility_expression)

Parameters

doc: const Document &: The document that the new OptionalContentMembershipDict will belong to.
ocgs: const std::vector< OptionalContentGroup > &: The list of OptionalContentGroups this MembershipDict refers to.
vp: VisibilityPolicy: The VisibilityPolicy of this MembershipDict.
visibility_expression: const PDFArray &

Create a new OptionalContentMembershipDict.

OptionalContentMembershipDict(OptionalContentMembershipDict && )

Parameters

: OptionalContentMembershipDict &&

~OptionalContentMembershipDict()

Member Function Documentation

std::vector< OptionalContentGroup > get_optional_content_groups()

Returns:

std::vector< OptionalContentGroup >

An array containing OptionalContentGroups.

Gets the list of OptionalContentGroups for this membership dictionary. This may consist of one OCG or several.

std::unique_ptr< PDFArray > get_visibility_expression()

Returns:

std::unique_ptr< PDFArray >

A Visibility Expression array.

GetVisibilityExpression Gets the Visibility Expression for this membership dictionary.

VisibilityPolicy get_visibility_policy()

Returns:

VisibilityPolicy

A Visibility Policy.

Gets the Visbility Policy for this membership dictionary.

OptionalContentMembershipDict & operator=(OptionalContentMembershipDict && )

Parameters

: OptionalContentMembershipDict &&

Returns:

OptionalContentMembershipDict &

bool operator==(const OptionalContentMembershipDict & other)

Parameters

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

Returns:

bool

true if both objects refer to the same membership dictionary; false otherwise.

Determines whether this OptionalContentMembershipDict is equal to another.

Two OptionalContentMembershipDict objects are considered equal if they refer to the same underlying PDOCMD object.

std::string to_string()

Returns:

std::string

A string describing this OptionalContentMembershipDict.

Returns a string representation of this OptionalContentMembershipDict.

The string includes the names of all associated OptionalContentGroups and the current VisibilityPolicy.