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.AnnotText
Description
No description available in the introspection data.
Synopsis
- newtype AnnotText = AnnotText (ManagedPtr AnnotText)
- class GObject o => IsAnnotText o
- toAnnotText :: (MonadIO m, IsAnnotText o) => o -> m AnnotText
- noAnnotText :: Maybe 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.
Constructors
AnnotText (ManagedPtr AnnotText) |
Instances
GObject AnnotText Source # | |
Defined in GI.Poppler.Objects.AnnotText Methods gobjectType :: AnnotText -> IO GType # | |
IsObject AnnotText Source # | |
Defined in GI.Poppler.Objects.AnnotText | |
IsAnnot AnnotText Source # | |
Defined in GI.Poppler.Objects.AnnotText | |
IsAnnotMarkup AnnotText Source # | |
Defined in GI.Poppler.Objects.AnnotText | |
IsAnnotText AnnotText Source # | |
Defined in GI.Poppler.Objects.AnnotText |
class GObject o => IsAnnotText o Source #
Type class for types which can be safely cast to AnnotText
, for instance with toAnnotText
.
Instances
(GObject a, (UnknownAncestorError AnnotText a :: Constraint)) => IsAnnotText a Source # | |
Defined in GI.Poppler.Objects.AnnotText | |
IsAnnotText AnnotText Source # | |
Defined in GI.Poppler.Objects.AnnotText |
toAnnotText :: (MonadIO m, IsAnnotText o) => o -> m AnnotText Source #
Methods
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