GnuCash  4.12-68-g5dc52459a1+
Typedefs | Functions
dialog-progress.h File Reference

API for displaying progress of long-running operations. More...

#include <glib.h>

Go to the source code of this file.

Typedefs

typedef gboolean(* GNCProgressCancelFunc) (gpointer user_data)
 

Functions

GNCProgressDialog * gnc_progress_dialog_new (GtkWidget *parent, gboolean use_ok_button)
 Displays a pop-up dialog for showing the progress of a long-running activity. More...
 
GNCProgressDialog * gnc_progress_dialog_custom (GtkLabel *primary, GtkLabel *secondary, GtkProgressBar *bar, GtkLabel *suboperation, GtkTextView *log)
 Creates a dialog for displaying the progress of an activity using existing widgets. More...
 
void gnc_progress_dialog_set_title (GNCProgressDialog *progress, const char *title)
 Set the title of a pop-up progress dialog. More...
 
void gnc_progress_dialog_set_primary (GNCProgressDialog *progress, const gchar *str)
 Set the primary text of the progress dialog. More...
 
void gnc_progress_dialog_set_heading (GNCProgressDialog *progress, const char *heading)
 Set the primary text of the progress dialog. More...
 
void gnc_progress_dialog_set_secondary (GNCProgressDialog *progress, const gchar *str)
 Set the secondary text of the progress dialog. More...
 
void gnc_progress_dialog_set_sub (GNCProgressDialog *progress, const gchar *str)
 Set the suboperation text of the progress dialog. More...
 
void gnc_progress_dialog_reset_log (GNCProgressDialog *progress)
 Show the progress log and delete any existing text. More...
 
void gnc_progress_dialog_append_log (GNCProgressDialog *progress, const gchar *str)
 Append str to the progress log. More...
 
void gnc_progress_dialog_pause (GNCProgressDialog *progress)
 Show that progress has been paused by appending "(paused)" to the suboperation text, the window title, or the primary text. More...
 
void gnc_progress_dialog_resume (GNCProgressDialog *progress)
 Remove any indication that progress has paused by removing any existing "(paused)" suffix from the suboperation text, the window title, and the primary text. More...
 
void gnc_progress_dialog_set_cancel_func (GNCProgressDialog *progress, GNCProgressCancelFunc cancel_func, gpointer user_data)
 Show a Cancel button and set the C function which will be called when it is pressed by the user. More...
 
void gnc_progress_dialog_set_cancel_scm_func (GNCProgressDialog *progress, SCM cancel_scm_func)
 Show a Cancel button and set the Guile procedure that will be called when it is pressed by the user. More...
 
void gnc_progress_dialog_set_value (GNCProgressDialog *progress, gdouble value)
 Set the fraction of the progress bar to fill, where 0 is empty and 1 is full. More...
 
guint gnc_progress_dialog_push (GNCProgressDialog *progress, gdouble weight)
 Create a new "virtual" progress bar that, as it becomes full, will fill the current bar by the fraction specified by weight. More...
 
guint gnc_progress_dialog_pop (GNCProgressDialog *progress)
 Moves up one level in the stack of virtual bars. More...
 
guint gnc_progress_dialog_pop_full (GNCProgressDialog *progress)
 Fills the current progress bar, then calls gnc_progress_dialog_pop(). More...
 
void gnc_progress_dialog_reset_value (GNCProgressDialog *progress)
 Pop up to the top level and clear the progress bar. More...
 
void gnc_progress_dialog_update (GNCProgressDialog *progress)
 Update the GUI of the progress dialog, and call any pending cancel callbacks. More...
 
void gnc_progress_dialog_finish (GNCProgressDialog *progress)
 Set the progress meter to fully complete, change the heading, if any, to "Complete", enable the 'OK' button, and make the dialog non-modal. More...
 
void gnc_progress_dialog_destroy (GNCProgressDialog *progress)
 Destroy the dialog. More...
 

Detailed Description

API for displaying progress of long-running operations.

Author
Copyright (C) 2000 Dave Peticolas
Copyright (C) 2008 Charles Day

Definition in file dialog-progress.h.