Struct ambient_api::prelude::EditorPrompt

pub struct EditorPrompt<T>
where
    T: Editor + Debug + Clone + Sync + Send + 'static,
{
    pub title: String,
    pub value: T,
    pub set_screen: Arc<CbDebuggable<dyn Fn(Option<Element>) + Sync + Send>>,
    pub on_ok: Arc<CbDebuggable<dyn Fn(&mut World, T) + Sync + Send>>,
    pub on_cancel: Option<Arc<CbDebuggable<dyn Fn(&mut World) + Sync + Send>>>,
    pub validator: Option<Arc<CbDebuggable<dyn Fn(&T) -> bool + Sync + Send>>>,
}

A full-screen prompt dialog to edit a value.

Fields

title: String

The title of the prompt.

value: T

The initial value to edit.

set_screen: Arc<CbDebuggable<dyn Fn(Option<Element>) + Sync + Send>>

The callback to set the screen to None.

on_ok: Arc<CbDebuggable<dyn Fn(&mut World, T) + Sync + Send>>

The callback to run when the user clicks “Ok”.

on_cancel: Option<Arc<CbDebuggable<dyn Fn(&mut World) + Sync + Send>>>

The callback to run when the user clicks “Cancel”.

validator: Option<Arc<CbDebuggable<dyn Fn(&T) -> bool + Sync + Send>>>

The validator to run on the value. If the validator returns false, the “Ok” button will be disabled.

Implementations

impl<T> EditorPrompt<T>

where T: Editor + Debug + Clone + Sync + Send + 'static,

pub fn el( title: String, value: T, set_screen: Arc<CbDebuggable<dyn Fn(Option<Element>) + Sync + Send>>, on_ok: Arc<CbDebuggable<dyn Fn(&mut World, T) + Sync + Send>>, on_cancel: Option<Arc<CbDebuggable<dyn Fn(&mut World) + Sync + Send>>>, validator: Option<Arc<CbDebuggable<dyn Fn(&T) -> bool + Sync + Send>>> ) -> Element

Create an Element from this component.

impl<T> EditorPrompt<T>

where T: Editor + Debug + Clone + Sync + Send + 'static,

pub fn new( title: impl Into<String>, value: T, set_screen: Arc<CbDebuggable<dyn Fn(Option<Element>) + Sync + Send>>, on_ok: impl Fn(&mut World, T) + Sync + Send + 'static ) -> EditorPrompt<T>

Creates a new EditorPrompt with the given title, value and callback.

Trait Implementations

impl<T> Clone for EditorPrompt<T>

where T: Clone + Editor + Debug + Sync + Send + 'static,

fn clone(&self) -> EditorPrompt<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for EditorPrompt<T>

where T: Debug + Editor + Clone + Sync + Send + 'static,

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

Formats the value using the given formatter.

impl<T> ElementComponent for EditorPrompt<T>

where T: Editor + Debug + Clone + Sync + Send + 'static,

fn render(self: Box<EditorPrompt<T>>, hooks: &mut Hooks<'_>) -> Element

Render the virtual tree for this component.