Struct PromptInput

pub struct PromptInput {
    pub send_icon: LiveValue,
    pub stop_icon: LiveValue,
    pub task: Task,
    pub interactivity: Interactivity,
    pub bot_capabilities: Option<BotCapabilities>,
    /* private fields */
}

A prepared text input for conversation with bots.

This is mostly a dummy widget. Prefer using and adapting crate::widgets::chat::Chat instead.

Fields

send_icon: LiveValue

Icon used by this widget when the task is set to Task::Send.

stop_icon: LiveValue

Icon used by this widget when the task is set to Task::Stop.

task: Task

If this widget should provoke sending a message or stopping the current response.

interactivity: Interactivity

If this widget should be interactive or not.

bot_capabilities: Option<BotCapabilities>

Capabilities of the currently selected bot

Implementations

impl PromptInput

pub fn reset(&mut self, cx: &mut Cx)

Reset this prompt input erasing text, removing attachments, etc.

Shadows the [CommandTextInput::reset] method.

pub fn submitted(&self, actions: &Actions) -> bool

Check if the submit button or the return key was pressed.

Note: To know what the button submission means, check Self::task or the utility methods.

pub fn call_pressed(&self, actions: &Actions) -> bool

pub fn has_send_task(&self) -> bool

Shorthand to check if Self::task is set to Task::Send.

pub fn has_stop_task(&self) -> bool

Shorthand to check if Self::task is set to Task::Stop.

pub fn enable(&mut self)

Allows submission.

pub fn disable(&mut self)

Disallows submission.

pub fn set_send(&mut self)

Shorthand to set Self::task to Task::Send.

pub fn set_stop(&mut self)

Shorthand to set Self::task to Task::Stop.

pub fn set_bot_capabilities( &mut self, cx: &mut Cx, capabilities: Option<BotCapabilities>, )

Set the capabilities of the currently selected bot

Methods from Deref<Target = CommandTextInput>

pub fn keyboard_focus_index(&self) -> Option<usize>

pub fn set_keyboard_focus_index(&mut self, idx: usize)

Sets the keyboard focus index for the list of selectable items Only updates the visual highlight state of the dropdown items

pub fn reset(&mut self, cx: &mut Cx)

Clear all text and hide the popup going back to initial state.

pub fn clear_items(&mut self)

Clears the list of items.

Normally called as response to should_build_items.

pub fn add_item(&mut self, widget: WidgetRef)

Add a custom selectable item to the list.

Normally called after clearing the previous items.

pub fn add_unselectable_item(&mut self, widget: WidgetRef)

Add a custom unselectable item to the list.

Ex: Headers, dividers, etc.

Normally called after clearing the previous items.

pub fn search_text(&self) -> String

Get the current search query.

You probably want this for filtering purposes when updating the items.

pub fn item_selected( &self, actions: &[Box<dyn ActionTrait>], ) -> Option<WidgetRef>

Checks if any item has been selected in the given actions and returns a reference to the selected item as a widget.

pub fn should_build_items(&self, actions: &[Box<dyn ActionTrait>]) -> bool

Returns true if an action in the given actions indicates that the items to display need to be recomputed again.

For example, this returns true if the trigger character was typed, if the search filter changes, etc.

pub fn text_input_ref(&self) -> TextInputRef

Returns a reference to the inner TextInput widget.

pub fn search_input_ref(&self) -> TextInputRef

Returns a reference to the inner TextInput widget used for search.

pub fn request_text_input_focus(&mut self)

Obtain focus in the main TextInput widget as soon as possible.

Methods from Deref<Target = View>

pub fn swap_child(&mut self, pos_a: usize, pos_b: usize)

pub fn child_index(&mut self, comp: &WidgetRef) -> Option<usize>

pub fn child_at_index(&mut self, index: usize) -> Option<&WidgetRef>

pub fn set_scroll_pos(&mut self, cx: &mut Cx, v: DVec2)

pub fn area(&self) -> Area

pub fn walk_from_previous_size(&self, walk: Walk) -> Walk

pub fn child_count(&self) -> usize

pub fn debug_print_children(&self)

pub fn set_key_focus(&self, cx: &mut Cx)

Trait Implementations

impl Deref for PromptInput

type Target = CommandTextInput

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for PromptInput

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl LiveApply for PromptInput

fn apply( &mut self, cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, start_index: usize, nodes: &[LiveNode], ) -> usize

fn apply_over(&mut self, cx: &mut Cx, nodes: &[LiveNode])

impl LiveApplyReset for PromptInput

fn apply_reset( &mut self, cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, start_index: usize, nodes: &[LiveNode], )

impl LiveApplyValue for PromptInput

fn apply_value( &mut self, cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, index: usize, nodes: &[LiveNode], ) -> usize

impl LiveHook for PromptInput

fn after_new_from_doc(&mut self, cx: &mut Cx)

fn apply_value_unknown( &mut self, cx: &mut Cx, _apply: &mut Apply<'_, '_, '_>, index: usize, nodes: &[LiveNode], ) -> usize

fn skip_apply_animator( &mut self, _cx: &mut Cx, _apply: &mut Apply<'_, '_, '_>, _index: usize, _nodes: &[LiveNode], ) -> bool

fn apply_value_instance( &mut self, _cx: &mut Cx, _apply: &mut Apply<'_, '_, '_>, index: usize, nodes: &[LiveNode], ) -> usize

fn skip_apply( &mut self, _cx: &mut Cx, _apply: &mut Apply<'_, '_, '_>, _index: usize, _nodes: &[LiveNode], ) -> Option<usize>

fn before_apply( &mut self, _cx: &mut Cx, _apply: &mut Apply<'_, '_, '_>, _index: usize, _nodes: &[LiveNode], )

fn after_apply( &mut self, _cx: &mut Cx, _apply: &mut Apply<'_, '_, '_>, _index: usize, _nodes: &[LiveNode], )

fn after_apply_from(&mut self, cx: &mut Cx, apply: &mut Apply<'_, '_, '_>)

fn after_update_from_doc(&mut self, _cx: &mut Cx)

fn after_apply_from_doc(&mut self, _cx: &mut Cx)

fn after_new_before_apply(&mut self, _cx: &mut Cx)

impl LiveHookDeref for PromptInput

fn deref_before_apply( &mut self, cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, index: usize, nodes: &[LiveNode], )

fn deref_after_apply( &mut self, cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, index: usize, nodes: &[LiveNode], )

impl LiveNew for PromptInput

fn live_type_info(cx: &mut Cx) -> LiveTypeInfo

fn live_design_with(cx: &mut Cx)

fn new(cx: &mut Cx) -> Self

fn new_apply( cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, index: usize, nodes: &[LiveNode], ) -> Self

where Self: Sized,

fn new_apply_over(cx: &mut Cx, nodes: &[LiveNode]) -> Self

where Self: Sized,

fn new_apply_mut_index( cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, index: &mut usize, nodes: &[LiveNode], ) -> Self

where Self: Sized,

fn new_from_ptr(cx: &mut Cx, live_ptr: Option<LivePtr>) -> Self

where Self: Sized,

fn update_from_ptr(&mut self, cx: &mut Cx, live_ptr: Option<LivePtr>)

fn update_from_ptr_with_scope( &mut self, cx: &mut Cx, live_ptr: Option<LivePtr>, scope: &mut Scope<'_, '_>, )

fn new_from_ptr_with_scope( cx: &mut Cx, live_ptr: Option<LivePtr>, scope: &mut Scope<'_, '_>, ) -> Self

where Self: Sized,

fn new_main(cx: &mut Cx) -> Option<Self>

where Self: Sized,

fn register_main_module(cx: &mut Cx)

fn update_main(&mut self, cx: &mut Cx)

fn new_local(cx: &mut Cx) -> Self

where Self: Sized,

fn new_from_module( cx: &mut Cx, module_id: LiveModuleId, id: LiveId, ) -> Option<Self>

where Self: Sized,

fn update_from_module( &mut self, cx: &mut Cx, module_id: LiveModuleId, id: LiveId, )

impl LiveRegister for PromptInput

fn live_register(cx: &mut Cx)

impl Widget for PromptInput

fn set_text(&mut self, cx: &mut Cx, v: &str)

fn text(&self) -> String

fn handle_event( &mut self, cx: &mut Cx, event: &Event, scope: &mut Scope<'_, '_>, )

fn draw_walk( &mut self, cx: &mut Cx2d<'_, '_>, scope: &mut Scope<'_, '_>, walk: Walk, ) -> DrawStep

fn handle_event_with( &mut self, cx: &mut Cx, event: &Event, scope: &mut Scope<'_, '_>, _sweep_area: Area, )

fn widget(&self, path: &[LiveId]) -> WidgetRef

fn widgets(&self, paths: &[&[LiveId]]) -> WidgetSet

fn widget_uid(&self) -> WidgetUid

fn widget_to_data( &self, _cx: &mut Cx, _actions: &[Box<dyn ActionTrait>], _nodes: &mut Vec<LiveNode>, _path: &[LiveId], ) -> bool

fn data_to_widget( &mut self, _cx: &mut Cx, _nodes: &[LiveNode], _path: &[LiveId], )

fn draw_3d( &mut self, _cx: &mut Cx3d<'_, '_>, _scope: &mut Scope<'_, '_>, ) -> Result<(), WidgetRef>

fn draw_3d_all(&mut self, cx: &mut Cx3d<'_, '_>, scope: &mut Scope<'_, '_>)

fn draw( &mut self, cx: &mut Cx2d<'_, '_>, scope: &mut Scope<'_, '_>, ) -> Result<(), WidgetRef>

fn draw_walk_all( &mut self, cx: &mut Cx2d<'_, '_>, scope: &mut Scope<'_, '_>, walk: Walk, )

fn draw_all(&mut self, cx: &mut Cx2d<'_, '_>, scope: &mut Scope<'_, '_>)

fn draw_unscoped(&mut self, cx: &mut Cx2d<'_, '_>) -> Result<(), WidgetRef>

fn draw_all_unscoped(&mut self, cx: &mut Cx2d<'_, '_>)

fn set_key_focus(&self, cx: &mut Cx)

fn key_focus(&self, cx: &Cx) -> bool

fn set_disabled(&mut self, _cx: &mut Cx, _disabled: bool)

fn disabled(&self, _cx: &Cx) -> bool

fn ref_cast_type_id(&self) -> TypeId

where Self: 'static,

fn ui_runner(&self) -> UiRunner<Self>

where Self: Sized + 'static,

impl WidgetNode for PromptInput

fn visible(&self) -> bool

fn set_visible(&mut self, cx: &mut Cx, visible: bool)

fn area(&self) -> Area

fn walk(&mut self, cx: &mut Cx) -> Walk

fn redraw(&mut self, cx: &mut Cx)

fn find_widgets( &self, path: &[LiveId], cached: WidgetCache, results: &mut WidgetSet, )

fn uid_to_widget(&self, uid: WidgetUid) -> WidgetRef

fn widget_design(&mut self) -> Option<&mut dyn WidgetDesign>

fn set_action_data(&mut self, _data: Arc<dyn ActionTrait>)

fn action_data(&self) -> Option<Arc<dyn ActionTrait>>