Struct cursive_core::views::NamedView

source ·
pub struct NamedView<V> { /* private fields */ }
Expand description

Wrapper around a view to make it identifiable.

This lets other views refer to this one using a string identifier.

See Nameable for an easy way to wrap any view with it.

Implementations§

source§

impl<V> NamedView<V>

source

pub fn new<S: Into<String>>(name: S, view: V) -> Self

Wraps view in a new NamedView.

source

pub fn get_mut(&mut self) -> ViewRef<V>

Gets mutable access to the inner view.

This returns a ViewRef<V>, which implement DerefMut<Target = V>.

§Panics

Panics if another reference for this view already exists.

source

pub fn name(&self) -> &str

Returns the name attached to this view.

source

pub fn set_name<S: Into<String>>(&mut self, name: S)

Changes the name attached to this view.

Trait Implementations§

source§

impl<T: View + 'static> ViewWrapper for NamedView<T>

§

type V = T

Type that this view wraps.
source§

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. Read more
source§

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. Read more
source§

fn into_inner(self) -> Result<Self::V, Self>
where Self::V: Sized,

Attempts to retrieve the inner view.
source§

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

Wraps the find method.
source§

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

Wraps the focus_view method.
source§

fn wrap_draw(&self, printer: &Printer<'_, '_>)

Wraps the draw method.
source§

fn wrap_required_size(&mut self, req: Vec2) -> Vec2

Wraps the required_size method.
source§

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

Wraps the on_event method.
source§

fn wrap_layout(&mut self, size: Vec2)

Wraps the layout method.
source§

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

Wraps the take_focus method.
source§

fn wrap_needs_relayout(&self) -> bool

Wraps the needs_relayout method.
source§

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

Wraps the important_area method.

Auto Trait Implementations§

§

impl<V> Freeze for NamedView<V>

§

impl<V> !RefUnwindSafe for NamedView<V>

§

impl<V> Send for NamedView<V>
where V: Send,

§

impl<V> Sync for NamedView<V>
where V: Send,

§

impl<V> Unpin for NamedView<V>

§

impl<V> !UnwindSafe for NamedView<V>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> AnyView for T
where T: View,

source§

fn as_any(&self) -> &(dyn Any + 'static)

Downcast self to a Any.

source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Downcast self to a mutable Any.

source§

fn as_boxed_any(self: Box<T>) -> Box<dyn Any>

Returns a boxed any from a boxed self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Finder for T
where T: View,

source§

fn call_on_all<V, F>(&mut self, sel: &Selector<'_>, callback: F)
where V: View, F: FnMut(&mut V),

Runs a callback on all views identified by sel. Read more
source§

fn call_on<V, F, R>(&mut self, sel: &Selector<'_>, callback: F) -> Option<R>
where V: View, F: FnOnce(&mut V) -> R,

Runs a callback on the view identified by sel. Read more
source§

fn call_on_name<V, F, R>(&mut self, name: &str, callback: F) -> Option<R>
where V: View, F: FnOnce(&mut V) -> R,

Convenient method to use call_on with a view::Selector::Name.
source§

fn find_name<V>(&mut self, name: &str) -> Option<ViewRef<V>>
where V: View,

Convenient method to find a view wrapped in an NamedView.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoBoxedView for T
where T: View,

source§

fn into_boxed_view(self) -> Box<dyn View>

Returns a Box<View>.
source§

impl<T> Nameable for T
where T: View,

source§

fn with_name<S: Into<String>>(self, name: S) -> NamedView<Self>

Wraps this view into an NamedView with the given id. Read more
source§

impl<T> Resizable for T
where T: View,

source§

fn resized( self, width: SizeConstraint, height: SizeConstraint, ) -> ResizedView<Self>

Wraps self in a ResizedView with the given size constraints.
source§

fn fixed_size<S: Into<Vec2>>(self, size: S) -> ResizedView<Self>

Wraps self into a fixed-size ResizedView.
source§

fn fixed_width(self, width: usize) -> ResizedView<Self>

Wraps self into a fixed-width ResizedView.
source§

fn fixed_height(self, height: usize) -> ResizedView<Self>

Wraps self into a fixed-width ResizedView.
source§

fn full_screen(self) -> ResizedView<Self>

Wraps self into a full-screen ResizedView.
source§

fn full_width(self) -> ResizedView<Self>

Wraps self into a full-width ResizedView.
source§

fn full_height(self) -> ResizedView<Self>

Wraps self into a full-height ResizedView.
source§

fn max_size<S: Into<Vec2>>(self, size: S) -> ResizedView<Self>

Wraps self into a limited-size ResizedView.
source§

fn max_width(self, max_width: usize) -> ResizedView<Self>

Wraps self into a limited-width ResizedView.
source§

fn max_height(self, max_height: usize) -> ResizedView<Self>

Wraps self into a limited-height ResizedView.
source§

fn min_size<S: Into<Vec2>>(self, size: S) -> ResizedView<Self>

Wraps self into a ResizedView at least sized size.
source§

fn min_width(self, min_width: usize) -> ResizedView<Self>

Wraps self in a ResizedView at least min_width wide.
source§

fn min_height(self, min_height: usize) -> ResizedView<Self>

Wraps self in a ResizedView at least min_height tall.
source§

impl<T> Scrollable for T
where T: View,

source§

fn scrollable(self) -> ScrollView<Self>

Wraps self in a ScrollView.
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

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

source§

fn draw(&self, printer: &Printer<'_, '_>)

Draws the view with the given printer (includes bounds) and focus. Read more
source§

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

Returns the minimum size the view requires with the given restrictions. Read more
source§

fn on_event(&mut self, ch: Event) -> EventResult

Called when an event is received (key press, mouse event, …). Read more
source§

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

Called once the size for this view has been decided. Read more
source§

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

Attempt to give this view the focus. Read more
source§

fn call_on_any( &mut self, selector: &Selector<'_>, callback: &mut dyn FnMut(&mut (dyn View + 'static)), )

Runs a closure on the view identified by the given selector. Read more
source§

fn needs_relayout(&self) -> bool

Should return true if the view content changed since the last call to layout(). Read more
source§

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

Moves the focus to the view identified by the given selector. Read more
source§

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

What part of the view is important and should be visible? Read more
source§

fn type_name(&self) -> &'static str

Returns the type of this view. Read more
source§

impl<T> With for T

source§

fn wrap_with<U, F: FnOnce(Self) -> U>(self, f: F) -> U

Calls the given closure and return the result. Read more
source§

fn with<F: FnOnce(&mut Self)>(self, f: F) -> Self

Calls the given closure on self.
source§

fn try_with<E, F>(self, f: F) -> Result<Self, E>
where F: FnOnce(&mut Self) -> Result<(), E>,

Calls the given closure on self.
source§

fn with_if<F>(self, condition: bool, f: F) -> Self
where F: FnOnce(&mut Self),

Calls the given closure if condition == true.