blob: b35bd139b34a11ae0cc3dcdc2de19e4f5b93d9d5 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
/*
* This file is subject to the terms of the GFX License. If a copy of
* the license was not distributed with this file, you can obtain one at:
*
* http://ugfx.io/license.html
*/
/**
* @file src/gwin/gwin_keyboard_layout.h
* @brief GWIN Virtual Keyboard Layout structures.
*/
#ifndef _GWIN_KEYBOARD_LAYOUT_H
#define _GWIN_KEYBOARD_LAYOUT_H
/**
* A GVKeyTable is a set of definitions that define how the keyboard lays out
* its keys. A GVKeyTable consists of a number of GVKeySets and a special key table.
*
* A GVKeySet is a set of keys that make up the currently visible keyboard.
* Special keys in the GVKeySet can be used to switch between GVKeySets within
* the GVKeyTable. An example is a shift key which switches between the GVKeySet of
* lower case keys and the GVKeySet of upper case keys. GVKeySet number 0 is special
* in that it is the default GVKeySet when the keyboard is first displayed.
*
* A GVKeySet is made up of GVKeyRow's. Each GVKeyRow describes the keys on one row
* of the keyboard.
*
* Each GVKeyRow covers a number of key columns. Different rows can have different numbers of columns.
* eg. 'Q' -> 'P' has 10 keys while 'A' to 'L' has 9. Additionally each key can cover more than one
* column position eg a wide space bar.
*
* Each GVKeyRow is just a string. Each character is the caption for one key. Using the same
* character for two or more adjacent keys merges the keys into one big key covering multiple key columns.
* Characters \001 to \037 (1 to 31) are special keys. How to handle and draw those is described by the
* special key structure array. Special keys do things like changing keysets, returning characters less than 32,
* have multiple character keycaps.
*
* Note: keycaps from the special key table with a single character from 1 to 31 in them may invoke special drawn
* symbols eg. character 13 may cause a special symbol to be drawn for the enter key. Other than those characters
* which are drawn as symbols by the keyboard draw function, all other characters for keycaps are drawn using the
* current widget font.
*
* Special keycaps handled by the standard draw:
* \001 (1) - Shift (up arrow)
* \002 (2) - Shift locked (up arrow - bold)
* \010 (8) - Tab (right arrow)
* \011 (9) - BackSpace (left arrow)
* \015 (13) - Carriage Return (hooked left arrow)
*/
typedef struct GVSpecialKey {
const char const *keycap; // The caption on the key
const char const *sendkey; // The key to send (NULL means none)
gU8 flags; // Flags
#define GVKEY_INVERT 0x01 // Invert the color
#define GVKEY_SINGLESET 0x02 // Change set when this key is pressed but only for a single keystroke
#define GVKEY_LOCKSET 0x04 // Change set when this key is pressed but stay there until the set is changed by the user
gU8 newset; // The new set to change to
} GVSpecialKey;
typedef const char **GVKeySet; // Array of Rows - Null indicates the end
typedef struct GVKeyTable {
const GVSpecialKey *skeys; // Array of Special Key structures
const GVKeySet *ksets; // Array of KeySets - Null indicates the end
} GVKeyTable;
#endif /* _GWIN_KEYBOARD_LAYOUT_H */
/** @} */
|
