gi-poppler-0.18.29: Poppler bindings

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.ImageMapping

Contents

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

Description

A ImageMapping structure represents the location of an image on the page

Synopsis

newtype ImageMapping = ImageMapping (ManagedPtr ImageMapping)
newZeroImageMapping :: MonadIO m => m ImageMapping
imageMappingCopy :: (HasCallStack, MonadIO m) => ImageMapping -> m ImageMapping
imageMappingFree :: (HasCallStack, MonadIO m) => ImageMapping -> m ()
imageMappingNew :: (HasCallStack, MonadIO m) => m ImageMapping
getImageMappingArea :: MonadIO m => ImageMapping -> m Rectangle
getImageMappingImageId :: MonadIO m => ImageMapping -> m Int32
setImageMappingImageId :: MonadIO m => ImageMapping -> Int32 -> m ()

Exported types

newtype ImageMapping Source #

Memory-managed wrapper type.

Constructors

ImageMapping (ManagedPtr ImageMapping)

Instances

Instances details

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

newZeroImageMapping :: MonadIO m => m ImageMapping Source #

Construct a ImageMapping struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Expand

Methods

Getters

None.

Setters

None.

copy

imageMappingCopy Source #

Arguments

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

Creates a copy of mapping

free

imageMappingFree Source #

Arguments

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

Frees the given ImageMapping

new

imageMappingNew Source #

Arguments

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

Creates a new ImageMapping

Properties

area

a Rectangle representing an area of the page

getImageMappingArea :: MonadIO m => ImageMapping -> m Rectangle Source #

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

get imageMapping #area

imageId

an image identifier

getImageMappingImageId :: MonadIO m => ImageMapping -> m Int32 Source #

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

get imageMapping #imageId

setImageMappingImageId :: MonadIO m => ImageMapping -> Int32 -> m () Source #

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

set imageMapping [ #imageId := value ]