Struct AlignedView

pub struct AlignedView<T> { /* private fields */ }

This struct aligns a child view with a given alignment.

The child view will have its minimum allowed size. Additionally, the child may get cropped if it is larger than the available size.

The padded space around the child view is filled with the View color from cursive’s color palette.

Usage

The AlignedView may be used in 2 different ways:

1. Via the Alignable composition trait
2. Via normal constructors

Using Alignable

use cursive::{Cursive, CursiveExt};
use cursive::view::Resizable;
use cursive::views::{Panel, DummyView};
use cursive_aligned_view::Alignable;

fn main() {
    let mut siv = Cursive::default();

    let panel = Panel::new(DummyView)
        .title("Hello, world!")
        .fixed_width(20)
        .align_top_center(); // `align_...` methods from `Alignable`

    siv.add_fullscreen_layer(panel);
    // siv.run()
}

Constructors

use cursive::{Cursive, CursiveExt};
use cursive::view::Resizable;
use cursive::views::{Panel, DummyView};
use cursive_aligned_view::AlignedView;

fn main() {
    let mut siv = Cursive::default();

    let panel = Panel::new(DummyView)
        .title("Hello, world!")
        .fixed_width(20);
    let aligned = AlignedView::with_bottom_center(panel); // constructor

    siv.add_fullscreen_layer(aligned);
    // siv.run()
}

Implementations

impl<T: View> AlignedView<T>

pub fn new(view: T, alignment: Align) -> Self

pub fn with_top_left(view: T) -> Self

Wrap a child view and align it at the top-left of the parent.

pub fn with_top_center(view: T) -> Self

Wrap a child view and align it at the top-center of the parent.

pub fn with_top_right(view: T) -> Self

Wrap a child view and align it at the top-right of the parent.

pub fn with_center_left(view: T) -> Self

Wrap a child view and align it at the center-left of the parent.

pub fn with_center(view: T) -> Self

Wrap a child view and align it at the center of the parent.

pub fn with_center_right(view: T) -> Self

Wrap a child view and align it at the center-right of the parent.

pub fn with_bottom_left(view: T) -> Self

Wrap a child view and align it at the bottom-left of the parent.

pub fn with_bottom_center(view: T) -> Self

Wrap a child view and align it at the bottom-center of the parent.

pub fn with_bottom_right(view: T) -> Self

Wrap a child view and align it at the bottom-right of the parent.

pub fn set_top_left(&mut self)

Set the alignment of this view to top-left.

pub fn set_top_center(&mut self)

Set the alignment of this view to top-center.

pub fn set_top_right(&mut self)

Set the alignment of this view to top-right.

pub fn set_center_left(&mut self)

Set the alignment of this view to center-left.

pub fn set_center(&mut self)

Set the alignment of this view to center.

pub fn set_center_right(&mut self)

Set the alignment of this view to center-right.

pub fn set_bottom_left(&mut self)

Set the alignment of this view to bottom-left.

pub fn set_bottom_center(&mut self)

Set the alignment of this view to bottom-center.

pub fn set_bottom_right(&mut self)

Set the alignment of this view to bottom-right.

pub fn alignment(&self) -> &Align

Get the current alignment of this view.

Trait Implementations

impl<T: View> ViewWrapper for AlignedView<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_draw(&self, printer: &Printer<'_, '_>)

Wraps the draw method.

fn wrap_layout(&mut self, size: Vec2)

Wraps the layout method.

fn wrap_needs_relayout(&self) -> bool

Wraps the needs_relayout method.

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

Wraps the required_size method.

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

Wraps the on_event method.

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

Wraps the important_area 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: &mut dyn FnMut(&mut (dyn View + 'static)), )

Wraps the find method.

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

Wraps the focus_view method.