Skip to main content

PropsOut

Struct PropsOut 

Source
pub struct PropsOut {
Show 14 fields pub spec: NodeSpec, pub style: TextStyle, pub key: Option<String>, pub index: Option<u64>, pub row_count: Option<u64>, pub title: Option<String>, pub always_on_top: bool, pub secure_input: bool, pub option_as_alt: OptionAsAlt, pub ime_off: bool, pub key_focus: bool, pub tooltip: Option<String>, pub windows: Vec<(String, WindowConfig)>, pub wrap: bool,
}
Expand description

Everything a prop list can carry; elements pick the parts they use.

Fields§

§spec: NodeSpec§style: TextStyle§key: Option<String>§index: Option<u64>

index: the data index this node is opened under, which beats key when a binding is handed both.

§row_count: Option<u64>

rowCount: how many indexed rows the node’s virtual list has (Core::row_count).

§title: Option<String>§always_on_top: bool

alwaysOnTop: the root asked for the window above every other app’s this frame (Core::set_always_on_top).

§secure_input: bool

secureInput: the root asked for secure keyboard entry while the window has the keyboard (Core::set_secure_input).

§option_as_alt: OptionAsAlt

optionAsAlt: which Option keys the root asked to act as Alt this frame (Core::set_option_as_alt).

§ime_off: bool

imeOff: the root asked for the platform’s input method off in its window this frame (Core::set_ime_off).

§key_focus: bool§tooltip: Option<String>

Hover hint: the element lowering floats widgets::tooltip below the node while it is hovered (the parser also marks the spec hoverable).

§windows: Vec<(String, WindowConfig)>

The windows the root declared (Core::declare_window, in order).

§wrap: bool

Whether the wrap row was declared: the mode is in style.wrap, whose default is Word, so the style alone cannot say. A single-line editor folds to its width when it was (EditOptions::wrap); nothing else reads it.

Implementations§

Source§

impl PropsOut

Source

pub fn identity(&self) -> Identity<'_>

The identity the list gave the node (see Identity).

Source

pub fn new() -> Self

Source

pub fn with_spec(&mut self, f: impl FnOnce(NodeSpec) -> NodeSpec)

Applies a builder step to the spec in place.

Source

pub fn apply_tooltip(&mut self, hint: impl Into<String>)

All three effects of the tooltip prop at once: hover tracking and the accessible description (both NodeSpec::apply_tooltip), plus the hint the element lowering floats. A parser that only extracted the string cannot end up implementing two of the three.

Source

pub fn for_leaf(self) -> Self

The list for a leaf — a line, polygon, path, cells grid, image or edit — whose tooltip the core floats beside it rather than as its last child, since a leaf holds none (backlog RG113): the spec asks for the hint drawn (crate::spec::AccessSpec::tooltip), and the leaf’s door floats it while the leaf is hovered. Core::open_from calls it for the leaves it opens; a binding that lowers an image or an edit through its own door calls it before handing the spec over. A list with no tooltip comes back as it went in.

Source

pub fn apply_pad(&mut self, pad: PadShorthand)

Resolves the pad shorthand family and applies it — a no-op when the frontend saw none of the seven names, so a spec built from another source keeps its padding.

Trait Implementations§

Source§

impl Clone for PropsOut

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 PropsOut

Source§

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

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

impl Default for PropsOut

Source§

fn default() -> Self

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

impl PartialEq for PropsOut

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 PropsOut

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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, 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.