Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | None |
Language | Haskell2010 |
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
- 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.
AnnotMarkup (ManagedPtr AnnotMarkup) |
Instances
Eq AnnotMarkup Source # | |
Defined in GI.Poppler.Objects.AnnotMarkup (==) :: AnnotMarkup -> AnnotMarkup -> Bool (/=) :: AnnotMarkup -> AnnotMarkup -> Bool | |
GObject AnnotMarkup Source # | |
Defined in GI.Poppler.Objects.AnnotMarkup | |
ManagedPtrNewtype AnnotMarkup Source # | |
Defined in GI.Poppler.Objects.AnnotMarkup toManagedPtr :: AnnotMarkup -> ManagedPtr AnnotMarkup | |
TypedObject AnnotMarkup Source # | |
Defined in GI.Poppler.Objects.AnnotMarkup glibType :: IO GType | |
IsGValue AnnotMarkup Source # | Convert |
Defined in GI.Poppler.Objects.AnnotMarkup toGValue :: AnnotMarkup -> IO GValue fromGValue :: GValue -> IO AnnotMarkup | |
HasParentTypes AnnotMarkup Source # | |
Defined in GI.Poppler.Objects.AnnotMarkup | |
type ParentTypes AnnotMarkup Source # | |
Defined in GI.Poppler.Objects.AnnotMarkup |
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 # | |
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
.
Methods
Overloaded methods
getDate
:: (HasCallStack, MonadIO m, IsAnnotMarkup a) | |
=> a |
|
-> m Date | Returns: a |
Returns the date and time when the annotation was created
getExternalData
annotMarkupGetExternalData Source #
:: (HasCallStack, MonadIO m, IsAnnotMarkup a) | |
=> a |
|
-> m AnnotExternalDataType | Returns: |
Gets the external data type of popplerAnnot
.
getLabel
:: (HasCallStack, MonadIO m, IsAnnotMarkup a) | |
=> a |
|
-> m Text | Returns: the label text of |
Retrieves the label text of popplerAnnot
.
getOpacity
annotMarkupGetOpacity Source #
:: (HasCallStack, MonadIO m, IsAnnotMarkup a) | |
=> a |
|
-> m Double | Returns: the opacity value of |
Retrieves the opacity value of popplerAnnot
.
getPopupIsOpen
annotMarkupGetPopupIsOpen Source #
:: (HasCallStack, MonadIO m, IsAnnotMarkup a) | |
=> a |
|
-> m Bool | Returns: the state of |
Retrieves the state of the popup window related to popplerAnnot
.
getPopupRectangle
annotMarkupGetPopupRectangle Source #
:: (HasCallStack, MonadIO m, IsAnnotMarkup a) | |
=> a |
|
-> m (Bool, Rectangle) | Returns: |
Retrieves the rectangle of the popup window related to popplerAnnot
.
Since: 0.12
getReplyTo
annotMarkupGetReplyTo Source #
:: (HasCallStack, MonadIO m, IsAnnotMarkup a) | |
=> a |
|
-> m AnnotMarkupReplyType | Returns: |
Gets the reply type of popplerAnnot
.
getSubject
annotMarkupGetSubject Source #
:: (HasCallStack, MonadIO m, IsAnnotMarkup a) | |
=> a |
|
-> m Text | Returns: the subject text of |
Retrives the subject text of popplerAnnot
.
hasPopup
:: (HasCallStack, MonadIO m, IsAnnotMarkup a) | |
=> a |
|
-> m Bool | Returns: |
Return True
if the markup annotation has a popup window associated
Since: 0.12
setLabel
:: (HasCallStack, MonadIO m, IsAnnotMarkup a) | |
=> a |
|
-> Maybe Text |
|
-> m () |
Sets the label text of popplerAnnot
, replacing the current one
Since: 0.16
setOpacity
annotMarkupSetOpacity Source #
:: (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
:: (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
annotMarkupSetPopupIsOpen Source #
:: (HasCallStack, MonadIO m, IsAnnotMarkup a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets the state of the popup window related to popplerAnnot
.
Since: 0.16
setPopupRectangle
annotMarkupSetPopupRectangle Source #
:: (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