chiark / gitweb /
Add documentation for `msg'.
[mgLib] / cancel.h
1 /* -*-c-*-
2  *
3  * $Id: cancel.h,v 1.1 1998/12/11 09:44:21 mdw Exp $
4  *
5  * Handle Escape keypresses, directing them to cancel buttons
6  *
7  * (c) 1998 Straylight/Edgeware
8  */
9
10 /*----- Licensing notice --------------------------------------------------* 
11  *
12  * This file is part of the mgLib GTK utilities library.
13  *
14  * mgLib is free software; you can redistribute it and/or modify
15  * it under the terms of the GNU General Public License as published by
16  * the Free Software Foundation; either version 2 of the License, or
17  * (at your option) any later version.
18  * 
19  * mgLib is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22  * GNU General Public License for more details.
23  * 
24  * You should have received a copy of the GNU General Public License
25  * along with mgLib; if not, write to the Free Software Foundation,
26  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27  */
28
29 /*----- Revision history --------------------------------------------------* 
30  *
31  * $Log: cancel.h,v $
32  * Revision 1.1  1998/12/11 09:44:21  mdw
33  * Initial version.
34  *
35  */
36
37 #ifndef CANCEL_H
38 #define CANCEL_H
39
40 #ifdef __cplusplus
41   extern "C" {
42 #endif
43
44 /*----- Header files ------------------------------------------------------*/
45
46 #include <gtk/gtk.h>
47
48 /*----- Functions provided ------------------------------------------------*/
49
50 /* --- @cancel@ --- *
51  *
52  * Arguments:   @GtkWindow *win@ = window in which this is happening
53  *              @GtkWidget *w@ = widget to activate, or null
54  *
55  * Returns:     ---
56  *
57  * Use:         Sets up @win@ so that a press of `escape' will activate
58  *              @w@ or destroy @win@.
59  */
60
61 extern void cancel(GtkWindow */*win*/, GtkWidget */*w*/);
62
63 /*----- That's all, folks -------------------------------------------------*/
64
65 #ifdef __cplusplus
66   }
67 #endif
68
69 #endif