Enum Action

pub enum Action {
    Create(Tree<Element>, CreateOrder),
    ModifyController(Box<dyn FnOnce(&mut Controller)>),
    ModifyModel(Box<dyn FnOnce(&mut Model)>),
    ModifyView(Box<dyn FnOnce(&mut View)>),
    SubmitCallback(CallbackId),
    Focus,
    Enable,
    Disable,
    Destroy,
    ReleaseButtons,
}

An interface-level event

Variants

Create(Tree<Element>, CreateOrder)

ModifyController(Box<dyn FnOnce(&mut Controller)>)

ModifyModel(Box<dyn FnOnce(&mut Model)>)

ModifyView(Box<dyn FnOnce(&mut View)>)

SubmitCallback(CallbackId)

This will submit produce an event with the Model containing this callback ID, but will not modify the current Model callback ID.

See the Form widget control FormSubmitCallback for a control function that submits a model with the currently set callback ID.

Focus

Change the view state from Enabled to Focused; it is a debug error if the view state is not Enabled.

If top is true, node will be moved to the last sibling position (“top”), otherwise position relative to siblings will remain unchanged

Enable

Change view.state from Disabled to Enabled; it is a debug error if the view state is not Disabled

Disable

Change the view.state from Enabled to Disabled; it is a debug error if the view state is not Enabled

Destroy

Destroy the target element and children.

If the node was focused, then focus is shifted to the parent. If it was the root node that was focused, then this is always an error since the root node is always focused as the common ancestor of all nodes.

ReleaseButtons

Trigger any release buttons that exist in the current input map of the controller of the target node.

This can be used when focus is changing and input state should not be orphaned.

Implementations

impl Action

pub fn create_singleton(element: Element, order: CreateOrder) -> Self

Produces a Create action that creates a singleton subtree containing the given Element

pub fn set_view(view: View) -> Self

Produces a ModifyView action that sets the given View data.

pub fn set_controller(controller: Controller) -> Self

Produces a ModifyController action that sets the given Controller data.

pub fn set_model(model: Model) -> Self

Produces a ModifyModel action that sets the given Model data.

pub fn set_view_component<V>(component: V) -> Self

where V: Kind + 'static,

Produces a ModifyView action that sets the given component Kind

pub fn update_view_component<V>(component: V) -> Self

where V: Kind + 'static,

Produces a ModifyView action that updates the current component with the given value and panics if the current component is not the same Kind

pub fn set_controller_component<V>(component: V) -> Self

where V: Kind + 'static,

Produces a ModifyController action that sets the given component Kind

pub fn update_controller_component<V>(component: V) -> Self

where V: Kind + 'static,

Produces a ModifyController action that updates the current component with the given value and panics if the current component is not the same Kind

pub fn set_model_component<V>(component: V) -> Self

where V: Kind + 'static,

Produces a ModifyModel action that sets the given component Kind

pub fn update_model_component<V>(component: V) -> Self

where V: Kind + 'static,

Produces a ModifyModel action that updates the current component with the given value and panics if the current component is not the same Kind

Trait Implementations

impl Debug for Action

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

Formats the value using the given formatter.

impl From<(Tree<Element>, CreateOrder)> for Action

fn from(value: (Tree<Element>, CreateOrder)) -> Self

Converts to this type from the input type.

impl From<Box<dyn FnOnce(&mut Controller)>> for Action

fn from(value: Box<dyn FnOnce(&mut Controller)>) -> Self

Converts to this type from the input type.

impl From<Box<dyn FnOnce(&mut Model)>> for Action

fn from(value: Box<dyn FnOnce(&mut Model)>) -> Self

Converts to this type from the input type.

impl From<Box<dyn FnOnce(&mut View)>> for Action

fn from(value: Box<dyn FnOnce(&mut View)>) -> Self

Converts to this type from the input type.

impl From<CallbackId> for Action

fn from(value: CallbackId) -> Self

Converts to this type from the input type.

impl TryFrom<Action> for ()

type Error = TryIntoError<Action>

The type returned in the event of a conversion error.

fn try_from(value: Action) -> Result<Self, TryIntoError<Action>>

Performs the conversion.

impl TryFrom<Action> for (Tree<Element>, CreateOrder)

type Error = TryIntoError<Action>

The type returned in the event of a conversion error.

fn try_from(value: Action) -> Result<Self, TryIntoError<Action>>

Performs the conversion.

impl TryFrom<Action> for Box<dyn FnOnce(&mut Controller)>

type Error = TryIntoError<Action>

The type returned in the event of a conversion error.

fn try_from(value: Action) -> Result<Self, TryIntoError<Action>>

Performs the conversion.

impl TryFrom<Action> for Box<dyn FnOnce(&mut Model)>

type Error = TryIntoError<Action>

The type returned in the event of a conversion error.

fn try_from(value: Action) -> Result<Self, TryIntoError<Action>>

Performs the conversion.

impl TryFrom<Action> for Box<dyn FnOnce(&mut View)>

type Error = TryIntoError<Action>

The type returned in the event of a conversion error.

fn try_from(value: Action) -> Result<Self, TryIntoError<Action>>

Performs the conversion.

impl TryFrom<Action> for CallbackId

type Error = TryIntoError<Action>

The type returned in the event of a conversion error.

fn try_from(value: Action) -> Result<Self, TryIntoError<Action>>

Performs the conversion.