Keyboard widget. Used to provide a virtual on-screen keyboard.
GWIN allows it to easily create buttons with different styles and check for different meta states such as: PRESSED, CLICKED, RELEASED etc.
- Precondition
- GFX_USE_GWIN must be set to GFXON in your gfxconf.h
-
GWIN_NEED_BUTTON must be set to GFXON in your gfxconf.h
|
| Renderings |
| Built-in rendering functions for the keyboard widget.
|
|
◆ gwinGKeyboardCreate()
Create a keyboard widget.
- Returns
- NULL if there is no resultant drawing area, otherwise a window handle.
- Parameters
-
[in] | g | The GDisplay to display this window on |
[in] | gb | The GKeyboardObject structure to initialise. If this is NULL the structure is dynamically allocated. |
[in] | pInit | The initialisation parameters |
- Note
- The drawing color and the background color get set to the current defaults. If you haven't called
gwinSetDefaultColor()
or gwinSetDefaultBgColor()
then these are GFX_WHITE and GFX_BLACK respectively.
-
The font gets set to the current default font. If you haven't called
gwinSetDefaultFont()
then there is no default font and text drawing operations will no nothing.
-
A keyboard remembers its normal drawing state. If there is a window manager then it is automatically redrawn if the window is moved or its visibility state is changed.
-
A keyboard supports mouse input.
- Function Class: Normal API, this function can be invoked by regular system threads.
◆ gwinKeyboardGetEventSource()
GSourceHandle gwinKeyboardGetEventSource |
( |
GHandle |
gh | ) |
|
Get the keyboard event source for a GWIN virtual keyboard.
- Returns
- The event source handle or NULL if this is not a virtual keyboard
- Parameters
-
[in] | gh | The GWIN virtual keyboard |
- Note
- Normal GINPUT Keyboard events are returned by this event source.
◆ gwinKeyboardSetLayout()
void gwinKeyboardSetLayout |
( |
GHandle |
gh, |
|
|
const struct GVKeyTable * |
layout |
|
) |
| |
Set the layout for the virtual keyboard.
- Parameters
-
- Note
- Changing the layout resets the keyboard to key set 0 of the keyboard and cancels any pending shifts.
◆ GEVENT_GWIN_KEYBOARD
#define GEVENT_GWIN_KEYBOARD (GEVENT_GWIN_CTRL_FIRST+6) |
◆ GKEYBOARD_FLG_REVERTSET
#define GKEYBOARD_FLG_REVERTSET 0x01 |
The internal keyboard flags and other defines.
- Note
- Used only for writing a custom draw routine.
Definition at line 47 of file gwin_keyboard.h.
◆ GEventGWinKeyboard
◆ GKeyboardObject
The keyboard widget structure.
- Note
- Do not use the members directly - treat it as a black-box.