Skip to main content

FormViewSpec

Struct FormViewSpec 

Source
pub struct FormViewSpec<'a> {
    pub title: &'a str,
    pub subtitle: Option<&'a str>,
    pub fields: &'a [FormField],
    pub banner: Option<(&'a str, Color32)>,
    pub trailing: Option<&'a [(&'a str, Vec<String>)]>,
    pub extra: Option<(&'a str, &'a dyn Fn(&mut Ui))>,
    pub exit_label: &'a str,
    pub rollback: bool,
    pub hits_prefix: &'a str,
}
Expand description

Everything ABOUT the form that the consumer supplies. Borrowed; the form view holds no state of its own beyond egui memory.

Fields§

§title: &'a str

The form’s heading — e.g. "E3 ⟠ Extrude". Also the scope key for this form’s transient view state and per-field widget ids, so it must be STABLE and UNIQUE per subject (a feature id / constraint id qualifies).

§subtitle: Option<&'a str>

An optional second line under the title (a status, a type name…).

§fields: &'a [FormField]

The schema fields to render, in schema order.

§banner: Option<(&'a str, Color32)>

A message banner drawn under the title — e.g. the feature’s run error.

§trailing: Option<&'a [(&'a str, Vec<String>)]>

Read-only sections appended after the fields — e.g. [("Outputs", …)].

§extra: Option<(&'a str, &'a dyn Fn(&mut Ui))>

ONE consumer-drawn section (title, drawer) placed after the schema groups and before the trailing sections — for a subject whose editing surface the schema cannot express (a spline’s anchor list). The drawer is Fn, so anything it decides goes through interior mutability the consumer owns; the form view stays intent-out like everything else here.

§exit_label: &'a str

The exit button’s label — the button at the RIGHT end of the title row. Both of today’s consumers say “Return to tree” — the history feature list and the constraint list are BOTH drawn by panels::tree, so the word is literal, not a metaphor (Q12). A consumer whose list is NOT a tree supplies its own wording here.

§rollback: bool

Whether this consumer’s subject lives in a ROLLED history — i.e. whether LEAVING the form also means “roll the model back to the tip”.

The form view holds no engine and therefore cannot roll anything itself (that is FormViewOut::roll_to_tip, which the caller acts on). What this flag does is decide, in ONE place, whether an exit carries that intent — so no consumer has to hard-code “am I the history panel?” at its exit arm. The history panel passes true; assembly constraints have no rollback at all (the owner’s call) and pass false, which is why their panel has no roll branch to get wrong.

§hits_prefix: &'a str

Prefix for every published hit key. "" for a consumer that shows ONE form at a time (history); a consumer that can show several at once MUST pass a prefix carrying the subject id or the rects collide silently.

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for FormViewSpec<'a>

§

impl<'a> !Send for FormViewSpec<'a>

§

impl<'a> !Sync for FormViewSpec<'a>

§

impl<'a> !UnwindSafe for FormViewSpec<'a>

§

impl<'a> Freeze for FormViewSpec<'a>

§

impl<'a> Unpin for FormViewSpec<'a>

§

impl<'a> UnsafeUnpin for FormViewSpec<'a>

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> Downcast for T
where T: Any,

Source§

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

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

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

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

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

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<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

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