typedef struct _t_PDOCG *PDOCG; false. ASBool PDOCGEnumProc(PDOCG ocg, void *clientData); ocg | IN/OUT The optional-content group object.
|
clientData | IN/OUT A pointer to user-supplied data to pass to the proc each time it is called.
|
PDOCG PDOCGCreate(PDDoc pdDoc, ASConstText name); pdDoc | The document in which the group is used.
|
name | The name of the optional-content group.
|
PDOCG PDOCGCreateFromCosObj(CosObj ocgObj); ocgObj | The Cos object.
|
void PDOCGDestroy(PDOCG pdocg); pdocg | The optional-content group object.
|
CosObj PDOCGGetCosObj(PDOCG pdocg); pdocg | The optional-content group object.
|
ON-OFF state of the optional-content group (OCG) object in a given context. ASBool PDOCGGetCurrentState(PDOCG pdocg, PDOCContext ocContext); pdocg | The optional-content group object.
|
ocContext | The context for which to get the group's state.
|
PDOCG PDOCGGetFromCosObj(CosObj obj); obj | The Cos object.
|
ON or OFF) of the optional-content group (OCG) object in a given configuration. If the configuration has a BaseState of Unchanged, and the OCG is not listed explicitly in its ON list or OFF list, then the initial state is taken from the OCG's current state in the document's default context, and the method returns false. ASBool PDOCGGetInitialState(PDOCG pdocg, PDOCConfig pdOCCfg, ASBool *initState); pdocg | The optional-content group object.
|
pdOCCfg | The configuration for which to get the group's initial state.
|
initState |
Gets the intent list for an optional-content group. An intent is an ASAtom value broadly describing the intended use, either View or Design.
A group's content is considered to be optional (that is, the group's state is considered in its visibility) if any intent in its list matches an intent of the context. The intent list of the context is usually set from the intent list of the document configuration.
ASAtom *PDOCGGetIntent(PDOCG pdocg); pdocg | The optional-content group object for which the intent is desired.
|
ASBool PDOCGGetLocked(PDOCG ocg, PDOCConfig pdOCCfg); ocg | |
pdOCCfg | IN The optional-content configuration.
|
ASText PDOCGGetName(PDOCG pdocg); pdocg | The optional-content group object for which the name is desired.
|
PDDoc PDOCGGetPDDoc(PDOCG pdocg); pdocg | The optional-content group object for which the document is desired.
|
CreatorInfoLanguageExportZoomPrintViewUserPageElementCosObj PDOCGGetUsageEntry(PDOCG pdocg, ASAtom entry); pdocg | The optional-content group object.
|
entry | The usage key in the usage dictionary entry.
|
NULL Cos object if the operation fails (because the OCG is malformed or has no dictionary, or because the dictionary has no entry corresponding to the given key). Tests whether the optional-content group is marked as having had its state set directly by client code in the specified context (as opposed to automatically by the optional-content AutoState mechanism).
When a group is so marked, automatic state changes caused by the View event are prevented. When a group's automatic state change is caused by the Export or Print event, the user-override setting for the group is ignored.
A configuration's AS array defines how usage entries are used to automatically manipulate the OCG states. It associates an event ( View, Print, or Export) with a list of OCGs and a category, or list of usage keys identifying OCG usage dictionary entries.
ASBool PDOCGGetUserOverride(PDOCG ocg, PDOCContext ctx); ocg | The optional-content group object.
|
ctx | The context for which the group is tested.
|
ASBool PDOCGHasUsageInfo(PDOCG pdocg); pdocg | The optional-content group object.
|
ON-OFF state information for the optional-content group (OCG) object in a given configuration. void PDOCGRemoveInitialState(PDOCG pdocg, PDOCConfig pdOCCfg); pdocg | The optional-content group object.
|
pdOCCfg | The configuration for which to remove the group's initial state.
|
ON-OFF state of the optional-content group (OCG) object in a given context. void PDOCGSetCurrentState(PDOCG pdocg, PDOCContext ocContext, ASBool newState); pdocg | The optional-content group object.
|
ocContext | The context for which to set the group's state.
|
newState | The new state.
|
ON or OFF) of the optional-content group (OCG) object in a given configuration. void PDOCGSetInitialState(PDOCG pdocg, PDOCConfig pdOCCfg, ASBool onOff); pdocg | The optional-content group object.
|
pdOCCfg | The configuration for which to set the group's initial state.
|
onOff |
Sets the Intent entry in an optional-content group's Cos dictionary. An intent is an ASAtom value broadly describing the intended use, which can be either View or Design.
A group's content is considered to be optional (that is, the group's state is considered in its visibility) if any intent in its list matches an intent of the context. The intent list of the context is usually set from the intent list of the document configuration.
void PDOCGSetIntent(PDOCG pdocg, ASAtom *intent); pdocg | The optional-content group object for which the intent is desired.
|
intent | The new Intent entry value, an array of atoms terminated with ASAtomNull.
|
void PDOCGSetLocked(PDOCG ocg, PDOCConfig pdOCCfg, ASBool locked); ocg | |
pdOCCfg | IN/OUT The optional-content configuration.
|
locked |
void PDOCGSetName(PDOCG pdocg, ASConstText name); pdocg | The optional-content group object.
|
name | The new name string.
|
Sets a Usage dictionary entry in an optional-content group (OCG) object. The entry associates usage information with an entry key for retrieval. If a dictionary does not exist, the method creates one.
A Usage dictionary entry provides more specific intended usage information than an intent entry. The possible key values are:
CreatorInfoLanguageExportZoomPrintViewUserPageElement
The usage value can act as a kind of metadata, describing the sort of things that belong to the group, such as text in French, fine detail on a map, or a watermark. The usage values can also be used by the AutoState mechanism to make decisions about what groups should be on and what groups should be off. The AutoState mechanism considers the usage information in the OCGs, the AS array of the configuration, and external factors; for example, the language the application is running in, the current zoom level on the page, or if the page is being printed.
void PDOCGSetUsageDictEntry(PDOCG pdocg, ASAtom usagekey, CosObj usageinfo); pdocg | The optional-content group object.
|
usagekey | The usage entry key.
|
usageinfo | The usage information to associate with the key.
|
Marks the optional-content group as having had its state set directly by client code in the specified context (as opposed to automatically by the optional-content AutoState mechanism).
When a group is so marked, automatic state changes caused by the View event are prevented. When a group's automatic state change is caused by the Export or Print event, the user-override setting for the group is ignored.
A configuration's AS array defines how usage entries are used to automatically manipulate the OCG states. It associates an event ( View, Print, or Export) with a list of OCGs and a category, or list of usage keys identifying OCG usage dictionary entries.
void PDOCGSetUserOverride(PDOCG ocg, PDOCContext ctx, ASBool overridden); ocg | The optional-content group object.
|
ctx | The context for which the group is marked.
|
overridden |
Tests whether an optional-content group (OCG) object is used in a context initialized using the given configuration.
A group's content is considered to be optional (that is, the group's state is considered in its visibility) if any intent in its list matches an intent of the context. The intent list of the context is usually set from the intent list of the document configuration.
ASBool PDOCGUsedInOCConfig(PDOCG pdocg, PDOCConfig pdoccfg); pdocg | The optional-content group object.
|
pdoccfg | The optional-content configuration.
|
Tests whether an optional-content group (OCG) object is used in a given context.
A group's content is considered to be optional (that is, the group's state is considered in its visibility) if any intent in its list matches an intent of the context. The intent list of the context is usually set from the intent list of the document configuration.
ASBool PDOCGUsedInOCContext(PDOCG pdocg, PDOCContext pdocctx); pdocg | The optional-content group object.
|
pdocctx | The optional-content context.
|