Pileus Git - ~andy/gtk/blob - gtk/gtkprogress.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 #ifndef __GTK_PROGRESS_H__
  28 #define __GTK_PROGRESS_H__
  29
  30
  31 #include <gtk/gtkwidget.h>
  32 #include <gtk/gtkadjustment.h>
  33
  34
  35 G_BEGIN_DECLS
  36
  37 #if !defined (GTK_DISABLE_DEPRECATED) || defined (__GTK_PROGRESS_C__) || defined (__GTK_PROGRESS_BAR_C__)
  38
  39 #define GTK_TYPE_PROGRESS            (gtk_progress_get_type ())
  40 #define GTK_PROGRESS(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_PROGRESS, GtkProgress))
  41 #define GTK_PROGRESS_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_PROGRESS, GtkProgressClass))
  42 #define GTK_IS_PROGRESS(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_PROGRESS))
  43 #define GTK_IS_PROGRESS_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_PROGRESS))
  44 #define GTK_PROGRESS_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_PROGRESS, GtkProgressClass))
  45
  46 #endif /* !GTK_DISABLE_DEPRECATED */
  47
  48 typedef struct _GtkProgress       GtkProgress;
  49 typedef struct _GtkProgressClass  GtkProgressClass;
  50
  51
  52 struct _GtkProgress
  53 {
  54   GtkWidget widget;
  55
  56   GtkAdjustment *adjustment;
  57   GdkPixmap     *offscreen_pixmap;
  58   gchar         *format;
  59   gfloat         x_align;
  60   gfloat         y_align;
  61
  62   guint          show_text : 1;
  63   guint          activity_mode : 1;
  64   guint          use_text_format : 1;
  65 };
  66
  67 struct _GtkProgressClass
  68 {
  69   GtkWidgetClass parent_class;
  70
  71   void (* paint)            (GtkProgress *progress);
  72   void (* update)           (GtkProgress *progress);
  73   void (* act_mode_enter)   (GtkProgress *progress);
  74
  75   /* Padding for future expansion */
  76   void (*_gtk_reserved1) (void);
  77   void (*_gtk_reserved2) (void);
  78   void (*_gtk_reserved3) (void);
  79   void (*_gtk_reserved4) (void);
  80 };
  81
  82 /* This entire interface is deprecated. Use GtkProgressBar
  83  * directly.
  84  */
  85
  86 #if !defined (GTK_DISABLE_DEPRECATED) || defined (__GTK_PROGRESS_C__) || defined (__GTK_PROGRESS_BAR_C__)
  87
  88 GType      gtk_progress_get_type            (void) G_GNUC_CONST;
  89 void       gtk_progress_set_show_text       (GtkProgress   *progress,
  90                                              gboolean       show_text);
  91 void       gtk_progress_set_text_alignment  (GtkProgress   *progress,
  92                                              gfloat         x_align,
  93                                              gfloat         y_align);
  94 void       gtk_progress_set_format_string   (GtkProgress   *progress,
  95                                              const gchar   *format);
  96 void       gtk_progress_set_adjustment      (GtkProgress   *progress,
  97                                              GtkAdjustment *adjustment);
  98 void       gtk_progress_configure           (GtkProgress   *progress,
  99                                              gdouble        value,
 100                                              gdouble        min,
 101                                              gdouble        max);
 102 void       gtk_progress_set_percentage      (GtkProgress   *progress,
 103                                              gdouble        percentage);
 104 void       gtk_progress_set_value           (GtkProgress   *progress,
 105                                              gdouble        value);
 106 gdouble    gtk_progress_get_value           (GtkProgress   *progress);
 107 void       gtk_progress_set_activity_mode   (GtkProgress   *progress,
 108                                              gboolean       activity_mode);
 109 gchar*     gtk_progress_get_current_text    (GtkProgress   *progress);
 110 gchar*     gtk_progress_get_text_from_value (GtkProgress   *progress,
 111                                              gdouble        value);
 112 gdouble    gtk_progress_get_current_percentage (GtkProgress *progress);
 113 gdouble    gtk_progress_get_percentage_from_value (GtkProgress *progress,
 114                                                    gdouble      value);
 115
 116 #endif /* !GTK_DISABLE_DEPRECATED */
 117
 118 G_END_DECLS
 119
 120 #endif /* __GTK_PROGRESS_H__ */