GI.GtkSource.Objects.MarkAttributes

Exported types

newtype MarkAttributes

Constructors

MarkAttributes (ManagedPtr MarkAttributes)

Instances

GObject MarkAttributes

Methods

gobjectType :: MarkAttributes -> IO GType

IsObject MarkAttributes

IsMarkAttributes MarkAttributes

class GObject o => IsMarkAttributes o

Instances

(GObject a, UnknownAncestorError Constraint MarkAttributes a) => IsMarkAttributes a

IsMarkAttributes MarkAttributes

toMarkAttributes :: (MonadIO m, IsMarkAttributes o) => o -> m MarkAttributes

noMarkAttributes :: Maybe MarkAttributes

Methods

getBackground

markAttributesGetBackground

Arguments

:: (HasCallStack, MonadIO m, IsMarkAttributes a)

=> a

attributes: a MarkAttributes.

-> m (Bool, RGBA)

Returns: whether background color for attributes was set.

Stores background color in background.

getGicon

markAttributesGetGicon

Arguments

:: (HasCallStack, MonadIO m, IsMarkAttributes a)

=> a

attributes: a MarkAttributes.

-> m Icon

Returns: An icon. The icon belongs to attributes and should not be unreffed.

Gets a Icon to be used as a base for rendered icon. Note that the icon can be Nothing if it wasn't set earlier.

getIconName

markAttributesGetIconName

Arguments

:: (HasCallStack, MonadIO m, IsMarkAttributes a)

=> a

attributes: a MarkAttributes.

-> m Text

Returns: An icon name. The string belongs to attributes and should not be freed.

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

Arguments

:: (HasCallStack, MonadIO m, IsMarkAttributes a)

=> a

attributes: a MarkAttributes.

-> m Pixbuf

Returns: A pixbuf. The pixbuf belongs to attributes and should not be unreffed.

Gets a Pixbuf to be used as a base for rendered icon. Note that the pixbuf can be Nothing if it wasn't set earlier.

getStockId

markAttributesGetStockId

Arguments

:: (HasCallStack, MonadIO m, IsMarkAttributes a)

=> a

attributes: a MarkAttributes.

-> m Text

Returns: Stock id. Returned string is owned by attributes and shouldn't be freed.

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

Arguments

:: (HasCallStack, MonadIO m, IsMarkAttributes a, IsMark b)

=> a

attributes: a MarkAttributes.

-> b

mark: a Mark.

-> m Text

Returns: A tooltip. The returned string should be freed by using free when done with it.

Queries for a tooltip by emitting a MarkAttributes::query-tooltip-markup signal. The tooltip may contain a markup.

getTooltipText

markAttributesGetTooltipText

Arguments

:: (HasCallStack, MonadIO m, IsMarkAttributes a, IsMark b)

=> a

attributes: a MarkAttributes.

-> b

mark: a Mark.

-> m Text

Returns: A tooltip. The returned string should be freed by using free when done with it.

Queries for a tooltip by emitting a MarkAttributes::query-tooltip-text signal. The tooltip is a plain text.

new

markAttributesNew

Arguments

:: (HasCallStack, MonadIO m)

=> m MarkAttributes

Returns: a new source mark attributes.

Creates a new source mark attributes.

renderIcon

markAttributesRenderIcon

Arguments

:: (HasCallStack, MonadIO m, IsMarkAttributes a, IsWidget b)

=> a

attributes: a MarkAttributes.

-> b

widget: widget of which style settings may be used.

-> Int32

size: size of the rendered icon.

-> m Pixbuf

Returns: A rendered pixbuf. The pixbuf belongs to attributes and should not be unreffed.

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

Arguments

:: (HasCallStack, MonadIO m, IsMarkAttributes a)

=> a

attributes: a MarkAttributes.

-> RGBA

background: a RGBA.

-> m ()

Sets background color to the one given in background.

setGicon

markAttributesSetGicon

Arguments

:: (HasCallStack, MonadIO m, IsMarkAttributes a, IsIcon b)

=> a

attributes: a MarkAttributes.

-> b

gicon: a Icon to be used.

-> m ()

Sets an icon to be used as a base for rendered icon.

setIconName

markAttributesSetIconName

Arguments

:: (HasCallStack, MonadIO m, IsMarkAttributes a)

=> a

attributes: a MarkAttributes.

-> Text

iconName: name of an icon to be used.

-> m ()

Sets a name of an icon to be used as a base for rendered icon.

setPixbuf

markAttributesSetPixbuf

Arguments

:: (HasCallStack, MonadIO m, IsMarkAttributes a, IsPixbuf b)

=> a

attributes: a MarkAttributes.

-> b

pixbuf: a Pixbuf to be used.

-> m ()

Sets a pixbuf to be used as a base for rendered icon.

setStockId

markAttributesSetStockId

Arguments

:: (HasCallStack, MonadIO m, IsMarkAttributes a)

=> a

attributes: a MarkAttributes.

-> Text

stockId: a stock id.

-> 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

constructMarkAttributesBackground :: IsMarkAttributes o => RGBA -> IO (GValueConstruct o)

getMarkAttributesBackground :: (MonadIO m, IsMarkAttributes o) => o -> m (Maybe RGBA)

setMarkAttributesBackground :: (MonadIO m, IsMarkAttributes o) => o -> RGBA -> m ()

gicon

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 ()

iconName

constructMarkAttributesIconName :: IsMarkAttributes o => Text -> IO (GValueConstruct o)

getMarkAttributesIconName :: (MonadIO m, IsMarkAttributes o) => o -> m Text

setMarkAttributesIconName :: (MonadIO m, IsMarkAttributes o) => o -> Text -> m ()

pixbuf

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 ()

stockId

constructMarkAttributesStockId :: IsMarkAttributes o => Text -> IO (GValueConstruct o)

getMarkAttributesStockId :: (MonadIO m, IsMarkAttributes o) => o -> m Text

setMarkAttributesStockId :: (MonadIO m, IsMarkAttributes o) => o -> Text -> m ()

Signals

queryTooltipMarkup

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 :: MarkAttributesQueryTooltipMarkupCallback -> IO Closure

mk_MarkAttributesQueryTooltipMarkupCallback :: C_MarkAttributesQueryTooltipMarkupCallback -> IO (FunPtr C_MarkAttributesQueryTooltipMarkupCallback)

noMarkAttributesQueryTooltipMarkupCallback :: Maybe MarkAttributesQueryTooltipMarkupCallback

onMarkAttributesQueryTooltipMarkup :: (IsMarkAttributes a, MonadIO m) => a -> MarkAttributesQueryTooltipMarkupCallback -> m SignalHandlerId

wrap_MarkAttributesQueryTooltipMarkupCallback :: MarkAttributesQueryTooltipMarkupCallback -> Ptr () -> Ptr Mark -> Ptr () -> IO CString

queryTooltipText

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 :: MarkAttributesQueryTooltipTextCallback -> IO Closure

mk_MarkAttributesQueryTooltipTextCallback :: C_MarkAttributesQueryTooltipTextCallback -> IO (FunPtr C_MarkAttributesQueryTooltipTextCallback)

noMarkAttributesQueryTooltipTextCallback :: Maybe MarkAttributesQueryTooltipTextCallback

onMarkAttributesQueryTooltipText :: (IsMarkAttributes a, MonadIO m) => a -> MarkAttributesQueryTooltipTextCallback -> m SignalHandlerId

wrap_MarkAttributesQueryTooltipTextCallback :: MarkAttributesQueryTooltipTextCallback -> Ptr () -> Ptr Mark -> Ptr () -> IO CString