Copyright | Will Thompson, Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
GI.Poppler.Objects.AnnotMarkup
Contents
Description
- newtype AnnotMarkup = AnnotMarkup (ManagedPtr AnnotMarkup)
- class GObject o => IsAnnotMarkup o
- toAnnotMarkup :: IsAnnotMarkup o => o -> IO AnnotMarkup
- noAnnotMarkup :: Maybe AnnotMarkup
- data AnnotMarkupGetDateMethodInfo
- annotMarkupGetDate :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> m Date
- data AnnotMarkupGetExternalDataMethodInfo
- annotMarkupGetExternalData :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> m AnnotExternalDataType
- data AnnotMarkupGetLabelMethodInfo
- annotMarkupGetLabel :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> m Text
- data AnnotMarkupGetOpacityMethodInfo
- annotMarkupGetOpacity :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> m Double
- data AnnotMarkupGetPopupIsOpenMethodInfo
- annotMarkupGetPopupIsOpen :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> m Bool
- data AnnotMarkupGetPopupRectangleMethodInfo
- annotMarkupGetPopupRectangle :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> m (Bool, Rectangle)
- data AnnotMarkupGetReplyToMethodInfo
- annotMarkupGetReplyTo :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> m AnnotMarkupReplyType
- data AnnotMarkupGetSubjectMethodInfo
- annotMarkupGetSubject :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> m Text
- data AnnotMarkupHasPopupMethodInfo
- annotMarkupHasPopup :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> m Bool
- data AnnotMarkupSetLabelMethodInfo
- annotMarkupSetLabel :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> Maybe Text -> m ()
- data AnnotMarkupSetOpacityMethodInfo
- annotMarkupSetOpacity :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> Double -> m ()
- data AnnotMarkupSetPopupMethodInfo
- annotMarkupSetPopup :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> Rectangle -> m ()
- data AnnotMarkupSetPopupIsOpenMethodInfo
- annotMarkupSetPopupIsOpen :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> Bool -> m ()
- data AnnotMarkupSetPopupRectangleMethodInfo
- annotMarkupSetPopupRectangle :: (HasCallStack, MonadIO m, IsAnnotMarkup a) => a -> Rectangle -> m ()
Exported types
newtype AnnotMarkup Source #
Constructors
AnnotMarkup (ManagedPtr AnnotMarkup) |
Instances
GObject AnnotMarkup Source # | |
IsObject AnnotMarkup Source # | |
IsAnnotMarkup AnnotMarkup Source # | |
IsAnnot AnnotMarkup Source # | |
((~) * info (ResolveAnnotMarkupMethod t AnnotMarkup), MethodInfo * info AnnotMarkup p) => IsLabel t (AnnotMarkup -> p) Source # | |
((~) * info (ResolveAnnotMarkupMethod t AnnotMarkup), MethodInfo * info AnnotMarkup p) => IsLabelProxy t (AnnotMarkup -> p) Source # | |
HasAttributeList * AnnotMarkup Source # | |
type AttributeList AnnotMarkup Source # | |
type SignalList AnnotMarkup Source # | |
class GObject o => IsAnnotMarkup o Source #
Instances
toAnnotMarkup :: IsAnnotMarkup o => o -> IO AnnotMarkup Source #
Methods
getDate
data AnnotMarkupGetDateMethodInfo Source #
Instances
((~) * signature (m Date), MonadIO m, IsAnnotMarkup a) => MethodInfo * AnnotMarkupGetDateMethodInfo a signature Source # | |
Arguments
:: (HasCallStack, MonadIO m, IsAnnotMarkup a) | |
=> a |
|
-> m Date | Returns: a |
Returns the date and time when the annotation was created
getExternalData
data AnnotMarkupGetExternalDataMethodInfo Source #
Instances
((~) * signature (m AnnotExternalDataType), MonadIO m, IsAnnotMarkup a) => MethodInfo * AnnotMarkupGetExternalDataMethodInfo a signature Source # | |
annotMarkupGetExternalData Source #
Arguments
:: (HasCallStack, MonadIO m, IsAnnotMarkup a) | |
=> a |
|
-> m AnnotExternalDataType | Returns: |
Gets the external data type of popplerAnnot
.
getLabel
data AnnotMarkupGetLabelMethodInfo Source #
Instances
((~) * signature (m Text), MonadIO m, IsAnnotMarkup a) => MethodInfo * AnnotMarkupGetLabelMethodInfo a signature Source # | |
Arguments
:: (HasCallStack, MonadIO m, IsAnnotMarkup a) | |
=> a |
|
-> m Text | Returns: the label text of |
Retrieves the label text of popplerAnnot
.
getOpacity
data AnnotMarkupGetOpacityMethodInfo Source #
Instances
((~) * signature (m Double), MonadIO m, IsAnnotMarkup a) => MethodInfo * AnnotMarkupGetOpacityMethodInfo a signature Source # | |
annotMarkupGetOpacity Source #
Arguments
:: (HasCallStack, MonadIO m, IsAnnotMarkup a) | |
=> a |
|
-> m Double | Returns: the opacity value of |
Retrieves the opacity value of popplerAnnot
.
getPopupIsOpen
data AnnotMarkupGetPopupIsOpenMethodInfo Source #
Instances
((~) * signature (m Bool), MonadIO m, IsAnnotMarkup a) => MethodInfo * AnnotMarkupGetPopupIsOpenMethodInfo a signature Source # | |
annotMarkupGetPopupIsOpen Source #
Arguments
:: (HasCallStack, MonadIO m, IsAnnotMarkup a) | |
=> a |
|
-> m Bool | Returns: the state of |
Retrieves the state of the popup window related to popplerAnnot
.
getPopupRectangle
data AnnotMarkupGetPopupRectangleMethodInfo Source #
Instances
((~) * signature (m (Bool, Rectangle)), MonadIO m, IsAnnotMarkup a) => MethodInfo * AnnotMarkupGetPopupRectangleMethodInfo a signature Source # | |
annotMarkupGetPopupRectangle Source #
Arguments
:: (HasCallStack, MonadIO m, IsAnnotMarkup a) | |
=> a |
|
-> m (Bool, Rectangle) | Returns: |
Retrieves the rectangle of the popup window related to popplerAnnot
.
Since: 0.12
getReplyTo
data AnnotMarkupGetReplyToMethodInfo Source #
Instances
((~) * signature (m AnnotMarkupReplyType), MonadIO m, IsAnnotMarkup a) => MethodInfo * AnnotMarkupGetReplyToMethodInfo a signature Source # | |
annotMarkupGetReplyTo Source #
Arguments
:: (HasCallStack, MonadIO m, IsAnnotMarkup a) | |
=> a |
|
-> m AnnotMarkupReplyType | Returns: |
Gets the reply type of popplerAnnot
.
getSubject
data AnnotMarkupGetSubjectMethodInfo Source #
Instances
((~) * signature (m Text), MonadIO m, IsAnnotMarkup a) => MethodInfo * AnnotMarkupGetSubjectMethodInfo a signature Source # | |
annotMarkupGetSubject Source #
Arguments
:: (HasCallStack, MonadIO m, IsAnnotMarkup a) | |
=> a |
|
-> m Text | Returns: the subject text of |
Retrives the subject text of popplerAnnot
.
hasPopup
data AnnotMarkupHasPopupMethodInfo Source #
Instances
((~) * signature (m Bool), MonadIO m, IsAnnotMarkup a) => MethodInfo * AnnotMarkupHasPopupMethodInfo a signature Source # | |
Arguments
:: (HasCallStack, MonadIO m, IsAnnotMarkup a) | |
=> a |
|
-> m Bool |
Return True
if the markup annotation has a popup window associated
Since: 0.12
setLabel
data AnnotMarkupSetLabelMethodInfo Source #
Instances
((~) * signature (Maybe Text -> m ()), MonadIO m, IsAnnotMarkup a) => MethodInfo * AnnotMarkupSetLabelMethodInfo a signature Source # | |
Arguments
:: (HasCallStack, MonadIO m, IsAnnotMarkup a) | |
=> a |
|
-> Maybe Text |
|
-> m () |
Sets the label text of popplerAnnot
, replacing the current one
Since: 0.16
setOpacity
data AnnotMarkupSetOpacityMethodInfo Source #
Instances
((~) * signature (Double -> m ()), MonadIO m, IsAnnotMarkup a) => MethodInfo * AnnotMarkupSetOpacityMethodInfo a signature Source # | |
annotMarkupSetOpacity Source #
Arguments
:: (HasCallStack, MonadIO m, IsAnnotMarkup a) | |
=> a |
|
-> Double |
|
-> 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
data AnnotMarkupSetPopupMethodInfo Source #
Instances
((~) * signature (Rectangle -> m ()), MonadIO m, IsAnnotMarkup a) => MethodInfo * AnnotMarkupSetPopupMethodInfo a signature Source # | |
Arguments
:: (HasCallStack, MonadIO m, IsAnnotMarkup a) | |
=> 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
data AnnotMarkupSetPopupIsOpenMethodInfo Source #
Instances
((~) * signature (Bool -> m ()), MonadIO m, IsAnnotMarkup a) => MethodInfo * AnnotMarkupSetPopupIsOpenMethodInfo a signature Source # | |
annotMarkupSetPopupIsOpen Source #
Arguments
:: (HasCallStack, MonadIO m, IsAnnotMarkup a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets the state of the popup window related to popplerAnnot
.
Since: 0.16
setPopupRectangle
data AnnotMarkupSetPopupRectangleMethodInfo Source #
Instances
((~) * signature (Rectangle -> m ()), MonadIO m, IsAnnotMarkup a) => MethodInfo * AnnotMarkupSetPopupRectangleMethodInfo a signature Source # | |
annotMarkupSetPopupRectangle Source #
Arguments
:: (HasCallStack, MonadIO m, IsAnnotMarkup a) | |
=> a |
|
-> Rectangle |
|
-> 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