GI.Gtk.Objects.ThemingEngine

ThemingEngine was the object used for rendering themed content in GTK+ widgets. It used to allow overriding GTK+'s default implementation of rendering functions by allowing engines to be loaded as modules.

ThemingEngine has been deprecated in GTK+ 3.14 and will be ignored for rendering. The advancements in CSS theming are good enough to allow themers to achieve their goals without the need to modify source code.

Exported types

newtype ThemingEngine

Constructors

ThemingEngine (ManagedPtr ThemingEngine)

Instances

GObject ThemingEngine

Methods

gobjectType :: ThemingEngine -> IO GType

IsObject ThemingEngine

IsThemingEngine ThemingEngine

((~) * info (ResolveThemingEngineMethod t ThemingEngine), MethodInfo * info ThemingEngine p) => IsLabel t (ThemingEngine -> p)

Methods

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

((~) * info (ResolveThemingEngineMethod t ThemingEngine), MethodInfo * info ThemingEngine p) => IsLabelProxy t (ThemingEngine -> p)

Methods

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

HasAttributeList * ThemingEngine

type AttributeList ThemingEngine

type AttributeList ThemingEngine

type SignalList ThemingEngine

type SignalList ThemingEngine

class GObject o => IsThemingEngine o

Instances

(GObject a, UnknownAncestorError Constraint ThemingEngine a) => IsThemingEngine a

IsThemingEngine ThemingEngine

toThemingEngine :: IsThemingEngine o => o -> IO ThemingEngine

noThemingEngine :: Maybe ThemingEngine

Methods

getBackgroundColor

data ThemingEngineGetBackgroundColorMethodInfo

Instances

((~) * signature ([StateFlags] -> m RGBA), MonadIO m, IsThemingEngine a) => MethodInfo * ThemingEngineGetBackgroundColorMethodInfo a signature

Methods

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

themingEngineGetBackgroundColor

Arguments

:: (HasCallStack, MonadIO m, IsThemingEngine a)

=> a

engine: a ThemingEngine

-> [StateFlags]

state: state to retrieve the color for

-> m RGBA

Deprecated: (Since version 3.14)

Gets the background color for a given state.

Since: 3.0

getBorder

data ThemingEngineGetBorderMethodInfo

Instances

((~) * signature ([StateFlags] -> m Border), MonadIO m, IsThemingEngine a) => MethodInfo * ThemingEngineGetBorderMethodInfo a signature

Methods

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

themingEngineGetBorder

Arguments

:: (HasCallStack, MonadIO m, IsThemingEngine a)

=> a

engine: a ThemingEngine

-> [StateFlags]

state: state to retrieve the border for

-> m Border

Deprecated: (Since version 3.14)

Gets the border for a given state as a Border.

Since: 3.0

getBorderColor

data ThemingEngineGetBorderColorMethodInfo

Instances

((~) * signature ([StateFlags] -> m RGBA), MonadIO m, IsThemingEngine a) => MethodInfo * ThemingEngineGetBorderColorMethodInfo a signature

Methods

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

themingEngineGetBorderColor

Arguments

:: (HasCallStack, MonadIO m, IsThemingEngine a)

=> a

engine: a ThemingEngine

-> [StateFlags]

state: state to retrieve the color for

-> m RGBA

Deprecated: (Since version 3.14)

Gets the border color for a given state.

Since: 3.0

getColor

data ThemingEngineGetColorMethodInfo

Instances

((~) * signature ([StateFlags] -> m RGBA), MonadIO m, IsThemingEngine a) => MethodInfo * ThemingEngineGetColorMethodInfo a signature

Methods

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

themingEngineGetColor

Arguments

:: (HasCallStack, MonadIO m, IsThemingEngine a)

=> a

engine: a ThemingEngine

-> [StateFlags]

state: state to retrieve the color for

-> m RGBA

Deprecated: (Since version 3.14)

Gets the foreground color for a given state.

Since: 3.0

getDirection

data ThemingEngineGetDirectionMethodInfo

Instances

((~) * signature (m TextDirection), MonadIO m, IsThemingEngine a) => MethodInfo * ThemingEngineGetDirectionMethodInfo a signature

Methods

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

themingEngineGetDirection

Arguments

:: (HasCallStack, MonadIO m, IsThemingEngine a)

=> a

engine: a ThemingEngine

-> m TextDirection

Returns: the widget direction

Deprecated: (Since version 3.8)Use themingEngineGetState and check for GTK_STATE_FLAG_DIR_LTR and GTK_STATE_FLAG_DIR_RTL instead.

Returns the widget direction used for rendering.

Since: 3.0

getFont

data ThemingEngineGetFontMethodInfo

Instances

((~) * signature ([StateFlags] -> m FontDescription), MonadIO m, IsThemingEngine a) => MethodInfo * ThemingEngineGetFontMethodInfo a signature

Methods

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

themingEngineGetFont

Arguments

:: (HasCallStack, MonadIO m, IsThemingEngine a)

=> a

engine: a ThemingEngine

-> [StateFlags]

state: state to retrieve the font for

-> m FontDescription

Returns: the FontDescription for the given state. This object is owned by GTK+ and should not be freed.

Deprecated: (Since version 3.8)Use gtk_theming_engine_get()

Returns the font description for a given state.

Since: 3.0

getJunctionSides

data ThemingEngineGetJunctionSidesMethodInfo

Instances

((~) * signature (m [JunctionSides]), MonadIO m, IsThemingEngine a) => MethodInfo * ThemingEngineGetJunctionSidesMethodInfo a signature

Methods

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

themingEngineGetJunctionSides

Arguments

:: (HasCallStack, MonadIO m, IsThemingEngine a)

=> a

engine: a ThemingEngine

-> m [JunctionSides]

Returns: the widget direction

Deprecated: (Since version 3.14)

Returns the widget direction used for rendering.

Since: 3.0

getMargin

data ThemingEngineGetMarginMethodInfo

Instances

((~) * signature ([StateFlags] -> m Border), MonadIO m, IsThemingEngine a) => MethodInfo * ThemingEngineGetMarginMethodInfo a signature

Methods

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

themingEngineGetMargin

Arguments

:: (HasCallStack, MonadIO m, IsThemingEngine a)

=> a

engine: a ThemingEngine

-> [StateFlags]

state: state to retrieve the border for

-> m Border

Deprecated: (Since version 3.14)

Gets the margin for a given state as a Border.

Since: 3.0

getPadding

data ThemingEngineGetPaddingMethodInfo

Instances

((~) * signature ([StateFlags] -> m Border), MonadIO m, IsThemingEngine a) => MethodInfo * ThemingEngineGetPaddingMethodInfo a signature

Methods

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

themingEngineGetPadding

Arguments

:: (HasCallStack, MonadIO m, IsThemingEngine a)

=> a

engine: a ThemingEngine

-> [StateFlags]

state: state to retrieve the padding for

-> m Border

Deprecated: (Since version 3.14)

Gets the padding for a given state as a Border.

Since: 3.0

getPath

data ThemingEngineGetPathMethodInfo

Instances

((~) * signature (m WidgetPath), MonadIO m, IsThemingEngine a) => MethodInfo * ThemingEngineGetPathMethodInfo a signature

Methods

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

themingEngineGetPath

Arguments

:: (HasCallStack, MonadIO m, IsThemingEngine a)

=> a

engine: a ThemingEngine

-> m WidgetPath

Returns: A WidgetPath

Deprecated: (Since version 3.14)

Returns the widget path used for style matching.

Since: 3.0

getProperty

data ThemingEngineGetPropertyMethodInfo

Instances

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

Methods

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

themingEngineGetProperty

Arguments

:: (HasCallStack, MonadIO m, IsThemingEngine a)

=> a

engine: a ThemingEngine

-> Text

property: the property name

-> [StateFlags]

state: state to retrieve the value for

-> m GValue

Deprecated: (Since version 3.14)

Gets a property value as retrieved from the style settings that apply to the currently rendered element.

Since: 3.0

getScreen

data ThemingEngineGetScreenMethodInfo

Instances

((~) * signature (m (Maybe Screen)), MonadIO m, IsThemingEngine a) => MethodInfo * ThemingEngineGetScreenMethodInfo a signature

Methods

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

themingEngineGetScreen

Arguments

:: (HasCallStack, MonadIO m, IsThemingEngine a)

=> a

engine: a ThemingEngine

-> m (Maybe Screen)

Returns: a Screen, or Nothing.

Deprecated: (Since version 3.14)

Returns the Screen to which engine currently rendering to.

getState

data ThemingEngineGetStateMethodInfo

Instances

((~) * signature (m [StateFlags]), MonadIO m, IsThemingEngine a) => MethodInfo * ThemingEngineGetStateMethodInfo a signature

Methods

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

themingEngineGetState

Arguments

:: (HasCallStack, MonadIO m, IsThemingEngine a)

=> a

engine: a ThemingEngine

-> m [StateFlags]

Returns: the state flags

Deprecated: (Since version 3.14)

returns the state used when rendering.

Since: 3.0

getStyleProperty

data ThemingEngineGetStylePropertyMethodInfo

Instances

((~) * signature (Text -> m GValue), MonadIO m, IsThemingEngine a) => MethodInfo * ThemingEngineGetStylePropertyMethodInfo a signature

Methods

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

themingEngineGetStyleProperty

Arguments

:: (HasCallStack, MonadIO m, IsThemingEngine a)

=> a

engine: a ThemingEngine

-> Text

propertyName: the name of the widget style property

-> m GValue

Deprecated: (Since version 3.14)

Gets the value for a widget style property.

Since: 3.0

hasClass

data ThemingEngineHasClassMethodInfo

Instances

((~) * signature (Text -> m Bool), MonadIO m, IsThemingEngine a) => MethodInfo * ThemingEngineHasClassMethodInfo a signature

Methods

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

themingEngineHasClass

Arguments

:: (HasCallStack, MonadIO m, IsThemingEngine a)

=> a

engine: a ThemingEngine

-> Text

styleClass: class name to look up

-> m Bool

Returns: True if engine has className defined

Deprecated: (Since version 3.14)

Returns True if the currently rendered contents have defined the given class name.

Since: 3.0

hasRegion

data ThemingEngineHasRegionMethodInfo

Instances

((~) * signature (Text -> m (Bool, [RegionFlags])), MonadIO m, IsThemingEngine a) => MethodInfo * ThemingEngineHasRegionMethodInfo a signature

Methods

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

themingEngineHasRegion

Arguments

:: (HasCallStack, MonadIO m, IsThemingEngine a)

=> a

engine: a ThemingEngine

-> Text

styleRegion: a region name

-> m (Bool, [RegionFlags])

Returns: True if region is defined

Deprecated: (Since version 3.14)

Returns True if the currently rendered contents have the region defined. If flagsReturn is not Nothing, it is set to the flags affecting the region.

Since: 3.0

load

themingEngineLoad

Arguments

:: (HasCallStack, MonadIO m)

=> Text

name: Theme engine name to load

-> m (Maybe ThemingEngine)

Returns: A theming engine, or Nothing if the engine name doesn’t exist.

Deprecated: (Since version 3.14)

Loads and initializes a theming engine module from the standard directories.

lookupColor

data ThemingEngineLookupColorMethodInfo

Instances

((~) * signature (Text -> m (Bool, RGBA)), MonadIO m, IsThemingEngine a) => MethodInfo * ThemingEngineLookupColorMethodInfo a signature

Methods

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

themingEngineLookupColor

Arguments

:: (HasCallStack, MonadIO m, IsThemingEngine a)

=> a

engine: a ThemingEngine

-> Text

colorName: color name to lookup

-> m (Bool, RGBA)

Returns: True if colorName was found and resolved, False otherwise

Deprecated: (Since version 3.14)

Looks up and resolves a color name in the current style’s color map.

Since: 3.0

stateIsRunning

data ThemingEngineStateIsRunningMethodInfo

Instances

((~) * signature (StateType -> m (Bool, Double)), MonadIO m, IsThemingEngine a) => MethodInfo * ThemingEngineStateIsRunningMethodInfo a signature

Methods

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

themingEngineStateIsRunning

Arguments

:: (HasCallStack, MonadIO m, IsThemingEngine a)

=> a

engine: a ThemingEngine

-> StateType

state: a widget state

-> m (Bool, Double)

Returns: True if there is a running transition animation for state.

Deprecated: (Since version 3.6)Always returns False

Returns True if there is a transition animation running for the current region (see styleContextPushAnimatableRegion).

If progress is not Nothing, the animation progress will be returned there, 0.0 means the state is closest to being False, while 1.0 means it’s closest to being True. This means transition animations will run from 0 to 1 when state is being set to True and from 1 to 0 when it’s being set to False.

Since: 3.0

Properties

name

data ThemingEngineNamePropertyInfo

Instances

AttrInfo ThemingEngineNamePropertyInfo

Associated Types

type AttrAllowedOps ThemingEngineNamePropertyInfo :: [AttrOpTag]

type AttrSetTypeConstraint ThemingEngineNamePropertyInfo :: * -> Constraint

type AttrBaseTypeConstraint ThemingEngineNamePropertyInfo :: * -> Constraint

type AttrGetType ThemingEngineNamePropertyInfo :: *

type AttrLabel ThemingEngineNamePropertyInfo :: Symbol

type AttrOrigin ThemingEngineNamePropertyInfo :: *

Methods

attrGet :: AttrBaseTypeConstraint ThemingEngineNamePropertyInfo o => Proxy * ThemingEngineNamePropertyInfo -> o -> IO (AttrGetType ThemingEngineNamePropertyInfo)

attrSet :: (AttrBaseTypeConstraint ThemingEngineNamePropertyInfo o, AttrSetTypeConstraint ThemingEngineNamePropertyInfo b) => Proxy * ThemingEngineNamePropertyInfo -> o -> b -> IO ()

attrClear :: AttrBaseTypeConstraint ThemingEngineNamePropertyInfo o => Proxy * ThemingEngineNamePropertyInfo -> o -> IO ()

attrConstruct :: (AttrBaseTypeConstraint ThemingEngineNamePropertyInfo o, AttrSetTypeConstraint ThemingEngineNamePropertyInfo b) => Proxy * ThemingEngineNamePropertyInfo -> b -> IO (GValueConstruct o)

type AttrOrigin ThemingEngineNamePropertyInfo

type AttrOrigin ThemingEngineNamePropertyInfo = ThemingEngine

type AttrLabel ThemingEngineNamePropertyInfo

type AttrLabel ThemingEngineNamePropertyInfo = "name"

type AttrGetType ThemingEngineNamePropertyInfo

type AttrGetType ThemingEngineNamePropertyInfo = Maybe Text

type AttrBaseTypeConstraint ThemingEngineNamePropertyInfo

type AttrBaseTypeConstraint ThemingEngineNamePropertyInfo = IsThemingEngine

type AttrSetTypeConstraint ThemingEngineNamePropertyInfo

type AttrSetTypeConstraint ThemingEngineNamePropertyInfo = * ~ Text

type AttrAllowedOps ThemingEngineNamePropertyInfo

type AttrAllowedOps ThemingEngineNamePropertyInfo = (:) AttrOpTag AttrConstruct ((:) AttrOpTag AttrGet ((:) AttrOpTag AttrClear ([] AttrOpTag)))

constructThemingEngineName :: IsThemingEngine o => Text -> IO (GValueConstruct o)

getThemingEngineName :: (MonadIO m, IsThemingEngine o) => o -> m (Maybe Text)

themingEngineName :: AttrLabelProxy "name"