Struct PopupState 

pub struct PopupState { /* private fields */ }

Implementations

impl PopupState

Auto-generated by derive_getters::Getters.

pub fn area(&self) -> &Option<Rect>

The last rendered area of the popup

Examples found in repository

examples/state.rs (line 76)

fn render_status_bar(frame: &mut Frame, area: Rect, state: &PopupState) {
    let popup_area = state.area().unwrap_or_default();
    let text = format!("Popup area: {popup_area:?}");
    let paragraph = Paragraph::new(text).style(Style::new().white().on_black());
    frame.render_widget(paragraph, area);
}

pub fn drag_state(&self) -> &DragState

A state indicating whether the popup is being dragged or not

impl PopupState

pub fn move_up(&mut self, amount: u16)

Examples found in repository

examples/state.rs (line 97)

fn handle_key_event(event: KeyEvent, popup: &mut PopupState, exit: &mut bool) {
    match event.code {
        KeyCode::Char('q') | KeyCode::Esc => *exit = true,
        KeyCode::Char('r') => *popup = PopupState::default(),
        KeyCode::Char('j') | KeyCode::Down => popup.move_down(1),
        KeyCode::Char('k') | KeyCode::Up => popup.move_up(1),
        KeyCode::Char('h') | KeyCode::Left => popup.move_left(1),
        KeyCode::Char('l') | KeyCode::Right => popup.move_right(1),
        _ => {}
    }
}

pub fn move_down(&mut self, amount: u16)

Examples found in repository

examples/state.rs (line 96)

fn handle_key_event(event: KeyEvent, popup: &mut PopupState, exit: &mut bool) {
    match event.code {
        KeyCode::Char('q') | KeyCode::Esc => *exit = true,
        KeyCode::Char('r') => *popup = PopupState::default(),
        KeyCode::Char('j') | KeyCode::Down => popup.move_down(1),
        KeyCode::Char('k') | KeyCode::Up => popup.move_up(1),
        KeyCode::Char('h') | KeyCode::Left => popup.move_left(1),
        KeyCode::Char('l') | KeyCode::Right => popup.move_right(1),
        _ => {}
    }
}

pub fn move_left(&mut self, amount: u16)

Examples found in repository

examples/state.rs (line 98)

fn handle_key_event(event: KeyEvent, popup: &mut PopupState, exit: &mut bool) {
    match event.code {
        KeyCode::Char('q') | KeyCode::Esc => *exit = true,
        KeyCode::Char('r') => *popup = PopupState::default(),
        KeyCode::Char('j') | KeyCode::Down => popup.move_down(1),
        KeyCode::Char('k') | KeyCode::Up => popup.move_up(1),
        KeyCode::Char('h') | KeyCode::Left => popup.move_left(1),
        KeyCode::Char('l') | KeyCode::Right => popup.move_right(1),
        _ => {}
    }
}

pub fn move_right(&mut self, amount: u16)

Examples found in repository

examples/state.rs (line 99)

fn handle_key_event(event: KeyEvent, popup: &mut PopupState, exit: &mut bool) {
    match event.code {
        KeyCode::Char('q') | KeyCode::Esc => *exit = true,
        KeyCode::Char('r') => *popup = PopupState::default(),
        KeyCode::Char('j') | KeyCode::Down => popup.move_down(1),
        KeyCode::Char('k') | KeyCode::Up => popup.move_up(1),
        KeyCode::Char('h') | KeyCode::Left => popup.move_left(1),
        KeyCode::Char('l') | KeyCode::Right => popup.move_right(1),
        _ => {}
    }
}

pub fn move_by(&mut self, x: i32, y: i32)

Move the popup by the given amount.

pub const fn move_to(&mut self, x: u16, y: u16)

Move the popup to the given position.

pub fn mouse_down(&mut self, col: u16, row: u16)

Set the state to dragging if the mouse click is in the popup title

pub const fn mouse_up(&mut self, _col: u16, _row: u16)

Set the state to not dragging

pub const fn mouse_drag(&mut self, col: u16, row: u16)

Move the popup if the state is dragging

pub fn handle_mouse_event(&mut self, event: MouseEvent)

Examples found in repository

examples/state.rs (line 87)

fn handle_events(popup: &mut PopupState, exit: &mut bool) -> Result<()> {
    let event = event::read()?;
    if let Some(key) = event.as_key_press_event() {
        handle_key_event(key, popup, exit);
    } else if let Event::Mouse(event) = event {
        popup.handle_mouse_event(event);
    }
    Ok(())
}

Trait Implementations

impl Clone for PopupState

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PopupState

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

Formats the value using the given formatter.

impl Default for PopupState

fn default() -> Self

Returns the “default value” for a type.