1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from
// from gir-files (https://github.com/gtk-rs/gir-files.git)
// DO NOT EDIT
use crate::ColorScheme;
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::{boxed::Box as Box_, fmt, mem::transmute};
glib::wrapper! {
/// A class for managing application-wide styling.
///
/// [`StyleManager`][crate::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`][struct@crate::StyleManager#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`][crate::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`][struct@crate::StyleManager#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`][crate::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`][struct@crate::StyleManager#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`][struct@crate::StyleManager#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`][struct@crate::StyleManager#color-scheme].
///
/// Readable
///
/// # Implements
///
/// [`trait@glib::ObjectExt`]
#[doc(alias = "HdyStyleManager")]
pub struct StyleManager(Object<ffi::HdyStyleManager, ffi::HdyStyleManagerClass>);
match fn {
type_ => || ffi::hdy_style_manager_get_type(),
}
}
impl StyleManager {
/// Gets the requested application color scheme.
///
/// # Returns
///
/// the color scheme
#[doc(alias = "hdy_style_manager_get_color_scheme")]
#[doc(alias = "get_color_scheme")]
pub fn color_scheme(&self) -> ColorScheme {
unsafe {
from_glib(ffi::hdy_style_manager_get_color_scheme(
self.to_glib_none().0,
))
}
}
/// Gets whether the application is using dark appearance.
///
/// # Returns
///
/// whether the application is using dark appearance
#[doc(alias = "hdy_style_manager_get_dark")]
#[doc(alias = "get_dark")]
pub fn is_dark(&self) -> bool {
unsafe { from_glib(ffi::hdy_style_manager_get_dark(self.to_glib_none().0)) }
}
/// 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
#[doc(alias = "hdy_style_manager_get_display")]
#[doc(alias = "get_display")]
pub fn display(&self) -> Option<gdk::Display> {
unsafe { from_glib_none(ffi::hdy_style_manager_get_display(self.to_glib_none().0)) }
}
/// Gets whether the application is using high contrast appearance.
///
/// # Returns
///
/// whether the application is using high contrast appearance
#[doc(alias = "hdy_style_manager_get_high_contrast")]
#[doc(alias = "get_high_contrast")]
pub fn is_high_contrast(&self) -> bool {
unsafe {
from_glib(ffi::hdy_style_manager_get_high_contrast(
self.to_glib_none().0,
))
}
}
/// Gets whether the system supports color schemes.
///
/// # Returns
///
/// whether the system supports color schemes
#[doc(alias = "hdy_style_manager_get_system_supports_color_schemes")]
#[doc(alias = "get_system_supports_color_schemes")]
pub fn system_supports_color_schemes(&self) -> bool {
unsafe {
from_glib(ffi::hdy_style_manager_get_system_supports_color_schemes(
self.to_glib_none().0,
))
}
}
/// 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`][struct@crate::StyleManager#dark] property can be used to query the current
/// effective appearance.
/// ## `color_scheme`
/// the color scheme
#[doc(alias = "hdy_style_manager_set_color_scheme")]
pub fn set_color_scheme(&self, color_scheme: ColorScheme) {
unsafe {
ffi::hdy_style_manager_set_color_scheme(
self.to_glib_none().0,
color_scheme.into_glib(),
);
}
}
/// Gets the default [`StyleManager`][crate::StyleManager] instance.
///
/// It manages all [`gdk::Display`][crate::gdk::Display] instances unless the style manager for
/// that display has an override.
///
/// See `get_for_display()`.
///
/// # Returns
///
/// the default style manager
#[doc(alias = "hdy_style_manager_get_default")]
#[doc(alias = "get_default")]
#[allow(clippy::should_implement_trait)]
pub fn default() -> Option<StyleManager> {
assert_initialized_main_thread!();
unsafe { from_glib_none(ffi::hdy_style_manager_get_default()) }
}
/// Gets the [`StyleManager`][crate::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
#[doc(alias = "hdy_style_manager_get_for_display")]
#[doc(alias = "get_for_display")]
pub fn for_display(display: &gdk::Display) -> Option<StyleManager> {
assert_initialized_main_thread!();
unsafe {
from_glib_none(ffi::hdy_style_manager_get_for_display(
display.to_glib_none().0,
))
}
}
#[cfg(feature = "v1_6")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_6")))]
#[doc(alias = "color-scheme")]
pub fn connect_color_scheme_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_color_scheme_trampoline<F: Fn(&StyleManager) + 'static>(
this: *mut ffi::HdyStyleManager,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::color-scheme\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_color_scheme_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[cfg(feature = "v1_6")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_6")))]
#[doc(alias = "dark")]
pub fn connect_dark_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_dark_trampoline<F: Fn(&StyleManager) + 'static>(
this: *mut ffi::HdyStyleManager,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::dark\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_dark_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[cfg(feature = "v1_6")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_6")))]
#[doc(alias = "high-contrast")]
pub fn connect_high_contrast_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_high_contrast_trampoline<F: Fn(&StyleManager) + 'static>(
this: *mut ffi::HdyStyleManager,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::high-contrast\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_high_contrast_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[cfg(feature = "v1_6")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_6")))]
#[doc(alias = "system-supports-color-schemes")]
pub fn connect_system_supports_color_schemes_notify<F: Fn(&Self) + 'static>(
&self,
f: F,
) -> SignalHandlerId {
unsafe extern "C" fn notify_system_supports_color_schemes_trampoline<
F: Fn(&StyleManager) + 'static,
>(
this: *mut ffi::HdyStyleManager,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::system-supports-color-schemes\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_system_supports_color_schemes_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl fmt::Display for StyleManager {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("StyleManager")
}
}