chiark / gitweb /
Script to transform CVS sources into buildable source tree.
[mgLib] / msg.h
CommitLineData
1c48db0c 1/* -*-c-*-
2 *
19c0192c 3 * $Id: msg.h,v 1.3 1999/05/05 18:52:45 mdw Exp $
1c48db0c 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
19c0192c 15 * it under the terms of the GNU Library General Public License as
16 * published by the Free Software Foundation; either version 2 of the
17 * License, or (at your option) any later version.
1c48db0c 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
19c0192c 22 * GNU Library General Public License for more details.
1c48db0c 23 *
19c0192c 24 * You should have received a copy of the GNU Library General Public
25 * License along with mgLib; if not, write to the Free Software
26 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1c48db0c 27 */
28
29/*----- Revision history --------------------------------------------------*
30 *
31 * $Log: msg.h,v $
19c0192c 32 * Revision 1.3 1999/05/05 18:52:45 mdw
33 * Change licensing conditions to LGPL.
34 *
ed2737aa 35 * Revision 1.2 1999/04/29 20:48:13 mdw
36 * Add documentation for `msg'.
37 *
1c48db0c 38 * Revision 1.1 1998/12/11 09:44:21 mdw
39 * Initial version.
40 *
41 */
42
43#ifndef MSG_H
44#define MSG_H
45
46#ifdef __cplusplus
47 extern "C" {
48#endif
49
50/*----- Header files ------------------------------------------------------*/
51
52#include <gtk/gtk.h>
53
54/*----- Functions provided ------------------------------------------------*/
55
56/* --- @msg@ --- *
57 *
58 * Arguments: @char *buttons@ = the button strings to display
59 * @char *msg@ = the message skeleton string
60 *
61 * Returns: Index of the button selected.
62 *
63 * Use: Displays a message to the user in a nice dialogue box and
64 * returns the index of the button selected.
ed2737aa 65 *
66 * The @msg@ argument is a @printf@-style format string, which
67 * contains the message to actually be shown. The @buttons@
68 * argument is a comma-separated list of buttons to be drawn,
69 * from right to left. A button name can be preceded with `:'
70 * to indicate that it's the default, or `~' if it's the
71 * `cancel' button. The return value is the zero-based index
72 * of the button selected.
1c48db0c 73 */
74
75extern int msg(const char */*buttons*/, const char */*msg*/, ...);
76
77/*----- That's all, folks -------------------------------------------------*/
78
79#ifdef __cplusplus
80 }
81#endif
82
83#endif