GI.Poppler.Objects.FormField

No description available in the introspection data.

Exported types

newtype FormField

Memory-managed wrapper type.

Constructors

FormField (ManagedPtr FormField)

Instances

GObject FormField

Defined in GI.Poppler.Objects.FormField

Methods

gobjectType :: IO GType

HasParentTypes FormField

Defined in GI.Poppler.Objects.FormField

type ParentTypes FormField

Defined in GI.Poppler.Objects.FormField

type ParentTypes FormField = Object ': ([] :: [Type])

class (GObject o, IsDescendantOf FormField o) => IsFormField o

Type class for types which can be safely cast to FormField, for instance with toFormField.

Instances

(GObject o, IsDescendantOf FormField o) => IsFormField o

Defined in GI.Poppler.Objects.FormField

toFormField :: (MonadIO m, IsFormField o) => o -> m FormField

Cast to FormField, for types for which this is known to be safe. For general casts, use castTo.

noFormField :: Maybe FormField

A convenience alias for Nothing :: Maybe FormField.

Methods

buttonGetButtonType

formFieldButtonGetButtonType

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> m FormButtonType

Returns: FormButtonType of field

Gets the button type of field

buttonGetState

formFieldButtonGetState

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> m Bool

Returns: current state of field

Queries a FormField and returns its current state. Returns True if field is pressed in and False if it is raised.

buttonSetState

formFieldButtonSetState

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> Bool

state: True or False

-> m ()

Sets the status of field. Set to True if you want the FormField to be 'pressed in', and False to raise it.

choiceCanSelectMultiple

formFieldChoiceCanSelectMultiple

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> m Bool

Returns: True if field allows multiple choices to be selected

Checks whether field allows multiple choices to be selected

choiceCommitOnChange

formFieldChoiceCommitOnChange :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Bool

No description available in the introspection data.

choiceDoSpellCheck

formFieldChoiceDoSpellCheck

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> m Bool

Returns: True if spell checking should be done for field

Checks whether spell checking should be done for the contents of field

choiceGetChoiceType

formFieldChoiceGetChoiceType

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> m FormChoiceType

Returns: FormChoiceType of field

Gets the choice type of field

choiceGetItem

formFieldChoiceGetItem

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> Int32

index: the index of the item

-> m Text

Returns: a new allocated string. It must be freed with free when done.

Returns the contents of the item on field at the given index

choiceGetNItems

formFieldChoiceGetNItems

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> m Int32

Returns: the number of items on field

Returns the number of items on field

choiceGetText

formFieldChoiceGetText

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> m Text

Returns: a new allocated string. It must be freed with free when done.

Retrieves the contents of field.

choiceIsEditable

formFieldChoiceIsEditable

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> m Bool

Returns: True if field is editable

Checks whether field is editable

choiceIsItemSelected

formFieldChoiceIsItemSelected

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> Int32

index: the index of the item

-> m Bool

Returns: True if item at index is currently selected

Checks whether the item at the given index on field is currently selected

choiceSelectItem

formFieldChoiceSelectItem

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> Int32

index: the index of the item

-> m ()

Selects the item at the given index on field

choiceSetText

formFieldChoiceSetText

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> Text

text: the new text

-> m ()

Sets the text in field to the given value, replacing the current contents

choiceToggleItem

formFieldChoiceToggleItem

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> Int32

index: the index of the item

-> m ()

Changes the state of the item at the given index

choiceUnselectAll

formFieldChoiceUnselectAll

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> m ()

Unselects all the items on field

getAction

formFieldGetAction

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> m Action

Returns: the action to perform. The returned object is owned by field and should not be freed

Retrieves the action (Action) that shall be performed when field is activated, or Nothing

Since: 0.18

getAdditionalAction

formFieldGetAdditionalAction

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> AdditionalActionType

type: the type of additional action

-> m Action

Returns: the action to perform. The returned object is owned by field and should not be freed.

Retrieves the action (Action) that shall be performed when an additional action is triggered on field, or Nothing.

Since: 0.72

getFieldType

formFieldGetFieldType

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> m FormFieldType

Returns: FormFieldType of field

Gets the type of field

getFontSize

formFieldGetFontSize

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> m Double

Returns: the font size of field

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

formFieldGetId

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> m Int32

Returns: the id of field

Gets the id of field

getMappingName

formFieldGetMappingName

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> m Text

Returns: a new allocated string. It must be freed with free when done.

Gets the mapping name of field that is used when exporting interactive form field data from the document

Since: 0.16

getName

formFieldGetName

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> m Text

Returns: a new allocated string. It must be freed with free when done.

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

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> m Text

Returns: a new allocated string. It must be freed with free when done.

Gets the partial name of field.

Since: 0.16

isReadOnly

formFieldIsReadOnly

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> m Bool

Returns: True if field is read only

Checks whether field is read only

textDoScroll

formFieldTextDoScroll :: (HasCallStack, MonadIO m, IsFormField a) => a -> m Bool

No description available in the introspection data.

textDoSpellCheck

formFieldTextDoSpellCheck

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> m Bool

Returns: True if spell checking should be done for field

Checks whether spell checking should be done for the contents of field

textGetMaxLen

formFieldTextGetMaxLen

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> m Int32

Returns: the maximum allowed number of characters in field, or -1 if there is no maximum.

Retrieves the maximum allowed length of the text in field

textGetText

formFieldTextGetText

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> m Text

Returns: a new allocated string. It must be freed with free when done.

Retrieves the contents of field.

textGetTextType

formFieldTextGetTextType

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> m FormTextType

Returns: FormTextType of field

Gets the text type of field.

textIsPassword

formFieldTextIsPassword

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> m Bool

Returns: True if the content of field is a password

Checks whether content of field is a password and it must be hidden

textIsRichText

formFieldTextIsRichText

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> m Bool

Returns: True if the contents of field are rich text

Checks whether the contents of field are rich text

textSetText

formFieldTextSetText

Arguments

:: (HasCallStack, MonadIO m, IsFormField a)

=> a

field: a FormField

-> Text

text: the new text

-> m ()

Sets the text in field to the given value, replacing the current contents.