aboutsummaryrefslogtreecommitdiffstats
path: root/ui/progress_dlg.h
diff options
context:
space:
mode:
authorGerald Combs <gerald@wireshark.org>2012-07-19 21:49:52 +0000
committerGerald Combs <gerald@wireshark.org>2012-07-19 21:49:52 +0000
commit0da59a005829eb5daf49c6477219a35ac4e73ab3 (patch)
tree0890e6704f36a03fa1d444d4ad8e25411ec36f34 /ui/progress_dlg.h
parentbdb0898ff8fccc3a7fba48bd36c8a13899745177 (diff)
Pass {delayed_}create_progress_dlg a pointer the top level window
so that we can properly associate a widget with create, update, and destroy events. Only used by Qt so far but it should be easy enough to add to GTK+. Rename ui/qt/progress_dialog.{h,cpp} to progress_bar.{h,cpp}. Show a progress bar in the status bar of the main window instead of creating a separate dialog. Note that we still need to add a "cancel" mechanism and display the task and item titles somewhere. Thus began the War Against Gratuitous Dialogs. svn path=/trunk/; revision=43833
Diffstat (limited to 'ui/progress_dlg.h')
-rw-r--r--ui/progress_dlg.h38
1 files changed, 21 insertions, 17 deletions
diff --git a/ui/progress_dlg.h b/ui/progress_dlg.h
index d145750dd8..4531ade197 100644
--- a/ui/progress_dlg.h
+++ b/ui/progress_dlg.h
@@ -46,52 +46,56 @@ typedef struct progdlg progdlg_t;
* needs in order to manipulate the dialog, and return a pointer to
* it.
*
- * @param task_title the task to do, e.g. "Loading"
- * @param item_title the item to do, e.g. "capture.cap"
+ * @param widget UI widget to associate with the progress dialog, e.g.
+ * the main window.
+ * @param task_title The task to do, e.g. "Loading"
+ * @param item_title The item to do, e.g. "capture.cap"
* @param terminate_is_stop TRUE if the operation can't be cancelled, just
* stopped (i.e., it has a "Stop" button and clicking it doesn't undo
* anything already done), FALSE if it can
- * @param stop_flag a pointer to a Boolean variable that will be
+ * @param stop_flag A pointer to a Boolean variable that will be
* set to TRUE if the user hits that button
- * @return the newly created progress dialog
+ * @return The newly created progress dialog
*/
-progdlg_t *create_progress_dlg(const gchar *task_title, const gchar *item_title,
+progdlg_t *create_progress_dlg(const gpointer top_level_window, const gchar *task_title, const gchar *item_title,
gboolean terminate_is_stop, gboolean *stop_flag);
/**
* Create a progress dialog, but only if it's not likely to disappear
* immediately. This can be disconcerting for the user.
*
- * @param task_title the task to do, e.g. "Loading"
- * @param item_title the item to do, e.g. "capture.cap"
+ * @param top_level The top-level window associated with the progress update.
+ * May be NULL.
+ * @param task_title The task to do, e.g. "Loading"
+ * @param item_title The item to do, e.g. "capture.cap"
* @param terminate_is_stop TRUE if the operation can't be cancelled, just
* stopped (i.e., it has a "Stop" button and clicking it doesn't undo
* anything already done), FALSE if it can
- * @param stop_flag a pointer to a Boolean variable that will be
+ * @param stop_flag A pointer to a Boolean variable that will be
* set to TRUE if the user hits that button
- * @param start_time a pointer to a GTimeVal structure which holds
+ * @param start_time A pointer to a GTimeVal structure which holds
* the time at which the caller started to process the data
- * @param progress the current progress (0..1)
- * @return the newly created progress dialog
+ * @param progress The current progress (0..1)
+ * @return The newly created progress dialog
*/
progdlg_t *
-delayed_create_progress_dlg(const gchar *task_title, const gchar *item_title,
+delayed_create_progress_dlg(const gpointer top_level_window, const gchar *task_title, const gchar *item_title,
gboolean terminate_is_stop, gboolean *stop_flag,
const GTimeVal *start_time, gfloat progress);
/**
* Update the progress information of the progress dialog box.
*
- * @param dlg the progress dialog from create_progress_dlg()
- * @param percentage the current percentage value (0..1)
- * @param status the new status string to show, e.g. "3000KB of 6000KB"
+ * @param dlg The progress dialog from create_progress_dlg()
+ * @param percentage The current percentage value (0..1)
+ * @param status the New status string to show, e.g. "3000KB of 6000KB"
*/
void update_progress_dlg(progdlg_t *dlg, gfloat percentage, const gchar *status);
/**
- * Destroy the progress bar.
+ * Destroy or hide the progress bar.
*
- * @param dlg the progress dialog from create_progress_dlg()
+ * @param dlg The progress dialog from create_progress_dlg()
*/
void destroy_progress_dlg(progdlg_t *dlg);