Struct CommandTemplateWidget 

pub struct CommandTemplateWidget {
    pub template: CommandTemplate,
    pub current_variable_index: usize,
    /* private fields */
}

The widget for a command containing variables

Fields

template: CommandTemplate

The command template

current_variable_index: usize

The index of the current variable being edited (for highlighting)

Implementations

impl CommandTemplateWidget

pub fn new(theme: &Theme, inline: bool, template: CommandTemplate) -> Self

Creates a new widget for the command template

Methods from Deref<Target = CommandTemplate>

pub fn has_pending_variable(&self) -> bool

Checks if the command has any variables without value

pub fn previous_values_for( &self, flat_variable_name: &str, ) -> Option<Vec<String>>

Retrieves the previously selected values for the given flat variable name

pub fn variable_context(&self) -> BTreeMap<String, String>

Retrieves the context for a variable in the command

pub fn count_variables(&self) -> usize

Counts the total number of variables in the template (both filled and unfilled)

pub fn variable_at(&self, index: usize) -> Option<&Variable>

Returns the variable at a specific index (0-based)

pub fn set_variable_value( &mut self, index: usize, value: Option<String>, ) -> Option<String>

Updates the value of the variable at the given index, returning the previous value if any (0-based)

pub fn set_variable_values(&mut self, values: &[Option<String>])

Sets the values for the variables in the template, in order.

This function will iterate through the variables and assign the values from the given slice in order starting from the first one until no more values are available.

pub fn new_variable_value_for( &self, flat_variable_name: impl Into<String>, value: impl Into<String>, ) -> VariableValue

Creates a VariableValue for this command with the given flat variable name and value

Trait Implementations

impl Clone for CommandTemplateWidget

fn clone(&self) -> CommandTemplateWidget

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Deref for CommandTemplateWidget

type Target = CommandTemplate

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for CommandTemplateWidget

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

Mutably dereferences the value.

impl Display for CommandTemplateWidget

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

Formats the value using the given formatter.

impl Widget for &CommandTemplateWidget

fn render(self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.