Struct imgui::drag_drop::DragDropFlags [−][src]
#[repr(transparent)]pub struct DragDropFlags { /* fields omitted */ }
Expand description
Flags for igBeginDragDropSource(), igAcceptDragDropPayload()
Implementations
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.
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.
Disable the behavior that allows to open tree nodes and collapsing header by holding over them while dragging a source item.
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.
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.
Automatically expire the payload if the source ceases to be submitted (otherwise payloads are persisting while being dragged)
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.
Do not draw the default highlight rectangle when hovering over target.
Request hiding the igBeginDragDropSource tooltip from the igBeginDragDropTarget site.
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
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
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.
Returns true
if there are flags common to both self
and other
.
Returns true
if all of the flags in other
are contained within self
.
Inserts or removes the specified flags depending on the passed value.
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
.
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
.
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
.
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
.
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
Disables all flags disabled in the set.
Returns the union of the two sets of flags.
type Output = Self
type Output = Self
The resulting type after applying the |
operator.
Adds the set of flags.
Toggles the set of flags.
Extends a collection with the contents of an iterator. Read more
extend_one
)Extends a collection with exactly one element.
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
Creates a value from an iterator. Read more
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
Disables all flags enabled in the set.
Auto Trait Implementations
impl RefUnwindSafe for DragDropFlags
impl Send for DragDropFlags
impl Sync for DragDropFlags
impl Unpin for DragDropFlags
impl UnwindSafe for DragDropFlags
Blanket Implementations
Mutably borrows from an owned value. Read more