Pileus Git - ~andy/gtk/blob - gtk/gtkruler.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 /*
  28  * NOTE this widget is considered too specialized/little-used for
  29  * GTK+, and will in the future be moved to some other package.  If
  30  * your application needs this widget, feel free to use it, as the
  31  * widget does work and is useful in some applications; it's just not
  32  * of general interest. However, we are not accepting new features for
  33  * the widget, and it will eventually move out of the GTK+
  34  * distribution.
  35  */
  36
  37 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  38 #error "Only <gtk/gtk.h> can be included directly."
  39 #endif
  40
  41 #ifndef __GTK_RULER_H__
  42 #define __GTK_RULER_H__
  43
  44
  45 #include <gtk/gtkwidget.h>
  46
  47
  48 G_BEGIN_DECLS
  49
  50 #define GTK_TYPE_RULER            (gtk_ruler_get_type ())
  51 #define GTK_RULER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_RULER, GtkRuler))
  52 #define GTK_RULER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_RULER, GtkRulerClass))
  53 #define GTK_IS_RULER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_RULER))
  54 #define GTK_IS_RULER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_RULER))
  55 #define GTK_RULER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_RULER, GtkRulerClass))
  56
  57
  58 typedef struct _GtkRuler              GtkRuler;
  59 typedef struct _GtkRulerPrivate       GtkRulerPrivate;
  60 typedef struct _GtkRulerClass         GtkRulerClass;
  61 typedef struct _GtkRulerMetric        GtkRulerMetric;
  62
  63 /* All distances below are in 1/72nd's of an inch. (According to
  64  * Adobe that's a point, but points are really 1/72.27 in.)
  65  */
  66 struct _GtkRuler
  67 {
  68   GtkWidget widget;
  69
  70   /* <private> */
  71   GtkRulerPrivate *priv;
  72 };
  73
  74 struct _GtkRulerClass
  75 {
  76   GtkWidgetClass parent_class;
  77
  78   void (* draw_ticks) (GtkRuler *ruler,
  79                        cairo_t  *cr);
  80   void (* draw_pos)   (GtkRuler *ruler,
  81                        cairo_t  *cr);
  82
  83   /* Padding for future expansion */
  84   void (*_gtk_reserved1) (void);
  85   void (*_gtk_reserved2) (void);
  86   void (*_gtk_reserved3) (void);
  87   void (*_gtk_reserved4) (void);
  88 };
  89
  90 struct _GtkRulerMetric
  91 {
  92   gchar *metric_name;
  93   gchar *abbrev;
  94   /* This should be points_per_unit. This is the size of the unit
  95    * in 1/72nd's of an inch and has nothing to do with screen pixels */
  96   gdouble pixels_per_unit;
  97   gdouble ruler_scale[10];
  98   gint subdivide[5];        /* five possible modes of subdivision */
  99 };
 100
 101
 102 GType           gtk_ruler_get_type   (void) G_GNUC_CONST;
 103 GtkWidget     * gtk_ruler_new        (GtkOrientation  orientation);
 104 void            gtk_ruler_set_metric (GtkRuler       *ruler,
 105                                       GtkMetricType   metric);
 106 GtkMetricType   gtk_ruler_get_metric (GtkRuler       *ruler);
 107 void            gtk_ruler_set_range  (GtkRuler       *ruler,
 108                                       gdouble         lower,
 109                                       gdouble         upper,
 110                                       gdouble         position,
 111                                       gdouble         max_size);
 112 void            gtk_ruler_get_range  (GtkRuler       *ruler,
 113                                       gdouble        *lower,
 114                                       gdouble        *upper,
 115                                       gdouble        *position,
 116                                       gdouble        *max_size);
 117
 118 G_END_DECLS
 119
 120 #endif /* __GTK_RULER_H__ */