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 :: (MonadIO m, IsFormField o) => o -> m FormField
- noFormField :: Maybe 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
- 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
- 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
Constructors
FormField (ManagedPtr FormField) |
class GObject o => IsFormField o Source #
Instances
toFormField :: (MonadIO m, IsFormField o) => o -> m FormField Source #
Methods
buttonGetButtonType
formFieldButtonGetButtonType Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m FormButtonType | Returns: |
Gets the button type of field
buttonGetState
formFieldButtonGetState Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Bool | Returns: current state of |
buttonSetState
formFieldButtonSetState Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> Bool | |
-> m () |
choiceCanSelectMultiple
formFieldChoiceCanSelectMultiple Source #
Arguments
:: (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 #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Bool | Returns: |
Checks whether spell checking should be done for the contents of field
choiceGetChoiceType
formFieldChoiceGetChoiceType Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m FormChoiceType | Returns: |
Gets the choice type of field
choiceGetItem
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
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
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
formFieldChoiceIsEditable Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Bool | Returns: |
Checks whether field
is editable
choiceIsItemSelected
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
formFieldChoiceSelectItem Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> Int32 |
|
-> m () |
Selects the item at the given index on field
choiceSetText
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
formFieldChoiceToggleItem Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> Int32 |
|
-> m () |
Changes the state of the item at the given index
choiceUnselectAll
formFieldChoiceUnselectAll Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m () |
Unselects all the items on field
getAction
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Action | Returns: the action to perform. The returned
object is owned by |
getFieldType
formFieldGetFieldType Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m FormFieldType | Returns: |
Gets the type of field
getFontSize
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Double | Returns: the font size of |
Gets the font size of field
getId
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Int32 | Returns: the id of |
Gets the id of field
getMappingName
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
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
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
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Bool | Returns: |
Checks whether field
is read only
textDoScroll
formFieldTextDoScroll :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Bool Source #
No description available in the introspection data.
textDoSpellCheck
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
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
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
formFieldTextGetTextType Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m FormTextType | Returns: |
Gets the text type of field
.
textIsPassword
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
formFieldTextIsRichText Source #
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> m Bool | Returns: |
Checks whether the contents of field
are rich text
textSetText
Arguments
:: (HasCallStack, MonadIO m, IsFormField a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the text in field
to the given value, replacing the current contents.