Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (inaki@blueleaf.cc)
Safe Haskell	None
Language	Haskell2010

GI.Poppler.Objects.AnnotMarkup

Contents

Exported types
Methods

Description

No description available in the introspection data.

Synopsis

newtype AnnotMarkup = AnnotMarkup (ManagedPtr AnnotMarkup)
class (GObject o, IsDescendantOf AnnotMarkup o) => IsAnnotMarkup o
toAnnotMarkup :: (MonadIO m, IsAnnotMarkup o) => o -> m AnnotMarkup
noAnnotMarkup :: Maybe AnnotMarkup
annotMarkupGetDate :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> m Date
annotMarkupGetExternalData :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> m AnnotExternalDataType
annotMarkupGetLabel :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> m Text
annotMarkupGetOpacity :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> m Double
annotMarkupGetPopupIsOpen :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> m Bool
annotMarkupGetPopupRectangle :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> m (Bool, Rectangle)
annotMarkupGetReplyTo :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> m AnnotMarkupReplyType
annotMarkupGetSubject :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> m Text
annotMarkupHasPopup :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> m Bool
annotMarkupSetLabel :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> Maybe Text -> m ()
annotMarkupSetOpacity :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> Double -> m ()
annotMarkupSetPopup :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> Rectangle -> m ()
annotMarkupSetPopupIsOpen :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> Bool -> m ()
annotMarkupSetPopupRectangle :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> Rectangle -> m ()

Exported types

newtype AnnotMarkup Source #

Memory-managed wrapper type.

Constructors

AnnotMarkup (ManagedPtr AnnotMarkup)

Instances

GObject AnnotMarkup Source #
Instance details Defined in GI.Poppler.Objects.AnnotMarkup Methods gobjectType :: IO GType #
HasParentTypes AnnotMarkup Source #
Instance details Defined in GI.Poppler.Objects.AnnotMarkup
type ParentTypes AnnotMarkup Source #
Instance details Defined in GI.Poppler.Objects.AnnotMarkup type ParentTypes AnnotMarkup = Annot ': (Object ': ([] :: [Type]))

class (GObject o, IsDescendantOf AnnotMarkup o) => IsAnnotMarkup o Source #

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

Instances

(GObject o, IsDescendantOf AnnotMarkup o) => IsAnnotMarkup o Source #
Instance details Defined in GI.Poppler.Objects.AnnotMarkup

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

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

noAnnotMarkup :: Maybe AnnotMarkup Source #

A convenience alias for Nothing :: Maybe AnnotMarkup.

Methods

getDate

annotMarkupGetDate Source #

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

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

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

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

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

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

getSubject

annotMarkupGetSubject Source #

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

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

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

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

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

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

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