Struct cursive_aligned_view::AlignedView

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

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;
use cursive::view::Boxable;
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;
use cursive::view::Boxable;
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()
}

Methods

impl<T: View> AlignedView<T>

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> View for AlignedView<T>

fn draw(&self, printer: &Printer)

Draws the view with the given printer (includes bounds) and focus.

fn layout(&mut self, size: Vec2)

Called once the size for this view has been decided.

fn needs_relayout(&self) -> bool

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

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

Returns the minimum size the view requires with the given restrictions.

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

Called when an event is received (key press, mouse event, ...).

fn call_on_any<'a>(&mut self, sel: &Selector, cb: AnyCb<'a>)

Runs a closure on the view identified by the given selector.

fn focus_view(&mut self, sel: &Selector) -> Result<(), ()>

Moves the focus to the view identified by the given selector.

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

This view is offered focus. Will it take it?

fn important_area(&self, view_size: Vec2) -> Rect

What part of the view is important and should be visible?