Struct cursive_core::views::CircularFocus

pub struct CircularFocus<T: View> { /* private fields */ }

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: View> CircularFocus<T>

pub fn new(view: T) -> Self

Creates a new CircularFocus around the given view.

Does not wrap anything by default, so you’ll want to call one of the setters.

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 wraps_left_right(&self) -> bool

Return true if left/right keys cause focus to wrap around.

pub fn wraps_up_down(&self) -> bool

Return true if up/down keys cause focus to wrap around.

pub fn wrap_arrows(self) -> Self

Make this view now wrap focus around when arrow keys are pressed.

pub fn wrap_up_down(self) -> Self

Make this view now wrap focus around when the up/down keys are pressed.

pub fn wrap_left_right(self) -> Self

Make this view now wrap focus around when the left/right keys are pressed.

pub fn with_wrap_tab(self, wrap_tab: bool) -> Self

Make this view now wrap focus around when the Tab key is pressed.

Chainable variant.

pub fn wrap_tab(self) -> Self

Make this view now wrap focus around when the Tab key is pressed.

Chainable variant.

pub fn with_wrap_left_right(self, wrap_left_right: bool) -> Self

Make this view now wrap focus around when the left/right keys are pressed.

pub fn with_wrap_up_down(self, wrap_up_down: bool) -> Self

Make this view now wrap focus around when the up/down keys are pressed.

pub fn with_wrap_arrows(self, wrap_arrows: bool) -> Self

Make this view now wrap focus around when arrow keys are pressed.

pub fn set_wrap_tab(&mut self, wrap_tab: bool)

Make this view now wrap focus around when the Tab key is pressed.

pub fn set_wrap_arrows(&mut self, wrap_arrows: bool)

Make this view now wrap focus around when arrow keys are pressed.

pub fn set_wrap_up_down(&mut self, wrap_up_down: bool)

Make this view now wrap focus around when the up/down keys are pressed.

pub fn set_wrap_left_right(&mut self, wrap_left_right: bool)

Make this view now wrap focus around when the left/right keys are pressed.

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: View> ViewWrapper for CircularFocus<T>

type V = T

Type that this view wraps.

fn with_view<F, R>(&self, f: F) -> Option<R>where
    F: FnOnce(&Self::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 Self::V) -> R,

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

fn into_inner(self) -> Result<Self::V, Self>where
    Self::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: Vec2) -> Vec2

Wraps the required_size method.

fn wrap_layout(&mut self, size: Vec2)

Wraps the layout method.

fn wrap_take_focus(
    &mut self,
    source: Direction
) -> Result<EventResult, CannotFocus>

Wraps the take_focus method.

fn wrap_call_on_any<'a>(&mut self, selector: &Selector<'_>, callback: AnyCb<'a>)

Wraps the find method.

fn wrap_focus_view(
    &mut self,
    selector: &Selector<'_>
) -> Result<EventResult, ViewNotFound>

Wraps the focus_view method.

fn wrap_needs_relayout(&self) -> bool

Wraps the needs_relayout method.

fn wrap_important_area(&self, size: Vec2) -> Rect

Wraps the important_area method.