Struct StreamView 

pub struct StreamView { /* private fields */ }

A scrollback of styled lines, with autoscroll that releases when the user scrolls back and re-arms at the bottom.

Implementations

impl StreamView

pub fn new(bounds: Rect) -> Self

pub fn set_max_lines(&mut self, n: usize)

pub fn push_line(&mut self, cells: &[Cell])

Appends a completed line.

pub fn set_partial(&mut self, cells: &[Cell])

Replaces the in-progress line. Called on every repaint while a line is still streaming, so it must overwrite rather than append.

pub fn clear(&mut self)

pub fn line_count(&self) -> usize

Total displayed lines, including the in-progress one.

pub fn row_count(&self) -> usize

Total display rows currently shown, including the in-progress line’s wrapped rows. This is what scroll arithmetic (page, max_top, and the keyboard handlers) counts, so scrolling lands correctly wherever a wrapped long line pushes rows out of alignment with logical lines.

pub fn scroll_to_bottom(&mut self)

pub fn scroll_to_top(&mut self)

pub fn scroll_up(&mut self, n: usize)

pub fn scroll_down(&mut self, n: usize)

pub fn is_at_bottom(&self) -> bool

pub fn select_all(&mut self)

Selects the entire scrollback in stream mode. Leaves no selection if the buffer is empty.

pub fn set_selection(&mut self, anchor: (usize, usize), head: (usize, usize))

Sets a selection between two carets (row, col). Order-independent: anchor and head may be given in either order.

pub fn clear_selection(&mut self)

pub fn has_selection(&self) -> bool

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

The selected text, or None when there is no selection. Logical lines are reconstructed: a soft wrap within a line does not become a newline.

pub fn plain_text(&self) -> String

The whole scrollback with attributes stripped, for File > Save As.

pub fn styled_lines(&self) -> Vec<Vec<Cell>>

The whole scrollback with attributes intact, for tests and golden files.

Trait Implementations

impl Debug for StreamView

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

Formats the value using the given formatter.

impl View for StreamView

fn bounds(&self) -> Rect

fn set_bounds(&mut self, bounds: Rect)

fn draw(&mut self, terminal: &mut Terminal)

fn handle_event(&mut self, event: &mut Event)

fn grow_mode(&self) -> GrowFlags

Get this view’s grow mode flags (Borland: TView::growMode).

fn set_grow_mode(&mut self, grow_mode: GrowFlags)

Set this view’s grow mode flags (Borland: TView::growMode).

fn can_focus(&self) -> bool

fn get_palette(&self) -> Option<Palette>

Get this view’s palette for the Borland indirect palette system Matches Borland: TView::getPalette()

fn set_focus(&mut self, focused: bool)

Set focus state - default implementation uses SF_FOCUSED flag Views should override only if they need custom focus behavior

fn window_number(&self) -> Option<u8>

Window number for Alt+1..9 selection (Borland: TWindow::number).

fn is_focused(&self) -> bool

Check if view is focused - reads SF_FOCUSED flag

fn options(&self) -> u16

Get view option flags (OF_SELECTABLE, OF_PRE_PROCESS, OF_POST_PROCESS, etc.)

fn set_options(&mut self, _options: u16)

Set view option flags

fn state(&self) -> u16

Get view state flags

fn set_state(&mut self, _state: u16)

Set view state flags

fn set_state_flag(&mut self, flag: u16, enable: bool)

Set or clear specific state flag(s) Matches Borland’s TView::setState(ushort aState, Boolean enable) If enable is true, sets the flag(s), otherwise clears them

fn get_state_flag(&self, flag: u16) -> bool

Check if specific state flag(s) are set Matches Borland’s TView::getState(ushort aState)

fn has_shadow(&self) -> bool

Check if view has shadow enabled

fn shadow_bounds(&self) -> Rect

Get bounds including shadow area

fn update_cursor(&self, _terminal: &mut Terminal)

Update cursor state (called after draw) Views that need to show a cursor when focused should override this

fn zoom(&mut self, _max_bounds: Rect)

Zoom (maximize/restore) the view with given maximum bounds Matches Borland: TWindow::zoom() toggles between current and max size Default implementation does nothing (only windows support zoom)

fn valid(&mut self, _command: u16) -> bool

Validate the view before performing a command (usually closing) Matches Borland: TView::valid(ushort command) - returns Boolean Returns true if the view’s state is valid for the given command Used for “Save before closing?” type scenarios and input validation

fn as_any(&self) -> &(dyn Any + 'static)

Downcast to concrete type (immutable) Allows accessing specific view type methods from trait object

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Downcast to concrete type (mutable) Allows accessing specific view type methods from trait object

fn dump_to_file(&self, terminal: &Terminal, path: &str) -> Result<(), Error>

Dump this view’s region of the terminal buffer to an ANSI file for debugging

fn is_default_button(&self) -> bool

Check if this view is a default button (for Enter key handling at Dialog level) Corresponds to Borland’s TButton::amDefault flag (tbutton.cc line 239)

fn button_command(&self) -> Option<u16>

Get the command ID for this button (if it’s a button) Returns None if not a button Used by Dialog to activate default button on Enter key

fn set_list_selection(&mut self, _index: usize)

Set the selection index for listbox views Only implemented by ListBox, other views ignore this

fn get_list_selection(&self) -> usize

Get the selection index for listbox views Only implemented by ListBox, other views return 0

fn get_redraw_union(&self) -> Option<Rect>

Get the union rect of previous and current bounds for redrawing Matches Borland: TView::locate() calculates union of old and new bounds Returns None if the view hasn’t moved since last redraw Used by Desktop to implement Borland’s drawUnderRect pattern

fn clear_move_tracking(&mut self)

Clear movement tracking after redrawing Matches Borland: Called after drawUnderRect completes

fn get_end_state(&self) -> u16

Get the end state for modal views Matches Borland: TGroup::endState field Returns the command ID that ended modal execution (0 if still running)

fn set_end_state(&mut self, _command: u16)

Set the end state for modal views Called by end_modal() to signal the modal loop should exit

fn make_global(&self, local_x: i16, local_y: i16) -> (i16, i16)

Convert local coordinates to global (screen) coordinates Matches Borland: TView::makeGlobal(TPoint source, TPoint& dest)

fn make_local(&self, global_x: i16, global_y: i16) -> (i16, i16)

Convert global (screen) coordinates to local view coordinates Matches Borland: TView::makeLocal(TPoint source, TPoint& dest)

fn draw_shadow(&self, terminal: &mut Terminal)

Draw shadow for this view Draws a shadow offset dynamically based on terminal cell aspect ratio Shadow is semi-transparent - darkens the underlying content by 50% This matches the Borland Turbo Vision behavior more closely

fn label_link(&self) -> Option<ViewId>

Get the linked control ViewId for labels Matches Borland: TLabel::link field Returns Some(ViewId) if this is a label with a linked control, None otherwise Used by Group to implement focus transfer when clicking labels

fn init_after_add(&mut self)

Initialize internal owner pointers after view is added to parent and won’t move This is called by parent’s add() method after the view is in its final position Views that contain other views by value should override this to set up owner chains Default implementation does nothing

fn constrain_to_parent_bounds(&mut self)

Constrain view bounds to parent/owner bounds Used after positioning (e.g., centering) to ensure view stays within valid area Matches Borland: TView::locate() constrains position to owner bounds

fn set_palette_chain(&mut self, _node: Option<PaletteChainNode>)

Set the QCell-based palette chain node for this view. Called by parent (Group/Window) during draw to establish the safe owner chain.

fn get_palette_chain(&self) -> Option<&PaletteChainNode>

Get the QCell-based palette chain node for this view. Used by map_color() to safely walk the owner chain.

fn set_parent_bounds(&mut self, _bounds: Rect)

Set the parent’s bounds for drag/resize limit resolution. Called by Desktop when adding windows.

fn map_color(&self, color_index: u8) -> Attr

Map a logical color index to an actual color attribute Matches Borland: TView::mapColor(uchar index)