chiark / gitweb /
debian: Fix package sections.
[mgLib] / msg.h
... / ...
CommitLineData
1/* -*-c-*-
2 *
3 * $Id: msg.h,v 1.7 2004/04/08 01:36:14 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 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.
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 Library General Public License for more details.
23 *
24 * You should have received a copy of the GNU Library General Public
25 * License along with mgLib; if not, write to the Free
26 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
27 * MA 02111-1307, USA.
28 */
29
30#ifndef MGLIB_MSG_H
31#define MGLIB_MSG_H
32
33#ifdef __cplusplus
34 extern "C" {
35#endif
36
37/*----- Header files ------------------------------------------------------*/
38
39#include <gtk/gtk.h>
40
41/*----- Functions provided ------------------------------------------------*/
42
43/* --- @msg@ --- *
44 *
45 * Arguments: @const char *title@ = the title for the message box
46 * @const char *buttons@ = the button strings to display
47 * @const char *msg@ = the message skeleton string
48 *
49 * Returns: Index of the button selected.
50 *
51 * Use: Displays a message to the user in a nice dialogue box and
52 * returns the index of the button selected.
53 *
54 * The @msg@ argument is a @printf@-style format string, which
55 * contains the message to actually be shown. The @buttons@
56 * argument is a comma-separated list of buttons to be drawn,
57 * from right to left. A button name can be preceded with `:'
58 * to indicate that it's the default, or `~' if it's the
59 * `cancel' button. The return value is the zero-based index
60 * of the button selected.
61 */
62
63extern int msg(const char */*msg*/, const char */*buttons*/,
64 const char */*msg*/, ...);
65
66/*----- That's all, folks -------------------------------------------------*/
67
68#ifdef __cplusplus
69 }
70#endif
71
72#endif