Enum bar_config::event::Event

pub enum Event {
    Click(MouseButton, MouseButtonState, Point),
    MouseMotion(Point),
    PositionChange(ComponentPosition),
}

Event which can be transmitted to the components.

This event needs to be created from the frontend and can then be sent to the bar using the Bar::notify method. Every component has the choice to use an event or ignore it.

Variants

Click(MouseButton, MouseButtonState, Point)

Mouse button action anywhere on the screen.

This event notifies all components that the user has clicked anywhere on the screen. It is required that the component knows about its position to act upon this event. To let a component know about its current position, the PositionChange event can be used.

MouseMotion(Point)

Update mouse position.

This event notifies all components about the current position of the mouse on the screen. It is required that the component knows about its position to act upon this event. To let a component know about its current position, the PositionChange event can be used.

PositionChange(ComponentPosition)

Update the position of a component.

This event is used to make a component aware of its position on the screen. This is required to react upon other events which are position dependent.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<Event> for Event

fn eq(&self, other: &Event) -> bool

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

fn ne(&self, other: &Event) -> bool

This method tests for !=.

impl PartialOrd<Event> for Event

fn partial_cmp(&self, other: &Event) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Event) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Event) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Event) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Event) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Ord for Event

fn cmp(&self, other: &Event) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Returns max if self is greater than max, and min if self is less than min. Otherwise this will return self. Panics if min > max.

impl Eq for Event

impl Copy for Event

impl Hash for Event

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Debug for Event

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

Formats the value using the given formatter.