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
  35 #include <gtk/gtkprogress.h>
  36
  37
  38 G_BEGIN_DECLS
  39
  40 #define GTK_TYPE_PROGRESS_BAR            (gtk_progress_bar_get_type ())
  41 #define GTK_PROGRESS_BAR(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_PROGRESS_BAR, GtkProgressBar))
  42 #define GTK_PROGRESS_BAR_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_PROGRESS_BAR, GtkProgressBarClass))
  43 #define GTK_IS_PROGRESS_BAR(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_PROGRESS_BAR))
  44 #define GTK_IS_PROGRESS_BAR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PROGRESS_BAR))
  45 #define GTK_PROGRESS_BAR_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_PROGRESS_BAR, GtkProgressBarClass))
  46
  47
  48 typedef struct _GtkProgressBar       GtkProgressBar;
  49 typedef struct _GtkProgressBarClass  GtkProgressBarClass;
  50
  51 typedef enum
  52 {
  53   GTK_PROGRESS_CONTINUOUS,
  54   GTK_PROGRESS_DISCRETE
  55 } GtkProgressBarStyle;
  56
  57 typedef enum
  58 {
  59   GTK_PROGRESS_LEFT_TO_RIGHT,
  60   GTK_PROGRESS_RIGHT_TO_LEFT,
  61   GTK_PROGRESS_BOTTOM_TO_TOP,
  62   GTK_PROGRESS_TOP_TO_BOTTOM
  63 } GtkProgressBarOrientation;
  64
  65 struct _GtkProgressBar
  66 {
  67   GtkProgress progress;
  68
  69   GtkProgressBarStyle       GSEAL (bar_style);
  70   GtkProgressBarOrientation GSEAL (orientation);
  71
  72   guint GSEAL (blocks);
  73   gint  GSEAL (in_block);
  74
  75   gint  GSEAL (activity_pos);
  76   guint GSEAL (activity_step);
  77   guint GSEAL (activity_blocks);
  78
  79   gdouble GSEAL (pulse_fraction);
  80
  81   guint GSEAL (activity_dir) : 1;
  82   guint GSEAL (ellipsize) : 3;
  83   guint GSEAL (dirty) : 1;
  84 };
  85
  86 struct _GtkProgressBarClass
  87 {
  88   GtkProgressClass parent_class;
  89
  90   /* Padding for future expansion */
  91   void (*_gtk_reserved1) (void);
  92   void (*_gtk_reserved2) (void);
  93   void (*_gtk_reserved3) (void);
  94   void (*_gtk_reserved4) (void);
  95 };
  96
  97
  98 GType      gtk_progress_bar_get_type             (void) G_GNUC_CONST;
  99 GtkWidget* gtk_progress_bar_new                  (void);
 100
 101 void       gtk_progress_bar_pulse                (GtkProgressBar *pbar);
 102 void       gtk_progress_bar_set_text             (GtkProgressBar *pbar,
 103                                                   const gchar    *text);
 104 void       gtk_progress_bar_set_fraction         (GtkProgressBar *pbar,
 105                                                   gdouble         fraction);
 106
 107 void       gtk_progress_bar_set_pulse_step       (GtkProgressBar *pbar,
 108                                                   gdouble         fraction);
 109 void       gtk_progress_bar_set_orientation      (GtkProgressBar *pbar,
 110                                                   GtkProgressBarOrientation orientation);
 111
 112 G_CONST_RETURN gchar* gtk_progress_bar_get_text       (GtkProgressBar *pbar);
 113 gdouble               gtk_progress_bar_get_fraction   (GtkProgressBar *pbar);
 114 gdouble               gtk_progress_bar_get_pulse_step (GtkProgressBar *pbar);
 115
 116 GtkProgressBarOrientation gtk_progress_bar_get_orientation (GtkProgressBar *pbar);
 117 void               gtk_progress_bar_set_ellipsize (GtkProgressBar     *pbar,
 118                                                    PangoEllipsizeMode  mode);
 119 PangoEllipsizeMode gtk_progress_bar_get_ellipsize (GtkProgressBar     *pbar);
 120
 121
 122 G_END_DECLS
 123
 124 #endif /* __GTK_PROGRESS_BAR_H__ */