Struct EnableableView

pub struct EnableableView<V> { /* private fields */ }

Wrapper around another view that can be enabled/disabled at will.

When disabled, all child views will be disabled and will stop receiving events.

Examples

use cursive_core::traits::Nameable;
use cursive_core::views::{Button, Checkbox, EnableableView, LinearLayout};
use cursive_core::Cursive;

let mut siv = Cursive::new();

siv.add_layer(
    LinearLayout::vertical()
        .child(EnableableView::new(Checkbox::new()).with_name("my_view"))
        .child(Button::new("Toggle", |s| {
            s.call_on_name("my_view", |v: &mut EnableableView<Checkbox>| {
                // This will disable (or re-enable) the checkbox, preventing the user from
                // interacting with it.
                v.set_enabled(!v.is_enabled());
            });
        })),
);

Implementations

impl<V> EnableableView<V>

pub fn new(view: V) -> Self

Creates a new EnableableView around view.

It will be enabled by default.

pub fn disable(&mut self)

Disables this view.

A disabled view cannot be selected.

pub fn disabled(self) -> Self

Disables this view.

Chainable variant.

pub fn enable(&mut self)

Re-enables this view.

pub fn set_enabled(&mut self, enabled: bool)

Enable or disable this view.

pub fn with_enabled(self, is_enabled: bool) -> Self

Enable or disable this view.

Chainable variant.

pub fn is_enabled(&self) -> bool

Returns true if this view is enabled.

pub fn get_inner(&self) -> &V

Gets access to the inner view.

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

Gets mutable access to the inner view.

Trait Implementations

impl<V> Default for EnableableView<V>

where V: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<V: View> ViewWrapper for EnableableView<V>

type V = V

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(&mut self, selector: &Selector<'_>, callback: AnyCb<'_>)

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.