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 |
- Exported types
- Methods
- buttonGetButtonType
- buttonGetState
- buttonSetState
- choiceCanSelectMultiple
- choiceCommitOnChange
- choiceDoSpellCheck
- choiceGetChoiceType
- choiceGetItem
- choiceGetNItems
- choiceGetText
- choiceIsEditable
- choiceIsItemSelected
- choiceSelectItem
- choiceSetText
- choiceToggleItem
- choiceUnselectAll
- getAction
- getAdditionalAction
- getAlternateUiName
- getFieldType
- getFontSize
- getId
- getMappingName
- getName
- getPartialName
- isReadOnly
- signatureValidateAsync
- signatureValidateFinish
- signatureValidateSync
- textDoScroll
- textDoSpellCheck
- textGetMaxLen
- textGetText
- textGetTextType
- textIsPassword
- textIsRichText
- textSetText
No description available in the introspection data.
Synopsis
- newtype FormField = FormField (ManagedPtr FormField)
- class (GObject o, IsDescendantOf FormField o) => IsFormField o
- toFormField :: (MonadIO m, IsFormField o) => o -> m FormField
- formFieldButtonGetButtonType :: (HasCallStack, MonadIO m, IsFormField a) => a -> m FormButtonType
- formFieldButtonGetState :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Bool
- formFieldButtonSetState :: (HasCallStack, MonadIO m, IsFormField a) => a -> Bool -> m ()
- formFieldChoiceCanSelectMultiple :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Bool
- formFieldChoiceCommitOnChange :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Bool
- formFieldChoiceDoSpellCheck :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Bool
- formFieldChoiceGetChoiceType :: (HasCallStack, MonadIO m, IsFormField a) => a -> m FormChoiceType
- formFieldChoiceGetItem :: (HasCallStack, MonadIO m, IsFormField a) => a -> Int32 -> m Text
- formFieldChoiceGetNItems :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Int32
- formFieldChoiceGetText :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Text
- formFieldChoiceIsEditable :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Bool
- formFieldChoiceIsItemSelected :: (HasCallStack, MonadIO m, IsFormField a) => a -> Int32 -> m Bool
- formFieldChoiceSelectItem :: (HasCallStack, MonadIO m, IsFormField a) => a -> Int32 -> m ()
- formFieldChoiceSetText :: (HasCallStack, MonadIO m, IsFormField a) => a -> Text -> m ()
- formFieldChoiceToggleItem :: (HasCallStack, MonadIO m, IsFormField a) => a -> Int32 -> m ()
- formFieldChoiceUnselectAll :: (HasCallStack, MonadIO m, IsFormField a) => a -> m ()
- formFieldGetAction :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Action
- formFieldGetAdditionalAction :: (HasCallStack, MonadIO m, IsFormField a) => a -> AdditionalActionType -> m Action
- formFieldGetAlternateUiName :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Text
- formFieldGetFieldType :: (HasCallStack, MonadIO m, IsFormField a) => a -> m FormFieldType
- formFieldGetFontSize :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Double
- formFieldGetId :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Int32
- formFieldGetMappingName :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Text
- formFieldGetName :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Text
- formFieldGetPartialName :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Text
- formFieldIsReadOnly :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Bool
- formFieldSignatureValidateAsync :: (HasCallStack, MonadIO m, IsFormField a, IsCancellable b) => a -> [SignatureValidationFlags] -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- formFieldSignatureValidateFinish :: (HasCallStack, MonadIO m, IsFormField a, IsAsyncResult b) => a -> b -> m SignatureInfo
- formFieldSignatureValidateSync :: (HasCallStack, MonadIO m, IsFormField a, IsCancellable b) => a -> [SignatureValidationFlags] -> Maybe b -> m SignatureInfo
- formFieldTextDoScroll :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Bool
- formFieldTextDoSpellCheck :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Bool
- formFieldTextGetMaxLen :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Int32
- formFieldTextGetText :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Text
- formFieldTextGetTextType :: (HasCallStack, MonadIO m, IsFormField a) => a -> m FormTextType
- formFieldTextIsPassword :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Bool
- formFieldTextIsRichText :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Bool
- formFieldTextSetText :: (HasCallStack, MonadIO m, IsFormField a) => a -> Text -> m ()
Exported types
Memory-managed wrapper type.
Instances
Eq FormField Source # | |
GObject FormField Source # | |
Defined in GI.Poppler.Objects.FormField | |
ManagedPtrNewtype FormField Source # | |
Defined in GI.Poppler.Objects.FormField toManagedPtr :: FormField -> ManagedPtr FormField | |
TypedObject FormField Source # | |
Defined in GI.Poppler.Objects.FormField | |
HasParentTypes FormField Source # | |
Defined in GI.Poppler.Objects.FormField | |
IsGValue (Maybe FormField) Source # | Convert |
Defined in GI.Poppler.Objects.FormField gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe FormField -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe FormField) | |
type ParentTypes FormField Source # | |
Defined in GI.Poppler.Objects.FormField type ParentTypes FormField = '[Object] |
class (GObject o, IsDescendantOf FormField o) => IsFormField o Source #
Type class for types which can be safely cast to FormField
, for instance with toFormField
.
Instances
(GObject o, IsDescendantOf FormField o) => IsFormField o Source # | |
Defined in GI.Poppler.Objects.FormField |
toFormField :: (MonadIO m, IsFormField o) => o -> m FormField Source #
Methods
Click to display all available methods, including inherited ones
Methods
bindProperty, bindPropertyFull, buttonGetButtonType, buttonGetState, buttonSetState, choiceCanSelectMultiple, choiceCommitOnChange, choiceDoSpellCheck, choiceGetChoiceType, choiceGetItem, choiceGetNItems, choiceGetText, choiceIsEditable, choiceIsItemSelected, choiceSelectItem, choiceSetText, choiceToggleItem, choiceUnselectAll, forceFloating, freezeNotify, getv, isFloating, isReadOnly, notify, notifyByPspec, ref, refSink, runDispose, signatureValidateAsync, signatureValidateFinish, signatureValidateSync, stealData, stealQdata, textDoScroll, textDoSpellCheck, textGetMaxLen, textGetText, textGetTextType, textIsPassword, textIsRichText, textSetText, thawNotify, unref, watchClosure.
Getters
getAction, getAdditionalAction, getAlternateUiName, getData, getFieldType, getFontSize, getId, getMappingName, getName, getPartialName, getProperty, getQdata.
Setters
buttonGetButtonType
formFieldButtonGetButtonType Source #
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m FormButtonType | Returns: |
Gets the button type of field
buttonGetState
formFieldButtonGetState Source #
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Bool | Returns: current state of |
buttonSetState
formFieldButtonSetState Source #
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> Bool | |
-> m () |
choiceCanSelectMultiple
formFieldChoiceCanSelectMultiple Source #
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Bool | Returns: |
Checks whether field
allows multiple choices to be selected
choiceCommitOnChange
formFieldChoiceCommitOnChange :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Bool Source #
No description available in the introspection data.
choiceDoSpellCheck
formFieldChoiceDoSpellCheck Source #
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Bool | Returns: |
Checks whether spell checking should be done for the contents of field
choiceGetChoiceType
formFieldChoiceGetChoiceType Source #
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m FormChoiceType | Returns: |
Gets the choice type of field
choiceGetItem
formFieldChoiceGetItem Source #
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> Int32 |
|
-> m Text | Returns: a new allocated string. It must be freed with |
Returns the contents of the item on field
at the given index
choiceGetNItems
formFieldChoiceGetNItems Source #
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Int32 | Returns: the number of items on |
Returns the number of items on field
choiceGetText
formFieldChoiceGetText Source #
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Text | Returns: a new allocated string. It must be freed with |
Retrieves the contents of field
.
choiceIsEditable
formFieldChoiceIsEditable Source #
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Bool | Returns: |
Checks whether field
is editable
choiceIsItemSelected
formFieldChoiceIsItemSelected Source #
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> Int32 |
|
-> m Bool | Returns: |
Checks whether the item at the given index on field
is currently selected
choiceSelectItem
formFieldChoiceSelectItem Source #
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> Int32 |
|
-> m () |
Selects the item at the given index on field
choiceSetText
formFieldChoiceSetText Source #
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the text in field
to the given value, replacing the current contents
choiceToggleItem
formFieldChoiceToggleItem Source #
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> Int32 |
|
-> m () |
Changes the state of the item at the given index
choiceUnselectAll
formFieldChoiceUnselectAll Source #
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m () |
Unselects all the items on field
getAction
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Action | Returns: the action to perform. The returned
object is owned by |
getAdditionalAction
formFieldGetAdditionalAction Source #
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> AdditionalActionType |
|
-> m Action | Returns: the action to perform. The returned
object is owned by |
getAlternateUiName
formFieldGetAlternateUiName Source #
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Text | Returns: a new allocated string. It must be freed with |
Gets the alternate ui name of field
. This name is also commonly
used by pdf producers/readers to show it as a tooltip when field
area
is hovered by a pointing device (eg. mouse).
Since: 0.88
getFieldType
formFieldGetFieldType Source #
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m FormFieldType | Returns: |
Gets the type of field
getFontSize
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Double | Returns: the font size of |
Gets the font size of field
WARNING: This function always returns 0. Contact the poppler mailing list if you're interested in implementing it properly
getId
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Int32 | Returns: the id of |
Gets the id of field
getMappingName
formFieldGetMappingName Source #
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Text | Returns: a new allocated string. It must be freed with |
Gets the mapping name of field
that is used when
exporting interactive form field data from the document
Since: 0.16
getName
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Text | Returns: a new allocated string. It must be freed with |
Gets the fully qualified name of field
. It's constructed by concatenating
the partial field names of the field and all of its ancestors.
Since: 0.16
getPartialName
formFieldGetPartialName Source #
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Text | Returns: a new allocated string. It must be freed with |
Gets the partial name of field
.
Since: 0.16
isReadOnly
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Bool | Returns: |
Checks whether field
is read only
signatureValidateAsync
formFieldSignatureValidateAsync Source #
:: (HasCallStack, MonadIO m, IsFormField a, IsCancellable b) | |
=> a |
|
-> [SignatureValidationFlags] |
|
-> Maybe b |
|
-> Maybe AsyncReadyCallback |
|
-> m () |
Asynchronously validates the cryptographic signature contained in signatureField
.
Since: 21.12.0
signatureValidateFinish
formFieldSignatureValidateFinish Source #
:: (HasCallStack, MonadIO m, IsFormField a, IsAsyncResult b) | |
=> a |
|
-> b |
|
-> m SignatureInfo | Returns: a |
Finishes validation of the cryptographic signature contained in signatureField
.
See formFieldSignatureValidateAsync
.
Since: 21.12.0
signatureValidateSync
formFieldSignatureValidateSync Source #
:: (HasCallStack, MonadIO m, IsFormField a, IsCancellable b) | |
=> a |
|
-> [SignatureValidationFlags] |
|
-> Maybe b |
|
-> m SignatureInfo | Returns: a |
Synchronously validates the cryptographic signature contained in signatureField
.
Since: 21.12.0
textDoScroll
formFieldTextDoScroll :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Bool Source #
No description available in the introspection data.
textDoSpellCheck
formFieldTextDoSpellCheck Source #
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Bool | Returns: |
Checks whether spell checking should be done for the contents of field
textGetMaxLen
formFieldTextGetMaxLen Source #
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Int32 | Returns: the maximum allowed number of characters in |
Retrieves the maximum allowed length of the text in field
textGetText
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Text | Returns: a new allocated string. It must be freed with |
Retrieves the contents of field
.
textGetTextType
formFieldTextGetTextType Source #
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m FormTextType | Returns: |
Gets the text type of field
.
textIsPassword
formFieldTextIsPassword Source #
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Bool | Returns: |
Checks whether content of field
is a password and it must be hidden
textIsRichText
formFieldTextIsRichText Source #
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Bool | Returns: |
Checks whether the contents of field
are rich text
textSetText
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the text in field
to the given value, replacing the current contents.