diff options
Diffstat (limited to 'include')
-rw-r--r-- | include/pugl/pugl.h | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/include/pugl/pugl.h b/include/pugl/pugl.h index 6e783e7..59b8847 100644 --- a/include/pugl/pugl.h +++ b/include/pugl/pugl.h @@ -1137,7 +1137,14 @@ typedef enum { PUGL_CURSOR_UP_DOWN, ///< Up/down arrow for vertical resize } PuglCursor; -/// Grab the keyboard input focus +/** + Grab the keyboard input focus. + + Note that this will fail if the view is not mapped and so should not, for + example, be called immediately after puglShow(). + + @return #PUGL_SUCCESS if the focus was successfully grabbed, or an error. +*/ PUGL_API PuglStatus puglGrabFocus(PuglView* view); |