| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria (inaki@blueleaf.cc) |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Poppler.Structs.AnnotMapping
Description
A AnnotMapping structure represents the location
of annot on the page
Synopsis
- newtype AnnotMapping = AnnotMapping (ManagedPtr AnnotMapping)
- newZeroAnnotMapping :: MonadIO m => m AnnotMapping
- noAnnotMapping :: Maybe 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
| BoxedObject AnnotMapping Source # | |
Defined in GI.Poppler.Structs.AnnotMapping Methods boxedType :: AnnotMapping -> IO GType # | |
| tag ~ AttrSet => Constructible AnnotMapping tag Source # | |
Defined in GI.Poppler.Structs.AnnotMapping Methods new :: MonadIO m => (ManagedPtr AnnotMapping -> AnnotMapping) -> [AttrOp AnnotMapping tag] -> m AnnotMapping # | |
newZeroAnnotMapping :: MonadIO m => m AnnotMapping Source #
Construct a AnnotMapping struct initialized to zero.
noAnnotMapping :: Maybe AnnotMapping Source #
A convenience alias for Nothing :: Maybe AnnotMapping.
Methods
copy
Arguments
| :: (HasCallStack, MonadIO m) | |
| => AnnotMapping |
|
| -> m AnnotMapping | Returns: a new allocated copy of |
Creates a copy of mapping
free
Arguments
| :: (HasCallStack, MonadIO m) | |
| => AnnotMapping |
|
| -> m () |
Frees the given AnnotMapping
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m AnnotMapping | Returns: a new |
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
setannotMapping [ #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