Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	Safe-Inferred
Language	Haskell2010

GI.Poppler.Structs.ActionResetForm

Contents

Exported types
Methods
Properties

Description

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

Synopsis

newtype ActionResetForm = ActionResetForm (ManagedPtr ActionResetForm)
newZeroActionResetForm :: MonadIO m => m ActionResetForm
getActionResetFormExclude :: MonadIO m => ActionResetForm -> m Bool
setActionResetFormExclude :: MonadIO m => ActionResetForm -> Bool -> m ()
clearActionResetFormFields :: MonadIO m => ActionResetForm -> m ()
getActionResetFormFields :: MonadIO m => ActionResetForm -> m [Text]
setActionResetFormFields :: MonadIO m => ActionResetForm -> Ptr (GList CString) -> m ()
clearActionResetFormTitle :: MonadIO m => ActionResetForm -> m ()
getActionResetFormTitle :: MonadIO m => ActionResetForm -> m (Maybe Text)
setActionResetFormTitle :: MonadIO m => ActionResetForm -> CString -> m ()
getActionResetFormType :: MonadIO m => ActionResetForm -> m ActionType
setActionResetFormType :: MonadIO m => ActionResetForm -> ActionType -> m ()

Exported types

newtype ActionResetForm Source #

Memory-managed wrapper type.

Constructors

ActionResetForm (ManagedPtr ActionResetForm)

Instances

Instances details

Eq ActionResetForm Source #
Instance details Defined in GI.Poppler.Structs.ActionResetForm Methods (==) :: ActionResetForm -> ActionResetForm -> Bool # (/=) :: ActionResetForm -> ActionResetForm -> Bool #
BoxedPtr ActionResetForm Source #
Instance details Defined in GI.Poppler.Structs.ActionResetForm Methods boxedPtrCopy :: ActionResetForm -> IO ActionResetForm boxedPtrFree :: ActionResetForm -> IO ()
CallocPtr ActionResetForm Source #
Instance details Defined in GI.Poppler.Structs.ActionResetForm Methods boxedPtrCalloc :: IO (Ptr ActionResetForm)
ManagedPtrNewtype ActionResetForm Source #
Instance details Defined in GI.Poppler.Structs.ActionResetForm Methods toManagedPtr :: ActionResetForm -> ManagedPtr ActionResetForm
tag ~ 'AttrSet => Constructible ActionResetForm tag Source #
Instance details Defined in GI.Poppler.Structs.ActionResetForm Methods new :: MonadIO m => (ManagedPtr ActionResetForm -> ActionResetForm) -> [AttrOp ActionResetForm tag] -> m ActionResetForm

newZeroActionResetForm :: MonadIO m => m ActionResetForm Source #

Construct a ActionResetForm struct initialized to zero.

Methods

Properties

exclude

whether to reset all but the listed fields

getActionResetFormExclude :: MonadIO m => ActionResetForm -> m Bool Source #

Get the value of the “exclude” field. When overloading is enabled, this is equivalent to

get actionResetForm #exclude

setActionResetFormExclude :: MonadIO m => ActionResetForm -> Bool -> m () Source #

Set the value of the “exclude” field. When overloading is enabled, this is equivalent to

set actionResetForm [ #exclude := value ]

fields

list of field names to reset / retain

clearActionResetFormFields :: MonadIO m => ActionResetForm -> m () Source #

Set the value of the “fields” field to Nothing. When overloading is enabled, this is equivalent to

clear #fields

getActionResetFormFields :: MonadIO m => ActionResetForm -> m [Text] Source #

Get the value of the “fields” field. When overloading is enabled, this is equivalent to

get actionResetForm #fields

setActionResetFormFields :: MonadIO m => ActionResetForm -> Ptr (GList CString) -> m () Source #

Set the value of the “fields” field. When overloading is enabled, this is equivalent to

set actionResetForm [ #fields := value ]

title

action title

clearActionResetFormTitle :: MonadIO m => ActionResetForm -> m () Source #

Set the value of the “title” field to Nothing. When overloading is enabled, this is equivalent to

clear #title

getActionResetFormTitle :: MonadIO m => ActionResetForm -> m (Maybe Text) Source #

Get the value of the “title” field. When overloading is enabled, this is equivalent to

get actionResetForm #title

setActionResetFormTitle :: MonadIO m => ActionResetForm -> CString -> m () Source #

Set the value of the “title” field. When overloading is enabled, this is equivalent to

set actionResetForm [ #title := value ]

type

action type (ActionTypeResetForm)

getActionResetFormType :: MonadIO m => ActionResetForm -> m ActionType Source #

Get the value of the “type” field. When overloading is enabled, this is equivalent to

get actionResetForm #type

setActionResetFormType :: MonadIO m => ActionResetForm -> ActionType -> m () Source #

Set the value of the “type” field. When overloading is enabled, this is equivalent to

set actionResetForm [ #type := value ]