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 |
No description available in the introspection data.
Synopsis
- newtype MarkAttributes = MarkAttributes (ManagedPtr MarkAttributes)
- class (GObject o, IsDescendantOf MarkAttributes o) => IsMarkAttributes o
- toMarkAttributes :: (MonadIO m, IsMarkAttributes o) => o -> m MarkAttributes
- noMarkAttributes :: Maybe MarkAttributes
- markAttributesGetBackground :: (HasCallStack, MonadIO m, IsMarkAttributes a) => a -> m (Bool, RGBA)
- markAttributesGetGicon :: (HasCallStack, MonadIO m, IsMarkAttributes a) => a -> m Icon
- markAttributesGetIconName :: (HasCallStack, MonadIO m, IsMarkAttributes a) => a -> m Text
- markAttributesGetPixbuf :: (HasCallStack, MonadIO m, IsMarkAttributes a) => a -> m Pixbuf
- markAttributesGetStockId :: (HasCallStack, MonadIO m, IsMarkAttributes a) => a -> m Text
- markAttributesGetTooltipMarkup :: (HasCallStack, MonadIO m, IsMarkAttributes a, IsMark b) => a -> b -> m Text
- markAttributesGetTooltipText :: (HasCallStack, MonadIO m, IsMarkAttributes a, IsMark b) => a -> b -> m Text
- markAttributesNew :: (HasCallStack, MonadIO m) => m MarkAttributes
- markAttributesRenderIcon :: (HasCallStack, MonadIO m, IsMarkAttributes a, IsWidget b) => a -> b -> Int32 -> m Pixbuf
- markAttributesSetBackground :: (HasCallStack, MonadIO m, IsMarkAttributes a) => a -> RGBA -> m ()
- markAttributesSetGicon :: (HasCallStack, MonadIO m, IsMarkAttributes a, IsIcon b) => a -> b -> m ()
- markAttributesSetIconName :: (HasCallStack, MonadIO m, IsMarkAttributes a) => a -> Text -> m ()
- markAttributesSetPixbuf :: (HasCallStack, MonadIO m, IsMarkAttributes a, IsPixbuf b) => a -> b -> m ()
- markAttributesSetStockId :: (HasCallStack, MonadIO m, IsMarkAttributes a) => a -> Text -> m ()
- constructMarkAttributesBackground :: IsMarkAttributes o => RGBA -> IO (GValueConstruct o)
- getMarkAttributesBackground :: (MonadIO m, IsMarkAttributes o) => o -> m (Maybe RGBA)
- setMarkAttributesBackground :: (MonadIO m, IsMarkAttributes o) => o -> RGBA -> m ()
- constructMarkAttributesGicon :: (IsMarkAttributes o, IsIcon a) => a -> IO (GValueConstruct o)
- getMarkAttributesGicon :: (MonadIO m, IsMarkAttributes o) => o -> m Icon
- setMarkAttributesGicon :: (MonadIO m, IsMarkAttributes o, IsIcon a) => o -> a -> m ()
- constructMarkAttributesIconName :: IsMarkAttributes o => Text -> IO (GValueConstruct o)
- getMarkAttributesIconName :: (MonadIO m, IsMarkAttributes o) => o -> m Text
- setMarkAttributesIconName :: (MonadIO m, IsMarkAttributes o) => o -> Text -> m ()
- constructMarkAttributesPixbuf :: (IsMarkAttributes o, IsPixbuf a) => a -> IO (GValueConstruct o)
- getMarkAttributesPixbuf :: (MonadIO m, IsMarkAttributes o) => o -> m Pixbuf
- setMarkAttributesPixbuf :: (MonadIO m, IsMarkAttributes o, IsPixbuf a) => o -> a -> m ()
- constructMarkAttributesStockId :: IsMarkAttributes o => Text -> IO (GValueConstruct o)
- getMarkAttributesStockId :: (MonadIO m, IsMarkAttributes o) => o -> m Text
- setMarkAttributesStockId :: (MonadIO m, IsMarkAttributes o) => o -> Text -> m ()
- type C_MarkAttributesQueryTooltipMarkupCallback = Ptr () -> Ptr Mark -> Ptr () -> IO CString
- type MarkAttributesQueryTooltipMarkupCallback = Mark -> IO Text
- afterMarkAttributesQueryTooltipMarkup :: (IsMarkAttributes a, MonadIO m) => a -> MarkAttributesQueryTooltipMarkupCallback -> m SignalHandlerId
- genClosure_MarkAttributesQueryTooltipMarkup :: MonadIO m => MarkAttributesQueryTooltipMarkupCallback -> m (GClosure C_MarkAttributesQueryTooltipMarkupCallback)
- mk_MarkAttributesQueryTooltipMarkupCallback :: C_MarkAttributesQueryTooltipMarkupCallback -> IO (FunPtr C_MarkAttributesQueryTooltipMarkupCallback)
- noMarkAttributesQueryTooltipMarkupCallback :: Maybe MarkAttributesQueryTooltipMarkupCallback
- onMarkAttributesQueryTooltipMarkup :: (IsMarkAttributes a, MonadIO m) => a -> MarkAttributesQueryTooltipMarkupCallback -> m SignalHandlerId
- wrap_MarkAttributesQueryTooltipMarkupCallback :: MarkAttributesQueryTooltipMarkupCallback -> C_MarkAttributesQueryTooltipMarkupCallback
- type C_MarkAttributesQueryTooltipTextCallback = Ptr () -> Ptr Mark -> Ptr () -> IO CString
- type MarkAttributesQueryTooltipTextCallback = Mark -> IO Text
- afterMarkAttributesQueryTooltipText :: (IsMarkAttributes a, MonadIO m) => a -> MarkAttributesQueryTooltipTextCallback -> m SignalHandlerId
- genClosure_MarkAttributesQueryTooltipText :: MonadIO m => MarkAttributesQueryTooltipTextCallback -> m (GClosure C_MarkAttributesQueryTooltipTextCallback)
- mk_MarkAttributesQueryTooltipTextCallback :: C_MarkAttributesQueryTooltipTextCallback -> IO (FunPtr C_MarkAttributesQueryTooltipTextCallback)
- noMarkAttributesQueryTooltipTextCallback :: Maybe MarkAttributesQueryTooltipTextCallback
- onMarkAttributesQueryTooltipText :: (IsMarkAttributes a, MonadIO m) => a -> MarkAttributesQueryTooltipTextCallback -> m SignalHandlerId
- wrap_MarkAttributesQueryTooltipTextCallback :: MarkAttributesQueryTooltipTextCallback -> C_MarkAttributesQueryTooltipTextCallback
Exported types
newtype MarkAttributes Source #
Memory-managed wrapper type.
MarkAttributes (ManagedPtr MarkAttributes) |
Instances
GObject MarkAttributes Source # | |
Defined in GI.GtkSource.Objects.MarkAttributes gobjectType :: IO GType | |
HasParentTypes MarkAttributes Source # | |
Defined in GI.GtkSource.Objects.MarkAttributes | |
type ParentTypes MarkAttributes Source # | |
Defined in GI.GtkSource.Objects.MarkAttributes |
class (GObject o, IsDescendantOf MarkAttributes o) => IsMarkAttributes o Source #
Type class for types which can be safely cast to MarkAttributes
, for instance with toMarkAttributes
.
Instances
(GObject o, IsDescendantOf MarkAttributes o) => IsMarkAttributes o Source # | |
Defined in GI.GtkSource.Objects.MarkAttributes |
toMarkAttributes :: (MonadIO m, IsMarkAttributes o) => o -> m MarkAttributes Source #
Cast to MarkAttributes
, for types for which this is known to be safe. For general casts, use castTo
.
noMarkAttributes :: Maybe MarkAttributes Source #
A convenience alias for Nothing
:: Maybe
MarkAttributes
.
Methods
getBackground
markAttributesGetBackground Source #
:: (HasCallStack, MonadIO m, IsMarkAttributes a) | |
=> a |
|
-> m (Bool, RGBA) | Returns: whether background color for |
Stores background color in background
.
getGicon
markAttributesGetGicon Source #
:: (HasCallStack, MonadIO m, IsMarkAttributes a) | |
=> a |
|
-> m Icon | Returns: An icon. The icon belongs to |
getIconName
markAttributesGetIconName Source #
:: (HasCallStack, MonadIO m, IsMarkAttributes a) | |
=> a |
|
-> m Text | Returns: An icon name. The string belongs to |
Gets a name of an icon to be used as a base for rendered icon. Note that the
icon name can be Nothing
if it wasn't set earlier.
getPixbuf
markAttributesGetPixbuf Source #
:: (HasCallStack, MonadIO m, IsMarkAttributes a) | |
=> a |
|
-> m Pixbuf | Returns: A pixbuf. The pixbuf belongs to |
getStockId
markAttributesGetStockId Source #
:: (HasCallStack, MonadIO m, IsMarkAttributes a) | |
=> a |
|
-> m Text | Returns: Stock id. Returned string is owned by |
Deprecated: (Since version 3.10)Don't use this function.
Gets a stock id of an icon used by this attributes. Note that the stock id can
be Nothing
if it wasn't set earlier.
getTooltipMarkup
markAttributesGetTooltipMarkup Source #
:: (HasCallStack, MonadIO m, IsMarkAttributes a, IsMark b) | |
=> a |
|
-> b |
|
-> m Text | Returns: A tooltip. The returned string should be freed by
using |
Queries for a tooltip by emitting
a MarkAttributes
::query-tooltip-markup
signal. The tooltip may contain
a markup.
getTooltipText
markAttributesGetTooltipText Source #
:: (HasCallStack, MonadIO m, IsMarkAttributes a, IsMark b) | |
=> a |
|
-> b |
|
-> m Text | Returns: A tooltip. The returned string should be freed by
using |
Queries for a tooltip by emitting
a MarkAttributes
::query-tooltip-text
signal. The tooltip is a plain
text.
new
:: (HasCallStack, MonadIO m) | |
=> m MarkAttributes | Returns: a new source mark attributes. |
Creates a new source mark attributes.
renderIcon
markAttributesRenderIcon Source #
:: (HasCallStack, MonadIO m, IsMarkAttributes a, IsWidget b) | |
=> a |
|
-> b |
|
-> Int32 |
|
-> m Pixbuf | Returns: A rendered pixbuf. The pixbuf belongs to |
Renders an icon of given size. The base of the icon is set by the last call
to one of: markAttributesSetPixbuf
,
markAttributesSetGicon
,
markAttributesSetIconName
or
markAttributesSetStockId
. size
cannot be lower than 1.
setBackground
markAttributesSetBackground Source #
:: (HasCallStack, MonadIO m, IsMarkAttributes a) | |
=> a |
|
-> RGBA |
|
-> m () |
Sets background color to the one given in background
.
setGicon
markAttributesSetGicon Source #
:: (HasCallStack, MonadIO m, IsMarkAttributes a, IsIcon b) | |
=> a |
|
-> b |
|
-> m () |
Sets an icon to be used as a base for rendered icon.
setIconName
markAttributesSetIconName Source #
:: (HasCallStack, MonadIO m, IsMarkAttributes a) | |
=> a |
|
-> Text |
|
-> m () |
Sets a name of an icon to be used as a base for rendered icon.
setPixbuf
markAttributesSetPixbuf Source #
:: (HasCallStack, MonadIO m, IsMarkAttributes a, IsPixbuf b) | |
=> a |
|
-> b |
|
-> m () |
Sets a pixbuf to be used as a base for rendered icon.
setStockId
markAttributesSetStockId Source #
:: (HasCallStack, MonadIO m, IsMarkAttributes a) | |
=> a |
|
-> Text |
|
-> m () |
Deprecated: (Since version 3.10)Don't use this function.
Sets stock id to be used as a base for rendered icon.
Properties
background
A color used for background of a line.
constructMarkAttributesBackground :: IsMarkAttributes o => RGBA -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “background
” property. This is rarely needed directly, but it is used by new
.
getMarkAttributesBackground :: (MonadIO m, IsMarkAttributes o) => o -> m (Maybe RGBA) Source #
Get the value of the “background
” property.
When overloading is enabled, this is equivalent to
get
markAttributes #background
setMarkAttributesBackground :: (MonadIO m, IsMarkAttributes o) => o -> RGBA -> m () Source #
Set the value of the “background
” property.
When overloading is enabled, this is equivalent to
set
markAttributes [ #background:=
value ]
gicon
A Icon
that may be a base of a rendered icon.
constructMarkAttributesGicon :: (IsMarkAttributes o, IsIcon a) => a -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “gicon
” property. This is rarely needed directly, but it is used by new
.
getMarkAttributesGicon :: (MonadIO m, IsMarkAttributes o) => o -> m Icon Source #
Get the value of the “gicon
” property.
When overloading is enabled, this is equivalent to
get
markAttributes #gicon
setMarkAttributesGicon :: (MonadIO m, IsMarkAttributes o, IsIcon a) => o -> a -> m () Source #
Set the value of the “gicon
” property.
When overloading is enabled, this is equivalent to
set
markAttributes [ #gicon:=
value ]
iconName
An icon name that may be a base of a rendered icon.
constructMarkAttributesIconName :: IsMarkAttributes o => Text -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “icon-name
” property. This is rarely needed directly, but it is used by new
.
getMarkAttributesIconName :: (MonadIO m, IsMarkAttributes o) => o -> m Text Source #
Get the value of the “icon-name
” property.
When overloading is enabled, this is equivalent to
get
markAttributes #iconName
setMarkAttributesIconName :: (MonadIO m, IsMarkAttributes o) => o -> Text -> m () Source #
Set the value of the “icon-name
” property.
When overloading is enabled, this is equivalent to
set
markAttributes [ #iconName:=
value ]
pixbuf
A Pixbuf
that may be a base of a rendered icon.
constructMarkAttributesPixbuf :: (IsMarkAttributes o, IsPixbuf a) => a -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “pixbuf
” property. This is rarely needed directly, but it is used by new
.
getMarkAttributesPixbuf :: (MonadIO m, IsMarkAttributes o) => o -> m Pixbuf Source #
Get the value of the “pixbuf
” property.
When overloading is enabled, this is equivalent to
get
markAttributes #pixbuf
setMarkAttributesPixbuf :: (MonadIO m, IsMarkAttributes o, IsPixbuf a) => o -> a -> m () Source #
Set the value of the “pixbuf
” property.
When overloading is enabled, this is equivalent to
set
markAttributes [ #pixbuf:=
value ]
stockId
A stock id that may be a base of a rendered icon.
constructMarkAttributesStockId :: IsMarkAttributes o => Text -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “stock-id
” property. This is rarely needed directly, but it is used by new
.
getMarkAttributesStockId :: (MonadIO m, IsMarkAttributes o) => o -> m Text Source #
Get the value of the “stock-id
” property.
When overloading is enabled, this is equivalent to
get
markAttributes #stockId
setMarkAttributesStockId :: (MonadIO m, IsMarkAttributes o) => o -> Text -> m () Source #
Set the value of the “stock-id
” property.
When overloading is enabled, this is equivalent to
set
markAttributes [ #stockId:=
value ]
Signals
queryTooltipMarkup
type C_MarkAttributesQueryTooltipMarkupCallback = Ptr () -> Ptr Mark -> Ptr () -> IO CString Source #
Type for the callback on the (unwrapped) C side.
type MarkAttributesQueryTooltipMarkupCallback Source #
= Mark |
|
-> IO Text | Returns: A tooltip. The string should be freed with
|
The code should connect to this signal to provide a tooltip for given
mark
. The tooltip can contain a markup.
afterMarkAttributesQueryTooltipMarkup :: (IsMarkAttributes a, MonadIO m) => a -> MarkAttributesQueryTooltipMarkupCallback -> m SignalHandlerId Source #
Connect a signal handler for the “query-tooltip-markup
” signal, to be run after the default handler.
When overloading is enabled, this is equivalent to
after
markAttributes #queryTooltipMarkup callback
genClosure_MarkAttributesQueryTooltipMarkup :: MonadIO m => MarkAttributesQueryTooltipMarkupCallback -> m (GClosure C_MarkAttributesQueryTooltipMarkupCallback) Source #
Wrap the callback into a GClosure
.
mk_MarkAttributesQueryTooltipMarkupCallback :: C_MarkAttributesQueryTooltipMarkupCallback -> IO (FunPtr C_MarkAttributesQueryTooltipMarkupCallback) Source #
Generate a function pointer callable from C code, from a C_MarkAttributesQueryTooltipMarkupCallback
.
noMarkAttributesQueryTooltipMarkupCallback :: Maybe MarkAttributesQueryTooltipMarkupCallback Source #
A convenience synonym for
.Nothing
:: Maybe
MarkAttributesQueryTooltipMarkupCallback
onMarkAttributesQueryTooltipMarkup :: (IsMarkAttributes a, MonadIO m) => a -> MarkAttributesQueryTooltipMarkupCallback -> m SignalHandlerId Source #
Connect a signal handler for the “query-tooltip-markup
” signal, to be run before the default handler.
When overloading is enabled, this is equivalent to
on
markAttributes #queryTooltipMarkup callback
wrap_MarkAttributesQueryTooltipMarkupCallback :: MarkAttributesQueryTooltipMarkupCallback -> C_MarkAttributesQueryTooltipMarkupCallback Source #
queryTooltipText
type C_MarkAttributesQueryTooltipTextCallback = Ptr () -> Ptr Mark -> Ptr () -> IO CString Source #
Type for the callback on the (unwrapped) C side.
type MarkAttributesQueryTooltipTextCallback Source #
= Mark |
|
-> IO Text | Returns: A tooltip. The string should be freed with
|
The code should connect to this signal to provide a tooltip for given
mark
. The tooltip should be just a plain text.
afterMarkAttributesQueryTooltipText :: (IsMarkAttributes a, MonadIO m) => a -> MarkAttributesQueryTooltipTextCallback -> m SignalHandlerId Source #
Connect a signal handler for the “query-tooltip-text
” signal, to be run after the default handler.
When overloading is enabled, this is equivalent to
after
markAttributes #queryTooltipText callback
genClosure_MarkAttributesQueryTooltipText :: MonadIO m => MarkAttributesQueryTooltipTextCallback -> m (GClosure C_MarkAttributesQueryTooltipTextCallback) Source #
Wrap the callback into a GClosure
.
mk_MarkAttributesQueryTooltipTextCallback :: C_MarkAttributesQueryTooltipTextCallback -> IO (FunPtr C_MarkAttributesQueryTooltipTextCallback) Source #
Generate a function pointer callable from C code, from a C_MarkAttributesQueryTooltipTextCallback
.
noMarkAttributesQueryTooltipTextCallback :: Maybe MarkAttributesQueryTooltipTextCallback Source #
A convenience synonym for
.Nothing
:: Maybe
MarkAttributesQueryTooltipTextCallback
onMarkAttributesQueryTooltipText :: (IsMarkAttributes a, MonadIO m) => a -> MarkAttributesQueryTooltipTextCallback -> m SignalHandlerId Source #
Connect a signal handler for the “query-tooltip-text
” signal, to be run before the default handler.
When overloading is enabled, this is equivalent to
on
markAttributes #queryTooltipText callback