Struct libhandy::StyleManager

pub struct StyleManager { /* private fields */ }

Available on crate feature v1_6 only.

A class for managing application-wide styling.

StyleManager provides a way to query and influence the application styles, such as whether to use dark or high contrast appearance.

It allows to set the color scheme via the color-scheme property, and to query the current appearance, as well as whether a system-wide color scheme preference exists.

Important: [gtk-application-prefer-dark-theme][struct@crate::Gtk::Settings#gtk-application-prefer-dark-theme] should not be used together with StyleManager and will result in a warning. Color schemes should be used instead.

Properties

color-scheme

The requested application color scheme.

The effective appearance will be decided based on the application color scheme and the system preferred color scheme. The dark property can be used to query the current effective appearance.

The HDY_COLOR_SCHEME_PREFER_LIGHT color scheme results in the application using light appearance unless the system prefers dark colors. This is the default value.

The HDY_COLOR_SCHEME_PREFER_DARK color scheme results in the application using dark appearance, but can still switch to the light appearance if the system can prefers it, for example, when the high contrast preference is enabled.

The HDY_COLOR_SCHEME_FORCE_LIGHT and HDY_COLOR_SCHEME_FORCE_DARK values ignore the system preference entirely, they are useful if the application wants to match its UI to its content or to provide a separate color scheme switcher.

If a per-gdk::Display style manager has its color scheme set to HDY_COLOR_SCHEME_DEFAULT, it will inherit the color scheme from the default style manager.

For the default style manager, HDY_COLOR_SCHEME_DEFAULT is equivalent to HDY_COLOR_SCHEME_FORCE_LIGHT.

The system-supports-color-schemes property can be used to check if the current environment provides a color scheme preference.

Readable | Writeable

dark

Whether the application is using dark appearance.

This property can be used to query the current appearance, as requested via color-scheme.

Readable

display

The display the style manager is associated with.

The display will be NULL for the style manager returned by get_default().

Readable | Writeable | Construct Only

high-contrast

Whether the application is using high contrast appearance.

This cannot be overridden by applications.

Readable

system-supports-color-schemes

Whether the system supports color schemes.

This property can be used to check if the current environment provides a color scheme preference. For example, applications might want to show a separate appearance switcher if it’s set to FALSE.

It’s only set at startup and cannot change its value later.

See color-scheme.

Readable

Implements

glib::ObjectExt

Implementations

impl StyleManager

pub fn color_scheme(&self) -> ColorScheme

Gets the requested application color scheme.

Returns

the color scheme

pub fn is_dark(&self) -> bool

Gets whether the application is using dark appearance.

Returns

whether the application is using dark appearance

pub fn display(&self) -> Option<Display>

Gets the display the style manager is associated with.

The display will be NULL for the style manager returned by get_default().

Returns

(nullable): the display

pub fn is_high_contrast(&self) -> bool

Gets whether the application is using high contrast appearance.

Returns

whether the application is using high contrast appearance

pub fn system_supports_color_schemes(&self) -> bool

Gets whether the system supports color schemes.

Returns

whether the system supports color schemes

pub fn set_color_scheme(&self, color_scheme: ColorScheme)

Sets the requested application color scheme.

The effective appearance will be decided based on the application color scheme and the system preferred color scheme. The dark property can be used to query the current effective appearance.

color_scheme

the color scheme

pub fn default() -> Option<StyleManager>

Gets the default StyleManager instance.

It manages all gdk::Display instances unless the style manager for that display has an override.

See get_for_display().

Returns

the default style manager

pub fn for_display(display: &Display) -> Option<StyleManager>

Gets the StyleManager instance managing @display.

It can be used to override styles for that specific display instead of the whole application.

Most applications should use get_default() instead.

display

a display

Returns

the style manager for @display

pub fn connect_color_scheme_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_dark_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_high_contrast_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_system_supports_color_schemes_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations

impl Clone for StyleManager

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 StyleManager

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

Formats the value using the given formatter.

impl Display for StyleManager

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

Formats the value using the given formatter.

impl HasParamSpec for StyleManager

type ParamSpec = ParamSpecObject

type SetValue = StyleManager

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, StyleManager>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for StyleManager

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 Ord for StyleManager

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for StyleManager

type Parent = Object

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

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 StyleManager

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 StyleManager

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for StyleManager