Struct smithay_client_toolkit::data_device::DndAction

pub struct DndAction { /* private fields */ }

drag and drop actions

This is a bitmask of the available/preferred actions in a drag-and-drop operation.

In the compositor, the selected action is a result of matching the actions offered by the source and destination sides. “action” events with a “none” action will be sent to both source and destination if there is no match. All further checks will effectively happen on (source actions ∩ destination actions).

In addition, compositors may also pick different actions in reaction to key modifiers being pressed. One common design that is used in major toolkits (and the behavior recommended for compositors) is:

• If no modifiers are pressed, the first match (in bit order) will be used.
• Pressing Shift selects “move”, if enabled in the mask.
• Pressing Control selects “copy”, if enabled in the mask.

Behavior beyond that is considered implementation-dependent. Compositors may for example bind other modifiers (like Alt/Meta) or drags initiated with other buttons than BTN_LEFT to specific actions (e.g. “ask”).

Implementations

impl DndAction

pub fn from_raw(n: u32) -> Option<DndAction>

pub fn to_raw(&self) -> u32

impl DndAction

pub const None: DndAction

no action

pub const Copy: DndAction

copy action

pub const Move: DndAction

move action

pub const Ask: DndAction

ask action

pub const fn empty() -> DndAction

Returns an empty set of flags.

pub const fn all() -> DndAction

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

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) -> DndAction

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

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

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

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

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: DndAction) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

pub const fn intersection(self, other: DndAction) -> DndAction

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

pub const fn union(self, other: DndAction) -> DndAction

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

pub const fn difference(self, other: DndAction) -> DndAction

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

pub const fn symmetric_difference(self, other: DndAction) -> DndAction

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> DndAction

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

Trait Implementations

impl Binary for DndAction

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

Formats the value using the given formatter.

impl BitAnd<DndAction> for DndAction

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

Returns the intersection between the two sets of flags.

type Output = DndAction

The resulting type after applying the & operator.

impl BitAndAssign<DndAction> for DndAction

fn bitand_assign(&mut self, other: DndAction)

Disables all flags disabled in the set.

impl BitOr<DndAction> for DndAction

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

Returns the union of the two sets of flags.

type Output = DndAction

The resulting type after applying the | operator.

impl BitOrAssign<DndAction> for DndAction

fn bitor_assign(&mut self, other: DndAction)

Adds the set of flags.

impl BitXor<DndAction> for DndAction

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

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

type Output = DndAction

The resulting type after applying the ^ operator.

impl BitXorAssign<DndAction> for DndAction

fn bitxor_assign(&mut self, other: DndAction)

Toggles the set of flags.

impl Clone for DndAction

fn clone(&self) -> DndAction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DndAction

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

Formats the value using the given formatter.

impl Extend<DndAction> for DndAction

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

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

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<DndAction> for DndAction

fn from_iter<T>(iterator: T) -> DndAction where
    T: IntoIterator<Item = DndAction>, 

Creates a value from an iterator.

impl Hash for DndAction

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

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 LowerHex for DndAction

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

Formats the value using the given formatter.

impl Not for DndAction

fn not(self) -> DndAction

Returns the complement of this set of flags.

type Output = DndAction

The resulting type after applying the ! operator.

impl Octal for DndAction

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

Formats the value using the given formatter.

impl Ord for DndAction

fn cmp(&self, other: &DndAction) -> 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

Restrict a value to a certain interval.

impl PartialEq<DndAction> for DndAction

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

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

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

This method tests for !=.

impl PartialOrd<DndAction> for DndAction

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

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

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

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

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

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

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

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

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 Sub<DndAction> for DndAction

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

Returns the set difference of the two sets of flags.

type Output = DndAction

The resulting type after applying the - operator.

impl SubAssign<DndAction> for DndAction

fn sub_assign(&mut self, other: DndAction)

Disables all flags enabled in the set.

impl UpperHex for DndAction

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

Formats the value using the given formatter.

impl Copy for DndAction

impl Eq for DndAction

impl StructuralEq for DndAction

impl StructuralPartialEq for DndAction