Struct kas::TkAction

#[must_use]
pub struct TkAction { /* fields omitted */ }

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.

Two TkAction values may be combined via bit-or (a | b). Bit-or assignments are supported by both 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.

Implementations

impl TkAction

pub const REDRAW: TkAction

The whole window requires redrawing

Note that event::Manager::redraw can instead be used for more selective redrawing.

pub const REGION_MOVED: TkAction

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.

Implies window redraw.

pub const SET_SIZE: TkAction

Reset size of all widgets without recalculating requirements

pub const RESIZE: TkAction

Resize all widgets

pub const RECONFIGURE: TkAction

Window requires reconfiguring

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

pub const CLOSE: TkAction

The current window or pop-up should be closed

pub const EXIT: TkAction

Close all windows and exit

pub const fn empty() -> TkAction

Returns an empty set of flags

pub const fn all() -> TkAction

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<TkAction>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> TkAction

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> TkAction

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

Returns true if there are flags common to both self and other.

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

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: TkAction)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: TkAction)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: TkAction)

Toggles the specified flags in-place.

pub fn set(&mut self, other: TkAction, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for TkAction

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

Formats the value using the given formatter.

impl BitAnd<TkAction> for TkAction

type Output = TkAction

The resulting type after applying the & operator.

fn bitand(self, other: TkAction) -> TkAction

Returns the intersection between the two sets of flags.

impl BitAndAssign<TkAction> for TkAction

fn bitand_assign(&mut self, other: TkAction)

Disables all flags disabled in the set.

impl BitOr<TkAction> for TkAction

type Output = TkAction

The resulting type after applying the | operator.

fn bitor(self, other: TkAction) -> TkAction

Returns the union of the two sets of flags.

impl BitOrAssign<TkAction> for TkAction

fn bitor_assign(&mut self, other: TkAction)

Adds the set of flags.

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

fn bitor_assign(&mut self, action: TkAction)

Performs the |= operation.

impl BitXor<TkAction> for TkAction

type Output = TkAction

The resulting type after applying the ^ operator.

fn bitxor(self, other: TkAction) -> TkAction

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<TkAction> for TkAction

fn bitxor_assign(&mut self, other: TkAction)

Toggles the set of flags.

impl Clone for TkAction

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

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

Formats the value using the given formatter.

impl Default for TkAction

fn default() -> TkAction

Returns the “default value” for a type.

impl Eq for TkAction

impl Extend<TkAction> for TkAction

fn extend<T: IntoIterator<Item = TkAction>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<TkAction> for TkAction

fn from_iter<T: IntoIterator<Item = TkAction>>(iterator: T) -> TkAction

Creates a value from an iterator.

impl Hash for TkAction

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl LowerHex for TkAction

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

Formats the value using the given formatter.

impl Not for TkAction

type Output = TkAction

The resulting type after applying the ! operator.

fn not(self) -> TkAction

Returns the complement of this set of flags.

impl Octal for TkAction

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

Formats the value using the given formatter.

impl Ord for TkAction

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

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

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

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

This method tests for !=.

impl PartialOrd<TkAction> for TkAction

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

impl Sub<TkAction> for TkAction

type Output = TkAction

The resulting type after applying the - operator.

fn sub(self, other: TkAction) -> TkAction

Returns the set difference of the two sets of flags.

impl SubAssign<TkAction> for TkAction

fn sub_assign(&mut self, other: TkAction)

Disables all flags enabled in the set.

impl UpperHex for TkAction

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

Formats the value using the given formatter.