| 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.ImageMapping
Description
A ImageMapping structure represents the location
of an image on the page
Synopsis
- newtype ImageMapping = ImageMapping (ManagedPtr ImageMapping)
- newZeroImageMapping :: MonadIO m => m ImageMapping
- noImageMapping :: Maybe 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
| BoxedObject ImageMapping Source # | |
Defined in GI.Poppler.Structs.ImageMapping Methods boxedType :: ImageMapping -> IO GType # | |
| tag ~ AttrSet => Constructible ImageMapping tag Source # | |
Defined in GI.Poppler.Structs.ImageMapping Methods new :: MonadIO m => (ManagedPtr ImageMapping -> ImageMapping) -> [AttrOp ImageMapping tag] -> m ImageMapping # | |
newZeroImageMapping :: MonadIO m => m ImageMapping Source #
Construct a ImageMapping struct initialized to zero.
noImageMapping :: Maybe ImageMapping Source #
A convenience alias for Nothing :: Maybe ImageMapping.
Methods
copy
Arguments
| :: (HasCallStack, MonadIO m) | |
| => ImageMapping |
|
| -> m ImageMapping | Returns: a new allocated copy of |
Creates a copy of mapping
free
Arguments
| :: (HasCallStack, MonadIO m) | |
| => ImageMapping |
|
| -> m () |
Frees the given ImageMapping
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m ImageMapping | Returns: a new |
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
setimageMapping [ #imageId:=value ]