GI.Gtk.Objects.Style

A Style object encapsulates the information that provides the look and feel for a widget.

In GTK+ 3.0, GtkStyle has been deprecated and replaced by
t'GI.Gtk.Objects.StyleContext.StyleContext'.

Each Widget has an associated Style object that is used when rendering that widget. Also, a Style holds information for the five possible widget states though not every widget supports all five states; see StateType.

Usually the Style for a widget is the same as the default style that is set by GTK+ and modified the theme engine.

Usually applications should not need to use or modify the Style of their widgets.

Exported types

newtype Style

Memory-managed wrapper type.

Constructors

Style (ManagedPtr Style)

Instances

Eq Style

Defined in GI.Gtk.Objects.Style

Methods

(==) :: Style -> Style -> Bool

(/=) :: Style -> Style -> Bool

IsGValue Style

Convert Style to and from GValue with toGValue and fromGValue.

Defined in GI.Gtk.Objects.Style

Methods

toGValue :: Style -> IO GValue

fromGValue :: GValue -> IO Style

GObject Style

Defined in GI.Gtk.Objects.Style

Methods

gobjectType :: IO GType

HasParentTypes Style

Defined in GI.Gtk.Objects.Style

type ParentTypes Style

Defined in GI.Gtk.Objects.Style

type ParentTypes Style = '[Object]

class (GObject o, IsDescendantOf Style o) => IsStyle o

Type class for types which can be safely cast to Style, for instance with toStyle.

Instances

(GObject o, IsDescendantOf Style o) => IsStyle o

Defined in GI.Gtk.Objects.Style

toStyle :: (MonadIO m, IsStyle o) => o -> m Style

Cast to Style, for types for which this is known to be safe. For general casts, use castTo.

noStyle :: Maybe Style

A convenience alias for Nothing :: Maybe Style.

Methods

Overloaded methods

applyDefaultBackground

styleApplyDefaultBackground :: (HasCallStack, MonadIO m, IsStyle a, IsWindow b) => a -> Context -> b -> StateType -> Int32 -> Int32 -> Int32 -> Int32 -> m ()

Deprecated: (Since version 3.0)Use StyleContext instead

No description available in the introspection data.

copy

styleCopy

Arguments

:: (HasCallStack, MonadIO m, IsStyle a)

=> a

style: a Style

-> m Style

Returns: a copy of style

Deprecated: (Since version 3.0)Use StyleContext instead

Creates a copy of the passed in Style object.

detach

styleDetach

Arguments

:: (HasCallStack, MonadIO m, IsStyle a)

=> a

style: a Style

-> m ()

Deprecated: (Since version 3.0)Use StyleContext instead

Detaches a style from a window. If the style is not attached to any windows anymore, it is unrealized. See gtk_style_attach().

getStyleProperty

styleGetStyleProperty

Arguments

:: (HasCallStack, MonadIO m, IsStyle a)

=> a

style: a Style

-> GType

widgetType: the GType of a descendant of Widget

-> Text

propertyName: the name of the style property to get

-> m GValue

Queries the value of a style property corresponding to a widget class is in the given style.

Since: 2.16

hasContext

styleHasContext

Arguments

:: (HasCallStack, MonadIO m, IsStyle a)

=> a

style: a Style

-> m Bool

Returns: True if style has a StyleContext

Returns whether style has an associated StyleContext.

Since: 3.0

lookupColor

styleLookupColor

Arguments

:: (HasCallStack, MonadIO m, IsStyle a)

=> a

style: a Style

-> Text

colorName: the name of the logical color to look up

-> m (Bool, Color)

Returns: True if the mapping was found.

Deprecated: (Since version 3.0)Use styleContextLookupColor instead

Looks up colorName in the style’s logical color mappings, filling in color and returning True if found, otherwise returning False. Do not cache the found mapping, because it depends on the Style and might change when a theme switch occurs.

Since: 2.10

lookupIconSet

styleLookupIconSet

Arguments

:: (HasCallStack, MonadIO m, IsStyle a)

=> a

style: a Style

-> Text

stockId: an icon name

-> m IconSet

Returns: icon set of stockId

Deprecated: (Since version 3.0)Use styleContextLookupIconSet instead

Looks up stockId in the icon factories associated with style and the default icon factory, returning an icon set if found, otherwise Nothing.

new

styleNew

Arguments

:: (HasCallStack, MonadIO m)

=> m Style

Returns: a new Style.

Deprecated: (Since version 3.0)Use StyleContext

Creates a new Style.

renderIcon

styleRenderIcon

Arguments

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

=> a

style: a Style

-> IconSource

source: the IconSource specifying the icon to render

-> TextDirection

direction: a text direction

-> StateType

state: a state

-> Int32

size: the size to render the icon at (tIconSize). A size of (GtkIconSize)-1 means render at the size of the source and don’t scale.

-> Maybe b

widget: the widget

-> Maybe Text

detail: a style detail

-> m Pixbuf

Returns: a newly-created Pixbuf containing the rendered icon

Deprecated: (Since version 3.0)Use renderIconPixbuf instead

Renders the icon specified by source at the given size according to the given parameters and returns the result in a pixbuf.

setBackground

styleSetBackground

Arguments

:: (HasCallStack, MonadIO m, IsStyle a, IsWindow b)

=> a

style: a Style

-> b

window: a Window

-> StateType

stateType: a state

-> m ()

Deprecated: (Since version 3.0)Use styleContextSetBackground instead

Sets the background of window to the background color or pixmap specified by style for the given state.

Properties

context

No description available in the introspection data.

constructStyleContext :: (IsStyle o, IsStyleContext a) => a -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “context” property. This is rarely needed directly, but it is used by new.

getStyleContext :: (MonadIO m, IsStyle o) => o -> m (Maybe StyleContext)

Get the value of the “context” property. When overloading is enabled, this is equivalent to

get style #context

Signals

realize

type C_StyleRealizeCallback = Ptr () -> Ptr () -> IO ()

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

type StyleRealizeCallback = IO ()

Emitted when the style has been initialized for a particular visual. Connecting to this signal is probably seldom useful since most of the time applications and widgets only deal with styles that have been already realized.

Since: 2.4

afterStyleRealize :: (IsStyle a, MonadIO m) => a -> StyleRealizeCallback -> m SignalHandlerId

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

after style #realize callback

genClosure_StyleRealize :: MonadIO m => StyleRealizeCallback -> m (GClosure C_StyleRealizeCallback)

Wrap the callback into a GClosure.

mk_StyleRealizeCallback :: C_StyleRealizeCallback -> IO (FunPtr C_StyleRealizeCallback)

Generate a function pointer callable from C code, from a C_StyleRealizeCallback.

noStyleRealizeCallback :: Maybe StyleRealizeCallback

A convenience synonym for Nothing :: Maybe StyleRealizeCallback.

onStyleRealize :: (IsStyle a, MonadIO m) => a -> StyleRealizeCallback -> m SignalHandlerId

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

on style #realize callback

wrap_StyleRealizeCallback :: StyleRealizeCallback -> C_StyleRealizeCallback

Wrap a StyleRealizeCallback into a C_StyleRealizeCallback.

unrealize

type C_StyleUnrealizeCallback = Ptr () -> Ptr () -> IO ()

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

type StyleUnrealizeCallback = IO ()

Emitted when the aspects of the style specific to a particular visual is being cleaned up. A connection to this signal can be useful if a widget wants to cache objects as object data on Style. This signal provides a convenient place to free such cached objects.

Since: 2.4

afterStyleUnrealize :: (IsStyle a, MonadIO m) => a -> StyleUnrealizeCallback -> m SignalHandlerId

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

after style #unrealize callback

genClosure_StyleUnrealize :: MonadIO m => StyleUnrealizeCallback -> m (GClosure C_StyleUnrealizeCallback)

Wrap the callback into a GClosure.

mk_StyleUnrealizeCallback :: C_StyleUnrealizeCallback -> IO (FunPtr C_StyleUnrealizeCallback)

Generate a function pointer callable from C code, from a C_StyleUnrealizeCallback.

noStyleUnrealizeCallback :: Maybe StyleUnrealizeCallback

A convenience synonym for Nothing :: Maybe StyleUnrealizeCallback.

onStyleUnrealize :: (IsStyle a, MonadIO m) => a -> StyleUnrealizeCallback -> m SignalHandlerId

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

on style #unrealize callback

wrap_StyleUnrealizeCallback :: StyleUnrealizeCallback -> C_StyleUnrealizeCallback

Wrap a StyleUnrealizeCallback into a C_StyleUnrealizeCallback.