gi-poppler-0.18.30: Poppler bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Poppler.Objects.AnnotText

Description

No description available in the introspection data.

Synopsis

Exported types

newtype AnnotText Source #

Memory-managed wrapper type.

Constructors

AnnotText (ManagedPtr AnnotText) 

Instances

Instances details
Eq AnnotText Source # 
Instance details

Defined in GI.Poppler.Objects.AnnotText

GObject AnnotText Source # 
Instance details

Defined in GI.Poppler.Objects.AnnotText

ManagedPtrNewtype AnnotText Source # 
Instance details

Defined in GI.Poppler.Objects.AnnotText

Methods

toManagedPtr :: AnnotText -> ManagedPtr AnnotText

TypedObject AnnotText Source # 
Instance details

Defined in GI.Poppler.Objects.AnnotText

Methods

glibType :: IO GType

HasParentTypes AnnotText Source # 
Instance details

Defined in GI.Poppler.Objects.AnnotText

IsGValue (Maybe AnnotText) Source #

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

Instance details

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 Source # 
Instance details

Defined in GI.Poppler.Objects.AnnotText

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

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

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

Instances

Instances details
(GObject o, IsDescendantOf AnnotText o) => IsAnnotText o Source # 
Instance details

Defined in GI.Poppler.Objects.AnnotText

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

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

Methods

getIcon

annotTextGetIcon Source #

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 Source #

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 Source #

Arguments

:: (HasCallStack, MonadIO m, IsAnnotText a) 
=> a

popplerAnnot: a AnnotText

-> m AnnotTextState

Returns: AnnotTextState of popplerAnnot.

Retrieves the state of popplerAnnot.

new

annotTextNew Source #

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 Source #

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 Source #

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