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 |
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.
Instances
newZeroAnnotMapping :: MonadIO m => m AnnotMapping Source #
Construct a AnnotMapping
struct initialized to zero.
Methods
Click to display all available methods, including inherited ones
copy
:: (HasCallStack, MonadIO m) | |
=> AnnotMapping |
|
-> m AnnotMapping | Returns: a new allocated copy of |
Creates a copy of mapping
free
:: (HasCallStack, MonadIO m) | |
=> AnnotMapping |
|
-> m () |
Frees the given AnnotMapping
new
:: (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
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