WoW:API Frame EnableKeyboard: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
mNo edit summary
m (Move page script moved page API Frame EnableKeyboard to API Frame EnableKeyboard without leaving a redirect)
 
(One intermediate revision by one other user not shown)
Line 3: Line 3:
<center>'''Frame:EnableKeyboard'''</center>
<center>'''Frame:EnableKeyboard'''</center>


Allows this frame to receive keyboard input via [[UIHANDLER OnKeyUp|OnKeyUp]] and [[UIHANDLER OnKeyDown|OnKeyDown]].  The frame must be [[API Region Show|shown]] to receive keyboard events.  The frame receiving keyboard input is the <i>only</i> frame receiving keyboard input, which means for example if you show a frame that receives keyboard events, the character cannot move with the keyboard or use key bindings until that frame is hidden again.
Allows this frame to receive keyboard input via [[UIHANDLER OnKeyUp|OnKeyUp]] and [[UIHANDLER OnKeyDown|OnKeyDown]].  The frame must be [[API Region Show|shown]] to receive keyboard events.  The frame receiving keyboard input is the ''only'' frame receiving keyboard input, which means for example if you show a frame that receives keyboard events, the character cannot move with the keyboard or use key bindings until that frame is hidden again.


It should also be noted that the [[frameStrata]] has to be at least DIALOG or higher for this to work.
It should also be noted that the [[frameStrata]] has to be at least DIALOG or higher for this to work.

Latest revision as of 04:45, 15 August 2023

Widget API ← Frame < EnableKeyboard

Frame:EnableKeyboard

Allows this frame to receive keyboard input via OnKeyUp and OnKeyDown. The frame must be shown to receive keyboard events. The frame receiving keyboard input is the only frame receiving keyboard input, which means for example if you show a frame that receives keyboard events, the character cannot move with the keyboard or use key bindings until that frame is hidden again.

It should also be noted that the frameStrata has to be at least DIALOG or higher for this to work.

frame:EnableKeyboard(enableFlag)

Parameters[edit]

Arguments[edit]

enableFlag
Boolean - Whether to enable (true) or disable (false)