Value options for PDOCConfigBaseState.
kPDOCBaseState_OFF | |
kPDOCBaseState_ON | |
kPDOCBaseState_Unchanged |
typedef struct _t_PDOCConfig *PDOCConfig; For value options see PDOCConfigBaseStates.
typedef ASUns8 PDOCConfigBaseState; false. ASBool PDOCConfigEnumProc(PDOCConfig occonfig, void *clientData); occonfig | The optional-content configuration object.
|
clientData | A pointer to user-supplied data to pass to the proc each time it is called.
|
PDOCConfig PDOCConfigCreate(PDDoc pdDoc); pdDoc | The document in which the configuration is used.
|
void PDOCConfigDestroy(PDOCConfig pdOCCfg); pdOCCfg | The configuration to destroy.
|
ON at one time. PDOCG **PDOCConfigGetAllRadioButtonGroups(PDOCConfig pdOCCfg); pdOCCfg | The configuration.
|
CosObj PDOCConfigGetCosObj(PDOCConfig pdOCCfg); pdOCCfg | The configuration for which a CosObj representation is desired.
|
ASText PDOCConfigGetCreator(PDOCConfig pdOCCfg); pdOCCfg | The configuration for which a creator is desired.
|
NULL if there is no such entry. The client is responsible for freeing the ASText using ASTextDestroy(). Gets the initial ON-OFF states of optional-content groups in an optional-content configuration.
The client is responsible for freeing storage for the arrays using ASfree().
void PDOCConfigGetInitState(PDOCConfig pdOCCfg, PDOCConfigBaseState *bs, PDOCG **onOCGs, PDOCG **offOCGs); pdOCCfg | The configuration for which the initial state is desired.
|
bs | (Filled by the method) An existing PDOCConfigBaseState structure in which to store the initialization information.
|
onOCGs | |
offOCGs |
Gets the Intent entry for an optional-content configuration. 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.
The intent array contains entries (atoms) terminated by ASAtomNull.
If the configuration has no Intent entry, the default value of View is used. In this case, optional content is disabled for contexts initialized with this configuration.
ASAtom *PDOCConfigGetIntent(PDOCConfig pdOCCfg); pdOCCfg | The configuration for which an intent list is desired.
|
PDOCG *PDOCConfigGetLockedArray(PDOCConfig pdOCCfg); pdOCCfg | The optional-content configuration.
|
ASText PDOCConfigGetName(PDOCConfig pdOCCfg); pdOCCfg | The configuration for which a name is desired.
|
NULL if there is no Name entry. The client is responsible for freeing the ASText object using ASTextDestroy(). ASBool PDOCConfigGetOCGOrder(PDOCConfig pdOCCfg, CosObj *orderObj); pdOCCfg | The configuration for which an OCG display order is desired.
|
orderObj | (Filled by the method) A pointer to the Cos object containing the OCG order array. See the description of the Optional Content Groups (OCG) in the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 8.11.2, page 222. You can find this document on the web store of the International Standards Organization (ISO). |
PDDoc PDOCConfigGetPDDoc(PDOCConfig pdOCCfg); pdOCCfg | The configuration for which a document is desired.
|
ON at one time. PDOCG *PDOCConfigGetRadioButtonGroupForOCG(PDOCConfig pdOCCfg, PDOCG ocg); pdOCCfg | The optional-content configuration.
|
ocg | The optional-content group for which to obtain the radio-button group.
|
ON at a time. A client must enforce this in the user interface-level code, not the PD-level code. void PDOCConfigMakeRadioButtonGroup(PDOCConfig pdOCCfg, PDOCG *ocgs); pdOCCfg | The optional-content configuration.
|
ocgs | A
NULL-terminated array of optional-content groups to be included in the group. |
void PDOCConfigSetCreator(PDOCConfig pdOCCfg, ASConstText creator); pdOCCfg | The configuration for which to set a creator.
|
creator | The new creator string.
|
ON-OFF states of optional-content groups to be saved in an optional-content configuration. void PDOCConfigSetInitState(PDOCConfig pdOCCfg, PDOCConfigBaseState bs, PDOCG *onOCGs, PDOCG *offOCGs); pdOCCfg | The configuration for which to set the initial state.
|
bs | An existing PDOCConfigBaseState structure containing the initialization information.
|
onOCGs | |
offOCGs |
Sets the Intent entry in an optional-content configuration's Cos dictionary. 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.
If the configuration has no Intent entry, the default value of View is used. In this case, optional content is disabled for contexts initialized with this configuration.
void PDOCConfigSetIntent(PDOCConfig pdOCCfg, ASAtom *intent); pdOCCfg | The configuration for which to set an intent.
|
intent | The new Intent entry value, an array of atoms terminated with ASAtomNull. To remove the Intent entry, pass an array with only one element, ASAtom
NULL. |
void PDOCConfigSetLockedArray(PDOCConfig pdOCCfg, PDOCG *lockedOCGs); pdOCCfg | The optional-content configuration.
|
lockedOCGs |
void PDOCConfigSetName(PDOCConfig pdOCCfg, ASConstText name); pdOCCfg | The configuration for which to set the name.
|
name | The new name string.
|
void PDOCConfigSetOCGOrder(PDOCConfig pdOCCfg, CosObj orderArray); pdOCCfg | The configuration for which a OCG is desired.
|
orderArray | The Cos object containing the OCG order array. See the description of the Optional Content Groups (OCG) in the ISO 32000-1:2008, Document Management-Portable Document Format-Part 1: PDF 1.7, section 8.11.2, page 222. You can find this document on the web store of the International Standards Organization (ISO). Pass NULL to remove any existing order entry. |