Struct ComposerState 

pub struct ComposerState { /* private fields */ }

The text, the attachments, the permission mode, and the model of a Composer.

Owned by the view that shows the composer, which observes it so a change renders. It owns the prompt’s TextareaState and holds the permission and model states, and reports what the user does as a ComposerEvent. The application changes what it shows through the methods here: add an attachment, move its upload progress, clear the text.

Enter submits, and Shift+Enter starts a new line. A prompt can be submitted when it has text or a ready attachment, no attachment is still uploading, and the composer is not disabled. A submit clears the text and the attachments unless set_clear_on_submit turned that off.

Implementations

impl ComposerState

pub fn new(window: &mut Window, cx: &mut Context<'_, Self>) -> Self

A composer with the default permission modes, an empty model catalog, and the placeholder “Hi, what do you need today?”.

pub fn with_models( self, models: Entity<ModelPickerState>, window: &mut Window, cx: &mut Context<'_, Self>, ) -> Self

Uses models for the model picker, in place of the empty one.

pub fn with_permission( self, permission: Entity<PermissionState>, window: &mut Window, cx: &mut Context<'_, Self>, ) -> Self

Uses permission for the permission menu, in place of the default modes.

pub fn watch_status( &mut self, item: impl Into<SharedString>, state: &Entity<StatusSelectState>, cx: &mut Context<'_, Self>, )

Forwards the changes of a status item as ComposerEvent::StatusChanged under item, and renders the composer when it changes.

pub fn input(&self) -> &Entity<TextareaState>

The prompt’s text state.

pub fn permission(&self) -> &Entity<PermissionState>

The permission state.

pub fn models(&self) -> &Entity<ModelPickerState>

The model picker state.

pub fn text(&self, cx: &App) -> SharedString

The prompt’s text.

pub fn set_text( &mut self, text: &str, window: &mut Window, cx: &mut Context<'_, Self>, )

Replaces the prompt’s text.

pub fn clear_text(&mut self, window: &mut Window, cx: &mut Context<'_, Self>)

Empties the prompt’s text.

pub fn focus(&self, window: &mut Window, cx: &mut App)

Puts the caret in the prompt.

pub fn placeholder(&self) -> &SharedString

The placeholder.

pub fn set_placeholder( &mut self, placeholder: impl Into<SharedString>, window: &mut Window, cx: &mut Context<'_, Self>, )

Replaces the placeholder shown while the prompt is empty.

pub fn max_lines(&self) -> usize

The most lines the prompt grows to before it scrolls.

pub fn set_max_lines(&mut self, lines: usize, cx: &mut Context<'_, Self>)

Sets the most lines the prompt grows to, at least one.

pub fn is_disabled(&self) -> bool

Whether the composer ignores input.

pub fn set_disabled(&mut self, disabled: bool, cx: &mut Context<'_, Self>)

Disables or enables the composer: the text, the send button, and submitting.

pub fn clears_on_submit(&self) -> bool

Whether a submit clears the text and the attachments.

pub fn set_clear_on_submit(&mut self, clear: bool)

Whether a submit clears the text and the attachments. On by default; turn it off when the application clears them itself, once the prompt is accepted.

pub fn attachments(&self) -> &[Attachment]

The attachments, in order.

pub fn add_attachment( &mut self, attachment: Attachment, cx: &mut Context<'_, Self>, )

Adds an attachment at the end. An attachment with the id of one already here replaces it in place.

pub fn remove_attachment( &mut self, id: &str, cx: &mut Context<'_, Self>, ) -> Option<Attachment>

Removes the attachment with id and returns it.

pub fn set_attachment_progress( &mut self, id: &str, progress: Option<f32>, cx: &mut Context<'_, Self>, )

Sets the upload progress of the attachment with id: a percentage, zero for queued, or None for done.

pub fn clear_attachments(&mut self, cx: &mut Context<'_, Self>)

Removes every attachment.

pub fn can_submit(&self, cx: &App) -> bool

Whether the prompt can be submitted now: it has text or an attachment, nothing is still uploading, and the composer is enabled.

pub fn submit( &mut self, window: &mut Window, cx: &mut Context<'_, Self>, ) -> bool

Submits the prompt if it can be, and says whether it did.

Trait Implementations

impl EventEmitter<ComposerEvent> for ComposerState

impl Focusable for ComposerState

The prompt’s focus, which holds the keyboard for the composer.

fn focus_handle(&self, cx: &App) -> FocusHandle

Returns the focus handle associated with this view.