| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria (inaki@blueleaf.cc) |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Poppler.Structs.FormFieldMapping
Description
A FormFieldMapping structure represents the location
of field on the page
Synopsis
- newtype FormFieldMapping = FormFieldMapping (ManagedPtr FormFieldMapping)
- newZeroFormFieldMapping :: MonadIO m => m FormFieldMapping
- noFormFieldMapping :: Maybe FormFieldMapping
- formFieldMappingCopy :: (HasCallStack, MonadIO m) => FormFieldMapping -> m FormFieldMapping
- formFieldMappingFree :: (HasCallStack, MonadIO m) => FormFieldMapping -> m ()
- formFieldMappingNew :: (HasCallStack, MonadIO m) => m FormFieldMapping
- getFormFieldMappingArea :: MonadIO m => FormFieldMapping -> m Rectangle
- clearFormFieldMappingField :: MonadIO m => FormFieldMapping -> m ()
- getFormFieldMappingField :: MonadIO m => FormFieldMapping -> m (Maybe FormField)
- setFormFieldMappingField :: MonadIO m => FormFieldMapping -> Ptr FormField -> m ()
Exported types
newtype FormFieldMapping Source #
Memory-managed wrapper type.
Constructors
| FormFieldMapping (ManagedPtr FormFieldMapping) |
Instances
| BoxedObject FormFieldMapping Source # | |
Defined in GI.Poppler.Structs.FormFieldMapping Methods boxedType :: FormFieldMapping -> IO GType # | |
| tag ~ AttrSet => Constructible FormFieldMapping tag Source # | |
Defined in GI.Poppler.Structs.FormFieldMapping Methods new :: MonadIO m => (ManagedPtr FormFieldMapping -> FormFieldMapping) -> [AttrOp FormFieldMapping tag] -> m FormFieldMapping # | |
newZeroFormFieldMapping :: MonadIO m => m FormFieldMapping Source #
Construct a FormFieldMapping struct initialized to zero.
noFormFieldMapping :: Maybe FormFieldMapping Source #
A convenience alias for Nothing :: Maybe FormFieldMapping.
Methods
copy
Arguments
| :: (HasCallStack, MonadIO m) | |
| => FormFieldMapping |
|
| -> m FormFieldMapping | Returns: a new allocated copy of |
Creates a copy of mapping
free
Arguments
| :: (HasCallStack, MonadIO m) | |
| => FormFieldMapping |
|
| -> m () |
Frees the given FormFieldMapping
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m FormFieldMapping | Returns: a new |
Creates a new FormFieldMapping
Properties
area
a Rectangle representing an area of the page
getFormFieldMappingArea :: MonadIO m => FormFieldMapping -> m Rectangle Source #
Get the value of the “area” field.
When overloading is enabled, this is equivalent to
get formFieldMapping #area
field
clearFormFieldMappingField :: MonadIO m => FormFieldMapping -> m () Source #
Set the value of the “field” field to Nothing.
When overloading is enabled, this is equivalent to
clear #field
getFormFieldMappingField :: MonadIO m => FormFieldMapping -> m (Maybe FormField) Source #
Get the value of the “field” field.
When overloading is enabled, this is equivalent to
get formFieldMapping #field
setFormFieldMappingField :: MonadIO m => FormFieldMapping -> Ptr FormField -> m () Source #
Set the value of the “field” field.
When overloading is enabled, this is equivalent to
setformFieldMapping [ #field:=value ]