GI.Poppler.Objects.Annot

No description available in the introspection data.

Exported types

newtype Annot

Memory-managed wrapper type.

Constructors

Annot (ManagedPtr Annot)

Instances

Eq Annot

Defined in GI.Poppler.Objects.Annot

Methods

(==) :: Annot -> Annot -> Bool

(/=) :: Annot -> Annot -> Bool

GObject Annot

Defined in GI.Poppler.Objects.Annot

ManagedPtrNewtype Annot

Defined in GI.Poppler.Objects.Annot

Methods

toManagedPtr :: Annot -> ManagedPtr Annot

TypedObject Annot

Defined in GI.Poppler.Objects.Annot

Methods

glibType :: IO GType

HasParentTypes Annot

Defined in GI.Poppler.Objects.Annot

IsGValue (Maybe Annot)

Convert Annot to and from GValue. See toGValue and fromGValue.

Defined in GI.Poppler.Objects.Annot

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Annot -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Annot)

type ParentTypes Annot

Defined in GI.Poppler.Objects.Annot

type ParentTypes Annot = '[Object]

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

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

Instances

(GObject o, IsDescendantOf Annot o) => IsAnnot o

Defined in GI.Poppler.Objects.Annot

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.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getAnnotType, getColor, getContents, getData, getFlags, getModified, getName, getPageIndex, getProperty, getQdata, getRectangle.

Setters

setColor, setContents, setData, setDataFull, setFlags, setProperty, setRectangle.

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