chiark / gitweb /
Add documentation for `msg'.
[mgLib] / msg.h
CommitLineData
1c48db0c 1/* -*-c-*-
2 *
ed2737aa 3 * $Id: msg.h,v 1.2 1999/04/29 20:48:13 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
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.h,v $
ed2737aa 32 * Revision 1.2 1999/04/29 20:48:13 mdw
33 * Add documentation for `msg'.
34 *
1c48db0c 35 * Revision 1.1 1998/12/11 09:44:21 mdw
36 * Initial version.
37 *
38 */
39
40#ifndef MSG_H
41#define MSG_H
42
43#ifdef __cplusplus
44 extern "C" {
45#endif
46
47/*----- Header files ------------------------------------------------------*/
48
49#include <gtk/gtk.h>
50
51/*----- Functions provided ------------------------------------------------*/
52
53/* --- @msg@ --- *
54 *
55 * Arguments: @char *buttons@ = the button strings to display
56 * @char *msg@ = the message skeleton string
57 *
58 * Returns: Index of the button selected.
59 *
60 * Use: Displays a message to the user in a nice dialogue box and
61 * returns the index of the button selected.
ed2737aa 62 *
63 * The @msg@ argument is a @printf@-style format string, which
64 * contains the message to actually be shown. The @buttons@
65 * argument is a comma-separated list of buttons to be drawn,
66 * from right to left. A button name can be preceded with `:'
67 * to indicate that it's the default, or `~' if it's the
68 * `cancel' button. The return value is the zero-based index
69 * of the button selected.
1c48db0c 70 */
71
72extern int msg(const char */*buttons*/, const char */*msg*/, ...);
73
74/*----- That's all, folks -------------------------------------------------*/
75
76#ifdef __cplusplus
77 }
78#endif
79
80#endif