progress_dlg.h

   1 /* progress_dlg.h
   2  * Definitions for progress dialog box routines
   3  *
   4  * $Id: progress_dlg.h,v 1.1 2001/03/24 02:07:20 guy Exp $
   5  *
   6  * Ethereal - Network traffic analyzer
   7  * By Gerald Combs <gerald@zing.org>
   8  * Copyright 1998 Gerald Combs
   9  *
  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 __PROGRESS_DLG_H__
  27 #define __PROGRESS_DLG_H__
  28
  29 /*
  30  * Progress (modal) dialog box routines.
  31  */
  32
  33 struct progdlg;
  34
  35 typedef struct progdlg progdlg_t;
  36
  37 /*
  38  * Create and pop up the progress dialog; allocate a "progdlg_t"
  39  * and initialize it to contain all information the implementation
  40  * needs in order to manipulate the dialog, and return a pointer to
  41  * it.
  42  *
  43  * The first argument is the title to give the dialog box; the second
  44  * argument is the string to put in the "stop this operation" button;
  45  * the third argument is a pointer to a Boolean variable that will be
  46  * set to TRUE if the user hits that button.
  47  */
  48 progdlg_t *create_progress_dlg(const gchar *title, const gchar *stop_title,
  49     gboolean *stop_flag);
  50
  51 /*
  52  * Set the percentage value of the progress bar.
  53  */
  54 void update_progress_dlg(progdlg_t *dlg, gfloat percentage);
  55
  56 /*
  57  * Destroy the progress bar.
  58  */
  59 void destroy_progress_dlg(progdlg_t *dlg);
  60
  61 #endif /* __PROGRESS_DLG_H__ */