gtkmm: Gtk::CssProvider Class Reference

CSS-like styling for widgets, implementing the StyleProvider base class. More...

#include <gtkmm/cssprovider.h>

Inheritance diagram for Gtk::CssProvider:

[legend]

Public Member Functions
	CssProvider (CssProvider && src) noexcept

CssProvider &	operator= (CssProvider && src) noexcept

	~CssProvider () noexcept override

GtkCssProvider *	gobj ()
	Provides access to the underlying C GObject. More...

const GtkCssProvider *	gobj () const
	Provides access to the underlying C GObject. More...

GtkCssProvider *	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

Glib::ustring	to_string () const
	Converts the provider into a string representation in CSS format. More...

void	load_from_data (const std::string &data)
	Loads data into this css provider, making it clear any previously loaded information. More...

void	load_from_string (const std::string &string)
	Loads string into css_provider. More...

void	load_from_bytes (const Glib::RefPtr< const Glib::Bytes > &data)
	Loads data into css_provider. More...

void	load_from_file (const Glib::RefPtr< const Gio::File > & file)
	Loads the data contained in file into css_provider. More...

void	load_from_path (const std::string & path)
	Loads the data contained in path into css_provider. More...

void	load_from_resource (const std::string & resource_path)
	Loads the data contained in the resource at resource_path into the css_provider. More...

void	load_named (const Glib::ustring & name, const Glib::ustring & variant)
	Loads a theme from the usual theme paths. More...

Glib::SignalProxy< void(const Glib::RefPtr< const CssSection > &, const Glib::Error &)>	signal_parsing_error ()

Public Member Functions inherited from Gtk::StyleProvider
	StyleProvider (StyleProvider && src) noexcept

StyleProvider &	operator= (StyleProvider && src) noexcept

	~StyleProvider () noexcept override

GtkStyleProvider *	gobj ()
	Provides access to the underlying C GObject. More...

const GtkStyleProvider *	gobj () const
	Provides access to the underlying C GObject. More...

Static Public Member Functions
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

static Glib::RefPtr< CssProvider >	create ()

Static Public Member Functions inherited from Gtk::StyleProvider
static void	add_interface (GType gtype_implementer)

static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

static void	add_provider_for_display (const Glib::RefPtr< Gdk::Display > & display, const Glib::RefPtr< StyleProvider > & provider, guint priority)
	Adds a global style provider to display, which will be used in style construction for all `Gtk::StyleContexts` under display. More...

static void	remove_provider_for_display (const Glib::RefPtr< Gdk::Display > & display, const Glib::RefPtr< StyleProvider > & provider)
	Removes provider from the global style providers list in display. More...

Protected Member Functions
	CssProvider ()

Protected Member Functions inherited from Gtk::StyleProvider
	StyleProvider ()
	You should derive from this class to use it. More...

Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Gtk::CssProvider >	wrap (GtkCssProvider * object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Related Functions inherited from Gtk::StyleProvider
Glib::RefPtr< Gtk::StyleProvider >	wrap (GtkStyleProvider * object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Detailed Description

CSS-like styling for widgets, implementing the StyleProvider base class.

It is able to parse CSS-like input in order to style widgets.

An application can cause GTK to parse a specific CSS style sheet by calling load_from_file() and adding the provider with StyleContext::add_provider() or StyleContext::add_provider_for_screen(). In addition, certain files will be read when GTK is initialized. See the GtkCssProvider documentation for details of these default files and details of the stylesheets.

Since gtkmm 3.0:

Constructor & Destructor Documentation

◆ CssProvider() [1/2]

Gtk::CssProvider::CssProvider ( CssProvider && src )

noexcept

◆ ~CssProvider()

Gtk::CssProvider::~CssProvider ( )

overridenoexcept

◆ CssProvider() [2/2]

Gtk::CssProvider::CssProvider ( )

protected

Member Function Documentation

◆ create()

static Glib::RefPtr< CssProvider > Gtk::CssProvider::create ( )

static

◆ get_type()

static GType Gtk::CssProvider::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

◆ gobj() [1/2]

GtkCssProvider * Gtk::CssProvider::gobj ( )

inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkCssProvider * Gtk::CssProvider::gobj ( ) const

inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GtkCssProvider * Gtk::CssProvider::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

◆ load_from_bytes()

void Gtk::CssProvider::load_from_bytes ( const Glib::RefPtr< const Glib::Bytes > & data )

Loads data into css_provider.

This clears any previously loaded information.

Since gtkmm 4.12:

Parameters

data	`Bytes` containing the data to load.

◆ load_from_data()

void Gtk::CssProvider::load_from_data ( const std::string & data )

Loads data into this css provider, making it clear any previously loaded information.

Deprecated:: 4.12: Use load_from_string() or load_from_bytes() instead.

Parameters

data	CSS data loaded in memory.

◆ load_from_file()

void Gtk::CssProvider::load_from_file ( const Glib::RefPtr< const Gio::File > & file )

Loads the data contained in file into css_provider.

This clears any previously loaded information.

Parameters

file	`Gio::File` pointing to a file to load.

◆ load_from_path()

void Gtk::CssProvider::load_from_path ( const std::string & path )

Loads the data contained in path into css_provider.

This clears any previously loaded information.

Parameters

path	The path of a filename to load, in the GLib filename encoding.

◆ load_from_resource()

void Gtk::CssProvider::load_from_resource ( const std::string & resource_path )

Loads the data contained in the resource at resource_path into the css_provider.

This clears any previously loaded information.

Parameters

resource_path A Gio::Resource resource path.

◆ load_from_string()

void Gtk::CssProvider::load_from_string ( const std::string & string )

Loads string into css_provider.

This clears any previously loaded information.

Since gtkmm 4.12:

Parameters

string The CSS to load.

◆ load_named()

void Gtk::CssProvider::load_named	(	const Glib::ustring &	name,
		const Glib::ustring &	variant
	)

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.

Parameters

name	A theme name.
variant	Variant to load, for example, "dark", or `nullptr` for the default.

◆ operator=()

CssProvider & Gtk::CssProvider::operator= ( CssProvider && src )

noexcept

◆ signal_parsing_error()

Glib::SignalProxy< void(const Glib::RefPtr< const CssSection > &, const Glib::Error &)> Gtk::CssProvider::signal_parsing_error ( )

Parameters

error The parsing error. The referenced object may belong to a subclass of Glib::Error, such as Gtk::CssParserError.

Slot Prototype:: void on_my_parsing_error(const Glib::RefPtr<const CssSection>& section, const Glib::Error& error)

Flags: Run Last

Signals that a parsing error occurred.

The path, line and position describe the actual location of the error as accurately as possible.

Parsing errors are never fatal, so the parsing will resume after the error. Errors may however cause parts of the given data or even all of it to not be parsed at all. So it is a useful idea to check that the parsing succeeds by connecting to this signal.

Note that this signal may be emitted at any time as the css provider may opt to defer parsing parts or all of the input to a later time than when a loading function was called.

Parameters

section	Section the error happened in.
error	The parsing error.

◆ to_string()

Glib::ustring Gtk::CssProvider::to_string ( ) const

Converts the provider into a string representation in CSS format.

Using load_from_string() with the return value from this function on a new provider created with new() will basically create a duplicate of this provider.

Returns: A new string representing the provider.

Friends And Related Function Documentation

◆ wrap()

Glib::RefPtr< Gtk::CssProvider > wrap	(	GtkCssProvider *	object,
		bool	take_copy = `false`
	)

A Glib::wrap() method for this object.

Parameters

object	The C instance.
take_copy	False if the result should take ownership of the C instance. True if it should take a new copy or ref.

Returns: A C++ instance that wraps this C instance.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Functions

Detailed Description

Constructor & Destructor Documentation

◆ CssProvider() [1/2]

◆ ~CssProvider()

◆ CssProvider() [2/2]

Member Function Documentation

◆ create()

◆ get_type()

◆ gobj() [1/2]

◆ gobj() [2/2]

◆ gobj_copy()

◆ load_from_bytes()

◆ load_from_data()

◆ load_from_file()

◆ load_from_path()

◆ load_from_resource()

◆ load_from_string()

◆ load_named()

◆ operator=()

◆ signal_parsing_error()

◆ to_string()

Friends And Related Function Documentation

◆ wrap()