Struct Layout

pub struct Layout {
    pub state: LayoutState,
    pub shape: LayoutData,
}

Associates the state of a layout with its definition. Contains everything necessary to present this layout to the user and to determine its reactions to inputs.

Fields

state: LayoutState

shape: LayoutData

Implementations

impl Layout

pub fn new( data: LayoutParseData, kind: ArrangementKind, purpose: ContentPurpose, ) -> Layout

pub fn get_current_view_position(&self) -> &(Point, View)

pub fn get_current_view(&self) -> &View

fn set_view(&mut self, view: String) -> Result<(), NoSuchView>

pub fn get_view_latched(&self) -> &LatchedState

fn find_index_by_position(&self, point: Point) -> Option<(usize, usize)>

Returns index within current view

pub fn foreach_visible_button<F>(&self, f: F)

where F: FnMut(Point, &Button, (usize, usize)),

Returns index within current view too.

fn apply_view_transition(&mut self, action: &Action)

fn unstick_locks(&mut self)

Unlatch all latched keys, so that the new view is the one before first press.

fn process_action_for_view<'a>( action: &'a Action, current_view: &str, latched: &LatchedState, ) -> (ViewTransition<'a>, LatchedState)

Last bool is new latch state. It doesn’t make sense when the result carries UnlatchAll, but let’s not be picky.

Although the state is not defined at the keys (it’s in the relationship between view and action), keys go through the following stages when clicked repeatedly: unlocked+unlatched -> locked+latched -> locked+unlatched -> unlocked+unlatched