imgui.flag

Class ImGuiPopupFlags

java.lang.Object

imgui.flag.ImGuiPopupFlags

public final class ImGuiPopupFlags
extends java.lang.Object

Flags for OpenPopup*(), BeginPopupContext*(), IsPopupOpen() functions. - To be backward compatible with older API which took an 'int mouse_button = 1' argument, we need to treat small flags values as a mouse button index, so we encode the mouse button in the first few bits of the flags. It is therefore guaranteed to be legal to pass a mouse button index in ImGuiPopupFlags. - For the same reason, we exceptionally default the ImGuiPopupFlags argument of BeginPopupContextXXX functions to 1 instead of 0. - Multiple buttons currently cannot be combined/or-ed in those functions (we could allow it later).

Field Summary

Fields

Modifier and Type	Field and Description
static int	AnyPopup
static int	AnyPopupId For IsPopupOpen(): ignore the ImGuiID parameter and test for any popup.
static int	AnyPopupLevel For IsPopupOpen(): search/test at any level of the popup stack (default test in the current level)
static int	MouseButtonDefault
static int	MouseButtonLeft For BeginPopupContext*(): open on Left Mouse release.
static int	MouseButtonMask
static int	MouseButtonMiddle For BeginPopupContext*(): open on Middle Mouse release.
static int	MouseButtonRight For BeginPopupContext*(): open on Right Mouse release.
static int	None
static int	NoOpenOverExistingPopup For OpenPopup*(), BeginPopupContext*(): don't open if there's already a popup at the same level of the popup stack
static int	NoOpenOverItems For BeginPopupContextWindow(): don't return true when hovering items, only when hovering empty space

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

See Also:

Constant Field Values

MouseButtonLeft

public static final int MouseButtonLeft

For BeginPopupContext*(): open on Left Mouse release. Guaranteed to always be == 0 (same as ImGuiMouseButton_Left)

See Also:

Constant Field Values

MouseButtonRight

public static final int MouseButtonRight

For BeginPopupContext*(): open on Right Mouse release. Guaranteed to always be == 1 (same as ImGuiMouseButton_Right)

See Also:

Constant Field Values

MouseButtonMiddle

public static final int MouseButtonMiddle

For BeginPopupContext*(): open on Middle Mouse release. Guaranteed to always be == 2 (same as ImGuiMouseButton_Middle)

See Also:

Constant Field Values

MouseButtonMask

public static final int MouseButtonMask

See Also:

Constant Field Values

MouseButtonDefault

public static final int MouseButtonDefault

See Also:

Constant Field Values

NoOpenOverExistingPopup

public static final int NoOpenOverExistingPopup

For OpenPopup*(), BeginPopupContext*(): don't open if there's already a popup at the same level of the popup stack

See Also:

Constant Field Values

NoOpenOverItems

public static final int NoOpenOverItems

For BeginPopupContextWindow(): don't return true when hovering items, only when hovering empty space

See Also:

Constant Field Values

AnyPopupId

public static final int AnyPopupId

For IsPopupOpen(): ignore the ImGuiID parameter and test for any popup.

See Also:

Constant Field Values

AnyPopupLevel

public static final int AnyPopupLevel

For IsPopupOpen(): search/test at any level of the popup stack (default test in the current level)

See Also:

Constant Field Values

AnyPopup

public static final int AnyPopup

See Also:

Constant Field Values