Struct rg3d_ui::message::UiMessage

pub struct UiMessage<M: MessageData, C: Control<M, C>> {
    pub flags: u64,
    // some fields omitted
}

Message is basic communication element that is used to deliver information to UI nodes or to user code.

Fields

flags: u64

A custom user flags.

Implementations

impl<M: MessageData, C: Control<M, C>> UiMessage<M, C>

#[must_use = "method creates new value which must be used"]pub fn reverse(&self) -> Self

Creates a new copy of the message with reversed direction. Typical use case is to re-send messages to create “response” in widget. For example you have a float input field and it has Value message. When the input field receives Value message with MessageDirection::ToWidget it checks if value needs to be changed and if it does, it re-sends same message but with reversed direction back to message queue so every “listener” can reach properly. The input field won’t react at MessageDirection::FromWidget message so there will be no infinite message loop.

pub fn destination(&self) -> Handle<UINode<M, C>>

pub fn data(&self) -> &UiMessageData<M, C>

pub fn set_handled(&self, handled: bool)

pub fn handled(&self) -> bool

pub fn direction(&self) -> MessageDirection

pub fn set_perform_layout(&self, value: bool)

pub fn need_perform_layout(&self) -> bool

pub fn user(
    destination: Handle<UINode<M, C>>,
    direction: MessageDirection,
    msg: M
) -> Self

Allows you to construct a new user-defined message.

pub fn has_flags(&self, flags: u64) -> bool

Trait Implementations

impl<M: Clone + MessageData, C: Clone + Control<M, C>> Clone for UiMessage<M, C>

fn clone(&self) -> UiMessage<M, C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M: Debug + MessageData, C: Debug + Control<M, C>> Debug for UiMessage<M, C>

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

Formats the value using the given formatter.

impl<M: PartialEq + MessageData, C: PartialEq + Control<M, C>> PartialEq<UiMessage<M, C>> for UiMessage<M, C>

fn eq(&self, other: &UiMessage<M, C>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &UiMessage<M, C>) -> bool

This method tests for !=.

impl<M: MessageData, C: Control<M, C>> StructuralPartialEq for UiMessage<M, C>