GI.Poppler.Objects.Annot

No description available in the introspection data.

Exported types

newtype Annot

Memory-managed wrapper type.

Constructors

Annot (ManagedPtr Annot)

Instances

GObject Annot

Defined in GI.Poppler.Objects.Annot

Methods

gobjectType :: Annot -> IO GType

IsObject Annot

Defined in GI.Poppler.Objects.Annot

IsAnnot Annot

Defined in GI.Poppler.Objects.Annot

class GObject o => IsAnnot o

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

Instances

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

Defined in GI.Poppler.Objects.Annot

IsAnnot Annot

Defined in GI.Poppler.Objects.Annot

IsAnnot AnnotMarkup

Defined in GI.Poppler.Objects.AnnotMarkup

IsAnnot AnnotFileAttachment

Defined in GI.Poppler.Objects.AnnotFileAttachment

IsAnnot AnnotMovie

Defined in GI.Poppler.Objects.AnnotMovie

IsAnnot AnnotFreeText

Defined in GI.Poppler.Objects.AnnotFreeText

IsAnnot AnnotTextMarkup

Defined in GI.Poppler.Objects.AnnotTextMarkup

IsAnnot AnnotText

Defined in GI.Poppler.Objects.AnnotText

IsAnnot AnnotSquare

Defined in GI.Poppler.Objects.AnnotSquare

IsAnnot AnnotLine

Defined in GI.Poppler.Objects.AnnotLine

IsAnnot AnnotCircle

Defined in GI.Poppler.Objects.AnnotCircle

IsAnnot AnnotScreen

Defined in GI.Poppler.Objects.AnnotScreen

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

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

noAnnot :: Maybe Annot

A convenience alias for Nothing :: 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