Struct zng::event::CommandArgs

pub struct CommandArgs {
    pub timestamp: DInstant,
    pub param: Option<CommandParam>,
    pub scope: CommandScope,
    pub enabled: bool,
    /* private fields */
}

Event args for command events.

Fields

timestamp: DInstant

Instant the event happened.

param: Option<CommandParam>

Optional parameter for the command handler.

scope: CommandScope

Scope of command that notified.

enabled: bool

If the command handle was enabled when the command notified.

If false the command primary action must not run, but a secondary “disabled interaction” that indicates what conditions enable the command is recommended.

Implementations

impl CommandArgs

pub fn new( timestamp: impl Into<DInstant>, propagation_handle: EventPropagationHandle, param: impl Into<Option<CommandParam>>, scope: impl Into<CommandScope>, enabled: impl Into<bool>, ) -> CommandArgs

New args from values that convert into the argument types.

pub fn now( param: impl Into<Option<CommandParam>>, scope: impl Into<CommandScope>, enabled: impl Into<bool>, ) -> CommandArgs

Arguments for event that happened now (INSTANT.now).

impl CommandArgs

pub fn param<T>(&self) -> Option<&T>

where T: Any,

Returns a reference to a parameter of T if parameter is set to a value of T.

pub fn enabled_param<T>(&self) -> Option<&T>

where T: Any,

Returns param if is enabled.

pub fn disabled_param<T>(&self) -> Option<&T>

where T: Any,

Returns param if is not enabled.

pub fn handle_enabled<F, R>( &self, local_handle: &CommandHandle, handler: F, ) -> Option<R>

where F: FnOnce(&CommandArgs) -> R,

Call handler if propagation is not stopped and the command and local handler are enabled. Stops propagation after handler is called.

This is the default behavior of commands, when a command has a handler it is relevant in the context, and overwrites lower priority handlers, but if the handler is disabled the command primary action is not run.

Returns the handler result if it was called.

Trait Implementations

impl AnyEventArgs for CommandArgs

fn delivery_list(&self, list: &mut UpdateDeliveryList)

Broadcast to all widget subscribers for CommandScope::App. Targets the window root for CommandScope::Window if found. Target ancestors and widget for CommandScope::Widget, if it is found.

fn clone_any(&self) -> Box<dyn AnyEventArgs>

Clone the event into a type erased box.

fn as_any(&self) -> &(dyn Any + 'static)

Access to dyn Any methods.

fn timestamp(&self) -> DInstant

Gets the instant this event happened.

fn propagation(&self) -> &EventPropagationHandle

Propagation handle associated with this event instance.

impl Clone for CommandArgs

fn clone(&self) -> CommandArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommandArgs

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

Formats the value using the given formatter.

impl EventArgs for CommandArgs

fn handle<F, R>(&self, handler: F) -> Option<R>

where F: FnOnce(&Self) -> R,

Calls handler and stops propagation if propagation is still allowed.