Struct penrose::draw::widget::LinesWithSelection

pub struct LinesWithSelection { /* fields omitted */ }

A set of lines that highlights the currently selected line.

Implementations

impl LinesWithSelection

pub fn new(
    font: String,
    point_size: i32,
    padding: f64,
    bg: Color,
    fg: Color,
    bg_sel: Color,
    fg_sel: Color,
    n_lines: usize,
    greedy: bool
) -> Self

Construct a new LinesWithSelection

pub fn set_input(&mut self, lines: Vec<String>) -> Result<()>

Set the displayed lines and selected index.

pub fn set_selected(&mut self, selected: usize) -> Result<()>

Set the currently selected index

Errors

Fails if the provided index is out of bounds

pub fn set_n_lines(&mut self, n_lines: usize)

Set the maximum number of lines from the input that will be displayed.

Defaults to 10

pub fn selected(&self) -> Option<&str>

The currently selected line (if there is one)

pub fn selected_index(&self) -> usize

The currently selected index

Trait Implementations

impl Clone for LinesWithSelection

pub fn clone(&self) -> LinesWithSelection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LinesWithSelection

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

Formats the value using the given formatter.

impl<X> Hook<X> for LinesWithSelection where
    X: XConn, 

pub fn startup(&mut self, wm: &mut WindowManager<X>) -> Result<()>

Trigger Point

pub fn new_client(
    &mut self,
    wm: &mut WindowManager<X>,
    client: &mut Client
) -> Result<()>

Trigger Point

pub fn remove_client(
    &mut self,
    wm: &mut WindowManager<X>,
    id: WinId
) -> Result<()>

Trigger Point

pub fn client_added_to_workspace(
    &mut self,
    wm: &mut WindowManager<X>,
    id: WinId,
    wix: usize
) -> Result<()>

Trigger Point

pub fn client_name_updated(
    &mut self,
    wm: &mut WindowManager<X>,
    id: WinId,
    name: &str,
    is_root: bool
) -> Result<()>

Trigger Point

pub fn layout_applied(
    &mut self,
    wm: &mut WindowManager<X>,
    workspace_index: usize,
    screen_index: usize
) -> Result<()>

Trigger Point

pub fn layout_change(
    &mut self,
    wm: &mut WindowManager<X>,
    workspace_index: usize,
    screen_index: usize
) -> Result<()>

Trigger Point

pub fn workspace_change(
    &mut self,
    wm: &mut WindowManager<X>,
    previous_workspace: usize,
    new_workspace: usize
) -> Result<()>

Trigger Point

pub fn workspaces_updated(
    &mut self,
    wm: &mut WindowManager<X>,
    names: &[&str],
    active: usize
) -> Result<()>

Trigger Point

pub fn screen_change(
    &mut self,
    wm: &mut WindowManager<X>,
    screen_index: usize
) -> Result<()>

Trigger Point

pub fn screens_updated(
    &mut self,
    wm: &mut WindowManager<X>,
    dimensions: &[Region]
) -> Result<()>

Trigger Point

pub fn randr_notify(&mut self, wm: &mut WindowManager<X>) -> Result<()>

Trigger Point

pub fn focus_change(
    &mut self,
    wm: &mut WindowManager<X>,
    id: WinId
) -> Result<()>

Trigger Point

pub fn event_handled(&mut self, wm: &mut WindowManager<X>) -> Result<()>

Trigger Point

impl KeyboardControlled for LinesWithSelection

pub fn handle_keypress(&mut self, k: KeyPress) -> Result<Option<KeyPress>>

Process the given KeyPress

impl PartialEq<LinesWithSelection> for LinesWithSelection

pub fn eq(&self, other: &LinesWithSelection) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &LinesWithSelection) -> bool

This method tests for !=.

impl StructuralPartialEq for LinesWithSelection

impl Widget for LinesWithSelection

pub fn draw(
    &mut self,
    ctx: &mut dyn DrawContext,
    _screen: usize,
    _screen_has_focus: bool,
    w: f64,
    h: f64
) -> Result<()>

Render the current state of the widget to the status bar window.

pub fn current_extent(
    &mut self,
    ctx: &mut dyn DrawContext,
    _h: f64
) -> Result<(f64, f64)>

Current required width and height for this widget due to its content

pub fn require_draw(&self) -> bool

Does this widget currently require re-rendering? (should be updated when 'draw' is called)

pub fn is_greedy(&self) -> bool

If true, this widget will expand to fill remaining available space after layout has been computed. If multiple greedy widgets are present in a given StatusBar then the available space will be split evenly between all widgets.