chiark / gitweb /
Kill most of old Disobedience man page, copying remaining text to a
[disorder] / disobedience / progress.c
1 /*
2  * This file is part of DisOrder.
3  * Copyright (C) 2006, 2007 Richard Kettlewell
4  *
5  * This program is free software: you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation, either version 3 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  * 
15  * You should have received a copy of the GNU General Public License
16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
17  */
18 /** @file disobedience/progress.c
19  * @brief Progress bar support
20  */
21
22 #include "disobedience.h"
23
24 /** @brief State for progress windows */
25 struct progress_window {
26   /** @brief The window */
27   GtkWidget *window;
28   /** @brief The bar */
29   GtkWidget *bar;
30 };
31
32 /** @brief Create a progress window */
33 struct progress_window *progress_window_new(const char *title,
34                                             GtkWidget *parent) {
35   struct progress_window *pw = xmalloc(sizeof *pw);
36
37   pw->window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
38   if(parent)
39     gtk_window_set_transient_for(GTK_WINDOW(pw->window),
40                                  GTK_WINDOW(parent));
41   g_signal_connect(pw->window, "destroy",
42                    G_CALLBACK(gtk_widget_destroyed), &pw->window);
43   gtk_window_set_default_size(GTK_WINDOW(pw->window), 360, -1);
44   gtk_window_set_title(GTK_WINDOW(pw->window), title);
45   pw->bar = gtk_progress_bar_new();
46   gtk_container_add(GTK_CONTAINER(pw->window), pw->bar);
47   gtk_widget_show_all(pw->window);
48   return pw;
49 }
50
51 /** @brief Report current progress
52  * The window is automatically destroyed if @p progress >= @p limit.
53  * To cancel a window just call with both set to 0.
54  */
55 void progress_window_progress(struct progress_window *pw,
56                               int progress,
57                               int limit) {
58   if(!pw)
59     return;
60   /* Maybe the user closed the window */
61   if(!pw->window)
62     return;
63   /* Clamp insane or inconvenient values */
64   if(limit <= 0)
65     progress = limit = 1;
66   if(progress < 0)
67     progress = 0;
68   /* Maybe we're done */
69   if(progress >= limit) {
70     gtk_widget_destroy(pw->window);
71     pw->window = pw->bar = 0;
72     return;
73   }
74   /* Display current progress */
75   gtk_progress_bar_set_fraction(GTK_PROGRESS_BAR(pw->bar),
76                                 (double)progress / limit);
77 }
78
79 /*
80 Local Variables:
81 c-basic-offset:2
82 comment-column:40
83 fill-column:79
84 indent-tabs-mode:nil
85 End:
86 */