Struct meli::components::utilities::Pager

pub struct Pager {
    text: String,
    cursor: (usize, usize),
    reflow: Reflow,
    height: usize,
    width: usize,
    minimum_width: usize,
    search: Option<SearchPattern>,
    dirty: bool,
    colors: ThemeAttribute,
    initialised: bool,
    show_scrollbar: bool,
    content: CellBuffer,
    text_lines: (usize, Vec<String>),
    movement: Option<PageMovement>,
    id: ComponentId,
}

A pager for text. Pager holds its own content in its own CellBuffer and when draw is called, it draws the current view of the text. It is responsible for scrolling etc.

Fields

text: String

cursor: (usize, usize)

reflow: Reflow

height: usize

width: usize

minimum_width: usize

search: Option<SearchPattern>

dirty: bool

colors: ThemeAttribute

initialised: bool

show_scrollbar: bool

content: CellBuffer

text_lines: (usize, Vec<String>)

movement: Option<PageMovement>

id: ComponentId

Implementations

impl Pager

pub const DESCRIPTION: &'static str

pub fn new(context: &Context) -> Self

pub fn set_show_scrollbar(&mut self, new_val: bool) -> &mut Self

pub fn set_colors(&mut self, new_val: ThemeAttribute) -> &mut Self

pub fn set_reflow(&mut self, new_val: Reflow) -> &mut Self

pub fn set_initialised(&mut self, new_val: bool) -> &mut Self

pub fn reflow(&self) -> Reflow

pub fn update_from_str(&mut self, text: &str, width: Option<usize>)

pub fn from_string(
    text: String,
    context: Option<&Context>,
    cursor_pos: Option<usize>,
    width: Option<usize>,
    colors: ThemeAttribute
) -> Self

pub fn from_str(
    text: &str,
    cursor_pos: Option<usize>,
    width: Option<usize>,
    colors: ThemeAttribute
) -> Self

pub fn from_buf(content: CellBuffer, cursor_pos: Option<usize>) -> Self

pub fn print_string(
    content: &mut CellBuffer,
    lines: &[String],
    colors: ThemeAttribute
)

pub fn cursor_pos(&self) -> usize

pub fn size(&self) -> (usize, usize)

Trait Implementations

impl Clone for Pager

fn clone(&self) -> Pager

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for Pager

fn draw(&mut self, grid: &mut CellBuffer, area: Area, context: &mut Context)

fn process_event(&mut self, event: &mut UIEvent, context: &mut Context) -> bool

fn is_dirty(&self) -> bool

fn set_dirty(&mut self, value: bool)

fn get_shortcuts(&self, context: &Context) -> ShortcutMaps

fn id(&self) -> ComponentId

fn set_id(&mut self, id: ComponentId)

fn is_visible(&self) -> bool

fn can_quit_cleanly(&mut self, _context: &Context) -> bool

fn kill(&mut self, _id: ComponentId, _context: &mut Context)

fn get_status(&self, _context: &Context) -> String

impl Debug for Pager

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

Formats the value using the given formatter.

impl Default for Pager

fn default() -> Pager

Returns the "default value" for a type.

impl Display for Pager

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

Formats the value using the given formatter.