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_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
38#error "Only <gtk/gtk.h> can be included directly."
39#endif
40
41#ifndef GTK_DISABLE_DEPRECATED
42
43#ifndef __GTK_RULER_H__
44#define __GTK_RULER_H__
45
46
47#include <gtk/gtkwidget.h>
48
49
50G_BEGIN_DECLS
51
52#define GTK_TYPE_RULER (gtk_ruler_get_type ())
53#define GTK_RULER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_RULER, GtkRuler))
54#define GTK_RULER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_RULER, GtkRulerClass))
55#define GTK_IS_RULER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_RULER))
56#define GTK_IS_RULER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_RULER))
57#define GTK_RULER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_RULER, GtkRulerClass))
58
59
60typedef struct _GtkRuler GtkRuler;
61typedef struct _GtkRulerClass GtkRulerClass;
62typedef struct _GtkRulerMetric GtkRulerMetric;
63
64/* All distances below are in 1/72nd's of an inch. (According to
65 * Adobe that's a point, but points are really 1/72.27 in.)
66 */
67struct _GtkRuler
68{
69 GtkWidget widget;
70
71 GdkPixmap *GSEAL (backing_store);
72 GdkGC *GSEAL (non_gr_exp_gc); /* unused */
73 GtkRulerMetric *GSEAL (metric);
74 gint GSEAL (xsrc);
75 gint GSEAL (ysrc);
76 gint GSEAL (slider_size);
77
78 /* The upper limit of the ruler (in points) */
79 gdouble GSEAL (lower);
80 /* The lower limit of the ruler */
81 gdouble GSEAL (upper);
82 /* The position of the mark on the ruler */
83 gdouble GSEAL (position);
84 /* The maximum size of the ruler */
85 gdouble GSEAL (max_size);
86};
87
88struct _GtkRulerClass
89{
90 GtkWidgetClass parent_class;
91
92 void (* draw_ticks) (GtkRuler *ruler);
93 void (* draw_pos) (GtkRuler *ruler);
94
95 /* Padding for future expansion */
96 void (*_gtk_reserved1) (void);
97 void (*_gtk_reserved2) (void);
98 void (*_gtk_reserved3) (void);
99 void (*_gtk_reserved4) (void);
100};
101
102struct _GtkRulerMetric
103{
104 gchar *metric_name;
105 gchar *abbrev;
106 /* This should be points_per_unit. This is the size of the unit
107 * in 1/72nd's of an inch and has nothing to do with screen pixels */
108 gdouble pixels_per_unit;
109 gdouble ruler_scale[10];
110 gint subdivide[5]; /* five possible modes of subdivision */
111};
112
113
114GType gtk_ruler_get_type (void) G_GNUC_CONST;
115void gtk_ruler_set_metric (GtkRuler *ruler,
116 GtkMetricType metric);
117GtkMetricType gtk_ruler_get_metric (GtkRuler *ruler);
118void gtk_ruler_set_range (GtkRuler *ruler,
119 gdouble lower,
120 gdouble upper,
121 gdouble position,
122 gdouble max_size);
123void gtk_ruler_get_range (GtkRuler *ruler,
124 gdouble *lower,
125 gdouble *upper,
126 gdouble *position,
127 gdouble *max_size);
128
129void gtk_ruler_draw_ticks (GtkRuler *ruler);
130void gtk_ruler_draw_pos (GtkRuler *ruler);
131
132G_END_DECLS
133
134#endif /* __GTK_RULER_H__ */
135
136#endif /* GTK_DISABLE_DEPRECATED */
137