gntkeys.h
Go to the documentation of this file.
1
5 /*
6 * GNT - The GLib Ncurses Toolkit
7 *
8 * GNT is the legal property of its developers, whose names are too numerous
9 * to list here. Please refer to the COPYRIGHT file distributed with this
10 * source distribution.
11 *
12 * This library is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
25 */
26
27 #ifndef GNT_KEYS_H
28 #define GNT_KEYS_H
29
30 #include <curses.h>
31 #include <term.h>
32
38 extern char *gnt_key_cup;
39 extern char *gnt_key_cdown;
40 extern char *gnt_key_cleft;
41 extern char *gnt_key_cright;
42
43 #define SAFE(x) ((x) ? (x) : "")
44
45 #define GNT_KEY_POPUP SAFE(key_f16) /* Apparently */
46
47 /* Arrow keys */
48 #define GNT_KEY_LEFT SAFE(key_left)
49 #define GNT_KEY_RIGHT SAFE(key_right)
50 #define GNT_KEY_UP SAFE(key_up)
51 #define GNT_KEY_DOWN SAFE(key_down)
52
53 #define GNT_KEY_CTRL_UP SAFE(gnt_key_cup)
54 #define GNT_KEY_CTRL_DOWN SAFE(gnt_key_cdown)
55 #define GNT_KEY_CTRL_RIGHT SAFE(gnt_key_cright)
56 #define GNT_KEY_CTRL_LEFT SAFE(gnt_key_cleft)
57
58 #define GNT_KEY_PGUP SAFE(key_ppage)
59 #define GNT_KEY_PGDOWN SAFE(key_npage)
60 #define GNT_KEY_HOME SAFE(key_home)
61 #define GNT_KEY_END SAFE(key_end)
62
63 #define GNT_KEY_ENTER carriage_return
64
65 #define GNT_KEY_BACKSPACE SAFE(key_backspace)
66 #define GNT_KEY_DEL SAFE(key_dc)
67 #define GNT_KEY_INS SAFE(key_ic)
68 #define GNT_KEY_BACK_TAB (back_tab ? back_tab : SAFE(key_btab))
69
70 #define GNT_KEY_CTRL_A "\001"
71 #define GNT_KEY_CTRL_B "\002"
72 #define GNT_KEY_CTRL_D "\004"
73 #define GNT_KEY_CTRL_E "\005"
74 #define GNT_KEY_CTRL_F "\006"
75 #define GNT_KEY_CTRL_G "\007"
76 #define GNT_KEY_CTRL_H "\010"
77 #define GNT_KEY_CTRL_I "\011"
78 #define GNT_KEY_CTRL_J "\012"
79 #define GNT_KEY_CTRL_K "\013"
80 #define GNT_KEY_CTRL_L "\014"
81 #define GNT_KEY_CTRL_M "\012"
82 #define GNT_KEY_CTRL_N "\016"
83 #define GNT_KEY_CTRL_O "\017"
84 #define GNT_KEY_CTRL_P "\020"
85 #define GNT_KEY_CTRL_R "\022"
86 #define GNT_KEY_CTRL_T "\024"
87 #define GNT_KEY_CTRL_U "\025"
88 #define GNT_KEY_CTRL_V "\026"
89 #define GNT_KEY_CTRL_W "\027"
90 #define GNT_KEY_CTRL_X "\030"
91 #define GNT_KEY_CTRL_Y "\031"
92
93 #define GNT_KEY_F1 SAFE(key_f1)
94 #define GNT_KEY_F2 SAFE(key_f2)
95 #define GNT_KEY_F3 SAFE(key_f3)
96 #define GNT_KEY_F4 SAFE(key_f4)
97 #define GNT_KEY_F5 SAFE(key_f5)
98 #define GNT_KEY_F6 SAFE(key_f6)
99 #define GNT_KEY_F7 SAFE(key_f7)
100 #define GNT_KEY_F8 SAFE(key_f8)
101 #define GNT_KEY_F9 SAFE(key_f9)
102 #define GNT_KEY_F10 SAFE(key_f10)
103 #define GNT_KEY_F11 SAFE(key_f11)
104 #define GNT_KEY_F12 SAFE(key_f12)
105
109 void gnt_init_keys(void);
110
117 void gnt_keys_refine(char *text);
118
126 const char *gnt_key_translate(const char *name);
127
135 const char *gnt_key_lookup(const char *key);
136
142 void gnt_keys_add_combination(const char *key);
143
149 void gnt_keys_del_combination(const char *key);
150
159 int gnt_keys_find_combination(const char *key);
160
161 /* A lot of commonly used variable names are defined in <term.h>.
162 * #undef them to make life easier for everyone. */
163
164 #undef columns
165 #undef lines
166 #undef buttons
167 #undef newline
168 #undef set_clock
169
170 #endif
gnt_init_keys
void gnt_init_keys(void)
Initialize the keys.
gnt_keys_refine
void gnt_keys_refine(char *text)
Refine input text.
gnt_key_lookup
const char * gnt_key_lookup(const char *key)
Translate a machine-readable representation of an input to a user-readable representation.
gnt_key_cup
char * gnt_key_cup
terminfo/termcap doesn&#39;t provide all the information that I want to use, eg.
gnt_keys_find_combination
int gnt_keys_find_combination(const char *key)
Find a combination from the given string.
gnt_keys_add_combination
void gnt_keys_add_combination(const char *key)
Add a key combination to the internal key-tree.
gnt_keys_del_combination
void gnt_keys_del_combination(const char *key)
Remove a key combination from the internal key-tree.
gnt_key_translate
const char * gnt_key_translate(const char *name)
Translate a user-readable representation of an input to a machine-readable representation.