Enum kas::TkAction

#[must_use]pub enum TkAction {
    None,
    Redraw,
    RegionMoved,
    Popup,
    SetSize,
    Resize,
    Reconfigure,
    Close,
    CloseAll,
}

Action required after processing

This type is returned by many widgets on modification to self and is tracked internally by event::Manager to determine which updates are needed to the UI.

All variants are progressive: e.g. Reconfigure implies all actions needed to handle Popup, RegionMoved and Redraw.

Two TkAction values may be combined by taking their maximum. Since this is a common operation, the + operator is defined to do this job, together with += on TkAction and event::Manager.

Users receiving a value of this type from a widget update method should generally call *mgr += action; during event handling. Prior to starting the event loop (toolkit.run()), these values can be ignored.

Variants

None

No action needed

Redraw

Whole window requires redrawing

Note that Manager::redraw can instead be used for more selective redrawing, if supported by the toolkit.

RegionMoved

Some widgets within a region moved

Used when a pop-up is closed or a region adjusted (e.g. scroll or switch tab) to update which widget is under the mouse cursor / touch events. Identifier is that of the parent widget/window encapsulating the region.

Popup

A pop-up opened/closed/needs resizing

SetSize

Reset size of all widgets without recalculating requirements

Resize

Resize all widgets

Reconfigure

Whole window requires reconfiguring

Configuring widgets assigns WidgetId identifiers and calls kas::WidgetConfig::configure.

Close

The window or pop-up should be closed

CloseAll

All windows should close (toolkit exit)

Trait Implementations

impl Add<TkAction> for TkAction

type Output = Self

The resulting type after applying the + operator.

pub fn add(self, rhs: TkAction) -> Self

Performs the + operation.

impl AddAssign<TkAction> for TkAction

pub fn add_assign(&mut self, rhs: TkAction)

Performs the += operation.

impl<'a> AddAssign<TkAction> for Manager<'a>

pub fn add_assign(&mut self, action: TkAction)

Performs the += operation.

impl Clone for TkAction

pub fn clone(&self) -> TkAction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for TkAction

impl Debug for TkAction

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

Formats the value using the given formatter.

impl Eq for TkAction

impl Ord for TkAction

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<TkAction> for TkAction

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<TkAction> for TkAction

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for TkAction

impl StructuralPartialEq for TkAction