GI.Gtk.Objects.CssProvider

GtkCssProvider is an object implementing the StyleProvider interface. It is able to parse [CSS-like][css-overview] input in order to style widgets.

An application can make GTK+ parse a specific CSS style sheet by calling cssProviderLoadFromFile or cssProviderLoadFromResource and adding the provider with styleContextAddProvider or styleContextAddProviderForDisplay.

In addition, certain files will be read when GTK+ is initialized. First, the file $XDG_CONFIG_HOME/gtk-4.0/gtk.css is loaded if it exists. Then, GTK+ loads the first existing file among XDG_DATA_HOME/themes/THEME/gtk-VERSION/gtk.css, $HOME/.themes/THEME/gtk-VERSION/gtk.css, $XDG_DATA_DIRS/themes/THEME/gtk-VERSION/gtk.css and DATADIR/share/themes/THEME/gtk-VERSION/gtk.css, where THEME is the name of the current theme (see the Settings:gtk-theme-name setting), DATADIR is the prefix configured when GTK+ was compiled (unless overridden by the GTK_DATA_PREFIX environment variable), and VERSION is the GTK+ version number. If no file is found for the current version, GTK+ tries older versions all the way back to 4.0.

In the same way, GTK+ tries to load a gtk-keys.css file for the current key theme, as defined by Settings:gtk-key-theme-name.

Exported types

newtype CssProvider

Memory-managed wrapper type.

Constructors

CssProvider (ManagedPtr CssProvider)

Instances

Eq CssProvider

Defined in GI.Gtk.Objects.CssProvider

Methods

(==) :: CssProvider -> CssProvider -> Bool

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

IsGValue CssProvider

Convert CssProvider to and from GValue with toGValue and fromGValue.

Defined in GI.Gtk.Objects.CssProvider

Methods

toGValue :: CssProvider -> IO GValue

fromGValue :: GValue -> IO CssProvider

GObject CssProvider

Defined in GI.Gtk.Objects.CssProvider

Methods

gobjectType :: IO GType

HasParentTypes CssProvider

Defined in GI.Gtk.Objects.CssProvider

type ParentTypes CssProvider

Defined in GI.Gtk.Objects.CssProvider

type ParentTypes CssProvider = '[Object, StyleProvider]

class (GObject o, IsDescendantOf CssProvider o) => IsCssProvider o

Type class for types which can be safely cast to CssProvider, for instance with toCssProvider.

Instances

(GObject o, IsDescendantOf CssProvider o) => IsCssProvider o

Defined in GI.Gtk.Objects.CssProvider

toCssProvider :: (MonadIO m, IsCssProvider o) => o -> m CssProvider

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

noCssProvider :: Maybe CssProvider

A convenience alias for Nothing :: Maybe CssProvider.

Methods

Overloaded methods

loadFromData

cssProviderLoadFromData

Arguments

:: (HasCallStack, MonadIO m, IsCssProvider a)

=> a

cssProvider: a CssProvider

-> ByteString

data: CSS data loaded in memory

-> m ()

Loads data into cssProvider, and by doing so clears any previously loaded information.

loadFromFile

cssProviderLoadFromFile

Arguments

:: (HasCallStack, MonadIO m, IsCssProvider a, IsFile b)

=> a

cssProvider: a CssProvider

-> b

file: File pointing to a file to load

-> m ()

Loads the data contained in file into cssProvider, making it clear any previously loaded information.

loadFromPath

cssProviderLoadFromPath

Arguments

:: (HasCallStack, MonadIO m, IsCssProvider a)

=> a

cssProvider: a CssProvider

-> Text

path: the path of a filename to load, in the GLib filename encoding

-> m ()

Loads the data contained in path into cssProvider, making it clear any previously loaded information.

loadFromResource

cssProviderLoadFromResource

Arguments

:: (HasCallStack, MonadIO m, IsCssProvider a)

=> a

cssProvider: a CssProvider

-> Text

resourcePath: a Resource resource path

-> m ()

Loads the data contained in the resource at resourcePath into the CssProvider, clearing any previously loaded information.

To track errors while loading CSS, connect to the CssProvider::parsing-error signal.

loadNamed

cssProviderLoadNamed

Arguments

:: (HasCallStack, MonadIO m, IsCssProvider a)

=> a

provider: a CssProvider

-> Text

name: A theme name

-> Maybe Text

variant: variant to load, for example, "dark", or Nothing for the default

-> m ()

Loads a theme from the usual theme paths. The actual process of finding the theme might change between releases, but it is guaranteed that this function uses the same mechanism to load the theme that GTK uses for loading its own theme.

new

cssProviderNew

Arguments

:: (HasCallStack, MonadIO m)

=> m CssProvider

Returns: A new CssProvider

Returns a newly created CssProvider.

toString

cssProviderToString

Arguments

:: (HasCallStack, MonadIO m, IsCssProvider a)

=> a

provider: the provider to write to a string

-> m Text

Returns: a new string representing the provider.

Converts the provider into a string representation in CSS format.

Using cssProviderLoadFromData with the return value from this function on a new provider created with cssProviderNew will basically create a duplicate of this provider.