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.Objects.Annot

Contents

Exported types
Methods

Description

No description available in the introspection data.

Synopsis

newtype Annot = Annot (ManagedPtr Annot)
class (GObject o, IsDescendantOf Annot o) => IsAnnot o
toAnnot :: (MonadIO m, IsAnnot o) => o -> m Annot
noAnnot :: Maybe Annot
annotGetAnnotType :: (HasCallStack, MonadIO m, IsAnnot a) => a -> m AnnotType
annotGetColor :: (HasCallStack, MonadIO m, IsAnnot a) => a -> m Color
annotGetContents :: (HasCallStack, MonadIO m, IsAnnot a) => a -> m Text
annotGetFlags :: (HasCallStack, MonadIO m, IsAnnot a) => a -> m [AnnotFlag]
annotGetModified :: (HasCallStack, MonadIO m, IsAnnot a) => a -> m Text
annotGetName :: (HasCallStack, MonadIO m, IsAnnot a) => a -> m Text
annotGetPageIndex :: (HasCallStack, MonadIO m, IsAnnot a) => a -> m Int32
annotGetRectangle :: (HasCallStack, MonadIO m, IsAnnot a) => a -> m Rectangle
annotSetColor :: (HasCallStack, MonadIO m, IsAnnot a) => a -> Maybe Color -> m ()
annotSetContents :: (HasCallStack, MonadIO m, IsAnnot a) => a -> Text -> m ()
annotSetFlags :: (HasCallStack, MonadIO m, IsAnnot a) => a -> [AnnotFlag] -> m ()
annotSetRectangle :: (HasCallStack, MonadIO m, IsAnnot a) => a -> Rectangle -> m ()

Exported types

newtype Annot Source #

Memory-managed wrapper type.

Constructors

Annot (ManagedPtr Annot)

Instances

GObject Annot Source #
Instance details Defined in GI.Poppler.Objects.Annot Methods gobjectType :: IO GType #
HasParentTypes Annot Source #
Instance details Defined in GI.Poppler.Objects.Annot
type ParentTypes Annot Source #
Instance details Defined in GI.Poppler.Objects.Annot type ParentTypes Annot = Object ': ([] :: [Type])

class (GObject o, IsDescendantOf Annot o) => IsAnnot o Source #

Type class for types which can be safely cast to Annot, for instance with toAnnot.

Instances

(GObject o, IsDescendantOf Annot o) => IsAnnot o Source #
Instance details Defined in GI.Poppler.Objects.Annot

toAnnot :: (MonadIO m, IsAnnot o) => o -> m Annot Source #

Cast to Annot, for types for which this is known to be safe. For general casts, use castTo.

noAnnot :: Maybe Annot Source #

A convenience alias for Nothing :: Maybe Annot.

Methods

getAnnotType

annotGetAnnotType Source #

Arguments

:: (HasCallStack, MonadIO m, IsAnnot a)
=> a	`popplerAnnot`: a `Annot`
-> m AnnotType	Returns: `AnnotType` of `popplerAnnot`.

Gets the type of popplerAnnot

getColor

annotGetColor Source #

Arguments

:: (HasCallStack, MonadIO m, IsAnnot a)
=> a	`popplerAnnot`: a `Annot`
-> m Color	Returns: a new allocated `Color` with the color values of `popplerAnnot`, or `Nothing`. It must be freed with `free` when done.

Retrieves the color of popplerAnnot.

getContents

annotGetContents Source #

Arguments

:: (HasCallStack, MonadIO m, IsAnnot a)
=> a	`popplerAnnot`: a `Annot`
-> m Text	Returns: a new allocated string with the contents of `popplerAnnot`. It must be freed with `free` when done.

Retrieves the contents of popplerAnnot.

getFlags

annotGetFlags Source #

Arguments

:: (HasCallStack, MonadIO m, IsAnnot a)
=> a	`popplerAnnot`: a `Annot`
-> m [AnnotFlag]	Returns: the flag field of `popplerAnnot`.

Retrieves the flag field specifying various characteristics of the popplerAnnot.

getModified

annotGetModified Source #

Arguments

:: (HasCallStack, MonadIO m, IsAnnot a)
=> a	`popplerAnnot`: a `Annot`
-> m Text	Returns: a new allocated string with the last modification data of `popplerAnnot`. It must be freed with `free` when done.

Retrieves the last modification data of popplerAnnot. The returned string will be either a PDF format date or a text string. See also poppler_date_parse()

getName

annotGetName Source #

Arguments

:: (HasCallStack, MonadIO m, IsAnnot a)
=> a	`popplerAnnot`: a `Annot`
-> m Text	Returns: a new allocated string with the name of `popplerAnnot`. It must be freed with `free` when done.

Retrieves the name of popplerAnnot.

getPageIndex

annotGetPageIndex Source #

Arguments

:: (HasCallStack, MonadIO m, IsAnnot a)
=> a	`popplerAnnot`: a `Annot`
-> m Int32	Returns: page index or -1

Returns the page index to which popplerAnnot is associated, or -1 if unknown

Since: 0.14

getRectangle

annotGetRectangle Source #

Arguments

:: (HasCallStack, MonadIO m, IsAnnot a)
=> a	`popplerAnnot`: a `Annot`
-> m Rectangle

Retrieves the rectangle representing the page coordinates where the annotation popplerAnnot is placed.

Since: 0.26

setColor

annotSetColor Source #

Arguments

:: (HasCallStack, MonadIO m, IsAnnot a)
=> a	`popplerAnnot`: a `Annot`
-> Maybe Color	`popplerColor`: a `Color`, or `Nothing`
-> m ()

Sets the color of popplerAnnot.

Since: 0.16

setContents

annotSetContents Source #

Arguments

:: (HasCallStack, MonadIO m, IsAnnot a)
=> a	`popplerAnnot`: a `Annot`
-> Text	`contents`: a text string containing the new contents
-> m ()

Sets the contents of popplerAnnot to the given value, replacing the current contents.

Since: 0.12

setFlags

annotSetFlags Source #

Arguments

:: (HasCallStack, MonadIO m, IsAnnot a)
=> a	`popplerAnnot`: a `Annot`
-> [AnnotFlag]	`flags`: a `AnnotFlag`
-> m ()

Sets the flag field specifying various characteristics of the popplerAnnot.

Since: 0.22

setRectangle

annotSetRectangle Source #

Arguments

:: (HasCallStack, MonadIO m, IsAnnot a)
=> a	`popplerAnnot`: a `Annot`
-> Rectangle	`popplerRect`: a `Rectangle` with the new annotation's coordinates
-> m ()

Move the annotation to the rectangle representing the page coordinates where the annotation popplerAnnot should be placed.

Since: 0.26