dialog-progress.h

Go to the documentation of this file.

/********************************************************************\
 * dialog-progress.h -- public GnuCash progress dialog functions    *
 * Copyright (C) 2000 Dave Peticolas                                *
 *                                                                  *
 * 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, contact:                        *
 *                                                                  *
 * Free Software Foundation           Voice:  +1-617-542-5942       *
 * 51 Franklin Street, Fifth Floor    Fax:    +1-617-542-2652       *
 * Boston, MA  02110-1301,  USA       gnu@gnu.org                   *
 *                                                                  *
\********************************************************************/

#ifndef DIALOG_PROGRESS_H
#define DIALOG_PROGRESS_H

#include <glib.h>


typedef struct _GNCProgressDialog GNCProgressDialog;

typedef gboolean (*GNCProgressCancelFunc) (gpointer user_data);


GNCProgressDialog * gnc_progress_dialog_new(GtkWidget *parent,
        gboolean use_ok_button);

GNCProgressDialog * gnc_progress_dialog_custom(GtkLabel       *primary,
        GtkLabel       *secondary,
        GtkProgressBar *bar,
        GtkLabel       *suboperation,
        GtkTextView    *log);

void gnc_progress_dialog_set_title(GNCProgressDialog *progress,
                                   const char *title);

void gnc_progress_dialog_set_primary(GNCProgressDialog *progress,
                                     const gchar *str);

void gnc_progress_dialog_set_heading(GNCProgressDialog *progress,
                                     const char *heading);

void gnc_progress_dialog_set_secondary(GNCProgressDialog *progress,
                                       const gchar *str);

void gnc_progress_dialog_set_sub(GNCProgressDialog *progress,
                                 const gchar *str);

void gnc_progress_dialog_reset_log(GNCProgressDialog *progress);

void gnc_progress_dialog_append_log(GNCProgressDialog *progress,
                                    const gchar *str);

void gnc_progress_dialog_pause(GNCProgressDialog *progress);

void gnc_progress_dialog_resume(GNCProgressDialog *progress);

void gnc_progress_dialog_set_cancel_func(GNCProgressDialog *progress,
        GNCProgressCancelFunc cancel_func,
        gpointer user_data);

void gnc_progress_dialog_set_cancel_scm_func(GNCProgressDialog *progress,
        SCM cancel_scm_func);

void gnc_progress_dialog_set_value(GNCProgressDialog *progress, gdouble value);

guint gnc_progress_dialog_push(GNCProgressDialog *progress, gdouble weight);

guint gnc_progress_dialog_pop(GNCProgressDialog *progress);

guint gnc_progress_dialog_pop_full(GNCProgressDialog *progress);

void gnc_progress_dialog_reset_value(GNCProgressDialog *progress);

void gnc_progress_dialog_update(GNCProgressDialog *progress);

void gnc_progress_dialog_finish(GNCProgressDialog *progress);

void gnc_progress_dialog_destroy(GNCProgressDialog *progress);

#endif