Struct Cycle

pub struct Cycle<T> {
    pub layouts: Vec<T>,
    /* private fields */
}

A LayoutGenerator that keeps track of layouts per tag and provides methods to cycle between them.

Fields

layouts: Vec<T>

The layouts this generator will cycle between.

Implementations

impl<T: LayoutGenerator> Cycle<T>

pub fn new(layouts: impl IntoIterator<Item = T>) -> Self

Creates a new Cycle from the given LayoutGenerators.

Examples

let cycler = Cycle::new([
    Box::<MasterStack>::default() as Box<dyn LayoutGenerator + Send>,
    Box::<Dwindle>::default() as _,
    Box::<Corner>::default() as _,
]);

pub fn cycle_layout_forward(&mut self, tag: &TagHandle)

Cycles the layout forward on the given tag.

pub fn cycle_layout_backward(&mut self, tag: &TagHandle)

Cycles the layout backward on the given tag.

pub fn current_layout(&self, tag: &TagHandle) -> Option<&T>

Retrieves the current layout.

Returns None if no layouts were given.

pub fn set_current_tag(&mut self, tag: TagHandle)

Sets the current tag to choose a layout for.

Trait Implementations

impl<T: LayoutGenerator> LayoutGenerator for Cycle<T>

fn layout(&self, window_count: u32) -> LayoutNode

Generates a tree of LayoutNodes.