Struct ScrollMessageArguments

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

Implementations

impl ScrollMessageArguments

pub fn get_scroll_position(&self) -> Result<Vector2, Error>

See: scroll_message_arguments::SCROLL_POSITION_PROPERTY

pub fn set_scroll_position(&self, value: Vector2) -> Result<(), Error>

See: scroll_message_arguments::SCROLL_POSITION_PROPERTY

pub fn get_scroll_speed(&self) -> Result<Vector2, Error>

See: scroll_message_arguments::SCROLL_SPEED_PROPERTY

pub fn set_scroll_speed(&self, value: Vector2) -> Result<(), Error>

See: scroll_message_arguments::SCROLL_SPEED_PROPERTY

Methods from Deref<Target = MessageArguments>

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

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 Deref for ScrollMessageArguments

type Target = MessageArguments

The resulting type after dereferencing.

fn deref(&self) -> &<ScrollMessageArguments as Deref>::Target

Dereferences the value.

impl Inherits<MessageArguments> for ScrollMessageArguments

fn upcast(self) -> Base

fn upcast_ref(&self) -> &Base

impl MessageArgumentsConstraint for ScrollMessageArguments

fn create(domain: &Domain) -> Result<ScrollMessageArguments, Error>