Struct cursive::views::CircularFocus

pub struct CircularFocus<T> where
    T: View,  { /* fields omitted */ }

Adds circular focus to a wrapped view.

Wrap a view in CircularFocus to enable wrap-around focus (when the focus exits this view, it will come back the other side).

It can be configured to wrap Tab (and Shift+Tab) keys, and/or Arrow keys.

Implementations

impl<T> CircularFocus<T> where
    T: View, 

pub fn new(view: T, wrap_tab: bool, wrap_arrows: bool) -> CircularFocus<T>

Creates a new CircularFocus around the given view.

If wrap_tab is true, Tab keys will cause focus to wrap around. If wrap_arrows is true, Arrow keys will cause focus to wrap around.

pub fn wrap_tab(view: T) -> CircularFocus<T>

Creates a new CircularFocus view which will wrap around Tab-based focus changes.

Whenever Tab would leave focus from this view, the focus will be brought back to the beginning of the view.

pub fn wrap_arrows(view: T) -> CircularFocus<T>

Creates a new CircularFocus view which will wrap around Tab-based focus changes.

Whenever an arrow key

pub fn wraps_tab(&self) -> bool

Returns true if Tab key cause focus to wrap around.

pub fn wraps_arrows(&self) -> bool

Returns true if Arrow keys cause focus to wrap around.

pub fn get_inner(&self) -> &T

Gets access to the inner view.

pub fn get_inner_mut(&mut self) -> &mut T

Gets mutable access to the inner view.

Trait Implementations

impl<T> ViewWrapper for CircularFocus<T> where
    T: View, 

type V = T

Type that this view wraps.

fn with_view<F, R>(&self, f: F) -> Option<R> where
    F: FnOnce(&<CircularFocus<T> as ViewWrapper>::V) -> R, 

Runs a function on the inner view, returning the result.

fn with_view_mut<F, R>(&mut self, f: F) -> Option<R> where
    F: FnOnce(&mut <CircularFocus<T> as ViewWrapper>::V) -> R, 

Runs a function on the inner view, returning the result.

fn into_inner(
    self
) -> Result<<CircularFocus<T> as ViewWrapper>::V, CircularFocus<T>> where
    <CircularFocus<T> as ViewWrapper>::V: Sized, 

Attempts to retrieve the inner view.

fn wrap_on_event(&mut self, event: Event) -> EventResult

Wraps the on_event method.

fn wrap_draw(&self, printer: &Printer)

Wraps the draw method.

fn wrap_required_size(&mut self, req: XY<usize>) -> XY<usize>

Wraps the required_size method.

fn wrap_layout(&mut self, size: XY<usize>)

Wraps the layout method.

fn wrap_take_focus(&mut self, source: Direction) -> bool

Wraps the take_focus method.

fn wrap_call_on_any(
    &mut self,
    selector: &Selector,
    callback: &'a mut (dyn FnMut(&mut (dyn View + 'static)) + 'a)
)

Wraps the find method.

fn wrap_focus_view(&mut self, selector: &Selector) -> Result<(), ()>

Wraps the focus_view method.

fn wrap_needs_relayout(&self) -> bool

Wraps the needs_relayout method.

fn wrap_important_area(&self, size: XY<usize>) -> Rect

Wraps the important_area method.