Documentation

UI::InputFlags

Enum

Flags that can be passed to Shortcut and SetNextItemShortcut.

Values

UI::InputFlags::None (0)

UI::InputFlags::Repeat (1)

Enable repeat. Return true on successive repeats. Default for legacy IsKeyPressed(). NOT Default for legacy IsMouseClicked(). MUST BE == 1.

UI::InputFlags::RouteActive (1024)

Route to active item only.

UI::InputFlags::RouteFocused (2048)

Route to windows in the focus stack (DEFAULT). Deep-most focused window takes inputs. Active item takes inputs over deep-most focused window.

UI::InputFlags::RouteGlobal (4096)

Global route (unless a focused window or active item registered the route).

UI::InputFlags::RouteAlways (8192)

Do not register route, poll keys directly.

UI::InputFlags::RouteOverFocused (16384)

Option: global route: higher priority than focused route (unless active item in focused route).

UI::InputFlags::RouteOverActive (32768)

Option: global route: higher priority than active item. Unlikely you need to use that: will interfere with every active items, e.g. CTRL+A registered by InputText will be overridden by this. May not be fully honored as user/internal code is likely to always assume they can access keys when active.

UI::InputFlags::RouteUnlessBgFocused (65536)

Option: global route: will not be applied if underlying background/void is focused (== no Dear ImGui windows are focused). Useful for overlay applications.

UI::InputFlags::RouteFromRootWindow (131072)

Option: route evaluated from the point of view of root window rather than current window.

UI::InputFlags::Tooltip (262144)

Automatically display a tooltip when hovering item [BETA] Unsure of right api (opt-in/opt-out)