CMake: Allow setting per target compiler warnings

[metze/wireshark/wip.git] / ui / progress_dlg.h

diff --git a/ui/progress_dlg.h b/ui/progress_dlg.h
index 638c8a3cca5959626393b60de4de4ae28ce5bb77..531784679ef275f920a9f892073e3d567e23f9e8 100644 (file)
--- a/ui/progress_dlg.h
+++ b/ui/progress_dlg.h
@@ -1,8 +1,6 @@
 /* progress_dlg.h
  * Definitions for progress dialog box routines
  *
- * $Id$
- *
  * Wireshark - Network traffic analyzer
  * By Gerald Combs <gerald@wireshark.org>
  * Copyright 1998 Gerald Combs
@@ -19,7 +17,7 @@
  *
  * 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.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
 #ifndef __PROGRESS_DLG_H__
@@ -46,52 +44,55 @@ 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 top_level_window 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(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_window 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,
+progdlg_t *delayed_create_progress_dlg(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);
 
@@ -100,3 +101,16 @@ void destroy_progress_dlg(progdlg_t *dlg);
 #endif /* __cplusplus */
 
 #endif /* __PROGRESS_DLG_H__ */
+
+/*
+ * Editor modelines
+ *
+ * Local Variables:
+ * c-basic-offset: 4
+ * tab-width: 8
+ * indent-tabs-mode: nil
+ * End:
+ *
+ * ex: set shiftwidth=4 tabstop=8 expandtab:
+ * :indentSize=4:tabSize=8:noTabs=true:
+ */