Skip to main content

Environment

Struct Environment 

Source
pub struct Environment {
    pub locale: Signal<LanguageIdentifier>,
    pub direction: Signal<Direction>,
    pub double_click_interval: Duration,
    pub tooltip_delay: Duration,
    pub theme_mode: ThemeMode,
    pub system_theme_mode: ThemeMode,
    pub drag_distance: Signal<u32>,
    pub debug_layout: bool,
    /* private fields */
}
Expand description

A model for system specific state which can be accessed by any model or view.

Fields§

§locale: Signal<LanguageIdentifier>

The locale used for localization.

§direction: Signal<Direction>

The text and layout direction used by the application.

§double_click_interval: Duration

The maximum interval between two clicks to be recognised as a double-click.

§tooltip_delay: Duration

The delay before a tooltip fades in.

§theme_mode: ThemeMode

The user’s theme preference (may be System to follow the OS).

§system_theme_mode: ThemeMode

The OS-reported system theme (always DarkMode or LightMode, never System).

§drag_distance: Signal<u32>

The distance the mouse has to be dragged to start a drag operation.

§debug_layout: bool

Whether the layout debug overlay is enabled. When set, views which underwent layout in the most recent layout pass are outlined in orange until the next layout pass.

Implementations§

Source§

impl Environment

Source

pub fn effective_theme(&self) -> ThemeMode

Returns the effective (resolved) theme, substituting the OS theme when the user preference is ThemeMode::System.

Trait Implementations§

Source§

impl Model for Environment

Source§

fn event(&mut self, cx: &mut EventContext<'_>, event: &mut Event)

Respond to events in order to mutate the model data. Read more
Source§

fn build(self, cx: &mut Context) -> &Self

Build the model data into the application tree. Read more
Source§

fn name(&self) -> Option<&'static str>

Returns the name of the Model if it has one.

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
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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