Struct Controller

pub struct Controller {
    pub component: Component,
    pub state: State,
    pub appearances: Appearances,
    pub focus_top: bool,
    pub bubble_trap: InputMask,
    /* private fields */
}

A component that holds control bindings and interaction state.

Controllers handle the translation of view::Input events to interface Actions via Control bindings.

Fields

component: Component

state: State

Defines behavior and appearance

appearances: Appearances

View appearance selection for each state

focus_top: bool

Controls whether the node will be moved to the last sibling position (“top”) when processed by a Focus action (either as the target node or an ancestor of the target node).

Defaults to false. Note that some widget builders may set this to true unless overridden (e.g. free frame widgets).

bubble_trap: InputMask

Controls whether unhandled input is bubbled up to parent: when true unhandled input will be trapped (not bubbled), when false unhandled input will be passed to the parent node.

Defaults to InputMask::empty()

Implementations

impl Controller

pub fn with_bindings<A: Application>(bindings: &Bindings<A>) -> Self

pub fn get_appearance(&self) -> &Appearance

pub fn get_bindings<A: Application>(&self) -> Bindings<A>

pub fn set_bindings<A: Application>(&mut self, bindings: &Bindings<A>)

Replaces all existing bindings

pub fn add_bindings<A: Application>(&mut self, bindings: &Bindings<A>)

Must be new bindings or else panics

pub fn insert_bindings<A: Application>(&mut self, bindings: &Bindings<A>)

Replaces existing bindings; should not fail

pub fn remove_bindings(&mut self, controls: &Controls)

Remove matching controls

pub fn clear_buttons(&mut self)

pub fn remove_any_button(&mut self)

pub fn remove_system(&mut self)

pub fn remove_text(&mut self)

pub fn remove_motion(&mut self)

pub fn remove_pointer(&mut self)

pub fn clear_bindings(&mut self)

Trait Implementations

impl AsRef<Controller> for Element

fn as_ref(&self) -> &Controller

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Controller

fn clone(&self) -> Controller

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Controller

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

Formats the value using the given formatter.

impl Default for Controller

fn default() -> Controller

Returns the “default value” for a type.

impl From<Component> for Controller

fn from(component: Component) -> Self

Converts to this type from the input type.