diff options
author | inmarket <andrewh@inmarket.com.au> | 2018-06-23 13:02:07 +1000 |
---|---|---|
committer | inmarket <andrewh@inmarket.com.au> | 2018-06-23 13:02:07 +1000 |
commit | 41271d632b74f5cf47c30d3b699eb6b2786f2136 (patch) | |
tree | 78bcb729c6d6177ca598f28908fefd186c50e9b6 /src/ginput/ginput_keyboard.h | |
parent | 3b97fb798e96514057bcf17263c1e5dbdcd7da26 (diff) | |
download | uGFX-41271d632b74f5cf47c30d3b699eb6b2786f2136.tar.gz uGFX-41271d632b74f5cf47c30d3b699eb6b2786f2136.tar.bz2 uGFX-41271d632b74f5cf47c30d3b699eb6b2786f2136.zip |
Added new type definitions - moving towards V3.0
Diffstat (limited to 'src/ginput/ginput_keyboard.h')
-rw-r--r-- | src/ginput/ginput_keyboard.h | 52 |
1 files changed, 22 insertions, 30 deletions
diff --git a/src/ginput/ginput_keyboard.h b/src/ginput/ginput_keyboard.h index a80e23d0..61a7a8af 100644 --- a/src/ginput/ginput_keyboard.h +++ b/src/ginput/ginput_keyboard.h @@ -175,47 +175,39 @@ typedef struct GEventKeyboard_t { /* External declarations. */ /*===========================================================================*/ -#ifdef __cplusplus -extern "C" { -#endif +/** + * @brief Create a keyboard input instance + * + * @param[in] instance The ID of the keyboard input instance (from 0 to 9999) + * + * @return The source handle of the created input instance + */ +GSourceHandle ginputGetKeyboard(unsigned instance); + +#if GINPUT_NEED_KEYBOARD || defined(__DOXYGEN__) /** - * @brief Create a keyboard input instance + * @brief Get the current keyboard status * - * @param[in] instance The ID of the keyboard input instance (from 0 to 9999) + * @param[in] instance The ID of the keyboard input instance + * @param[in] pkeyboard The keyboard event struct * - * @return The source handle of the created input instance + * @return Returns gFalse on an error (eg invalid instance) */ - GSourceHandle ginputGetKeyboard(unsigned instance); - - #if GINPUT_NEED_KEYBOARD || defined(__DOXYGEN__) + gBool ginputGetKeyboardStatus(unsigned instance, GEventKeyboard *pkeyboard); + #if !GKEYBOARD_LAYOUT_OFF || defined(__DOXYGEN__) /** - * @brief Get the current keyboard status + * @brief Set the keyboard layout * * @param[in] instance The ID of the keyboard input instance - * @param[in] pkeyboard The keyboard event struct + * @param[in] pLayout The keyboard layout micro-code. Passing NULL defaults to the driver's default layout. * - * @return Returns FALSE on an error (eg invalid instance) + * @return Returns gFalse on an error (eg invalid instance) */ - bool_t ginputGetKeyboardStatus(unsigned instance, GEventKeyboard *pkeyboard); - - #if !GKEYBOARD_LAYOUT_OFF || defined(__DOXYGEN__) - /** - * @brief Set the keyboard layout - * - * @param[in] instance The ID of the keyboard input instance - * @param[in] pLayout The keyboard layout micro-code. Passing NULL defaults to the driver's default layout. - * - * @return Returns FALSE on an error (eg invalid instance) - */ - bool_t ginputSetKeyboardLayout(unsigned instance, const void *pLayout); - #endif - #endif /* GINPUT_NEED_KEYBOARD */ - -#ifdef __cplusplus -} -#endif + gBool ginputSetKeyboardLayout(unsigned instance, const void *pLayout); + #endif +#endif /* GINPUT_NEED_KEYBOARD */ #endif /* _GINPUT_KEYBOARD_H */ /** @} */ |