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;
83 struct _GtkProgressBarClass
85 GtkProgressClass parent_class;
87 /* Padding for future expansion */
88 void (*_gtk_reserved1) (void);
89 void (*_gtk_reserved2) (void);
90 void (*_gtk_reserved3) (void);
91 void (*_gtk_reserved4) (void);
95 GType gtk_progress_bar_get_type (void) G_GNUC_CONST;
96 GtkWidget* gtk_progress_bar_new (void);
99 * GtkProgress/GtkProgressBar had serious problems in GTK 1.2.
101 * - Only 3 or 4 functions are really needed for 95% of progress
102 * interfaces; GtkProgress[Bar] had about 25 functions, and
103 * didn't even include these 3 or 4.
104 * - In activity mode, the API involves setting the adjustment
105 * to any random value, just to have the side effect of
106 * calling the progress bar update function - the adjustment
107 * is totally ignored in activity mode
108 * - You set the activity step as a pixel value, which means to
109 * set the activity step you basically need to connect to
111 * - There are ctree_set_expander_style()-functions, to randomly
112 * change look-and-feel for no good reason
113 * - The split between GtkProgress and GtkProgressBar makes no sense
116 * This was a big wart on GTK and made people waste lots of time,
117 * both learning and using the interface.
119 * So, I have added what I feel is the correct API, and marked all the
120 * rest deprecated. However, the changes are 100% backward-compatible and
121 * should break no existing code.
123 * The following 9 functions are the new programming interface.
125 void gtk_progress_bar_pulse (GtkProgressBar *pbar);
126 void gtk_progress_bar_set_text (GtkProgressBar *pbar,
128 void gtk_progress_bar_set_fraction (GtkProgressBar *pbar,
131 void gtk_progress_bar_set_pulse_step (GtkProgressBar *pbar,
133 void gtk_progress_bar_set_orientation (GtkProgressBar *pbar,
134 GtkProgressBarOrientation orientation);
136 G_CONST_RETURN gchar* gtk_progress_bar_get_text (GtkProgressBar *pbar);
137 gdouble gtk_progress_bar_get_fraction (GtkProgressBar *pbar);
138 gdouble gtk_progress_bar_get_pulse_step (GtkProgressBar *pbar);
140 GtkProgressBarOrientation gtk_progress_bar_get_orientation (GtkProgressBar *pbar);
141 void gtk_progress_bar_set_ellipsize (GtkProgressBar *pbar,
142 PangoEllipsizeMode mode);
143 PangoEllipsizeMode gtk_progress_bar_get_ellipsize (GtkProgressBar *pbar);
146 #ifndef GTK_DISABLE_DEPRECATED
148 /* Everything below here is deprecated */
149 GtkWidget* gtk_progress_bar_new_with_adjustment (GtkAdjustment *adjustment);
150 void gtk_progress_bar_set_bar_style (GtkProgressBar *pbar,
151 GtkProgressBarStyle style);
152 void gtk_progress_bar_set_discrete_blocks (GtkProgressBar *pbar,
154 /* set_activity_step() is not only deprecated, it doesn't even work.
155 * (Of course, it wasn't usable anyway, you had to set it from a size_allocate
156 * handler or something)
158 void gtk_progress_bar_set_activity_step (GtkProgressBar *pbar,
160 void gtk_progress_bar_set_activity_blocks (GtkProgressBar *pbar,
162 void gtk_progress_bar_update (GtkProgressBar *pbar,
165 #endif /* GTK_DISABLE_DEPRECATED */
169 #endif /* __GTK_PROGRESS_BAR_H__ */