GI.Poppler.Objects.Annot

Exported types

newtype Annot

Constructors

Annot (ManagedPtr Annot)

Instances

GObject Annot

Methods

gobjectType :: Annot -> IO GType

IsObject Annot

IsAnnot Annot

class GObject o => IsAnnot o

Instances

(GObject a, UnknownAncestorError Constraint Annot a) => IsAnnot a

IsAnnot AnnotMarkup

IsAnnot Annot

IsAnnot AnnotCircle

IsAnnot AnnotFileAttachment

IsAnnot AnnotLine

IsAnnot AnnotMovie

IsAnnot AnnotScreen

IsAnnot AnnotSquare

IsAnnot AnnotTextMarkup

IsAnnot AnnotFreeText

IsAnnot AnnotText

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

noAnnot :: Maybe Annot

Methods

getAnnotType

annotGetAnnotType

Arguments

:: (HasCallStack, MonadIO m, IsAnnot a)

=> a

popplerAnnot: a Annot

-> m AnnotType

Returns: AnnotType of popplerAnnot.

Gets the type of popplerAnnot

getColor

annotGetColor

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

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

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

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

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

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

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

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

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

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

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