Struct MessageArguments

pub struct MessageArguments(/* private fields */);

Expand description

MessageArguments is the base class for arguments passed in messages. An instance of MessageArguments together with an instance of MessageType forms a Kanzi message. In Kanzi when you dispatch a message, you dispatch a message of certain type and arguments.

Implementations§

§

impl MessageArguments

pub const fn as_ptr(&self) -> *mut MessageArgumentsWrapper

§

impl MessageArguments

pub fn get_source(&self) -> Result<Option<Weak<Node>>, Error>

Returns the source node for a message.

pub fn set_handled(&self, handled: bool) -> Result<(), Error>

Sets the handling status for a message.

pub fn is_handled(&self) -> Result<bool, Error>

Returns whether the message is handled.

pub fn get_argument<T>( &self, property_type: &PropertyType<T>, ) -> Result<<T as VariantConstraint>::RetArg, Error>
where T: PropertyTypeConstraint,

Returns the value of an argument.

§Returns

The value of the argument. If the argument is not present in this message arguments instance, returns the default value of the PropertyType.

pub fn get_optional_argument<T>( &self, property: &PropertyType<T>, ) -> Result<Option<<T as VariantConstraint>::RetArg>, Error>
where T: PropertyTypeConstraint,

Returns the value of an argument.

§Returns

The value of the argument. If the argument is not present in this message arguments instance, returns None.

pub fn set_argument<T>( &self, property: &PropertyType<T>, value: <T as VariantConstraint>::DataArg<'_>, ) -> Result<(), Error>
where T: PropertyTypeConstraint,

Sets the value of an argument.

Trait Implementations§

§

impl Drop for MessageArguments

§

fn drop(&mut self)

Executes the destructor for this type. Read more

§

impl Inheritable for MessageArguments

§

unsafe fn downcast_unchecked<T>(self) -> T
where T: Inherits<Self>,

Downcast the object to a more specific type. Read more

§

unsafe fn downcast_unchecked_ref<T>(&self) -> &T
where T: Inherits<Self>,

Downcast the object reference to a more specific type. Read more

§

Struct MessageArgumentsCopy item path

Implementations§

impl MessageArguments

pub const fn as_ptr(&self) -> *mut MessageArgumentsWrapper

impl MessageArguments

pub fn get_source(&self) -> Result<Option<Weak<Node>>, Error>

pub fn set_handled(&self, handled: bool) -> Result<(), Error>

pub fn is_handled(&self) -> Result<bool, Error>

pub fn get_argument<T>( &self, property_type: &PropertyType<T>, ) -> Result<<T as VariantConstraint>::RetArg, Error>where T: PropertyTypeConstraint,

§Returns

pub fn get_optional_argument<T>( &self, property: &PropertyType<T>, ) -> Result<Option<<T as VariantConstraint>::RetArg>, Error>where T: PropertyTypeConstraint,

§Returns

pub fn set_argument<T>( &self, property: &PropertyType<T>, value: <T as VariantConstraint>::DataArg<'_>, ) -> Result<(), Error>where T: PropertyTypeConstraint,

Trait Implementations§

impl Drop for MessageArguments

fn drop(&mut self)

impl Inheritable for MessageArguments

unsafe fn downcast_unchecked<T>(self) -> Twhere T: Inherits<Self>,

unsafe fn downcast_unchecked_ref<T>(&self) -> &Twhere T: Inherits<Self>,

impl Inherits<MessageArguments> for ActivateThemeMessageArguments

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<MessageArguments> for ActivatedMessageArguments

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<MessageArguments> for ActivationMessageArguments

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<MessageArguments> for ActivityInternalMessageArguments

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<MessageArguments> for ActivityMessageArguments

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<MessageArguments> for ActivityPrefabMessageArguments

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<MessageArguments> for AsynchronousLoadCompletedMessageArguments

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<MessageArguments> for BaseMessageArguments

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<MessageArguments> for CanceledMessageArguments

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<MessageArguments> for CanceledMessageArguments

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<MessageArguments> for CanceledMessageArguments

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<MessageArguments> for CanceledMessageArguments

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<MessageArguments> for CanceledMessageArguments

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<MessageArguments> for CharacterRemovalMessageArguments

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<MessageArguments> for ClickBeginMessageArguments

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<MessageArguments> for ClickCancelMessageArguments

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<MessageArguments> for ClickEnterMessageArguments

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<MessageArguments> for ClickLeaveMessageArguments

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<MessageArguments> for ClickMessageArguments

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<MessageArguments> for ClickedMessageArguments

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl Inherits<MessageArguments> for CommandMessageArguments

Struct MessageArguments

pub fn get_argument<T>( &self, property_type: &PropertyType<T>, ) -> Result<<T as VariantConstraint>::RetArg, Error>
where T: PropertyTypeConstraint,

pub fn get_optional_argument<T>( &self, property: &PropertyType<T>, ) -> Result<Option<<T as VariantConstraint>::RetArg>, Error>
where T: PropertyTypeConstraint,

pub fn set_argument<T>( &self, property: &PropertyType<T>, value: <T as VariantConstraint>::DataArg<'_>, ) -> Result<(), Error>
where T: PropertyTypeConstraint,

unsafe fn downcast_unchecked<T>(self) -> T
where T: Inherits<Self>,

unsafe fn downcast_unchecked_ref<T>(&self) -> &T
where T: Inherits<Self>,