Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkruler.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkRuler
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Base class for horizontal or vertical rulers
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <note>
   9 <para>
  10  This widget is considered too specialized/little-used for
  11  GTK+, and will in the future be moved to some other package.  If
  12  your application needs this widget, feel free to use it, as the
  13  widget does work and is useful in some applications; it's just not
  14  of general interest. However, we are not accepting new features for
  15  the widget, and it will eventually move out of the GTK+
  16  distribution.
  17 </para>
  18 </note>
  19 <para>
  20 The GTKRuler widget is a base class for horizontal and vertical rulers. Rulers
  21 are used to show the mouse pointer's location in a window. The ruler can either
  22 be horizontal or vertical on the window. Within the ruler a small triangle
  23 indicates the location of the mouse relative to the horizontal or vertical
  24 ruler. See #GtkHRuler to learn how to create a new horizontal ruler. See
  25 #GtkVRuler to learn how to create a new vertical ruler.
  26 </para>
  27
  28 <!-- ##### SECTION See_Also ##### -->
  29 <para>
  30 #GtkHRuler, #GtkVRuler
  31 </para>
  32
  33 <!-- ##### SECTION Stability_Level ##### -->
  34
  35
  36 <!-- ##### STRUCT GtkRuler ##### -->
  37 <para>
  38 All distances are in 1/72nd's of an inch. (According to Adobe thats a point, but
  39 points are really 1/72.27 in.)
  40 </para>
  41
  42
  43 <!-- ##### ARG GtkRuler:lower ##### -->
  44 <para>
  45
  46 </para>
  47
  48 <!-- ##### ARG GtkRuler:max-size ##### -->
  49 <para>
  50
  51 </para>
  52
  53 <!-- ##### ARG GtkRuler:metric ##### -->
  54 <para>
  55
  56 </para>
  57
  58 <!-- ##### ARG GtkRuler:position ##### -->
  59 <para>
  60
  61 </para>
  62
  63 <!-- ##### ARG GtkRuler:upper ##### -->
  64 <para>
  65
  66 </para>
  67
  68 <!-- ##### STRUCT GtkRulerMetric ##### -->
  69 <para>
  70 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.
  71 </para>
  72
  73 @metric_name:
  74 @abbrev:
  75 @pixels_per_unit:
  76 @ruler_scale:
  77 @subdivide:
  78
  79 <!-- ##### FUNCTION gtk_ruler_set_metric ##### -->
  80 <para>
  81 This calls the #GTKMetricType to set the ruler to units defined. Available units
  82 are GTK_PIXELS, GTK_INCHES, or GTK_CENTIMETERS. The default unit of measurement
  83 is GTK_PIXELS.
  84 </para>
  85
  86 @ruler: the gtkruler
  87 @metric: the unit of measurement
  88
  89
  90 <!-- ##### FUNCTION gtk_ruler_set_range ##### -->
  91 <para>
  92
  93 </para>
  94
  95 @ruler:
  96 @lower:
  97 @upper:
  98 @position:
  99 @max_size:
 100
 101
 102 <!-- ##### FUNCTION gtk_ruler_get_metric ##### -->
 103 <para>
 104
 105 </para>
 106
 107 @ruler:
 108 @Returns:
 109
 110
 111 <!-- ##### FUNCTION gtk_ruler_get_range ##### -->
 112 <para>
 113
 114 </para>
 115
 116 @ruler:
 117 @lower:
 118 @upper:
 119 @position:
 120 @max_size:
 121
 122