Pileus Git - ~andy/gtk/blob - 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 _GtkProgressBarPriv   GtkProgressBarPriv;
  48 typedef struct _GtkProgressBarClass  GtkProgressBarClass;
  49
  50 typedef enum
  51 {
  52   GTK_PROGRESS_LEFT_TO_RIGHT,
  53   GTK_PROGRESS_RIGHT_TO_LEFT,
  54   GTK_PROGRESS_BOTTOM_TO_TOP,
  55   GTK_PROGRESS_TOP_TO_BOTTOM
  56 } GtkProgressBarOrientation;
  57
  58 struct _GtkProgressBar
  59 {
  60   GtkWidget parent;
  61
  62   /* <private> */
  63   GtkProgressBarPriv *priv;
  64 };
  65
  66 struct _GtkProgressBarClass
  67 {
  68   GtkWidgetClass parent_class;
  69
  70   void (* paint)            (GtkProgressBar *progress);
  71   void (* update)           (GtkProgressBar *progress);
  72   void (* act_mode_enter)   (GtkProgressBar *progress);
  73
  74   /* Padding for future expansion */
  75   void (*_gtk_reserved1) (void);
  76   void (*_gtk_reserved2) (void);
  77   void (*_gtk_reserved3) (void);
  78   void (*_gtk_reserved4) (void);
  79   void (*_gtk_reserved5) (void);
  80   void (*_gtk_reserved6) (void);
  81   void (*_gtk_reserved7) (void);
  82   void (*_gtk_reserved8) (void);
  83 };
  84
  85
  86 GType      gtk_progress_bar_get_type             (void) G_GNUC_CONST;
  87 GtkWidget* gtk_progress_bar_new                  (void);
  88
  89 void       gtk_progress_bar_pulse                (GtkProgressBar *pbar);
  90 void       gtk_progress_bar_set_text             (GtkProgressBar *pbar,
  91                                                   const gchar    *text);
  92 void       gtk_progress_bar_set_fraction         (GtkProgressBar *pbar,
  93                                                   gdouble         fraction);
  94
  95 void       gtk_progress_bar_set_pulse_step       (GtkProgressBar *pbar,
  96                                                   gdouble         fraction);
  97 void       gtk_progress_bar_set_orientation      (GtkProgressBar *pbar,
  98                                                   GtkProgressBarOrientation orientation);
  99
 100 G_CONST_RETURN gchar* gtk_progress_bar_get_text       (GtkProgressBar *pbar);
 101 gdouble               gtk_progress_bar_get_fraction   (GtkProgressBar *pbar);
 102 gdouble               gtk_progress_bar_get_pulse_step (GtkProgressBar *pbar);
 103
 104 GtkProgressBarOrientation gtk_progress_bar_get_orientation (GtkProgressBar *pbar);
 105 void               gtk_progress_bar_set_ellipsize (GtkProgressBar     *pbar,
 106                                                    PangoEllipsizeMode  mode);
 107 PangoEllipsizeMode gtk_progress_bar_get_ellipsize (GtkProgressBar     *pbar);
 108
 109 void               gtk_progress_bar_set_show_text (GtkProgressBar     *pbar,
 110                                                    gboolean            show_text);
 111 gboolean           gtk_progress_bar_get_show_text (GtkProgressBar     *pbar);
 112
 113 G_END_DECLS
 114
 115 #endif /* __GTK_PROGRESS_BAR_H__ */