From Ulf Lamping: extend the progress dialog box to give more progress

[obnox/wireshark/wip.git] / progress_dlg.h

diff --git a/progress_dlg.h b/progress_dlg.h
index 2afb7ef31a3dc3d6e4405642073b38f38f64b93b..974a4ce807fccd3969919d4ea2cc3e5b99e09564 100644 (file)
--- a/progress_dlg.h
+++ b/progress_dlg.h
@@ -1,12 +1,11 @@
 /* progress_dlg.h
  * Definitions for progress dialog box routines
  *
- * $Id: progress_dlg.h,v 1.2 2002/07/30 10:13:14 guy Exp $
+ * $Id: progress_dlg.h,v 1.3 2002/08/28 10:07:28 guy Exp $
  *
  * Ethereal - Network traffic analyzer
- * By Gerald Combs <gerald@zing.org>
+ * By Gerald Combs <gerald@ethereal.com>
  * 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
@@ -40,30 +39,32 @@ typedef struct progdlg progdlg_t;
  * needs in order to manipulate the dialog, and return a pointer to
  * it.
  *
- * The first argument is the title to give the dialog box; the second
- * argument is the string to put in the "stop this operation" button;
- * the third argument is a pointer to a Boolean variable that will be
- * set to TRUE if the user hits that button.
+ * The first argument is the task to do, e.g. "Loading".
+ * The second argument is the item to do, e.g. "capture.cap".
+ * The third argument is the string to put in the "stop this operation" button.
+ * The fourth argument is a pointer to a Boolean variable that will be
+ *   set to TRUE if the user hits that button.
  */
-progdlg_t *create_progress_dlg(const gchar *title, const gchar *stop_title,
-    gboolean *stop_flag);
+progdlg_t *create_progress_dlg(const gchar *task_title, const gchar *item_title, 
+    const gchar *stop_title, gboolean *stop_flag);
 
 /* Create a progress dialog, but only if it's not likely to disappear
  * immediately, which can be disconcerting for the user.
  *
- * The first three arguments are as for create_progress_dlg().
+ * The first four arguments are as for create_progress_dlg().
  * Following those is a pointer to a GTimeVal structure which holds
  * the time at which the caller started to process the data, and the
  * current progress (0..1).
  */
-progdlg_t *delayed_create_progress_dlg(const gchar *title,
+progdlg_t *
+delayed_create_progress_dlg(const gchar *task_title, const gchar *item_title, 
     const gchar *stop_title, gboolean *stop_flag, GTimeVal *start_time,
     gfloat progress);
 
 /*
- * Set the percentage value of the progress bar.
+ * Update the progress information of the progress dialog box.
  */
-void update_progress_dlg(progdlg_t *dlg, gfloat percentage);
+void update_progress_dlg(progdlg_t *dlg, gfloat percentage, gchar *status);
 
 /*
  * Destroy the progress bar.