Move some headers for UI stuff, and the alert_box.c UI-specific file, to

the ui directory.  (Perhaps some other files that would be used by all
flavors of Wireshark, for any GUI toolkit or for someting such as
ncurses, and not for any command-line tool such as TShark, should be
moved there as well.)

Shuffle some #includes to put the "ui/XXX.h" includes together.

svn path=/trunk/; revision=40529

1 files changed, 168 insertions, 0 deletions

diff --git a/ui/simple_dialog.h b/ui/simple_dialog.h
new file mode 100644
index 0000000000..7687b4e77b
--- /dev/null
+++ b/ui/simple_dialog.h
@@ -0,0 +1,168 @@
+/* simple_dialog.h
+ * Definitions for alert box routines with toolkit-independent APIs but
+ * toolkit-dependent implementations.
+ *
+ * $Id$
+ *
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
+ * Copyright 1998 Gerald Combs
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ */
+
+#ifndef __DIALOG_H__
+#define __DIALOG_H__
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+/** @file
+ *  Simple dialog box.
+ *  @ingroup dialog_group
+ */
+
+
+/** Dialog types. */
+typedef enum {
+    ESD_TYPE_INFO,          /**< tells the user something they should know, but not requiring
+                                    any action; the only button should be "OK" */
+    ESD_TYPE_WARN,          /**< tells the user about a problem; the only button should be "OK" */
+    ESD_TYPE_CONFIRMATION,  /**< asks the user for confirmation; there should be more than
+                                    one button */
+    ESD_TYPE_ERROR,         /**< tells the user about a serious problem; the only button should be "OK" */
+    ESD_TYPE_STOP           /**< tells the user a stop action is in progress, there should be no button */
+} ESD_TYPE_E;
+
+/** display no buttons at all */
+#define ESD_BTN_NONE   0x00
+/** display an "Ok" button */
+#define ESD_BTN_OK     0x01
+/** display a "Cancel" button */
+#define ESD_BTN_CANCEL 0x02
+/** display a "Yes" button */
+#define ESD_BTN_YES    0x04
+/** display a "No" button */
+#define ESD_BTN_NO     0x08
+/** display a "Clear" button */
+#define ESD_BTN_CLEAR  0x10
+/** display a "Save" button */
+#define ESD_BTN_SAVE   0x20
+/** display a "Continue without Saving" button */
+#define ESD_BTN_DONT_SAVE 0x40
+/** display a "Quit without Saving" button */
+#define ESD_BTN_QUIT_DONT_SAVE 0x80
+
+/** Standard button combination "Ok" + "Cancel". */
+#define ESD_BTNS_OK_CANCEL	(ESD_BTN_OK|ESD_BTN_CANCEL)
+/** Standard button combination "Yes" + "No". */
+#define ESD_BTNS_YES_NO		(ESD_BTN_YES|ESD_BTN_NO)
+/** Standard button combination "Yes" + "No" + "Cancel". */
+#define ESD_BTNS_YES_NO_CANCEL	(ESD_BTN_YES|ESD_BTN_NO|ESD_BTN_CANCEL)
+/** Standard button combination "No" + "Cancel" + "Save". */
+#define ESD_BTNS_SAVE_DONTSAVE_CANCEL (ESD_BTN_DONT_SAVE|ESD_BTN_CANCEL|ESD_BTN_SAVE)
+/** Standard button combination "Quit without saving" + "Cancel" + "Save". */
+#define ESD_BTNS_SAVE_QUIT_DONTSAVE_CANCEL (ESD_BTN_QUIT_DONT_SAVE|ESD_BTN_CANCEL|ESD_BTN_SAVE)
+/** Standard button combination "Quit without saving" + "Cancel". */
+#define ESD_BTNS_QUIT_DONTSAVE_CANCEL (ESD_BTN_QUIT_DONT_SAVE|ESD_BTN_CANCEL)
+
+/** Create and show a simple dialog.
+ *
+ * @param type type of dialog
+ * @param btn_mask the buttons to display
+ * @param msg_format printf like message format
+ * @param ... printf like parameters
+ * @return the newly created dialog
+ */
+extern gpointer simple_dialog(ESD_TYPE_E type, gint btn_mask,
+    const gchar *msg_format, ...)
+    G_GNUC_PRINTF(3, 4);
+
+/** Create and show a simple dialog using a va_list.
+ *
+ * @param type type of dialog
+ * @param btn_mask the buttons to display
+ * @param msg_format printf like message format
+ * @param ap parameters
+ * @return the newly created dialog
+ */
+extern gpointer vsimple_dialog(ESD_TYPE_E type, gint btn_mask,
+   const gchar *msg_format, va_list ap);
+
+/** Callback function type for simple_dialog_set_cb() */
+typedef void (* simple_dialog_cb_t) (gpointer dialog, gint btn, gpointer data);
+
+/** Set the callback function for the dialog, called when a button was pressed.
+ *
+ * @param dialog the dialog from simple_dialog()
+ * @param callback_fct the callback function to set
+ * @param data data to be passed to the callback function
+ */
+extern void simple_dialog_set_cb(gpointer dialog, simple_dialog_cb_t callback_fct, gpointer data);
+
+/** Close the dialog, useful for "no button" dialogs.
+ *
+ * @param dialog the dialog to close from simple_dialog()
+ */
+extern void simple_dialog_close(gpointer dialog);
+
+/** Add a check button to the dialog (e.g. "Don't show this message again")
+ *
+ * @param dialog the dialog from simple_dialog()
+ * @param text the text to display
+ */
+extern void simple_dialog_check_set(gpointer dialog, gchar *text);
+
+/** Get the check buttons state.
+ *
+ * @param dialog the dialog from simple_dialog()
+ * @return current button state (TRUE is checked)
+ */
+extern gboolean simple_dialog_check_get(gpointer dialog);
+
+/** Surround the primary dialog message text by
+ *  simple_dialog_primary_start() and simple_dialog_primary_end().
+ *  To highlight the first sentence (will take effect on GTK2 only).
+ */
+extern char *simple_dialog_primary_start(void);
+/** Surround the primary dialog message text by
+ *  simple_dialog_primary_start() and simple_dialog_primary_end().
+ *  To highlight the first sentence (will take effect on GTK2 only).
+ */
+extern char *simple_dialog_primary_end(void);
+
+/** Escape the message text, if it probably contains Pango escape sequences.
+ *  For example html like tags starting with a <.
+ *
+ * @param msg the string to escape
+ * @return the escaped message text, must be freed with g_free() later
+ */
+extern char *simple_dialog_format_message(const char *msg);
+
+/**
+ * Display all queued messages.
+ * If a routine is called to display a dialog before there are any windows
+ * open, information to use to display the dialog is queued up.  This
+ * routine should be called once there are windows open, so that the queued
+ * up dialogs are displayed on top of those windows.
+ */
+extern void display_queued_messages(void);
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
+#endif /* __DIALOG_H__ */