simple_dialog.h

   1 /* simple_dialog.h
   2  * Definitions for alert box routines with toolkit-independent APIs but
   3  * toolkit-dependent implementations.
   4  *
   5  * $Id$
   6  *
   7  * Wireshark - Network traffic analyzer
   8  * By Gerald Combs <gerald@wireshark.org>
   9  * Copyright 1998 Gerald Combs
  10  *
  11  * This program is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU General Public License
  13  * as published by the Free Software Foundation; either version 2
  14  * of the License, or (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  24  */
  25
  26 #ifndef __DIALOG_H__
  27 #define __DIALOG_H__
  28
  29 #include <epan/gnuc_format_check.h>
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif /* __cplusplus */
  34
  35 /** @file
  36  *  Simple dialog box.
  37  *  @ingroup dialog_group
  38  */
  39
  40
  41 /** Dialog types. */
  42 typedef enum {
  43     ESD_TYPE_INFO,          /**< tells the user something they should know, but not requiring
  44                                     any action; the only button should be "OK" */
  45     ESD_TYPE_WARN,          /**< tells the user about a problem; the only button should be "OK" */
  46     ESD_TYPE_CONFIRMATION,  /**< asks the user for confirmation; there should be more than
  47                                     one button */
  48     ESD_TYPE_ERROR,         /**< tells the user about a serious problem; the only button should be "OK" */
  49     ESD_TYPE_STOP           /**< tells the user a stop action is in progress, there should be no button */
  50 } ESD_TYPE_E;
  51
  52 /** display no buttons at all */
  53 #define ESD_BTN_NONE   0x00
  54 /** display an "Ok" button */
  55 #define ESD_BTN_OK     0x01
  56 /** display a "Cancel" button */
  57 #define ESD_BTN_CANCEL 0x02
  58 /** display a "Yes" button */
  59 #define ESD_BTN_YES    0x04
  60 /** display a "No" button */
  61 #define ESD_BTN_NO     0x08
  62 /** display a "Clear" button */
  63 #define ESD_BTN_CLEAR  0x10
  64 /** display a "Save" button */
  65 #define ESD_BTN_SAVE   0x20
  66 /** display a "Continue without Saving" button */
  67 #define ESD_BTN_DONT_SAVE 0x40
  68 /** display a "Quit without Saving" button */
  69 #define ESD_BTN_QUIT_DONT_SAVE 0x80
  70
  71 /** Standard button combination "Ok" + "Cancel". */
  72 #define ESD_BTNS_OK_CANCEL      (ESD_BTN_OK|ESD_BTN_CANCEL)
  73 /** Standard button combination "Yes" + "No". */
  74 #define ESD_BTNS_YES_NO         (ESD_BTN_YES|ESD_BTN_NO)
  75 /** Standard button combination "Yes" + "No" + "Cancel". */
  76 #define ESD_BTNS_YES_NO_CANCEL  (ESD_BTN_YES|ESD_BTN_NO|ESD_BTN_CANCEL)
  77 /** Standard button combination "No" + "Cancel" + "Save". */
  78 #define ESD_BTNS_SAVE_DONTSAVE_CANCEL (ESD_BTN_DONT_SAVE|ESD_BTN_CANCEL|ESD_BTN_SAVE)
  79 /** Standard button combination "Quit without saving" + "Cancel" + "Save". */
  80 #define ESD_BTNS_SAVE_QUIT_DONTSAVE_CANCEL (ESD_BTN_QUIT_DONT_SAVE|ESD_BTN_CANCEL|ESD_BTN_SAVE)
  81
  82 /** Create and show a simple dialog.
  83  *
  84  * @param type type of dialog
  85  * @param btn_mask the buttons to display
  86  * @param msg_format printf like message format
  87  * @param ... printf like parameters
  88  * @return the newly created dialog
  89  */
  90 extern gpointer simple_dialog(ESD_TYPE_E type, gint btn_mask,
  91     const gchar *msg_format, ...)
  92     GNUC_FORMAT_CHECK(printf, 3, 4);
  93 /** Create and show a simple dialog using a va_list.
  94  *
  95  * @param type type of dialog
  96  * @param btn_mask the buttons to display
  97  * @param msg_format printf like message format
  98  * @param ap parameters
  99  * @return the newly created dialog
 100  */
 101 extern gpointer vsimple_dialog(ESD_TYPE_E type, gint btn_mask,
 102    const gchar *msg_format, va_list ap);
 103
 104 /** Callback function type for simple_dialog_set_cb() */
 105 typedef void (* simple_dialog_cb_t) (gpointer dialog, gint btn, gpointer data);
 106
 107 /** Set the callback function for the dialog, called when a button was pressed.
 108  *
 109  * @param dialog the dialog from simple_dialog()
 110  * @param callback_fct the callback function to set
 111  * @param data data to be passed to the callback function
 112  */
 113 extern void simple_dialog_set_cb(gpointer dialog, simple_dialog_cb_t callback_fct, gpointer data);
 114
 115 /** Close the dialog, useful for "no button" dialogs.
 116  *
 117  * @param dialog the dialog to close from simple_dialog()
 118  */
 119 extern void simple_dialog_close(gpointer dialog);
 120
 121 /** Add a check button to the dialog (e.g. "Don't show this message again")
 122  *
 123  * @param dialog the dialog from simple_dialog()
 124  * @param text the text to display
 125  */
 126 extern void simple_dialog_check_set(gpointer dialog, gchar *text);
 127
 128 /** Get the check buttons state.
 129  *
 130  * @param dialog the dialog from simple_dialog()
 131  * @return current button state (TRUE is checked)
 132  */
 133 extern gboolean simple_dialog_check_get(gpointer dialog);
 134
 135 /** Surround the primary dialog message text by
 136  *  simple_dialog_primary_start() and simple_dialog_primary_end().
 137  *  To highlight the first sentence (will take effect on GTK2 only).
 138  */
 139 extern char *simple_dialog_primary_start(void);
 140 /** Surround the primary dialog message text by
 141  *  simple_dialog_primary_start() and simple_dialog_primary_end().
 142  *  To highlight the first sentence (will take effect on GTK2 only).
 143  */
 144 extern char *simple_dialog_primary_end(void);
 145
 146 /** Escape the message text, if it probably contains Pango escape sequences.
 147  *  For example html like tags starting with a <.
 148  *
 149  * @param msg the string to escape
 150  * @return the escaped message text, must be freed with g_free() later
 151  */
 152 extern char *simple_dialog_format_message(const char *msg);
 153
 154 /**
 155  * Display all queued messages.
 156  * If a routine is called to display a dialog before there are any windows
 157  * open, information to use to display the dialog is queued up.  This
 158  * routine should be called once there are windows open, so that the queued
 159  * up dialogs are displayed on top of those windows.
 160  */
 161 extern void display_queued_messages(void);
 162
 163 #ifdef __cplusplus
 164 }
 165 #endif /* __cplusplus */
 166
 167 #endif /* __DIALOG_H__ */