Struct tty_form::coordinator::Coordinator

pub struct Coordinator<'a, 'b> { /* private fields */ }

Provides controlled access to a terminal interface. Coordinates allocation of lines and segments on the screen to elements.

Implementations

impl Coordinator<'_, '_>

pub fn set_cursor(&mut self, cursor: RelativePosition)

Set the cursor’s relative position.

pub fn hide_cursor(&mut self)

Hide the cursor.

pub fn segments(&self, element_id: &ElementId) -> Vec<&Segment>

Retrieves the specified element’s inline segments.

pub fn get_segment(
    &self,
    element_id: &ElementId,
    segment_id: &SegmentId
) -> &Segment

Retrieve the specified element’s inline segment.

pub fn get_segment_mut(
    &mut self,
    element_id: &ElementId,
    segment_id: &SegmentId
) -> &mut Segment

Retrieve a mutable reference to the specified element’s inline segment.

pub fn get_inline_line_id(&self, element_id: &ElementId) -> LineId

Retrieve the specified element’s inline line ID. This ID should be considered dirty between updates and after any block line updates.

pub fn add_segment(&mut self, element_id: &ElementId) -> &mut Segment

Add an inline segment to the specified element and return a mutable reference to it.

pub fn insert_segment(
    &mut self,
    element_id: &ElementId,
    index: usize
) -> &mut Segment

Insert an inline segment at the specified index and return a mutable reference to it.

pub fn remove_segment(&mut self, element_id: &ElementId, segment_id: &SegmentId)

Remove the specified inline segment from the element.

pub fn remove_segment_at(&mut self, element_id: &ElementId, index: usize)

Remove the inline segment at the specified index from the element.

pub fn lines(&self, element_id: &ElementId) -> Vec<&Line>

Retrieves the specified element’s block lines.

pub fn get_line(&self, _element_id: &ElementId, line_id: &LineId) -> &Line

Retrieve a specific block line for the specified element.

pub fn get_line_mut(
    &mut self,
    _element_id: &ElementId,
    line_id: &LineId
) -> &mut Line

Retrieve a mutable reference to a specified block line for the specified element.

pub fn add_line(&mut self, element_id: &ElementId) -> &mut Line

Append a block line to the specified element and return a mutable reference to it.

pub fn insert_line(&mut self, element_id: &ElementId, index: usize) -> &mut Line

Insert a block line at the specified index and return a mutable reference to it.

pub fn remove_line(&mut self, element_id: &ElementId, line_id: &LineId)

Remove the specified block line from the element.

pub fn remove_line_at(&mut self, element_id: &ElementId, index: usize)

Remove a block line from the specified index.