1 2@c %start of fragment 3 4@deftp Class <gtk-ruler> 5Derives from @code{<gtk-widget>}. 6 7This class defines the following slots: 8 9@table @code 10@item lower 11Lower limit of ruler 12 13@item upper 14Upper limit of ruler 15 16@item position 17Position of mark on the ruler 18 19@item max-size 20Maximum size of the ruler 21 22@item metric 23The metric used for the ruler 24 25@end table 26 27@end deftp 28 29@deffn Function gtk-ruler-set-metric (self@tie{}@code{<gtk-ruler>}) (metric@tie{}@code{<gtk-metric-type>}) 30@deffnx Method set-metric 31This calls the @code{<gtk-metric-type>} to set the ruler to units defined. 32Available units are GTK_PIXELS, GTK_INCHES, or GTK_CENTIMETERS. The default unit 33of measurement is GTK_PIXELS. 34 35@table @var 36@item ruler 37the gtkruler 38 39@item metric 40the unit of measurement 41 42@end table 43 44@end deffn 45 46@deffn Function gtk-ruler-set-range (self@tie{}@code{<gtk-ruler>}) (lower@tie{}@code{double}) (upper@tie{}@code{double}) (position@tie{}@code{double}) (max_size@tie{}@code{double}) 47@deffnx Method set-range 48This sets the range of the ruler using gfloat lower, gfloat upper, gfloat 49position, and gfloat max_size. 50 51@table @var 52@item ruler 53the gtkruler 54 55@item lower 56the lower limit of the ruler 57 58@item upper 59the upper limit of the ruler 60 61@item position 62the mark on the ruler 63 64@item max-size 65the maximum size of the ruler 66 67@end table 68 69@end deffn 70 71@deffn Function gtk-ruler-get-metric (self@tie{}@code{<gtk-ruler>}) @result{}@tie{} (ret@tie{}@code{<gtk-metric-type>}) 72@deffnx Method get-metric 73Gets the units used for a @code{<gtk-ruler>}. See @code{gtk-ruler-set-metric}. 74 75@table @var 76@item ruler 77a @code{<gtk-ruler>} 78 79@item ret 80the units currently used for @var{ruler} 81 82@end table 83 84@end deffn 85 86@deffn Function gtk-ruler-get-range (self@tie{}@code{<gtk-ruler>}) @result{}@tie{} (lower@tie{}@code{double}) (upper@tie{}@code{double}) (position@tie{}@code{double}) (max_size@tie{}@code{double}) 87@deffnx Method get-range 88Retrieves values indicating the range and current position of a 89@code{<gtk-ruler>}. See @code{gtk-ruler-set-range}. 90 91@table @var 92@item ruler 93a @code{<gtk-ruler>} 94 95@item lower 96location to store lower limit of the ruler, or @samp{@code{#f}} 97 98@item upper 99location to store upper limit of the ruler, or @samp{@code{#f}} 100 101@item position 102location to store the current position of the mark on the ruler, or 103@samp{@code{#f}} 104 105@item max-size 106location to store the maximum size of the ruler used when calculating the space 107to leave for the text, or @samp{@code{#f}}. 108 109@end table 110 111@end deffn 112 113 114@c %end of fragment 115