]> Pileus Git - ~andy/gtk/blob - gtk/gtkprogressbar.h
b64181384a84983728d2ddb1781a50d786ecb8f8
[~andy/gtk] / gtk / gtkprogressbar.h
1 /* GTK - The GIMP Toolkit
2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3  *
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.
8  *
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.
13  *
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.
18  */
19
20 /*
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/.
25  */
26
27 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
28 #error "Only <gtk/gtk.h> can be included directly."
29 #endif
30
31 #ifndef __GTK_PROGRESS_BAR_H__
32 #define __GTK_PROGRESS_BAR_H__
33
34 #include <gtk/gtkwidget.h>
35
36 G_BEGIN_DECLS
37
38 #define GTK_TYPE_PROGRESS_BAR            (gtk_progress_bar_get_type ())
39 #define GTK_PROGRESS_BAR(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_PROGRESS_BAR, GtkProgressBar))
40 #define GTK_PROGRESS_BAR_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_PROGRESS_BAR, GtkProgressBarClass))
41 #define GTK_IS_PROGRESS_BAR(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_PROGRESS_BAR))
42 #define GTK_IS_PROGRESS_BAR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PROGRESS_BAR))
43 #define GTK_PROGRESS_BAR_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_PROGRESS_BAR, GtkProgressBarClass))
44
45
46 typedef struct _GtkProgressBar              GtkProgressBar;
47 typedef struct _GtkProgressBarPrivate       GtkProgressBarPrivate;
48 typedef struct _GtkProgressBarClass         GtkProgressBarClass;
49
50 struct _GtkProgressBar
51 {
52   GtkWidget parent;
53
54   /*< private >*/
55   GtkProgressBarPrivate *priv;
56 };
57
58 struct _GtkProgressBarClass
59 {
60   GtkWidgetClass parent_class;
61
62   /* Padding for future expansion */
63   void (*_gtk_reserved1) (void);
64   void (*_gtk_reserved2) (void);
65   void (*_gtk_reserved3) (void);
66   void (*_gtk_reserved4) (void);
67 };
68
69
70 GType      gtk_progress_bar_get_type             (void) G_GNUC_CONST;
71 GtkWidget* gtk_progress_bar_new                  (void);
72
73 void       gtk_progress_bar_pulse                (GtkProgressBar *pbar);
74 void       gtk_progress_bar_set_text             (GtkProgressBar *pbar,
75                                                   const gchar    *text);
76 void       gtk_progress_bar_set_fraction         (GtkProgressBar *pbar,
77                                                   gdouble         fraction);
78
79 void       gtk_progress_bar_set_pulse_step       (GtkProgressBar *pbar,
80                                                   gdouble         fraction);
81 void       gtk_progress_bar_set_inverted         (GtkProgressBar *pbar,
82                                                   gboolean        inverted);
83
84 const gchar *      gtk_progress_bar_get_text       (GtkProgressBar *pbar);
85 gdouble            gtk_progress_bar_get_fraction   (GtkProgressBar *pbar);
86 gdouble            gtk_progress_bar_get_pulse_step (GtkProgressBar *pbar);
87
88 gboolean           gtk_progress_bar_get_inverted    (GtkProgressBar *pbar);
89 void               gtk_progress_bar_set_ellipsize (GtkProgressBar     *pbar,
90                                                    PangoEllipsizeMode  mode);
91 PangoEllipsizeMode gtk_progress_bar_get_ellipsize (GtkProgressBar     *pbar);
92
93 void               gtk_progress_bar_set_show_text (GtkProgressBar     *pbar,
94                                                    gboolean            show_text);
95 gboolean           gtk_progress_bar_get_show_text (GtkProgressBar     *pbar);
96
97 G_END_DECLS
98
99 #endif /* __GTK_PROGRESS_BAR_H__ */