Enum cursive_core::direction::Orientation

pub enum Orientation {
    Horizontal,
    Vertical,
}

Describes a vertical or horizontal orientation for a view.

Variants

Horizontal

Horizontal orientation

Vertical

Vertical orientation

Implementations

impl Orientation

pub fn pair() -> XY<Orientation>

Returns a XY(Horizontal, Vertical).

pub fn get<T: Clone>(self, v: &XY<T>) -> T

Returns the component of v corresponding to this orientation.

(Horizontal will return the x value, and Vertical will return the y value.)

pub fn swap(self) -> Self

Returns the other orientation.

pub fn get_ref<T>(self, v: &mut XY<T>) -> &mut T

Returns a mutable reference to the component of the given vector corresponding to this orientation.

Examples

let o = Orientation::Horizontal;
let mut xy = XY::new(1, 2);
*o.get_ref(&mut xy) = 42;

assert_eq!(xy, XY::new(42, 2));

pub fn stack<T: Iterator<Item = Vec2>>(self, iter: T) -> Vec2

Takes an iterator on sizes, and stack them in the current orientation, returning the size of the required bounding box.

• For an horizontal view, returns (Sum(x), Max(y)).
• For a vertical view, returns (Max(x), Sum(y)).

pub fn make_vec(self, main_axis: usize, second_axis: usize) -> Vec2

Creates a new Vec2 with main_axis in self’s axis, and second_axis for the other axis.

Examples

let o = Orientation::Horizontal;
let vec = o.make_vec(1, 2);

assert_eq!(vec, Vec2::new(1, 2));

let o = Orientation::Vertical;
let vec = o.make_vec(1, 2);

assert_eq!(vec, Vec2::new(2, 1));

Trait Implementations

impl Clone for Orientation

fn clone(&self) -> Orientation

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Orientation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for Orientation

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Orientation> for Orientation

fn eq(&self, other: &Orientation) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Orientation

impl Eq for Orientation

impl StructuralEq for Orientation

impl StructuralPartialEq for Orientation