chiark - git - mdw - mgLib/blob - msg.h

   1 /* -*-c-*-
   2  *
   3  * $Id: msg.h,v 1.6 2002/01/13 14:32:23 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 /*----- Revision history --------------------------------------------------*
  31  *
  32  * $Log: msg.h,v $
  33  * Revision 1.6  2002/01/13 14:32:23  mdw
  34  * Allow control over the message box title.
  35  *
  36  * Revision 1.5  2000/08/15 22:40:15  mdw
  37  * Change guard constants.
  38  *
  39  * Revision 1.4  1999/05/06 19:51:48  mdw
  40  * Reformatted the LGPL notice a little bit.
  41  *
  42  * Revision 1.3  1999/05/05 18:52:45  mdw
  43  * Change licensing conditions to LGPL.
  44  *
  45  * Revision 1.2  1999/04/29 20:48:13  mdw
  46  * Add documentation for `msg'.
  47  *
  48  * Revision 1.1  1998/12/11 09:44:21  mdw
  49  * Initial version.
  50  *
  51  */
  52
  53 #ifndef MGLIB_MSG_H
  54 #define MGLIB_MSG_H
  55
  56 #ifdef __cplusplus
  57   extern "C" {
  58 #endif
  59
  60 /*----- Header files ------------------------------------------------------*/
  61
  62 #include <gtk/gtk.h>
  63
  64 /*----- Functions provided ------------------------------------------------*/
  65
  66 /* --- @msg@ --- *
  67  *
  68  * Arguments:   @const char *title@ = the title for the message box
  69  *              @const char *buttons@ = the button strings to display
  70  *              @const char *msg@ = the message skeleton string
  71  *
  72  * Returns:     Index of the button selected.
  73  *
  74  * Use:         Displays a message to the user in a nice dialogue box and
  75  *              returns the index of the button selected.
  76  *
  77  *              The @msg@ argument is a @printf@-style format string, which
  78  *              contains the message to actually be shown.  The @buttons@
  79  *              argument is a comma-separated list of buttons to be drawn,
  80  *              from right to left.  A button name can be preceded with `:'
  81  *              to indicate that it's the default, or `~' if it's the
  82  *              `cancel' button.  The return value is the zero-based index
  83  *              of the button selected.
  84  */
  85
  86 extern int msg(const char */*msg*/, const char */*buttons*/,
  87                const char */*msg*/, ...);
  88
  89 /*----- That's all, folks -------------------------------------------------*/
  90
  91 #ifdef __cplusplus
  92   }
  93 #endif
  94
  95 #endif