gtkprogressbar.h 6.11 KB
Newer Older
Elliot Lee's avatar
Elliot Lee committed
1 2 3 4
/* GTK - The GIMP Toolkit
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10 11
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
15 16 17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
18
 */
19

20
/*
21
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22 23 24 25 26
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

Elliot Lee's avatar
Elliot Lee committed
27 28 29 30 31
#ifndef __GTK_PROGRESS_BAR_H__
#define __GTK_PROGRESS_BAR_H__


#include <gdk/gdk.h>
32
#include <gtk/gtkprogress.h>
Elliot Lee's avatar
Elliot Lee committed
33 34


35
G_BEGIN_DECLS
Elliot Lee's avatar
Elliot Lee committed
36

37
#define GTK_TYPE_PROGRESS_BAR            (gtk_progress_bar_get_type ())
Manish Singh's avatar
Manish Singh committed
38 39 40 41 42
#define GTK_PROGRESS_BAR(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_PROGRESS_BAR, GtkProgressBar))
#define GTK_PROGRESS_BAR_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_PROGRESS_BAR, GtkProgressBarClass))
#define GTK_IS_PROGRESS_BAR(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_PROGRESS_BAR))
#define GTK_IS_PROGRESS_BAR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PROGRESS_BAR))
#define GTK_PROGRESS_BAR_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_PROGRESS_BAR, GtkProgressBarClass))
Elliot Lee's avatar
Elliot Lee committed
43 44 45 46 47


typedef struct _GtkProgressBar       GtkProgressBar;
typedef struct _GtkProgressBarClass  GtkProgressBarClass;

48 49 50 51 52 53 54 55 56 57 58 59 60 61
typedef enum
{
  GTK_PROGRESS_CONTINUOUS,
  GTK_PROGRESS_DISCRETE
} GtkProgressBarStyle;

typedef enum
{
  GTK_PROGRESS_LEFT_TO_RIGHT,
  GTK_PROGRESS_RIGHT_TO_LEFT,
  GTK_PROGRESS_BOTTOM_TO_TOP,
  GTK_PROGRESS_TOP_TO_BOTTOM
} GtkProgressBarOrientation;

Elliot Lee's avatar
Elliot Lee committed
62 63
struct _GtkProgressBar
{
64 65 66 67 68 69 70
  GtkProgress progress;

  GtkProgressBarStyle bar_style;
  GtkProgressBarOrientation orientation;

  guint blocks;
  gint  in_block;
Elliot Lee's avatar
Elliot Lee committed
71

72 73
  gint  activity_pos;
  guint activity_step;
74
  guint activity_blocks;
75

76
  gdouble pulse_fraction;
77
  
78
  guint activity_dir : 1;
79
  guint ellipsize : 3;
Matthias Clasen's avatar
Matthias Clasen committed
80
  guint dirty : 1;
Elliot Lee's avatar
Elliot Lee committed
81 82 83 84
};

struct _GtkProgressBarClass
{
85
  GtkProgressClass parent_class;
86 87 88 89 90 91

  /* Padding for future expansion */
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
  void (*_gtk_reserved4) (void);
Elliot Lee's avatar
Elliot Lee committed
92 93 94
};


Manish Singh's avatar
Manish Singh committed
95
GType      gtk_progress_bar_get_type             (void) G_GNUC_CONST;
96
GtkWidget* gtk_progress_bar_new                  (void);
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122

/*
 * GtkProgress/GtkProgressBar had serious problems in GTK 1.2.
 * 
 *  - Only 3 or 4 functions are really needed for 95% of progress  
 *    interfaces; GtkProgress[Bar] had about 25 functions, and 
 *    didn't even include these 3 or 4.
 *  - In activity mode, the API involves setting the adjustment 
 *    to any random value, just to have the side effect of 
 *    calling the progress bar update function - the adjustment
 *    is totally ignored in activity mode
 *  - You set the activity step as a pixel value, which means to 
 *    set the activity step you basically need to connect to 
 *    size_allocate
 *  - There are ctree_set_expander_style()-functions, to randomly 
 *    change look-and-feel for no good reason
 *  - The split between GtkProgress and GtkProgressBar makes no sense 
 *    to me whatsoever.
 *  
 * This was a big wart on GTK and made people waste lots of time,
 * both learning and using the interface.
 * 
 * So, I have added what I feel is the correct API, and marked all the
 * rest deprecated. However, the changes are 100% backward-compatible and
 * should break no existing code.
 *
123
 * The following 9 functions are the new programming interface. 
124 125 126 127 128
 */
void       gtk_progress_bar_pulse                (GtkProgressBar *pbar);
void       gtk_progress_bar_set_text             (GtkProgressBar *pbar,
                                                  const gchar    *text);
void       gtk_progress_bar_set_fraction         (GtkProgressBar *pbar,
129
                                                  gdouble         fraction);
130 131

void       gtk_progress_bar_set_pulse_step       (GtkProgressBar *pbar,
132
                                                  gdouble         fraction);
133 134 135
void       gtk_progress_bar_set_orientation      (GtkProgressBar *pbar,
						  GtkProgressBarOrientation orientation);

136
G_CONST_RETURN gchar* gtk_progress_bar_get_text       (GtkProgressBar *pbar);
137 138
gdouble               gtk_progress_bar_get_fraction   (GtkProgressBar *pbar);
gdouble               gtk_progress_bar_get_pulse_step (GtkProgressBar *pbar);
139 140

GtkProgressBarOrientation gtk_progress_bar_get_orientation (GtkProgressBar *pbar);
141 142 143
void               gtk_progress_bar_set_ellipsize (GtkProgressBar     *pbar,
						   PangoEllipsizeMode  mode);
PangoEllipsizeMode gtk_progress_bar_get_ellipsize (GtkProgressBar     *pbar);
144 145


146 147
#ifndef GTK_DISABLE_DEPRECATED

148
/* Everything below here is deprecated */
149 150 151
GtkWidget* gtk_progress_bar_new_with_adjustment  (GtkAdjustment  *adjustment);
void       gtk_progress_bar_set_bar_style        (GtkProgressBar *pbar,
						  GtkProgressBarStyle style);
152
void       gtk_progress_bar_set_discrete_blocks  (GtkProgressBar *pbar,
153
						  guint           blocks);
154 155 156 157
/* set_activity_step() is not only deprecated, it doesn't even work.
 * (Of course, it wasn't usable anyway, you had to set it from a size_allocate
 * handler or something)
 */
158 159
void       gtk_progress_bar_set_activity_step    (GtkProgressBar *pbar,
                                                  guint           step);
160 161
void       gtk_progress_bar_set_activity_blocks  (GtkProgressBar *pbar,
						  guint           blocks);
162
void       gtk_progress_bar_update               (GtkProgressBar *pbar,
163
						  gdouble         percentage);
Elliot Lee's avatar
Elliot Lee committed
164

165 166
#endif /* GTK_DISABLE_DEPRECATED */

167
G_END_DECLS
Elliot Lee's avatar
Elliot Lee committed
168 169

#endif /* __GTK_PROGRESS_BAR_H__ */