comparison finch/libgnt/gntkeys.h @ 18049:1cedd520cd18

Doxygen skeleton and license info for gnt files.
author Sadrul Habib Chowdhury <imadil@gmail.com>
date Wed, 06 Jun 2007 15:42:29 +0000
parents 05d7fe2320a9
children 5c6f019e48f8 ac904659104f
comparison
equal deleted inserted replaced
18048:9aa2c89c8b9e 18049:1cedd520cd18
1 /**
2 * GNT - The GLib Ncurses Toolkit
3 *
4 * GNT is the legal property of its developers, whose names are too numerous
5 * to list here. Please refer to the COPYRIGHT file distributed with this
6 * source distribution.
7 *
8 * This library is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 */
22
1 #ifndef GNT_KEYS_H 23 #ifndef GNT_KEYS_H
2 #define GNT_KEYS_H 24 #define GNT_KEYS_H
3 25
4 #include <curses.h> 26 #include <curses.h>
5 #include <term.h> 27 #include <term.h>
78 #define GNT_KEY_F12 SAFE(key_f12) 100 #define GNT_KEY_F12 SAFE(key_f12)
79 101
80 /** 102 /**
81 * This will do stuff with the terminal settings and stuff. 103 * This will do stuff with the terminal settings and stuff.
82 */ 104 */
105 /**
106 *
107 */
83 void gnt_init_keys(void); 108 void gnt_init_keys(void);
109
110 /**
111 *
112 * @param text
113 */
84 void gnt_keys_refine(char *text); 114 void gnt_keys_refine(char *text);
115
85 const char *gnt_key_translate(const char *name); 116 const char *gnt_key_translate(const char *name);
86 const char *gnt_key_lookup(const char *key); 117 const char *gnt_key_lookup(const char *key);
87 118
119 /**
120 *
121 * @param path
122 */
88 void gnt_keys_add_combination(const char *path); 123 void gnt_keys_add_combination(const char *path);
124
125 /**
126 *
127 * @param path
128 */
89 void gnt_keys_del_combination(const char *path); 129 void gnt_keys_del_combination(const char *path);
130
131 /**
132 *
133 * @param path
134 *
135 * @return
136 */
90 int gnt_keys_find_combination(const char *path); 137 int gnt_keys_find_combination(const char *path);
91
92 138
93 /* A lot of commonly used variable names are defined in <term.h>. 139 /* A lot of commonly used variable names are defined in <term.h>.
94 * #undef them to make life easier for everyone. */ 140 * #undef them to make life easier for everyone. */
95 141
96 #undef columns 142 #undef columns