chiark / gitweb /
Add documentation for `msg'.
[mgLib] / msg.c
1 /* -*-c-*-
2  *
3  * $Id: msg.c,v 1.4 1999/04/29 20:48:13 mdw Exp $
4  *
5  * Display a message and get an answer
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: msg.c,v $
32  * Revision 1.4  1999/04/29 20:48:13  mdw
33  * Add documentation for `msg'.
34  *
35  * Revision 1.3  1999/03/25 23:36:10  mdw
36  * Compile to nothing in absence of GTK, for the benefit of parent packages
37  * which contain non-GTK-dependent parts.
38  *
39  * Revision 1.2  1998/12/15 23:48:06  mdw
40  * Use `dstr_putf' for formatting, rather than `sprintf'.
41  *
42  * Revision 1.1  1998/12/11 09:44:21  mdw
43  * Initial version.
44  *
45  */
46
47 #ifdef HAVE_GTK
48
49 /*----- Header files ------------------------------------------------------*/
50
51 #include <stdarg.h>
52 #include <stdio.h>
53 #include <stdlib.h>
54 #include <string.h>
55
56 #include <gtk/gtk.h>
57
58 #include <mLib/alloc.h>
59 #include <mLib/dstr.h>
60
61 #include "cancel.h"
62 #include "mdwfocus.h"
63 #include "msg.h"
64
65 /*----- Static variables --------------------------------------------------*/
66
67 static int reply;
68 static int creply;
69
70 /*----- Main code ---------------------------------------------------------*/
71
72 /* --- @msg@ --- *
73  *
74  * Arguments:   @char *buttons@ = the button strings to display
75  *              @char *msg@ = the message skeleton string
76  *
77  * Returns:     Index of the button selected.
78  *
79  * Use:         Displays a message to the user in a nice dialogue box and
80  *              returns the index of the button selected.
81  *
82  *              The @msg@ argument is a @printf@-style format string, which
83  *              contains the message to actually be shown.  The @buttons@
84  *              argument is a comma-separated list of buttons to be drawn,
85  *              from right to left.  A button name can be preceded with `:'
86  *              to indicate that it's the default, or `~' if it's the
87  *              `cancel' button.  The return value is the zero-based index
88  *              of the button selected.
89  */
90
91 static int close(GtkWidget *w, gpointer p)
92 {
93   reply = creply;
94   gtk_main_quit();
95   return (1);
96 }
97
98 static void click(GtkWidget *w, gpointer p)
99 {
100   reply = (int)p;
101   gtk_main_quit();
102 }
103
104 int msg(const char *buttons, const char *msg, ...)
105 {
106   GtkWidget *dbox, *w;
107
108   /* --- Make most of the dialogue box --- */
109
110   dbox = gtk_dialog_new();
111   gtk_signal_connect(GTK_OBJECT(dbox), "delete_event",
112                      GTK_SIGNAL_FUNC(close), 0);
113   gtk_box_set_homogeneous(GTK_BOX(GTK_DIALOG(dbox)->action_area), 0);  
114
115   /* --- Set up the message string --- */
116
117   {
118     dstr d;
119     va_list ap;
120
121     va_start(ap, msg);
122     dstr_create(&d);
123     dstr_vputf(&d, msg, ap);
124     va_end(ap);
125     w = gtk_label_new(d.buf);
126     gtk_box_pack_start(GTK_BOX(GTK_DIALOG(dbox)->vbox), w, 1, 1, 0);
127     gtk_window_position(GTK_WINDOW(dbox), GTK_WIN_POS_MOUSE);
128     gtk_widget_show(w);
129     gtk_misc_set_padding(GTK_MISC(w), 16, 16);
130     dstr_destroy(&d);
131   }
132
133   /* --- Set up the buttons --- */
134
135   {
136     char *p = xstrdup(buttons);
137     unsigned f = 0;
138     int i = 0;
139
140     enum {
141       f_ok = 1,
142       f_cancel = 2,
143       f_mdwfocus = 4
144     };
145
146     if (*p == '!') {
147       f |= f_mdwfocus;
148       p++;
149     }
150
151     creply = -1;
152
153     for (p = strtok(p, ","); p; p = strtok(0, ","), i++) {
154       unsigned ff = 0;
155       if (*p == ':') {
156         ff |= f_ok;
157         p++;
158       }
159       if (*p == '~') {
160         ff |= f_cancel;
161         creply = i;
162         p++;
163       }
164       w = gtk_button_new_with_label(p);
165       GTK_WIDGET_SET_FLAGS(w, GTK_CAN_DEFAULT);
166       gtk_box_pack_end(GTK_BOX(GTK_DIALOG(dbox)->action_area), w, 0, 0, 0);
167       gtk_signal_connect(GTK_OBJECT(w), "clicked",
168                          GTK_SIGNAL_FUNC(click), (gpointer)i);
169       if (ff & f_ok)
170         gtk_widget_grab_default(w);
171       if (ff & f_cancel)
172         cancel(GTK_WINDOW(dbox), w);
173       gtk_widget_show(w);
174     }
175     free(p);
176
177     /* --- Preflight checklist --- */
178
179     gtk_widget_realize(dbox);
180     if (f & f_mdwfocus)
181       mdwfocus(dbox);
182
183   }
184
185   /* --- Ready --- */
186
187   gtk_grab_add(GTK_WIDGET(dbox));
188   gtk_widget_show(dbox);
189   gtk_main();
190   gtk_grab_remove(GTK_WIDGET(dbox));
191   gtk_widget_destroy(dbox);
192   return (reply);
193 }
194
195 /*----- That's all, folks -------------------------------------------------*/
196
197 #else
198   int mgLib_msg = 0;
199 #endif