Enum FormKind 

pub enum FormKind {
    Screen,
    Window,
    Dialog,
    Drawer,
    Shelf,
    Fragment,
}

What a form is for.

The engine reports it and opens nothing: whether a dialog is a pushed scene or a modal window is the application’s decision, and it differs by machine.

Variants

Screen

The root tree of a Ui — a panel’s whole surface.

Window

A desktop window.

Dialog

A modal: Ui::push_scene on a panel, a modal window on a desktop.

Drawer

Ui::push_drawer.

Shelf

Ui::push_shelf.

Fragment

A subtree with no root of its own, for reuse inside other forms.

Implementations

impl FormKind

pub const NAMES: &'static [&'static str]

Every kind, in the spelling a form file uses.

pub const fn what(self) -> &'static str

assert!(FormKind::Dialog.what().contains("modal"));
// Every kind has one, and no two share it.
assert_ne!(FormKind::Drawer.what(), FormKind::Shelf.what());

One line on what this kind is for.

Here rather than in the designer because it is a fact about the format: the CLI prints it, the designer offers it when a form is being made, and neither of them should be keeping its own copy.

pub const fn default_side(self) -> Side

// A drawer is a side panel; a shelf is a bar.
assert_eq!(FormKind::Drawer.default_side(), Side::Before);
assert_eq!(FormKind::Shelf.default_side(), Side::Below);

Which edge one of these comes in from when the file does not say.

Trait Implementations

impl Clone for FormKind

fn clone(&self) -> FormKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FormKind

impl Debug for FormKind

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

Formats the value using the given formatter.

impl Eq for FormKind

impl Hash for FormKind

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FormKind

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FormKind