Struct View 

pub struct View<CID, CA, CS, CM>
where
    CID: EzCptIds,
    CA: EzArgs,
    CS: EzState,
    CM: EzMsg,
{ /* private fields */ }

The view is the struct that holds all your components. You’ll only have one view in your app but as many components as you want. Those components will be orchestrated by the view. This includes handling their layout, the focused one and forward event to them if needed.

Every component must implement two traits: Component and MockComponent. Component; its sole responsibility is to alter its state based on the events it receives. MockComponent; it is responsible for rendering the component and holding its state.

Implementations

impl<CID, CA, CS, CM> View<CID, CA, CS, CM>

where CID: EzCptIds, CA: EzArgs, CS: EzState, CM: EzMsg,

pub fn new() -> Self

Create a new view with the given [AppArguments]

impl<CID, CA, CS, CM> View<CID, CA, CS, CM>

where CID: EzCptIds, CA: EzArgs, CS: EzState, CM: EzMsg,

pub fn set_theme(self, theme: Theme) -> Self

Set the thme to be used by the view

pub fn focused(&mut self) -> Option<&EzCptId<CID>>

Get the current focus

pub fn focus(&mut self, id: &EzCptId<CID>, forward: bool) -> Result<bool>

Try to focus a component

Errors

• ViewError::ComponentNotFound if the component is not mounted

pub fn cycle_focus(&mut self) -> Result<()>

Set the focus to a component

Errors

• ViewError::ComponentNotFound if the component to be focused is not mounted

pub fn initial_focus(self, id: &EzCptId<CID>) -> Result<Self>

Set the focus to a component

Errors

• ViewError::ComponentNotFound if the initial component is not mounted

pub fn initial_legend(self, matchers: &[Matcher]) -> Self

Set an initial dynamic legend to be used by the view. It can later be updated by sending the EzEvent::UpdateLegend message to the view.

Errors

• ViewError::ComponentNotFound if the component is not mounted

pub fn blur(&mut self) -> Result<()>

Remove current focus and focus the last focused component

Errors

• ViewError::ComponentNotFound if the component to be focused is not mounted

pub fn mount(self, id: CID, component: BoxedComponent<CID, CA, CS, CM>) -> Self

Mount a new component to the view

Errors

• ViewError::ComponentAlreadyMounted if the component is already mounted

pub fn umount(self, id: &CID) -> Result<Self>

Unmount a component from the view

Errors

• ViewError::ComponentNotFound if the component is not mounted

pub fn mounted(&self, id: &CID) -> bool

Check if the component is mounted

pub fn layout(self, layout: CustomLayout<EzCptId<CID>>) -> View<CID, CA, CS, CM>

Set the CustomLayout to be used by the view

Notes: This should be called after you call Self::initial_legend

pub fn query_cpt( &self, id: &EzCptId<CID>, query: Attribute, ) -> Result<Option<AttrValue>>

Query a component for an attribute

Errors

• ViewError::ComponentNotFound if the component is not mounted

pub fn set_cpt_attr( &mut self, id: &EzCptId<CID>, attr: Attribute, value: AttrValue, ) -> Result<()>

Set an attribute to a component

Errors

• ViewError::ComponentNotFound if the component is not mounted

Trait Implementations

impl<CID, CA, CS, CM> Default for View<CID, CA, CS, CM>

where CID: EzCptIds, CA: EzArgs, CS: EzState, CM: EzMsg,

fn default() -> Self

Returns the “default value” for a type.