Struct Messages

pub struct Messages {
    pub messages: Vec<Message>,
    pub bot_context: Option<BotContext>,
    pub templates: HashMap<LiveId, LivePtr>,
    /* private fields */
}

View over a conversation with messages.

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

Fields

messages: Vec<Message>

The list of messages rendered by this widget.

bot_context: Option<BotContext>

Used to get bot information.

templates: HashMap<LiveId, LivePtr>

Registry of DSL templates used by custom content widgets.

This is exposed as it is for easy manipulation and it’s passed to BotClient::content_widget method allowing it to create widgets with [WidgetRef::new_from_ptr].

Implementations

impl Messages

pub fn is_at_bottom(&self) -> bool

Check if we’re at the end of the messages list.

pub fn user_scrolled(&self) -> bool

pub fn scroll_to_bottom(&mut self, cx: &mut Cx, triggered_by_stream: bool)

Jump to the end of the list instantly.

pub fn set_message_editor_visibility(&mut self, index: usize, visible: bool)

Show or hide the editor for a message.

Limitation: Only one editor can be shown at a time. If you try to show another editor, the previous one will be hidden. If you try to hide an editor different from the one currently shown, nothing will happen.

pub fn current_editor_text(&self) -> Option<String>

If currently editing a message, this will return the text in it’s editor.

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

If currently editing a message, this will return the index of the message.

pub fn set_messages(&mut self, messages: Vec<Message>, scroll_to_bottom: bool)

Set the messages and defer a scroll to bottom if requested.

pub fn reset_scroll_state(&mut self)

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 Messages

type Target = View

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for Messages

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

Mutably dereferences the value.

impl LiveApply for Messages

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 Messages

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

impl LiveApplyValue for Messages

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

impl LiveHook for Messages

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 Messages

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 Messages

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 Messages

fn live_register(cx: &mut Cx)

impl Widget for Messages

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 text(&self) -> String

fn set_text(&mut self, _cx: &mut Cx, _v: &str)

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 Messages

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>>