Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
GI.Poppler.Objects.AnnotText
Description
No description available in the introspection data.
Synopsis
- newtype AnnotText = AnnotText (ManagedPtr AnnotText)
- class (GObject o, IsDescendantOf AnnotText o) => IsAnnotText o
- toAnnotText :: (MonadIO m, IsAnnotText o) => o -> m AnnotText
- annotTextGetIcon :: (HasCallStack, MonadIO m, IsAnnotText a) => a -> m Text
- annotTextGetIsOpen :: (HasCallStack, MonadIO m, IsAnnotText a) => a -> m Bool
- annotTextGetState :: (HasCallStack, MonadIO m, IsAnnotText a) => a -> m AnnotTextState
- annotTextNew :: (HasCallStack, MonadIO m, IsDocument a) => a -> Rectangle -> m AnnotText
- annotTextSetIcon :: (HasCallStack, MonadIO m, IsAnnotText a) => a -> Text -> m ()
- annotTextSetIsOpen :: (HasCallStack, MonadIO m, IsAnnotText a) => a -> Bool -> m ()
Exported types
Memory-managed wrapper type.
Instances
Eq AnnotText Source # | |
GObject AnnotText Source # | |
Defined in GI.Poppler.Objects.AnnotText | |
ManagedPtrNewtype AnnotText Source # | |
Defined in GI.Poppler.Objects.AnnotText Methods toManagedPtr :: AnnotText -> ManagedPtr AnnotText | |
TypedObject AnnotText Source # | |
Defined in GI.Poppler.Objects.AnnotText | |
HasParentTypes AnnotText Source # | |
Defined in GI.Poppler.Objects.AnnotText | |
IsGValue (Maybe AnnotText) Source # | Convert |
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 # | |
Defined in GI.Poppler.Objects.AnnotText |
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
(GObject o, IsDescendantOf AnnotText o) => IsAnnotText o Source # | |
Defined in GI.Poppler.Objects.AnnotText |
toAnnotText :: (MonadIO m, IsAnnotText o) => o -> m AnnotText Source #
Methods
Click to display all available methods, including inherited ones
Methods
bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, hasPopup, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getAnnotType, getColor, getContents, getData, getDate, getExternalData, getFlags, getIcon, getIsOpen, getLabel, getModified, getName, getOpacity, getPageIndex, getPopupIsOpen, getPopupRectangle, getProperty, getQdata, getRectangle, getReplyTo, getState, getSubject.
Setters
setColor, setContents, setData, setDataFull, setFlags, setIcon, setIsOpen, setLabel, setOpacity, setPopup, setPopupIsOpen, setPopupRectangle, setProperty, setRectangle.
getIcon
Arguments
:: (HasCallStack, MonadIO m, IsAnnotText a) | |
=> a |
|
-> m Text | Returns: a new allocated string containing the icon name |
Gets name of the icon of popplerAnnot
.
getIsOpen
Arguments
:: (HasCallStack, MonadIO m, IsAnnotText a) | |
=> a |
|
-> m Bool | Returns: the state of |
Retrieves the state of popplerAnnot
.
getState
Arguments
:: (HasCallStack, MonadIO m, IsAnnotText a) | |
=> a |
|
-> m AnnotTextState | Returns: |
Retrieves the state of popplerAnnot
.
new
Arguments
:: (HasCallStack, MonadIO m, IsDocument a) | |
=> a |
|
-> Rectangle |
|
-> m AnnotText | Returns: A newly created |
Creates a new Text annotation that will be
located on rect
when added to a page. See
pageAddAnnot
Since: 0.16
setIcon
Arguments
:: (HasCallStack, MonadIO m, IsAnnotText a) | |
=> a |
|
-> Text |
|
-> 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
Arguments
:: (HasCallStack, MonadIO m, IsAnnotText a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether popplerAnnot
should initially be displayed open
Since: 0.16