gtkprogressbar.h 4.25 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Elliot Lee's avatar
Elliot Lee committed
2 3 4
 * 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
Javier Jardon's avatar
Javier Jardon committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
Elliot Lee's avatar
Elliot Lee committed
16
 */
17

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

25 26 27
#ifndef __GTK_PROGRESS_BAR_H__
#define __GTK_PROGRESS_BAR_H__

28
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
29 30 31
#error "Only <gtk/gtk.h> can be included directly."
#endif

Matthias Clasen's avatar
Matthias Clasen committed
32
#include <gtk/gtkwidget.h>
Elliot Lee's avatar
Elliot Lee committed
33

34
G_BEGIN_DECLS
Elliot Lee's avatar
Elliot Lee committed
35

36
#define GTK_TYPE_PROGRESS_BAR            (gtk_progress_bar_get_type ())
Manish Singh's avatar
Manish Singh committed
37 38 39 40 41
#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
42 43


44 45 46
typedef struct _GtkProgressBar              GtkProgressBar;
typedef struct _GtkProgressBarPrivate       GtkProgressBarPrivate;
typedef struct _GtkProgressBarClass         GtkProgressBarClass;
Elliot Lee's avatar
Elliot Lee committed
47 48 49

struct _GtkProgressBar
{
Matthias Clasen's avatar
Matthias Clasen committed
50 51
  GtkWidget parent;

52
  /*< private >*/
53
  GtkProgressBarPrivate *priv;
Elliot Lee's avatar
Elliot Lee committed
54 55 56 57
};

struct _GtkProgressBarClass
{
Matthias Clasen's avatar
Matthias Clasen committed
58 59
  GtkWidgetClass parent_class;

60 61 62 63 64
  /* 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
65 66 67
};


68
GDK_AVAILABLE_IN_ALL
Manish Singh's avatar
Manish Singh committed
69
GType      gtk_progress_bar_get_type             (void) G_GNUC_CONST;
70
GDK_AVAILABLE_IN_ALL
71
GtkWidget* gtk_progress_bar_new                  (void);
72

73
GDK_AVAILABLE_IN_ALL
74
void       gtk_progress_bar_pulse                (GtkProgressBar *pbar);
75
GDK_AVAILABLE_IN_ALL
76 77
void       gtk_progress_bar_set_text             (GtkProgressBar *pbar,
                                                  const gchar    *text);
78
GDK_AVAILABLE_IN_ALL
79
void       gtk_progress_bar_set_fraction         (GtkProgressBar *pbar,
80
                                                  gdouble         fraction);
81

82
GDK_AVAILABLE_IN_ALL
83
void       gtk_progress_bar_set_pulse_step       (GtkProgressBar *pbar,
84
                                                  gdouble         fraction);
85
GDK_AVAILABLE_IN_ALL
86 87
void       gtk_progress_bar_set_inverted         (GtkProgressBar *pbar,
                                                  gboolean        inverted);
88

89
GDK_AVAILABLE_IN_ALL
90
const gchar *      gtk_progress_bar_get_text       (GtkProgressBar *pbar);
91
GDK_AVAILABLE_IN_ALL
92
gdouble            gtk_progress_bar_get_fraction   (GtkProgressBar *pbar);
93
GDK_AVAILABLE_IN_ALL
94
gdouble            gtk_progress_bar_get_pulse_step (GtkProgressBar *pbar);
95

96
GDK_AVAILABLE_IN_ALL
97
gboolean           gtk_progress_bar_get_inverted    (GtkProgressBar *pbar);
98
GDK_AVAILABLE_IN_ALL
99
void               gtk_progress_bar_set_ellipsize (GtkProgressBar     *pbar,
Matthias Clasen's avatar
Matthias Clasen committed
100
                                                   PangoEllipsizeMode  mode);
101
GDK_AVAILABLE_IN_ALL
102
PangoEllipsizeMode gtk_progress_bar_get_ellipsize (GtkProgressBar     *pbar);
103

104
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
105 106
void               gtk_progress_bar_set_show_text (GtkProgressBar     *pbar,
                                                   gboolean            show_text);
107
GDK_AVAILABLE_IN_ALL
Matthias Clasen's avatar
Matthias Clasen committed
108
gboolean           gtk_progress_bar_get_show_text (GtkProgressBar     *pbar);
109

110
G_END_DECLS
Elliot Lee's avatar
Elliot Lee committed
111 112

#endif /* __GTK_PROGRESS_BAR_H__ */