gtkruler.h 4.31 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Elliot Lee's avatar
Elliot Lee committed
2 3 4
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10 11
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
15 16 17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
18
 */
19 20

/*
21
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22 23
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
24
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
25 26
 */

27 28 29 30 31 32 33 34 35 36
/*
 * NOTE this widget is considered too specialized/little-used for
 * GTK+, and will in the future be moved to some other package.  If
 * your application needs this widget, feel free to use it, as the
 * widget does work and is useful in some applications; it's just not
 * of general interest. However, we are not accepting new features for
 * the widget, and it will eventually move out of the GTK+
 * distribution.
 */

37
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
38 39 40
#error "Only <gtk/gtk.h> can be included directly."
#endif

Elliot Lee's avatar
Elliot Lee committed
41 42 43 44 45 46 47
#ifndef __GTK_RULER_H__
#define __GTK_RULER_H__


#include <gtk/gtkwidget.h>


48
G_BEGIN_DECLS
Elliot Lee's avatar
Elliot Lee committed
49

50
#define GTK_TYPE_RULER            (gtk_ruler_get_type ())
Manish Singh's avatar
Manish Singh committed
51 52 53 54 55
#define GTK_RULER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_RULER, GtkRuler))
#define GTK_RULER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_RULER, GtkRulerClass))
#define GTK_IS_RULER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_RULER))
#define GTK_IS_RULER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_RULER))
#define GTK_RULER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_RULER, GtkRulerClass))
Tim Janik's avatar
Tim Janik committed
56

Elliot Lee's avatar
Elliot Lee committed
57 58

typedef struct _GtkRuler        GtkRuler;
59
typedef struct _GtkRulerPriv    GtkRulerPriv;
Elliot Lee's avatar
Elliot Lee committed
60 61 62
typedef struct _GtkRulerClass   GtkRulerClass;
typedef struct _GtkRulerMetric  GtkRulerMetric;

63 64 65
/* All distances below are in 1/72nd's of an inch. (According to
 * Adobe that's a point, but points are really 1/72.27 in.)
 */
Elliot Lee's avatar
Elliot Lee committed
66 67 68 69
struct _GtkRuler
{
  GtkWidget widget;

70 71
  /* <private> */
  GtkRulerPriv *priv;
Elliot Lee's avatar
Elliot Lee committed
72 73 74 75 76 77 78 79
};

struct _GtkRulerClass
{
  GtkWidgetClass parent_class;

  void (* draw_ticks) (GtkRuler *ruler);
  void (* draw_pos)   (GtkRuler *ruler);
80 81 82 83 84 85

  /* Padding for future expansion */
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
  void (*_gtk_reserved4) (void);
Elliot Lee's avatar
Elliot Lee committed
86 87 88 89 90 91
};

struct _GtkRulerMetric
{
  gchar *metric_name;
  gchar *abbrev;
92 93
  /* This should be points_per_unit. This is the size of the unit
   * in 1/72nd's of an inch and has nothing to do with screen pixels */
94 95
  gdouble pixels_per_unit;
  gdouble ruler_scale[10];
Elliot Lee's avatar
Elliot Lee committed
96 97 98 99
  gint subdivide[5];        /* five possible modes of subdivision */
};


100
GType           gtk_ruler_get_type   (void) G_GNUC_CONST;
101
GtkWidget     * gtk_ruler_new        (GtkOrientation  orientation);
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
void            gtk_ruler_set_metric (GtkRuler       *ruler,
                                      GtkMetricType   metric);
GtkMetricType   gtk_ruler_get_metric (GtkRuler       *ruler);
void            gtk_ruler_set_range  (GtkRuler       *ruler,
                                      gdouble         lower,
                                      gdouble         upper,
                                      gdouble         position,
                                      gdouble         max_size);
void            gtk_ruler_get_range  (GtkRuler       *ruler,
                                      gdouble        *lower,
                                      gdouble        *upper,
                                      gdouble        *position,
                                      gdouble        *max_size);

void            gtk_ruler_draw_ticks (GtkRuler       *ruler);
void            gtk_ruler_draw_pos   (GtkRuler       *ruler);
Elliot Lee's avatar
Elliot Lee committed
118

119
G_END_DECLS
Elliot Lee's avatar
Elliot Lee committed
120 121

#endif /* __GTK_RULER_H__ */