GI.Poppler.Objects.AnnotText

No description available in the introspection data.

Exported types

newtype AnnotText

Memory-managed wrapper type.

Constructors

AnnotText (ManagedPtr AnnotText)

Instances

Eq AnnotText

Defined in GI.Poppler.Objects.AnnotText

Methods

(==) :: AnnotText -> AnnotText -> Bool

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

GObject AnnotText

Defined in GI.Poppler.Objects.AnnotText

ManagedPtrNewtype AnnotText

Defined in GI.Poppler.Objects.AnnotText

Methods

toManagedPtr :: AnnotText -> ManagedPtr AnnotText

TypedObject AnnotText

Defined in GI.Poppler.Objects.AnnotText

Methods

glibType :: IO GType

HasParentTypes AnnotText

Defined in GI.Poppler.Objects.AnnotText

IsGValue (Maybe AnnotText)

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

Defined in GI.Poppler.Objects.AnnotText

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes AnnotText

Defined in GI.Poppler.Objects.AnnotText

type ParentTypes AnnotText = '[AnnotMarkup, Annot, Object]

class (GObject o, IsDescendantOf AnnotText o) => IsAnnotText o

Type class for types which can be safely cast to AnnotText, for instance with toAnnotText.

Instances

(GObject o, IsDescendantOf AnnotText o) => IsAnnotText o

Defined in GI.Poppler.Objects.AnnotText

toAnnotText :: (MonadIO m, IsAnnotText o) => o -> m AnnotText

Cast to AnnotText, 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, hasPopup, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getAnnotType, getColor, getContents, getData, getDate, getExternalData, getFlags, getIcon, getIsOpen, getLabel, getModified, getName, getOpacity, getPageIndex, getPopupIsOpen, getPopupRectangle, getProperty, getQdata, getRectangle, getReplyTo, getState, getSubject.

Setters

setColor, setContents, setData, setDataFull, setFlags, setIcon, setIsOpen, setLabel, setOpacity, setPopup, setPopupIsOpen, setPopupRectangle, setProperty, setRectangle.

getIcon

annotTextGetIcon

Arguments

:: (HasCallStack, MonadIO m, IsAnnotText a)

=> a

popplerAnnot: a AnnotText

-> m Text

Returns: a new allocated string containing the icon name

Gets name of the icon of popplerAnnot.

getIsOpen

annotTextGetIsOpen

Arguments

:: (HasCallStack, MonadIO m, IsAnnotText a)

=> a

popplerAnnot: a AnnotText

-> m Bool

Returns: the state of popplerAnnot. True if it's open, False in other case.

Retrieves the state of popplerAnnot.

getState

annotTextGetState

Arguments

:: (HasCallStack, MonadIO m, IsAnnotText a)

=> a

popplerAnnot: a AnnotText

-> m AnnotTextState

Returns: AnnotTextState of popplerAnnot.

Retrieves the state of popplerAnnot.

new

annotTextNew

Arguments

:: (HasCallStack, MonadIO m, IsDocument a)

=> a

doc: a Document

-> Rectangle

rect: a Rectangle

-> m AnnotText

Returns: A newly created AnnotText annotation

Creates a new Text annotation that will be located on rect when added to a page. See pageAddAnnot

Since: 0.16

setIcon

annotTextSetIcon

Arguments

:: (HasCallStack, MonadIO m, IsAnnotText a)

=> a

popplerAnnot: a AnnotText

-> Text

icon: the name of an icon

-> m ()

Sets the icon of popplerAnnot. The following predefined icons are currently supported: <variablelist> <varlistentry> <term>ANNOT_TEXT_ICON_NOTE</term> </varlistentry> <varlistentry> <term>ANNOT_TEXT_ICON_COMMENT</term> </varlistentry> <varlistentry> <term>ANNOT_TEXT_ICON_KEY</term> </varlistentry> <varlistentry> <term>ANNOT_TEXT_ICON_HELP</term> </varlistentry> <varlistentry> <term>ANNOT_TEXT_ICON_NEW_PARAGRAPH</term> </varlistentry> <varlistentry> <term>ANNOT_TEXT_ICON_PARAGRAPH</term> </varlistentry> <varlistentry> <term>ANNOT_TEXT_ICON_INSERT</term> </varlistentry> <varlistentry> <term>ANNOT_TEXT_ICON_CROSS</term> </varlistentry> <varlistentry> <term>ANNOT_TEXT_ICON_CIRCLE</term> </varlistentry> </variablelist>

Since: 0.16

setIsOpen

annotTextSetIsOpen

Arguments

:: (HasCallStack, MonadIO m, IsAnnotText a)

=> a

popplerAnnot: a AnnotText

-> Bool

isOpen: whether annotation should initially be displayed open

-> m ()

Sets whether popplerAnnot should initially be displayed open

Since: 0.16