gtkmm  4.8.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gtk::StyleProvider Class Reference

Interface to provide style information to Gtk::StyleContext. More...

#include <gtkmm/styleprovider.h>

Inheritance diagram for Gtk::StyleProvider:
Inheritance graph
[legend]

Public Member Functions

 StyleProvider (StyleProvider && src) noexcept
 
StyleProvideroperator= (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 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

 StyleProvider ()
 You should derive from this class to use it. More...
 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Gtk::StyleProviderwrap (GtkStyleProvider * object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Detailed Description

Interface to provide style information to Gtk::StyleContext.

Gtk::StyleProvider is an interface used to provide style information to a Gtk::StyleContext. See StyleContext::add_provider() and add_provider_for_display().

GTK uses the Gtk::StyleProvider implementation for CSS in Gtk::CssProvider.

See also
Gtk::StyleContext, Gtk::CssProvider
Since gtkmm 3.0:

Constructor & Destructor Documentation

◆ StyleProvider() [1/2]

Gtk::StyleProvider::StyleProvider ( )
protected

You should derive from this class to use it.

◆ StyleProvider() [2/2]

Gtk::StyleProvider::StyleProvider ( StyleProvider &&  src)
noexcept

◆ ~StyleProvider()

Gtk::StyleProvider::~StyleProvider ( )
overridenoexcept

Member Function Documentation

◆ add_interface()

static void Gtk::StyleProvider::add_interface ( GType  gtype_implementer)
static

◆ add_provider_for_display()

static void Gtk::StyleProvider::add_provider_for_display ( const Glib::RefPtr< Gdk::Display > &  display,
const Glib::RefPtr< StyleProvider > &  provider,
guint  priority 
)
static

Adds a global style provider to display, which will be used in style construction for all Gtk::StyleContexts under display.

GTK uses this to make styling information from Gtk::Settings available.

Note
If both priorities are the same, A Gtk::StyleProvider added through add_provider() takes precedence over another added through this function.
Since gtkmm 4.10:
Parameters
displayA Gdk::Display.
providerA Gtk::StyleProvider.
priorityThe priority of the style provider. The lower it is, the earlier it will be used in the style construction. Typically this will be in the range between GTK_STYLE_PROVIDER_PRIORITY_FALLBACK and GTK_STYLE_PROVIDER_PRIORITY_USER.

◆ get_type()

static GType Gtk::StyleProvider::get_type ( )
static

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

◆ gobj() [1/2]

GtkStyleProvider* Gtk::StyleProvider::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkStyleProvider* Gtk::StyleProvider::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ operator=()

StyleProvider& Gtk::StyleProvider::operator= ( StyleProvider &&  src)
noexcept

◆ remove_provider_for_display()

static void Gtk::StyleProvider::remove_provider_for_display ( const Glib::RefPtr< Gdk::Display > &  display,
const Glib::RefPtr< StyleProvider > &  provider 
)
static

Removes provider from the global style providers list in display.

Since gtkmm 4.10:
Parameters
displayA Gdk::Display.
providerA Gtk::StyleProvider.

Friends And Related Function Documentation

◆ wrap()

Glib::RefPtr< Gtk::StyleProvider > wrap ( GtkStyleProvider *  object,
bool  take_copy = false 
)
related

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

Parameters
objectThe C instance.
take_copyFalse 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.