Struct Layout

pub struct Layout {
    pub name: String,
    pub flip: Flip,
    pub rotate: Rotation,
    pub reserve: Reserve,
    pub columns: Columns,
}

Describes a layout or pattern in which tiles (windows) will be arranged. The Layout allows to describe various types of “fixed” layouts used by a dynamic tiling manager. Those include layouts like MainAndStack, Fibonacci, Dwindle, CenterMain, etc.

Fields

name: String

Name and identifier of the layout. This is user chosen and no two layouts can have the same name.

flip: Flip

Flips the entire result of tiles as a whole if specified to be anything other than Flip::None

rotate: Rotation

Rotate the entire result of tiles as a whole, if specified to be anything other than Rotation::North

reserve: Reserve

Defines the layouts behavior if certain “columns” (eg. main, stack, or second-stack) are empty. See Reserve for more information.

columns: Columns

Configuration concerning the Main, Stack, and SecondStack columns. See Columns for more information.

Implementations

impl Layout

pub fn is_monocle(&self) -> bool

Returns true if the layout must be considered a Monocle layout.

The Monocle layout is a special layout that always consists of 0 or 1 windows. If there is a window, it is shown full screen.

pub fn is_main_and_deck(&self) -> bool

Returns true if the layout must be considered a MainAndDeck layout.

The MainAndDeck layout is a special layout that always consists of 0, 1 or 2 windows.

pub fn main_size(&self) -> Option<Size>

pub fn main_window_count(&self) -> Option<usize>

pub fn set_main_size(&mut self, size: Size)

Set the Size of the Main column to a specific value

pub fn increase_main_size(&mut self, upper_bound: i32)

Increase the Size of the Main column, but to no larger value than what is set in upper_bound.

The column is increased by a default amount, either [DEFAULT_MAIN_SIZE_CHANGE_PIXEL] or [DEFAULT_MAIN_SIZE_CHANGE_PERCENTAGE] depending on whether the current Size is a Size::Pixel or Size::Ratio.

If the current layout has no Main column, nothing happens

pub fn decrease_main_size(&mut self)

Decrease the Size of the Main column, but to no smaller value than zero.

The column is decreased by a default amount, either [DEFAULT_MAIN_SIZE_CHANGE_PIXEL] or [DEFAULT_MAIN_SIZE_CHANGE_PERCENTAGE] depending on whether the current Size is a Size::Pixel or Size::Ratio.

If the current layout has no Main column, nothing happens

pub fn change_main_size(&mut self, delta: i32, upper_bound: i32)

Change the Size of the Main column by a delta value.

The delta value can be positive or negative and is interpreted as either Size::Pixel or Size::Ratio based on the current Size of the Main column.

When the current Size is a Size::Pixel, the delta is interpreted as a pixel value.

use leftwm_layouts::Layout;
use leftwm_layouts::geometry::Size;

let mut layout = Layout::default();
layout.set_main_size(Size::Pixel(200));
layout.change_main_size(100, 500);
assert_eq!(Size::Pixel(300), layout.columns.main.unwrap().size);

When the current Size is a Size::Ratio, the delta is interpreted as a percentage value and converted into a ratio (i.e. 5 (percent) => Size::Ratio(0.05)).

use leftwm_layouts::Layout;
use leftwm_layouts::geometry::Size;

let mut layout = Layout::default();
layout.set_main_size(Size::Ratio(0.5));
layout.change_main_size(5, 500);
assert_eq!(Size::Ratio(0.55), layout.columns.main.unwrap().size);

pub fn set_main_window_count(&mut self, count: usize)

pub fn increase_main_window_count(&mut self)

pub fn decrease_main_window_count(&mut self)

pub fn rotate(&mut self, clockwise: bool)

pub fn check(&self)

pub fn update_defaults(custom: &Vec<Layout>) -> Vec<Layout>

Trait Implementations

impl Clone for Layout

fn clone(&self) -> Layout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Layout

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

Formats the value using the given formatter.

impl Default for Layout

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Layout

where Layout: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Layout

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Layout

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Layout