diff options
author | Kyle Auble <kyle.auble@outlook.com> | 2020-10-27 22:51:59 -0400 |
---|---|---|
committer | Albert Astals Cid <tsdgeos@yahoo.es> | 2021-02-14 10:56:05 +0000 |
commit | 133fb388029ec6e124e74b3a4111da20abe9ce7e (patch) | |
tree | 5b3d376b68a21ca683abec1e1a0d740ebd3333bc | |
parent | f58525e501684358a377b6412ea514a2ed8af333 (diff) |
glib: Document a recently added struct
-rw-r--r-- | glib/poppler-action.h | 20 |
1 files changed, 18 insertions, 2 deletions
diff --git a/glib/poppler-action.h b/glib/poppler-action.h index 52a5d90d..b4ea01e5 100644 --- a/glib/poppler-action.h +++ b/glib/poppler-action.h @@ -346,7 +346,7 @@ struct _PopplerActionRendition * PopplerActionOCGState: * @type: action type (%POPPLER_ACTION_OCG_STATE) * @title: action title - * @state_list: (element-type PopplerActionLayer): list of #PopplerActionLayer<-- -->s + * @state_list: (element-type PopplerActionLayer): list of #PopplerActionLayer<!-- -->s * * State of layer. * @@ -378,6 +378,22 @@ struct _PopplerActionJavascript gchar *script; }; +/** + * PopplerActionResetForm: + * @type: action type (%POPPLER_ACTION_RESET_FORM) + * @title: action title + * @fields: (element-type utf8) (nullable): list of field names to + * reset / retain + * @exclude: whether to reset all but the listed fields + * + * Resets some or all fields within a PDF form. + * + * The default behavior resets only the list of @fields, but setting + * @exclude to %TRUE will cause the action to reset all fields but those + * listed. Providing an empty list of fields resets the entire form. + * + * Since: 0.90 + */ struct _PopplerActionResetForm { PopplerActionType type; @@ -390,7 +406,7 @@ struct _PopplerActionResetForm /** * PopplerAction: * - * A data structure for holding actions + * A generic wrapper for actions that exposes only #PopplerActionType. */ union _PopplerAction { PopplerActionType type; |