Skip to main content

SurfaceSettings

Struct SurfaceSettings 

Source
pub struct SurfaceSettings {
Show 15 fields pub locale: String, pub strings: IndexMap<String, String>, pub mode: ModeSetting, pub system_dark: bool, pub density: Density, pub contrast: ContrastSetting, pub system_high_contrast: bool, pub font_scale: f32, pub hover: bool, pub reduced_motion: bool, pub insets: Insets, pub today: Option<String>, pub hover_close_ms: u32, pub read_only: bool, pub form_factor: Option<FormFactor>,
}
Expand description

What a host sets per surface (docs/round-1-contract.md §4–6).

Fields§

§locale: String

BCP 47; the week start and the text direction. Default en-US.

§strings: IndexMap<String, String>

Built-in string overrides by id.

§mode: ModeSetting§system_dark: bool

The platform prefers dark (mode: system).

§density: Density§contrast: ContrastSetting§system_high_contrast: bool

The platform asks for more contrast (contrast: system).

§font_scale: f32

Dynamic Type / font scale, applied to every resolved type size.

§hover: bool

A hover-capable pointer (@media (hover: hover), hover popovers).

§reduced_motion: bool

@media (prefers-reduced-motion: reduce); transitions become 0 ms.

§insets: Insets§today: Option<String>

Today as yyyy-mm-dd (calendars open on it and mark it).

§hover_close_ms: u32

How a hover overlay (Tooltip, openOn: hover Popover) closes when the pointer left its trigger and its content. 0 (default) = at once: the HOST delays forwarding the trigger’s un-hover (gpui’s grace). > 0 (natives: HOVER_CLOSE_MS) = the core holds it open and raises OutEvent::HoverTimer; the host calls Surface::hover_timeout when it fires.

§read_only: bool

VAPP-200: the viewer may read, not write (an app at app access read): every writing control builds as disabled: true (crate::read_only, fixtures/read-only.json).

§form_factor: Option<FormFactor>

VAPP-218: the HOST’s form factor, what @media (form-factor: …) matches (an editor preview’s phone frame, a phone). None (default) = derived from the surface width against the theme’s $breakpoint.md.

Trait Implementations§

Source§

impl Clone for SurfaceSettings

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 SurfaceSettings

Source§

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

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

impl Default for SurfaceSettings

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for SurfaceSettings

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for SurfaceSettings

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 Serialize for SurfaceSettings

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for SurfaceSettings

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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