GI.Gtk.Objects.StyleProperties

GtkStyleProperties provides the storage for style information that is used by StyleContext and other StyleProvider implementations.

Before style properties can be stored in GtkStyleProperties, they must be registered with gtk_style_properties_register_property().

Unless you are writing a StyleProvider implementation, you are unlikely to use this API directly, as gtk_style_context_get() and its variants are the preferred way to access styling information from widget implementations and theming engine implementations should use the APIs provided by ThemingEngine instead.

StyleProperties has been deprecated in GTK 3.16. The CSS machinery does not use it anymore and all users of this object have been deprecated.

Exported types

newtype StyleProperties

Constructors

StyleProperties (ManagedPtr StyleProperties)

Instances

GObject StyleProperties

Methods

gobjectType :: StyleProperties -> IO GType

IsObject StyleProperties

IsStyleProperties StyleProperties

IsStyleProvider StyleProperties

((~) * info (ResolveStylePropertiesMethod t StyleProperties), MethodInfo * info StyleProperties p) => IsLabel t (StyleProperties -> p)

Methods

fromLabel :: Proxy# Symbol t -> StyleProperties -> p

((~) * info (ResolveStylePropertiesMethod t StyleProperties), MethodInfo * info StyleProperties p) => IsLabelProxy t (StyleProperties -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> StyleProperties -> p

HasAttributeList * StyleProperties

type AttributeList StyleProperties

type AttributeList StyleProperties

type SignalList StyleProperties

type SignalList StyleProperties

class GObject o => IsStyleProperties o

Instances

(GObject a, UnknownAncestorError Constraint StyleProperties a) => IsStyleProperties a

IsStyleProperties StyleProperties

toStyleProperties :: IsStyleProperties o => o -> IO StyleProperties

noStyleProperties :: Maybe StyleProperties

Methods

clear

data StylePropertiesClearMethodInfo

Instances

((~) * signature (m ()), MonadIO m, IsStyleProperties a) => MethodInfo * StylePropertiesClearMethodInfo a signature

Methods

overloadedMethod :: MethodProxy StylePropertiesClearMethodInfo a -> signature -> s

stylePropertiesClear

Arguments

:: (HasCallStack, MonadIO m, IsStyleProperties a)

=> a

props: a StyleProperties

-> m ()

Deprecated: (Since version 3.16)StyleProperties are deprecated.

Clears all style information from props.

getProperty

data StylePropertiesGetPropertyMethodInfo

Instances

((~) * signature (Text -> [StateFlags] -> m (Bool, GValue)), MonadIO m, IsStyleProperties a) => MethodInfo * StylePropertiesGetPropertyMethodInfo a signature

Methods

overloadedMethod :: MethodProxy StylePropertiesGetPropertyMethodInfo a -> signature -> s

stylePropertiesGetProperty

Arguments

:: (HasCallStack, MonadIO m, IsStyleProperties a)

=> a

props: a StyleProperties

-> Text

property: style property name

-> [StateFlags]

state: state to retrieve the property value for

-> m (Bool, GValue)

Returns: True if the property exists in props, False otherwise

Deprecated: (Since version 3.16)StyleProperties are deprecated.

Gets a style property from props for the given state. When done with value, valueUnset needs to be called to free any allocated memory.

Since: 3.0

lookupColor

data StylePropertiesLookupColorMethodInfo

Instances

((~) * signature (Text -> m SymbolicColor), MonadIO m, IsStyleProperties a) => MethodInfo * StylePropertiesLookupColorMethodInfo a signature

Methods

overloadedMethod :: MethodProxy StylePropertiesLookupColorMethodInfo a -> signature -> s

stylePropertiesLookupColor

Arguments

:: (HasCallStack, MonadIO m, IsStyleProperties a)

=> a

props: a StyleProperties

-> Text

name: color name to lookup

-> m SymbolicColor

Returns: The mapped color

Deprecated: (Since version 3.8)SymbolicColor is deprecated.

Returns the symbolic color that is mapped to name.

Since: 3.0

mapColor

data StylePropertiesMapColorMethodInfo

Instances

((~) * signature (Text -> SymbolicColor -> m ()), MonadIO m, IsStyleProperties a) => MethodInfo * StylePropertiesMapColorMethodInfo a signature

Methods

overloadedMethod :: MethodProxy StylePropertiesMapColorMethodInfo a -> signature -> s

stylePropertiesMapColor

Arguments

:: (HasCallStack, MonadIO m, IsStyleProperties a)

=> a

props: a StyleProperties

-> Text

name: color name

-> SymbolicColor

color: SymbolicColor to map name to

-> m ()

Deprecated: (Since version 3.8)SymbolicColor is deprecated.

Maps color so it can be referenced by name. See stylePropertiesLookupColor

Since: 3.0

merge

data StylePropertiesMergeMethodInfo

Instances

((~) * signature (b -> Bool -> m ()), MonadIO m, IsStyleProperties a, IsStyleProperties b) => MethodInfo * StylePropertiesMergeMethodInfo a signature

Methods

overloadedMethod :: MethodProxy StylePropertiesMergeMethodInfo a -> signature -> s

stylePropertiesMerge

Arguments

:: (HasCallStack, MonadIO m, IsStyleProperties a, IsStyleProperties b)

=> a

props: a StyleProperties

-> b

propsToMerge: a second StyleProperties

-> Bool

replace: whether to replace values or not

-> m ()

Deprecated: (Since version 3.16)StyleProperties are deprecated.

Merges into props all the style information contained in propsToMerge. If replace is True, the values will be overwritten, if it is False, the older values will prevail.

Since: 3.0

new

stylePropertiesNew

Arguments

:: (HasCallStack, MonadIO m)

=> m StyleProperties

Returns: a new StyleProperties

Deprecated: (Since version 3.16)StyleProperties are deprecated.

Returns a newly created StyleProperties

setProperty

data StylePropertiesSetPropertyMethodInfo

Instances

((~) * signature (Text -> [StateFlags] -> GValue -> m ()), MonadIO m, IsStyleProperties a) => MethodInfo * StylePropertiesSetPropertyMethodInfo a signature

Methods

overloadedMethod :: MethodProxy StylePropertiesSetPropertyMethodInfo a -> signature -> s

stylePropertiesSetProperty

Arguments

:: (HasCallStack, MonadIO m, IsStyleProperties a)

=> a

props: a StyleProperties

-> Text

property: styling property to set

-> [StateFlags]

state: state to set the value for

-> GValue

value: new value for the property

-> m ()

Deprecated: (Since version 3.16)StyleProperties are deprecated.

Sets a styling property in props.

Since: 3.0

unsetProperty

data StylePropertiesUnsetPropertyMethodInfo

Instances

((~) * signature (Text -> [StateFlags] -> m ()), MonadIO m, IsStyleProperties a) => MethodInfo * StylePropertiesUnsetPropertyMethodInfo a signature

Methods

overloadedMethod :: MethodProxy StylePropertiesUnsetPropertyMethodInfo a -> signature -> s

stylePropertiesUnsetProperty

Arguments

:: (HasCallStack, MonadIO m, IsStyleProperties a)

=> a

props: a StyleProperties

-> Text

property: property to unset

-> [StateFlags]

state: state to unset

-> m ()

Deprecated: (Since version 3.16)StyleProperties are deprecated.

Unsets a style property in props.

Since: 3.0