imgui.flag

Class ImGuiDragDropFlags

java.lang.Object

imgui.flag.ImGuiDragDropFlags

public final class ImGuiDragDropFlags
extends java.lang.Object

Flags for ImGui::BeginDragDropSource(), ImGui::AcceptDragDropPayload()

Field Summary

Fields

Modifier and Type	Field and Description
static int	AcceptBeforeDelivery AcceptDragDropPayload() will returns true even before the mouse button is released.
static int	AcceptNoDrawDefaultRect Do not draw the default highlight rectangle when hovering over target.
static int	AcceptNoPreviewTooltip Request hiding the BeginDragDropSource tooltip from the BeginDragDropTarget site.
static int	AcceptPeekOnly For peeking ahead and inspecting the payload before delivery.
static int	None Definition: 0
static int	PayloadAutoExpire Automatically expire the payload if the source cease to be submitted (otherwise payloads are persisting while being dragged)
static int	PayloadNoCrossContext Hint to specify that the payload may not be copied outside current dear imgui context.
static int	PayloadNoCrossProcess Hint to specify that the payload may not be copied outside current process.
static int	SourceAllowNullID Allow items such as Text(), Image() that have no unique identifier to be used as drag source, by manufacturing a temporary identifier based on their window-relative position.
static int	SourceAutoExpirePayload Renamed in 1.90.9
static int	SourceExtern External source (from outside of dear imgui), won't attempt to read current item/window info.
static int	SourceNoDisableHover By default, when dragging we clear data so that IsItemHovered() will return false, to avoid subsequent user code submitting tooltips.
static int	SourceNoHoldToOpenOthers Disable the behavior that allows to open tree nodes and collapsing header by holding over them while dragging a source item.
static int	SourceNoPreviewTooltip Disable preview tooltip.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

None

public static final int None

Definition: 0

See Also:

Constant Field Values

SourceNoPreviewTooltip

public static final int SourceNoPreviewTooltip

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

Definition: 1 << 0

See Also:

Constant Field Values

SourceNoDisableHover

public static final int SourceNoDisableHover

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

Definition: 1 << 1

See Also:

Constant Field Values

SourceNoHoldToOpenOthers

public static final int SourceNoHoldToOpenOthers

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

Definition: 1 << 2

See Also:

Constant Field Values

SourceAllowNullID

public static final int SourceAllowNullID

Allow items such as Text(), Image() 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.

Definition: 1 << 3

See Also:

Constant Field Values

SourceExtern

public static final int SourceExtern

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

Definition: 1 << 4

See Also:

Constant Field Values

PayloadAutoExpire

public static final int PayloadAutoExpire

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

Definition: 1 << 5

See Also:

Constant Field Values

PayloadNoCrossContext

public static final int PayloadNoCrossContext

Hint to specify that the payload may not be copied outside current dear imgui context.

Definition: 1 << 6

See Also:

Constant Field Values

PayloadNoCrossProcess

public static final int PayloadNoCrossProcess

Hint to specify that the payload may not be copied outside current process.

Definition: 1 << 7

See Also:

Constant Field Values

AcceptBeforeDelivery

public static final int AcceptBeforeDelivery

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

Definition: 1 << 10

See Also:

Constant Field Values

AcceptNoDrawDefaultRect

public static final int AcceptNoDrawDefaultRect

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

Definition: 1 << 11

See Also:

Constant Field Values

AcceptNoPreviewTooltip

public static final int AcceptNoPreviewTooltip

Request hiding the BeginDragDropSource tooltip from the BeginDragDropTarget site.

Definition: 1 << 12

See Also:

Constant Field Values

AcceptPeekOnly

public static final int AcceptPeekOnly

For peeking ahead and inspecting the payload before delivery.

Definition: ImGuiDragDropFlags_AcceptBeforeDelivery | ImGuiDragDropFlags_AcceptNoDrawDefaultRect

See Also:

Constant Field Values

SourceAutoExpirePayload

public static final int SourceAutoExpirePayload

Renamed in 1.90.9

Definition: ImGuiDragDropFlags_PayloadAutoExpire

See Also:

Constant Field Values