Struct orbtk_api::event::EventQueue

pub struct EventQueue { /* fields omitted */ }

The EventQueue is used to register and read new events.

Implementations

impl EventQueue

pub fn new() -> Self

Creates a new event queue.

pub fn append(&mut self, other: &mut Vec<EventBox>)

Appends a new event box.

pub fn register_event_with_strategy<E: Event>(
    &mut self,
    event: E,
    strategy: EventStrategy,
    source: Entity
)

Registers an event with a given event strategy and a source (Entity of a widget) where the event should start.

pub fn register_event<E: Event>(&mut self, event: E, source: Entity)

pub fn dequeue(&mut self) -> Option<EventBox>

Dequeue an event.

pub fn len(&self) -> usize

Returns the number of events in the EventQueue.

pub fn is_empty(&self) -> bool

If the EventQueue has more then zero events it will return true otherwise false.

Trait Implementations

impl Debug for EventQueue

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

Formats the value using the given formatter.

impl Default for EventQueue

fn default() -> EventQueue

Returns the "default value" for a type.

impl<'a> IntoIterator for &'a mut EventQueue

type Item = EventBox

The type of the elements being iterated over.

type IntoIter = EventQueueIterator<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.