Skip to main content

AccessibilityPreferences

Struct AccessibilityPreferences 

Source
#[non_exhaustive]
pub struct AccessibilityPreferences { pub text_scaling_factor: f32, pub reduce_motion: bool, pub high_contrast: bool, pub reduce_transparency: bool, }
Expand description

OS-detected accessibility preferences.

A single copy lives on SystemTheme, shared across light and dark variants. These are runtime values detected from the OS – not stored in TOML presets. Outside this crate, start from AccessibilityPreferences::DEFAULT (or default()) and set fields.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§text_scaling_factor: f32

Text scaling factor (1.0 = no scaling): the factor of the user’s preference for larger text that the toolkit has not applied. Multiply font sizes by it (scaled) to honour the preference. Where the toolkit’s own scale factor carries the preference, it is 1.0: on a GNOME or Budgie X11 session, where winit and gpui take their scale factor from the Xft.dpi gnome-settings-daemon writes as 96 × text-scaling-factor × the window scale (gnome-settings-daemon 51.0 plugins/xsettings/gsd-xsettings-manager.c:666-668, :742, :797-798; winit 0.30.13 src/platform_impl/linux/x11/util/randr.rs:41-53, :145-146; gpui-pre-linux 0.3.10 src/linux/x11/client.rs:2674-2681). They do so only while WINIT_X11_SCALE_FACTOR and GPUI_X11_SCALE_FACTOR are unset (randr.rs:112-154, client.rs:2623-2669); with an override the application owns the scale, and the factor is applied nowhere.

§reduce_motion: bool

Whether the user has requested reduced motion.

§high_contrast: bool

Whether a high-contrast mode is active.

§reduce_transparency: bool

Whether the user has requested reduced transparency.

Implementations§

Source§

impl AccessibilityPreferences

Source

pub const DEFAULT: Self

No text scaling and no flag set: what Default::default returns, usable in a const or static.

Source

pub fn from_system() -> Self

Read the OS accessibility preferences without resolving a theme.

Runs the same platform reader SystemTheme::from_system runs (KDE kdeglobals, GNOME portal + gsettings, macOS NSWorkspace, Windows UISettings) and takes its accessibility block, blocking on it with pollster::block_on. Fields no reader supplies keep their defaults. Never fails: with no reader or a failing reader the defaults are returned, with reduce_motion the platform’s read (crate::detect::detect_reduced_motion, the one the readers make).

Use it on the preset path, where accessibility is orthogonal to the theme choice (a user with large text wants it under a preset too).

Source

pub fn text_scale_factor(&self) -> f32

The text-scaling multiplier the toolkit has not applied: text_scaling_factor when it is finite and positive, else 1.0, so a factor no platform could mean (NaN, zero, negative, infinite) leaves text at its size.

Source

pub fn scaled(&self, size: f32) -> f32

A text size times text_scale_factor.

For every text size alike: a widget’s font, a text_scale role’s size, the default fonts. No other length is scaled. Where the product is not a normal positive number (a finite factor large enough to overflow f32, or one small enough to make it subnormal or zero), size is returned unscaled, as for a factor that is not finite and positive.

Trait Implementations§

Source§

impl Clone for AccessibilityPreferences

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AccessibilityPreferences

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AccessibilityPreferences

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for AccessibilityPreferences

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for AccessibilityPreferences

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> NoneValue for T
where T: Default,

Source§

type NoneType = T

Source§

fn null_value() -> T

The none-equivalent value.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more