1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
27 #ifndef __GTK_PROGRESS_BAR_H__
28 #define __GTK_PROGRESS_BAR_H__
32 #include <gtk/gtkprogress.h>
37 #define GTK_TYPE_PROGRESS_BAR (gtk_progress_bar_get_type ())
38 #define GTK_PROGRESS_BAR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_PROGRESS_BAR, GtkProgressBar))
39 #define GTK_PROGRESS_BAR_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_PROGRESS_BAR, GtkProgressBarClass))
40 #define GTK_IS_PROGRESS_BAR(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_PROGRESS_BAR))
41 #define GTK_IS_PROGRESS_BAR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PROGRESS_BAR))
42 #define GTK_PROGRESS_BAR_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_PROGRESS_BAR, GtkProgressBarClass))
45 typedef struct _GtkProgressBar GtkProgressBar;
46 typedef struct _GtkProgressBarClass GtkProgressBarClass;
50 GTK_PROGRESS_CONTINUOUS,
52 } GtkProgressBarStyle;
56 GTK_PROGRESS_LEFT_TO_RIGHT,
57 GTK_PROGRESS_RIGHT_TO_LEFT,
58 GTK_PROGRESS_BOTTOM_TO_TOP,
59 GTK_PROGRESS_TOP_TO_BOTTOM
60 } GtkProgressBarOrientation;
62 struct _GtkProgressBar
66 GtkProgressBarStyle bar_style;
67 GtkProgressBarOrientation orientation;
74 guint activity_blocks;
76 gdouble pulse_fraction;
78 guint activity_dir : 1;
82 struct _GtkProgressBarClass
84 GtkProgressClass parent_class;
86 /* Padding for future expansion */
87 void (*_gtk_reserved1) (void);
88 void (*_gtk_reserved2) (void);
89 void (*_gtk_reserved3) (void);
90 void (*_gtk_reserved4) (void);
94 GType gtk_progress_bar_get_type (void) G_GNUC_CONST;
95 GtkWidget* gtk_progress_bar_new (void);
98 * GtkProgress/GtkProgressBar had serious problems in GTK 1.2.
100 * - Only 3 or 4 functions are really needed for 95% of progress
101 * interfaces; GtkProgress[Bar] had about 25 functions, and
102 * didn't even include these 3 or 4.
103 * - In activity mode, the API involves setting the adjustment
104 * to any random value, just to have the side effect of
105 * calling the progress bar update function - the adjustment
106 * is totally ignored in activity mode
107 * - You set the activity step as a pixel value, which means to
108 * set the activity step you basically need to connect to
110 * - There are ctree_set_expander_style()-functions, to randomly
111 * change look-and-feel for no good reason
112 * - The split between GtkProgress and GtkProgressBar makes no sense
115 * This was a big wart on GTK and made people waste lots of time,
116 * both learning and using the interface.
118 * So, I have added what I feel is the correct API, and marked all the
119 * rest deprecated. However, the changes are 100% backward-compatible and
120 * should break no existing code.
122 * The following 9 functions are the new programming interface.
124 void gtk_progress_bar_pulse (GtkProgressBar *pbar);
125 void gtk_progress_bar_set_text (GtkProgressBar *pbar,
127 void gtk_progress_bar_set_fraction (GtkProgressBar *pbar,
130 void gtk_progress_bar_set_pulse_step (GtkProgressBar *pbar,
132 void gtk_progress_bar_set_orientation (GtkProgressBar *pbar,
133 GtkProgressBarOrientation orientation);
135 G_CONST_RETURN gchar* gtk_progress_bar_get_text (GtkProgressBar *pbar);
136 gdouble gtk_progress_bar_get_fraction (GtkProgressBar *pbar);
137 gdouble gtk_progress_bar_get_pulse_step (GtkProgressBar *pbar);
139 GtkProgressBarOrientation gtk_progress_bar_get_orientation (GtkProgressBar *pbar);
140 void gtk_progress_bar_set_ellipsize (GtkProgressBar *pbar,
141 PangoEllipsizeMode mode);
142 PangoEllipsizeMode gtk_progress_bar_get_ellipsize (GtkProgressBar *pbar);
145 #ifndef GTK_DISABLE_DEPRECATED
147 /* Everything below here is deprecated */
148 GtkWidget* gtk_progress_bar_new_with_adjustment (GtkAdjustment *adjustment);
149 void gtk_progress_bar_set_bar_style (GtkProgressBar *pbar,
150 GtkProgressBarStyle style);
151 void gtk_progress_bar_set_discrete_blocks (GtkProgressBar *pbar,
153 /* set_activity_step() is not only deprecated, it doesn't even work.
154 * (Of course, it wasn't usable anyway, you had to set it from a size_allocate
155 * handler or something)
157 void gtk_progress_bar_set_activity_step (GtkProgressBar *pbar,
159 void gtk_progress_bar_set_activity_blocks (GtkProgressBar *pbar,
161 void gtk_progress_bar_update (GtkProgressBar *pbar,
164 #endif /* GTK_DISABLE_DEPRECATED */
168 #endif /* __GTK_PROGRESS_BAR_H__ */