| 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.Structs.LinkMapping
Description
A LinkMapping structure represents the location
of action on the page
Synopsis
- newtype LinkMapping = LinkMapping (ManagedPtr LinkMapping)
- newZeroLinkMapping :: MonadIO m => m LinkMapping
- noLinkMapping :: Maybe LinkMapping
- linkMappingCopy :: (HasCallStack, MonadIO m) => LinkMapping -> m LinkMapping
- linkMappingFree :: (HasCallStack, MonadIO m) => LinkMapping -> m ()
- linkMappingNew :: (HasCallStack, MonadIO m) => m LinkMapping
- clearLinkMappingAction :: MonadIO m => LinkMapping -> m ()
- getLinkMappingAction :: MonadIO m => LinkMapping -> m (Maybe Action)
- setLinkMappingAction :: MonadIO m => LinkMapping -> Ptr Action -> m ()
- getLinkMappingArea :: MonadIO m => LinkMapping -> m Rectangle
Exported types
newtype LinkMapping Source #
Memory-managed wrapper type.
Constructors
| LinkMapping (ManagedPtr LinkMapping) |
Instances
| BoxedObject LinkMapping Source # | |
Defined in GI.Poppler.Structs.LinkMapping Methods boxedType :: LinkMapping -> IO GType # | |
| tag ~ AttrSet => Constructible LinkMapping tag Source # | |
Defined in GI.Poppler.Structs.LinkMapping Methods new :: MonadIO m => (ManagedPtr LinkMapping -> LinkMapping) -> [AttrOp LinkMapping tag] -> m LinkMapping # | |
newZeroLinkMapping :: MonadIO m => m LinkMapping Source #
Construct a LinkMapping struct initialized to zero.
noLinkMapping :: Maybe LinkMapping Source #
A convenience alias for Nothing :: Maybe LinkMapping.
Methods
copy
Arguments
| :: (HasCallStack, MonadIO m) | |
| => LinkMapping |
|
| -> m LinkMapping | Returns: a new allocated copy of |
Creates a copy of mapping
free
Arguments
| :: (HasCallStack, MonadIO m) | |
| => LinkMapping |
|
| -> m () |
Frees the given LinkMapping
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m LinkMapping | Returns: a new |
Creates a new LinkMapping
Properties
action
a Action
clearLinkMappingAction :: MonadIO m => LinkMapping -> m () Source #
Set the value of the “action” field to Nothing.
When overloading is enabled, this is equivalent to
clear #action
getLinkMappingAction :: MonadIO m => LinkMapping -> m (Maybe Action) Source #
Get the value of the “action” field.
When overloading is enabled, this is equivalent to
get linkMapping #action
setLinkMappingAction :: MonadIO m => LinkMapping -> Ptr Action -> m () Source #
Set the value of the “action” field.
When overloading is enabled, this is equivalent to
setlinkMapping [ #action:=value ]
area
a Rectangle representing an area of the page
getLinkMappingArea :: MonadIO m => LinkMapping -> m Rectangle Source #
Get the value of the “area” field.
When overloading is enabled, this is equivalent to
get linkMapping #area