GI.Poppler.Objects.AnnotMarkup

No description available in the introspection data.

Exported types

newtype AnnotMarkup

Memory-managed wrapper type.

Constructors

AnnotMarkup (ManagedPtr AnnotMarkup)

Instances

GObject AnnotMarkup

Defined in GI.Poppler.Objects.AnnotMarkup

Methods

gobjectType :: AnnotMarkup -> IO GType

IsObject AnnotMarkup

Defined in GI.Poppler.Objects.AnnotMarkup

IsAnnot AnnotMarkup

Defined in GI.Poppler.Objects.AnnotMarkup

IsAnnotMarkup AnnotMarkup

Defined in GI.Poppler.Objects.AnnotMarkup

class GObject o => IsAnnotMarkup o

Type class for types which can be safely cast to AnnotMarkup, for instance with toAnnotMarkup.

Instances

(GObject a, (UnknownAncestorError AnnotMarkup a :: Constraint)) => IsAnnotMarkup a

Defined in GI.Poppler.Objects.AnnotMarkup

IsAnnotMarkup AnnotMarkup

Defined in GI.Poppler.Objects.AnnotMarkup

IsAnnotMarkup AnnotFileAttachment

Defined in GI.Poppler.Objects.AnnotFileAttachment

IsAnnotMarkup AnnotFreeText

Defined in GI.Poppler.Objects.AnnotFreeText

IsAnnotMarkup AnnotTextMarkup

Defined in GI.Poppler.Objects.AnnotTextMarkup

IsAnnotMarkup AnnotText

Defined in GI.Poppler.Objects.AnnotText

IsAnnotMarkup AnnotSquare

Defined in GI.Poppler.Objects.AnnotSquare

IsAnnotMarkup AnnotLine

Defined in GI.Poppler.Objects.AnnotLine

IsAnnotMarkup AnnotCircle

Defined in GI.Poppler.Objects.AnnotCircle

toAnnotMarkup :: (MonadIO m, IsAnnotMarkup o) => o -> m AnnotMarkup

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

noAnnotMarkup :: Maybe AnnotMarkup

A convenience alias for Nothing :: Maybe AnnotMarkup.

Methods

getDate

annotMarkupGetDate

Arguments

:: (HasCallStack, MonadIO m, IsAnnotMarkup a)

=> a

popplerAnnot: a AnnotMarkup

-> m Date

Returns: a Date representing the date and time when the annotation was created, or Nothing

Returns the date and time when the annotation was created

getExternalData

annotMarkupGetExternalData

Arguments

:: (HasCallStack, MonadIO m, IsAnnotMarkup a)

=> a

popplerAnnot: a AnnotMarkup

-> m AnnotExternalDataType

Returns: AnnotExternalDataType of popplerAnnot.

Gets the external data type of popplerAnnot.

getLabel

annotMarkupGetLabel

Arguments

:: (HasCallStack, MonadIO m, IsAnnotMarkup a)

=> a

popplerAnnot: a AnnotMarkup

-> m Text

Returns: the label text of popplerAnnot.

Retrieves the label text of popplerAnnot.

getOpacity

annotMarkupGetOpacity

Arguments

:: (HasCallStack, MonadIO m, IsAnnotMarkup a)

=> a

popplerAnnot: a AnnotMarkup

-> m Double

Returns: the opacity value of popplerAnnot, between 0 (transparent) and 1 (opaque)

Retrieves the opacity value of popplerAnnot.

getPopupIsOpen

annotMarkupGetPopupIsOpen

Arguments

:: (HasCallStack, MonadIO m, IsAnnotMarkup a)

=> a

popplerAnnot: a AnnotMarkup

-> m Bool

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

Retrieves the state of the popup window related to popplerAnnot.

getPopupRectangle

annotMarkupGetPopupRectangle

Arguments

:: (HasCallStack, MonadIO m, IsAnnotMarkup a)

=> a

popplerAnnot: a AnnotMarkup

-> m (Bool, Rectangle)

Returns: True if Rectangle was correctly filled, False otherwise

Retrieves the rectangle of the popup window related to popplerAnnot.

Since: 0.12

getReplyTo

annotMarkupGetReplyTo

Arguments

:: (HasCallStack, MonadIO m, IsAnnotMarkup a)

=> a

popplerAnnot: a AnnotMarkup

-> m AnnotMarkupReplyType

Returns: AnnotMarkupReplyType of popplerAnnot.

Gets the reply type of popplerAnnot.

getSubject

annotMarkupGetSubject

Arguments

:: (HasCallStack, MonadIO m, IsAnnotMarkup a)

=> a

popplerAnnot: a AnnotMarkup

-> m Text

Returns: the subject text of popplerAnnot.

Retrives the subject text of popplerAnnot.

hasPopup

annotMarkupHasPopup

Arguments

:: (HasCallStack, MonadIO m, IsAnnotMarkup a)

=> a

popplerAnnot: a AnnotMarkup

-> m Bool

Returns: True, if popplerAnnot has popup, False otherwise

Return True if the markup annotation has a popup window associated

Since: 0.12

setLabel

annotMarkupSetLabel

Arguments

:: (HasCallStack, MonadIO m, IsAnnotMarkup a)

=> a

popplerAnnot: a AnnotMarkup

-> Maybe Text

label: a text string containing the new label, or Nothing

-> m ()

Sets the label text of popplerAnnot, replacing the current one

Since: 0.16

setOpacity

annotMarkupSetOpacity

Arguments

:: (HasCallStack, MonadIO m, IsAnnotMarkup a)

=> a

popplerAnnot: a AnnotMarkup

-> Double

opacity: a constant opacity value, between 0 (transparent) and 1 (opaque)

-> m ()

Sets the opacity of popplerAnnot. This value applies to all visible elements of popplerAnnot in its closed state, but not to the pop-up window that appears when it's openened

Since: 0.16

setPopup

annotMarkupSetPopup

Arguments

:: (HasCallStack, MonadIO m, IsAnnotMarkup a)

=> a

popplerAnnot: a AnnotMarkup

-> Rectangle

popupRect: a Rectangle

-> m ()

Associates a new popup window for editing contents of popplerAnnot. Popup window shall be displayed by viewers at popupRect on the page.

Since: 0.16

setPopupIsOpen

annotMarkupSetPopupIsOpen

Arguments

:: (HasCallStack, MonadIO m, IsAnnotMarkup a)

=> a

popplerAnnot: a AnnotMarkup

-> Bool

isOpen: whether popup window should initially be displayed open

-> m ()

Sets the state of the popup window related to popplerAnnot.

Since: 0.16

setPopupRectangle

annotMarkupSetPopupRectangle

Arguments

:: (HasCallStack, MonadIO m, IsAnnotMarkup a)

=> a

popplerAnnot: a AnnotMarkup

-> Rectangle

popplerRect: a Rectangle to set

-> m ()

Sets the rectangle of the popup window related to popplerAnnot. This doesn't have any effect if popplerAnnot doesn't have a popup associated, use annotMarkupSetPopup to associate a popup window to a AnnotMarkup.

Since: 0.33