MCPcopy Create free account
hub / github.com/KebsCS/KBotExt / SetKeyOwner

Method SetKeyOwner

KBotExt/imgui/imgui.cpp:9027–9040  ·  view source on GitHub ↗

_LockXXX flags are useful to lock keys away from code which is not input-owner aware. When using _LockXXX flags, you can use ImGuiKeyOwner_Any to lock keys from everyone. - SetKeyOwner(..., None) : clears owner - SetKeyOwner(..., Any, !Lock) : illegal (assert) - SetKeyOwner(..., Any or None, Lock) : set lock

Source from the content-addressed store, hash-verified

9025// - SetKeyOwner(..., Any, !Lock) : illegal (assert)
9026// - SetKeyOwner(..., Any or None, Lock) : set lock
9027void ImGui::SetKeyOwner(ImGuiKey key, ImGuiID owner_id, ImGuiInputFlags flags)
9028{
9029 IM_ASSERT(IsNamedKeyOrModKey(key) && (owner_id != ImGuiKeyOwner_Any || (flags & (ImGuiInputFlags_LockThisFrame | ImGuiInputFlags_LockUntilRelease)))); // Can only use _Any with _LockXXX flags (to eat a key away without an ID to retrieve it)
9030 IM_ASSERT((flags & ~ImGuiInputFlags_SupportedBySetKeyOwner) == 0); // Passing flags not supported by this function!
9031
9032 ImGuiContext& g = *GImGui;
9033 ImGuiKeyOwnerData* owner_data = GetKeyOwnerData(&g, key);
9034 owner_data->OwnerCurr = owner_data->OwnerNext = owner_id;
9035
9036 // We cannot lock by default as it would likely break lots of legacy code.
9037 // In the case of using LockUntilRelease while key is not down we still lock during the frame (no key_data->Down test)
9038 owner_data->LockUntilRelease = (flags & ImGuiInputFlags_LockUntilRelease) != 0;
9039 owner_data->LockThisFrame = (flags & ImGuiInputFlags_LockThisFrame) != 0 || (owner_data->LockUntilRelease);
9040}
9041
9042// Rarely used helper
9043void ImGui::SetKeyOwnersForKeyChord(ImGuiKeyChord key_chord, ImGuiID owner_id, ImGuiInputFlags flags)

Callers

nothing calls this directly

Calls 2

IsNamedKeyOrModKeyFunction · 0.85
GetKeyOwnerDataFunction · 0.85

Tested by

no test coverage detected