gi-gtksource-3.0.23: GtkSource bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.GtkSource.Objects.MarkAttributes

Description

No description available in the introspection data.

Synopsis

Exported types

newtype MarkAttributes Source #

Memory-managed wrapper type.

Constructors

MarkAttributes (ManagedPtr MarkAttributes) 

Instances

Instances details
Eq MarkAttributes Source # 
Instance details

Defined in GI.GtkSource.Objects.MarkAttributes

GObject MarkAttributes Source # 
Instance details

Defined in GI.GtkSource.Objects.MarkAttributes

ManagedPtrNewtype MarkAttributes Source # 
Instance details

Defined in GI.GtkSource.Objects.MarkAttributes

TypedObject MarkAttributes Source # 
Instance details

Defined in GI.GtkSource.Objects.MarkAttributes

Methods

glibType :: IO GType

IsGValue MarkAttributes Source #

Convert MarkAttributes to and from GValue with toGValue and fromGValue.

Instance details

Defined in GI.GtkSource.Objects.MarkAttributes

Methods

toGValue :: MarkAttributes -> IO GValue

fromGValue :: GValue -> IO MarkAttributes

HasParentTypes MarkAttributes Source # 
Instance details

Defined in GI.GtkSource.Objects.MarkAttributes

type ParentTypes MarkAttributes Source # 
Instance details

Defined in GI.GtkSource.Objects.MarkAttributes

type ParentTypes MarkAttributes = '[Object]

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

Instances details
(GObject o, IsDescendantOf MarkAttributes o) => IsMarkAttributes o Source # 
Instance details

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.

Methods

Overloaded methods

getBackground

markAttributesGetBackground Source #

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

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

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

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

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

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 queryTooltipMarkup signal. The tooltip may contain a markup.

getTooltipText

markAttributesGetTooltipText Source #

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 queryTooltipText signal. The tooltip is a plain text.

new

markAttributesNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m MarkAttributes

Returns: a new source mark attributes.

Creates a new source mark attributes.

renderIcon

markAttributesRenderIcon Source #

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

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

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

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

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

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

A color used for background of a line.

constructMarkAttributesBackground :: (IsMarkAttributes o, MonadIO m) => RGBA -> m (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, MonadIO m, IsIcon a) => a -> m (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, MonadIO m) => Text -> m (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, MonadIO m, IsPixbuf a) => a -> m (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, MonadIO m) => Text -> m (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 #

Arguments

 = Mark

mark: The Mark.

-> IO Text

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

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 queryTooltipMarkup signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after markAttributes #queryTooltipMarkup callback

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

Connect a signal handler for the queryTooltipMarkup signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on markAttributes #queryTooltipMarkup callback

queryTooltipText

type C_MarkAttributesQueryTooltipTextCallback = Ptr () -> Ptr Mark -> Ptr () -> IO CString Source #

Type for the callback on the (unwrapped) C side.

type MarkAttributesQueryTooltipTextCallback Source #

Arguments

 = Mark

mark: The Mark.

-> IO Text

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

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 queryTooltipText signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after markAttributes #queryTooltipText callback

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

Connect a signal handler for the queryTooltipText signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on markAttributes #queryTooltipText callback