Struct gtk4::StyleContext

#[repr(transparent)]
pub struct StyleContext { /* private fields */ }

The relevant API has been moved to Widget where applicable; otherwise, there is no replacement for querying the style machinery. Stylable UI elements should use widgets. StyleContext stores styling information affecting a widget.

In order to construct the final style information, StyleContext queries information from all attached GtkStyleProviders. Style providers can be either attached explicitly to the context through StyleContextExt::add_provider(), or to the display through add_provider_for_display(). The resulting style is a combination of all providers’ information in priority order.

For GTK widgets, any StyleContext returned by WidgetExt::style_context() will already have a gdk::Display and RTL/LTR information set. The style context will also be updated automatically if any of these settings change on the widget.

Style Classes

Widgets can add style classes to their context, which can be used to associate different styles by class. The documentation for individual widgets lists which style classes it uses itself, and which style classes may be added by applications to affect their appearance.

Custom styling in UI libraries and applications

If you are developing a library with custom widgets that render differently than standard components, you may need to add a StyleProvider yourself with the GTK_STYLE_PROVIDER_PRIORITY_FALLBACK priority, either a CssProvider or a custom object implementing the StyleProvider interface. This way themes may still attempt to style your UI elements in a different way if needed so.

If you are using custom styling on an applications, you probably want then to make your style information prevail to the theme’s, so you must use a StyleProvider with the GTK_STYLE_PROVIDER_PRIORITY_APPLICATION priority, keep in mind that the user settings in XDG_CONFIG_HOME/gtk-4.0/gtk.css will still take precedence over your changes, as it uses the GTK_STYLE_PROVIDER_PRIORITY_USER priority.

Implements

StyleContextExt, glib::ObjectExt

Implementations

impl StyleContext

pub const NONE: Option<&'static StyleContext> = None

pub fn add_provider_for_display(
    display: &impl IsA<Display>,
    provider: &impl IsA<StyleProvider>,
    priority: u32
)

Adds a global style provider to @display, which will be used in style construction for all GtkStyleContexts under @display.

GTK uses this to make styling information from Settings available.

Note: If both priorities are the same, A StyleProvider added through StyleContextExt::add_provider() takes precedence over another added through this function.

display

a gdk::Display

provider

a StyleProvider

priority

the 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

pub fn remove_provider_for_display(
    display: &impl IsA<Display>,
    provider: &impl IsA<StyleProvider>
)

Removes @provider from the global style providers list in @display.

display

a gdk::Display

provider

a StyleProvider

Trait Implementations

impl Clone for StyleContext

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StyleContext

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for StyleContext

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for StyleContext

fn hash<H>(&self, state: &mut H)where
    H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: StyleContextImpl> IsSubclassable<T> for StyleContext

fn class_init(class: &mut Class<Self>)

Override the virtual methods of this class for the given subclass and do other class initialization.

fn instance_init(instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for StyleContext

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for StyleContext

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for StyleContext

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for StyleContext

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for StyleContext

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for StyleContext