Copyright | Will Thompson, Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
GI.Poppler.Objects.FormField
Contents
- Exported types
- Methods
- buttonGetButtonType
- buttonGetState
- buttonSetState
- choiceCanSelectMultiple
- choiceCommitOnChange
- choiceDoSpellCheck
- choiceGetChoiceType
- choiceGetItem
- choiceGetNItems
- choiceGetText
- choiceIsEditable
- choiceIsItemSelected
- choiceSelectItem
- choiceSetText
- choiceToggleItem
- choiceUnselectAll
- getAction
- getFieldType
- getFontSize
- getId
- getMappingName
- getName
- getPartialName
- isReadOnly
- textDoScroll
- textDoSpellCheck
- textGetMaxLen
- textGetText
- textGetTextType
- textIsPassword
- textIsRichText
- textSetText
Description
- newtype FormField = FormField (ManagedPtr FormField)
- class GObject o => IsFormField o
- toFormField :: IsFormField o => o -> IO FormField
- noFormField :: Maybe FormField
- data FormFieldButtonGetButtonTypeMethodInfo
- formFieldButtonGetButtonType :: (HasCallStack, MonadIO m, IsFormField a) => a -> m FormButtonType
- data FormFieldButtonGetStateMethodInfo
- formFieldButtonGetState :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Bool
- data FormFieldButtonSetStateMethodInfo
- formFieldButtonSetState :: (HasCallStack, MonadIO m, IsFormField a) => a -> Bool -> m ()
- data FormFieldChoiceCanSelectMultipleMethodInfo
- formFieldChoiceCanSelectMultiple :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Bool
- data FormFieldChoiceCommitOnChangeMethodInfo
- formFieldChoiceCommitOnChange :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Bool
- data FormFieldChoiceDoSpellCheckMethodInfo
- formFieldChoiceDoSpellCheck :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Bool
- data FormFieldChoiceGetChoiceTypeMethodInfo
- formFieldChoiceGetChoiceType :: (HasCallStack, MonadIO m, IsFormField a) => a -> m FormChoiceType
- data FormFieldChoiceGetItemMethodInfo
- formFieldChoiceGetItem :: (HasCallStack, MonadIO m, IsFormField a) => a -> Int32 -> m Text
- data FormFieldChoiceGetNItemsMethodInfo
- formFieldChoiceGetNItems :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Int32
- data FormFieldChoiceGetTextMethodInfo
- formFieldChoiceGetText :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Text
- data FormFieldChoiceIsEditableMethodInfo
- formFieldChoiceIsEditable :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Bool
- data FormFieldChoiceIsItemSelectedMethodInfo
- formFieldChoiceIsItemSelected :: (HasCallStack, MonadIO m, IsFormField a) => a -> Int32 -> m Bool
- data FormFieldChoiceSelectItemMethodInfo
- formFieldChoiceSelectItem :: (HasCallStack, MonadIO m, IsFormField a) => a -> Int32 -> m ()
- data FormFieldChoiceSetTextMethodInfo
- formFieldChoiceSetText :: (HasCallStack, MonadIO m, IsFormField a) => a -> Text -> m ()
- data FormFieldChoiceToggleItemMethodInfo
- formFieldChoiceToggleItem :: (HasCallStack, MonadIO m, IsFormField a) => a -> Int32 -> m ()
- data FormFieldChoiceUnselectAllMethodInfo
- formFieldChoiceUnselectAll :: (HasCallStack, MonadIO m, IsFormField a) => a -> m ()
- data FormFieldGetActionMethodInfo
- formFieldGetAction :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Action
- data FormFieldGetFieldTypeMethodInfo
- formFieldGetFieldType :: (HasCallStack, MonadIO m, IsFormField a) => a -> m FormFieldType
- data FormFieldGetFontSizeMethodInfo
- formFieldGetFontSize :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Double
- data FormFieldGetIdMethodInfo
- formFieldGetId :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Int32
- data FormFieldGetMappingNameMethodInfo
- formFieldGetMappingName :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Text
- data FormFieldGetNameMethodInfo
- formFieldGetName :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Text
- data FormFieldGetPartialNameMethodInfo
- formFieldGetPartialName :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Text
- data FormFieldIsReadOnlyMethodInfo
- formFieldIsReadOnly :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Bool
- data FormFieldTextDoScrollMethodInfo
- formFieldTextDoScroll :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Bool
- data FormFieldTextDoSpellCheckMethodInfo
- formFieldTextDoSpellCheck :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Bool
- data FormFieldTextGetMaxLenMethodInfo
- formFieldTextGetMaxLen :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Int32
- data FormFieldTextGetTextMethodInfo
- formFieldTextGetText :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Text
- data FormFieldTextGetTextTypeMethodInfo
- formFieldTextGetTextType :: (HasCallStack, MonadIO m, IsFormField a) => a -> m FormTextType
- data FormFieldTextIsPasswordMethodInfo
- formFieldTextIsPassword :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Bool
- data FormFieldTextIsRichTextMethodInfo
- formFieldTextIsRichText :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Bool
- data FormFieldTextSetTextMethodInfo
- formFieldTextSetText :: (HasCallStack, MonadIO m, IsFormField a) => a -> Text -> m ()
Exported types
Constructors
FormField (ManagedPtr FormField) |
Instances
GObject FormField Source # | |
IsObject FormField Source # | |
IsFormField FormField Source # | |
((~) * info (ResolveFormFieldMethod t FormField), MethodInfo * info FormField p) => IsLabel t (FormField -> p) Source # | |
((~) * info (ResolveFormFieldMethod t FormField), MethodInfo * info FormField p) => IsLabelProxy t (FormField -> p) Source # | |
HasAttributeList * FormField Source # | |
type AttributeList FormField Source # | |
type SignalList FormField Source # | |
class GObject o => IsFormField o Source #
Instances
toFormField :: IsFormField o => o -> IO FormField Source #
Methods
buttonGetButtonType
data FormFieldButtonGetButtonTypeMethodInfo Source #
Instances
((~) * signature (m FormButtonType), MonadIO m, IsFormField a) => MethodInfo * FormFieldButtonGetButtonTypeMethodInfo a signature Source # | |
formFieldButtonGetButtonType Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m FormButtonType | Returns: |
Gets the button type of field
buttonGetState
data FormFieldButtonGetStateMethodInfo Source #
Instances
((~) * signature (m Bool), MonadIO m, IsFormField a) => MethodInfo * FormFieldButtonGetStateMethodInfo a signature Source # | |
formFieldButtonGetState Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Bool | Returns: current state of |
buttonSetState
data FormFieldButtonSetStateMethodInfo Source #
Instances
((~) * signature (Bool -> m ()), MonadIO m, IsFormField a) => MethodInfo * FormFieldButtonSetStateMethodInfo a signature Source # | |
formFieldButtonSetState Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> Bool | |
-> m () |
choiceCanSelectMultiple
data FormFieldChoiceCanSelectMultipleMethodInfo Source #
Instances
((~) * signature (m Bool), MonadIO m, IsFormField a) => MethodInfo * FormFieldChoiceCanSelectMultipleMethodInfo a signature Source # | |
formFieldChoiceCanSelectMultiple Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Bool | Returns: |
Checks whether field
allows multiple choices to be selected
choiceCommitOnChange
data FormFieldChoiceCommitOnChangeMethodInfo Source #
Instances
((~) * signature (m Bool), MonadIO m, IsFormField a) => MethodInfo * FormFieldChoiceCommitOnChangeMethodInfo a signature Source # | |
formFieldChoiceCommitOnChange :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Bool Source #
No description available in the introspection data.
choiceDoSpellCheck
data FormFieldChoiceDoSpellCheckMethodInfo Source #
Instances
((~) * signature (m Bool), MonadIO m, IsFormField a) => MethodInfo * FormFieldChoiceDoSpellCheckMethodInfo a signature Source # | |
formFieldChoiceDoSpellCheck Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Bool | Returns: |
Checks whether spell checking should be done for the contents of field
choiceGetChoiceType
data FormFieldChoiceGetChoiceTypeMethodInfo Source #
Instances
((~) * signature (m FormChoiceType), MonadIO m, IsFormField a) => MethodInfo * FormFieldChoiceGetChoiceTypeMethodInfo a signature Source # | |
formFieldChoiceGetChoiceType Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m FormChoiceType | Returns: |
Gets the choice type of field
choiceGetItem
data FormFieldChoiceGetItemMethodInfo Source #
Instances
((~) * signature (Int32 -> m Text), MonadIO m, IsFormField a) => MethodInfo * FormFieldChoiceGetItemMethodInfo a signature Source # | |
formFieldChoiceGetItem Source #
Arguments
:: (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
data FormFieldChoiceGetNItemsMethodInfo Source #
Instances
((~) * signature (m Int32), MonadIO m, IsFormField a) => MethodInfo * FormFieldChoiceGetNItemsMethodInfo a signature Source # | |
formFieldChoiceGetNItems Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Int32 | Returns: the number of items on |
Returns the number of items on field
choiceGetText
data FormFieldChoiceGetTextMethodInfo Source #
Instances
((~) * signature (m Text), MonadIO m, IsFormField a) => MethodInfo * FormFieldChoiceGetTextMethodInfo a signature Source # | |
formFieldChoiceGetText Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Text | Returns: a new allocated string. It must be freed with |
Retrieves the contents of field
.
choiceIsEditable
data FormFieldChoiceIsEditableMethodInfo Source #
Instances
((~) * signature (m Bool), MonadIO m, IsFormField a) => MethodInfo * FormFieldChoiceIsEditableMethodInfo a signature Source # | |
formFieldChoiceIsEditable Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Bool | Returns: |
Checks whether field
is editable
choiceIsItemSelected
data FormFieldChoiceIsItemSelectedMethodInfo Source #
Instances
((~) * signature (Int32 -> m Bool), MonadIO m, IsFormField a) => MethodInfo * FormFieldChoiceIsItemSelectedMethodInfo a signature Source # | |
formFieldChoiceIsItemSelected Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> Int32 |
|
-> m Bool | Returns: |
Checks whether the item at the given index on field
is currently selected
choiceSelectItem
data FormFieldChoiceSelectItemMethodInfo Source #
Instances
((~) * signature (Int32 -> m ()), MonadIO m, IsFormField a) => MethodInfo * FormFieldChoiceSelectItemMethodInfo a signature Source # | |
formFieldChoiceSelectItem Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> Int32 |
|
-> m () |
Selects the item at the given index on field
choiceSetText
data FormFieldChoiceSetTextMethodInfo Source #
Instances
((~) * signature (Text -> m ()), MonadIO m, IsFormField a) => MethodInfo * FormFieldChoiceSetTextMethodInfo a signature Source # | |
formFieldChoiceSetText Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the text in field
to the given value, replacing the current contents
choiceToggleItem
data FormFieldChoiceToggleItemMethodInfo Source #
Instances
((~) * signature (Int32 -> m ()), MonadIO m, IsFormField a) => MethodInfo * FormFieldChoiceToggleItemMethodInfo a signature Source # | |
formFieldChoiceToggleItem Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> Int32 |
|
-> m () |
Changes the state of the item at the given index
choiceUnselectAll
data FormFieldChoiceUnselectAllMethodInfo Source #
Instances
((~) * signature (m ()), MonadIO m, IsFormField a) => MethodInfo * FormFieldChoiceUnselectAllMethodInfo a signature Source # | |
formFieldChoiceUnselectAll Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m () |
Unselects all the items on field
getAction
data FormFieldGetActionMethodInfo Source #
Instances
((~) * signature (m Action), MonadIO m, IsFormField a) => MethodInfo * FormFieldGetActionMethodInfo a signature Source # | |
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Action | Returns: the action to perform. The returned
object is owned by |
getFieldType
data FormFieldGetFieldTypeMethodInfo Source #
Instances
((~) * signature (m FormFieldType), MonadIO m, IsFormField a) => MethodInfo * FormFieldGetFieldTypeMethodInfo a signature Source # | |
formFieldGetFieldType Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m FormFieldType | Returns: |
Gets the type of field
getFontSize
data FormFieldGetFontSizeMethodInfo Source #
Instances
((~) * signature (m Double), MonadIO m, IsFormField a) => MethodInfo * FormFieldGetFontSizeMethodInfo a signature Source # | |
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Double | Returns: the font size of |
Gets the font size of field
getId
data FormFieldGetIdMethodInfo Source #
Instances
((~) * signature (m Int32), MonadIO m, IsFormField a) => MethodInfo * FormFieldGetIdMethodInfo a signature Source # | |
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Int32 | Returns: the id of |
Gets the id of field
getMappingName
data FormFieldGetMappingNameMethodInfo Source #
Instances
((~) * signature (m Text), MonadIO m, IsFormField a) => MethodInfo * FormFieldGetMappingNameMethodInfo a signature Source # | |
formFieldGetMappingName Source #
Arguments
:: (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
data FormFieldGetNameMethodInfo Source #
Instances
((~) * signature (m Text), MonadIO m, IsFormField a) => MethodInfo * FormFieldGetNameMethodInfo a signature Source # | |
Arguments
:: (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
data FormFieldGetPartialNameMethodInfo Source #
Instances
((~) * signature (m Text), MonadIO m, IsFormField a) => MethodInfo * FormFieldGetPartialNameMethodInfo a signature Source # | |
formFieldGetPartialName Source #
Arguments
:: (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
data FormFieldIsReadOnlyMethodInfo Source #
Instances
((~) * signature (m Bool), MonadIO m, IsFormField a) => MethodInfo * FormFieldIsReadOnlyMethodInfo a signature Source # | |
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Bool | Returns: |
Checks whether field
is read only
textDoScroll
data FormFieldTextDoScrollMethodInfo Source #
Instances
((~) * signature (m Bool), MonadIO m, IsFormField a) => MethodInfo * FormFieldTextDoScrollMethodInfo a signature Source # | |
formFieldTextDoScroll :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Bool Source #
No description available in the introspection data.
textDoSpellCheck
data FormFieldTextDoSpellCheckMethodInfo Source #
Instances
((~) * signature (m Bool), MonadIO m, IsFormField a) => MethodInfo * FormFieldTextDoSpellCheckMethodInfo a signature Source # | |
formFieldTextDoSpellCheck Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Bool | Returns: |
Checks whether spell checking should be done for the contents of field
textGetMaxLen
data FormFieldTextGetMaxLenMethodInfo Source #
Instances
((~) * signature (m Int32), MonadIO m, IsFormField a) => MethodInfo * FormFieldTextGetMaxLenMethodInfo a signature Source # | |
formFieldTextGetMaxLen Source #
Arguments
:: (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
data FormFieldTextGetTextMethodInfo Source #
Instances
((~) * signature (m Text), MonadIO m, IsFormField a) => MethodInfo * FormFieldTextGetTextMethodInfo a signature Source # | |
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Text | Returns: a new allocated string. It must be freed with |
Retrieves the contents of field
.
textGetTextType
data FormFieldTextGetTextTypeMethodInfo Source #
Instances
((~) * signature (m FormTextType), MonadIO m, IsFormField a) => MethodInfo * FormFieldTextGetTextTypeMethodInfo a signature Source # | |
formFieldTextGetTextType Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m FormTextType | Returns: |
Gets the text type of field
.
textIsPassword
data FormFieldTextIsPasswordMethodInfo Source #
Instances
((~) * signature (m Bool), MonadIO m, IsFormField a) => MethodInfo * FormFieldTextIsPasswordMethodInfo a signature Source # | |
formFieldTextIsPassword Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Bool | Returns: |
Checks whether content of field
is a password and it must be hidden
textIsRichText
data FormFieldTextIsRichTextMethodInfo Source #
Instances
((~) * signature (m Bool), MonadIO m, IsFormField a) => MethodInfo * FormFieldTextIsRichTextMethodInfo a signature Source # | |
formFieldTextIsRichText Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Bool | Returns: |
Checks whether the contents of field
are rich text
textSetText
data FormFieldTextSetTextMethodInfo Source #
Instances
((~) * signature (Text -> m ()), MonadIO m, IsFormField a) => MethodInfo * FormFieldTextSetTextMethodInfo a signature Source # | |
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the text in field
to the given value, replacing the current contents.