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

GI.Poppler.Structs.AnnotMapping

Contents

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

Description

A AnnotMapping structure represents the location of annot on the page

Synopsis

newtype AnnotMapping = AnnotMapping (ManagedPtr AnnotMapping)
newZeroAnnotMapping :: MonadIO m => m AnnotMapping
annotMappingCopy :: (HasCallStack, MonadIO m) => AnnotMapping -> m AnnotMapping
annotMappingFree :: (HasCallStack, MonadIO m) => AnnotMapping -> m ()
annotMappingNew :: (HasCallStack, MonadIO m) => m AnnotMapping
clearAnnotMappingAnnot :: MonadIO m => AnnotMapping -> m ()
getAnnotMappingAnnot :: MonadIO m => AnnotMapping -> m (Maybe Annot)
setAnnotMappingAnnot :: MonadIO m => AnnotMapping -> Ptr Annot -> m ()
getAnnotMappingArea :: MonadIO m => AnnotMapping -> m Rectangle

Exported types

newtype AnnotMapping Source #

Memory-managed wrapper type.

Constructors

AnnotMapping (ManagedPtr AnnotMapping)

Instances

Instances details

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

newZeroAnnotMapping :: MonadIO m => m AnnotMapping Source #

Construct a AnnotMapping struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Expand

Methods

copy, free.

Getters

None.

Setters

None.

copy

annotMappingCopy Source #

Arguments

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

Creates a copy of mapping

free

annotMappingFree Source #

Arguments

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

Frees the given AnnotMapping

new

annotMappingNew Source #

Arguments

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

Creates a new AnnotMapping

Properties

annot

a Annot

clearAnnotMappingAnnot :: MonadIO m => AnnotMapping -> m () Source #

Set the value of the “annot” field to Nothing. When overloading is enabled, this is equivalent to

clear #annot

getAnnotMappingAnnot :: MonadIO m => AnnotMapping -> m (Maybe Annot) Source #

Get the value of the “annot” field. When overloading is enabled, this is equivalent to

get annotMapping #annot

setAnnotMappingAnnot :: MonadIO m => AnnotMapping -> Ptr Annot -> m () Source #

Set the value of the “annot” field. When overloading is enabled, this is equivalent to

set annotMapping [ #annot := value ]

area

a Rectangle representing an area of the page

getAnnotMappingArea :: MonadIO m => AnnotMapping -> m Rectangle Source #

Get the value of the “area” field. When overloading is enabled, this is equivalent to

get annotMapping #area