Struct imgui::drag_drop::DragDropFlags

#[repr(transparent)]
pub struct DragDropFlags { /* private fields */ }

Flags for igBeginDragDropSource(), igAcceptDragDropPayload()

Implementations

impl DragDropFlags

pub const SOURCE_NO_PREVIEW_TOOLTIP: Self = _

By default, a successful call to igBeginDragDropSource opens a tooltip so you can display a preview or description of the source contents. This flag disable this behavior.

pub const SOURCE_NO_DISABLE_HOVER: Self = _

By default, when dragging we clear data so that igIsItemHovered() will return false, to avoid subsequent user code submitting tooltips. This flag disable this behavior so you can still call igIsItemHovered() on the source item.

pub const SOURCE_NO_HOLD_TO_OPEN_OTHERS: Self = _

Disable the behavior that allows to open tree nodes and collapsing header by holding over them while dragging a source item.

pub const SOURCE_ALLOW_NULL_ID: Self = _

Allow items such as igText(), igImage() that have no unique identifier to be used as drag source, by manufacturing a temporary identifier based on their window-relative position. This is extremely unusual within the dear imgui ecosystem and so we made it explicit.

pub const SOURCE_EXTERN: Self = _

External source (from outside of imgui), won’t attempt to read current item/window info. Will always return true. Only one Extern source can be active simultaneously.

pub const SOURCE_AUTO_EXPIRE_PAYLOAD: Self = _

Automatically expire the payload if the source ceases to be submitted (otherwise payloads are persisting while being dragged)

pub const ACCEPT_BEFORE_DELIVERY: Self = _

igAcceptDragDropPayload() will returns true even before the mouse button is released. You can then call igIsDelivery() to test if the payload needs to be delivered.

pub const ACCEPT_NO_DRAW_DEFAULT_RECT: Self = _

Do not draw the default highlight rectangle when hovering over target.

pub const ACCEPT_NO_PREVIEW_TOOLTIP: Self = _

Request hiding the igBeginDragDropSource tooltip from the igBeginDragDropTarget site.

pub const ACCEPT_PEEK_ONLY: Self = _

For peeking ahead and inspecting the payload before delivery. This is just a convenience flag for the intersection of ACCEPT_BEFORE_DELIVERY and ACCEPT_NO_DRAW_DEFAULT_RECT

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

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<Self>

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

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

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

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

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: Self) -> Self

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: Self) -> Self

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: Self) -> Self

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

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 DragDropFlags

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

Formats the value using the given formatter.

impl BitAnd<DragDropFlags> for DragDropFlags

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

Returns the intersection between the two sets of flags.

type Output = DragDropFlags

The resulting type after applying the & operator.

impl BitAndAssign<DragDropFlags> for DragDropFlags

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<DragDropFlags> for DragDropFlags

fn bitor(self, other: DragDropFlags) -> Self

Returns the union of the two sets of flags.

type Output = DragDropFlags

The resulting type after applying the | operator.

impl BitOrAssign<DragDropFlags> for DragDropFlags

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<DragDropFlags> for DragDropFlags

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

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

type Output = DragDropFlags

The resulting type after applying the ^ operator.

impl BitXorAssign<DragDropFlags> for DragDropFlags

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for DragDropFlags

fn clone(&self) -> DragDropFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DragDropFlags

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

Formats the value using the given formatter.

impl Extend<DragDropFlags> for DragDropFlags

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

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

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

Creates a value from an iterator.

impl Hash for DragDropFlags

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for DragDropFlags

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

Formats the value using the given formatter.

impl Not for DragDropFlags

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = DragDropFlags

The resulting type after applying the ! operator.

impl Octal for DragDropFlags

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

Formats the value using the given formatter.

impl Ord for DragDropFlags

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<DragDropFlags> for DragDropFlags

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<DragDropFlags> for DragDropFlags

fn partial_cmp(&self, other: &DragDropFlags) -> 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<DragDropFlags> for DragDropFlags

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

Returns the set difference of the two sets of flags.

type Output = DragDropFlags

The resulting type after applying the - operator.

impl SubAssign<DragDropFlags> for DragDropFlags

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for DragDropFlags

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

Formats the value using the given formatter.

impl Copy for DragDropFlags

impl Eq for DragDropFlags

impl StructuralEq for DragDropFlags

impl StructuralPartialEq for DragDropFlags