Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	Safe-Inferred
Language	Haskell2010

GI.Poppler.Structs.LinkMapping

Contents

Exported types
Methods
- copy
- free
- new
Properties
- action
- area

Description

A LinkMapping structure represents the location of action on the page

Synopsis

newtype LinkMapping = LinkMapping (ManagedPtr LinkMapping)
newZeroLinkMapping :: MonadIO m => m 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

Instances details

Eq LinkMapping Source #
Instance details Defined in GI.Poppler.Structs.LinkMapping Methods (==) :: LinkMapping -> LinkMapping -> Bool # (/=) :: LinkMapping -> LinkMapping -> Bool #
GBoxed LinkMapping Source #
Instance details Defined in GI.Poppler.Structs.LinkMapping
ManagedPtrNewtype LinkMapping Source #
Instance details Defined in GI.Poppler.Structs.LinkMapping Methods toManagedPtr :: LinkMapping -> ManagedPtr LinkMapping
TypedObject LinkMapping Source #
Instance details Defined in GI.Poppler.Structs.LinkMapping Methods glibType :: IO GType
HasParentTypes LinkMapping Source #
Instance details Defined in GI.Poppler.Structs.LinkMapping
tag ~ 'AttrSet => Constructible LinkMapping tag Source #
Instance details Defined in GI.Poppler.Structs.LinkMapping Methods new :: MonadIO m => (ManagedPtr LinkMapping -> LinkMapping) -> [AttrOp LinkMapping tag] -> m LinkMapping
IsGValue (Maybe LinkMapping) Source #	Convert `LinkMapping` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Poppler.Structs.LinkMapping Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe LinkMapping -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe LinkMapping)
type ParentTypes LinkMapping Source #
Instance details Defined in GI.Poppler.Structs.LinkMapping type ParentTypes LinkMapping = '[] :: [Type]

newZeroLinkMapping :: MonadIO m => m LinkMapping Source #

Construct a LinkMapping struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Expand

Methods

copy, free.

Getters

None.

Setters

None.

copy

linkMappingCopy Source #

Arguments

:: (HasCallStack, MonadIO m)
=> LinkMapping	`mapping`: a `LinkMapping` to copy
-> m LinkMapping	Returns: a new allocated copy of `mapping`

Creates a copy of mapping

free

linkMappingFree Source #

Arguments

:: (HasCallStack, MonadIO m)
=> LinkMapping	`mapping`: a `LinkMapping`
-> m ()

Frees the given LinkMapping

new

linkMappingNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> m LinkMapping	Returns: a new `LinkMapping`, use `linkMappingFree` to free it

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

set linkMapping [ #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