zng_app::event

Struct CommandArgs

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

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§

source§

impl CommandArgs

source

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

New args from values that convert into the argument types.

source

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

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

source§

impl CommandArgs

source

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

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

source

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

Returns param if is enabled.

source

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

Returns param if is not enabled.

source

pub fn handle_enabled<F, R>( &self, local_handle: &CommandHandle, handler: F, ) -> Option<R>
where F: FnOnce(&Self) -> 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§

source§

impl AnyEventArgs for CommandArgs

source§

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.

source§

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

Clone the event into a type erased box.
source§

fn as_any(&self) -> &dyn Any

Access to dyn Any methods.
source§

fn timestamp(&self) -> DInstant

Gets the instant this event happened.
source§

fn propagation(&self) -> &EventPropagationHandle

Propagation handle associated with this event instance. Read more
source§

impl Clone for CommandArgs

source§

fn clone(&self) -> CommandArgs

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for CommandArgs

source§

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

Formats the value using the given formatter. Read more
source§

impl EventArgs for CommandArgs

source§

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

Calls handler and stops propagation if propagation is still allowed. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
source§

impl<T> StateValue for T
where T: Any + Send + Sync,