92 lines
3.2 KiB
Groff
92 lines
3.2 KiB
Groff
|
'\"
|
||
|
|
'\" Copyright (c) 1990 The Regents of the University of California.
|
||
|
|
'\" All rights reserved.
|
||
|
|
'\"
|
||
|
|
'\" Permission is hereby granted, without written agreement and without
|
||
|
|
'\" license or royalty fees, to use, copy, modify, and distribute this
|
||
|
|
'\" documentation for any purpose, provided that the above copyright
|
||
|
|
'\" notice and the following two paragraphs appear in all copies.
|
||
|
|
'\"
|
||
|
|
'\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
|
||
|
|
'\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
|
||
|
|
'\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
|
||
|
|
'\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
|
'\"
|
||
|
|
'\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
|
||
|
|
'\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
|
||
|
|
'\" AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
|
||
|
|
'\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
|
||
|
|
'\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
|
||
|
|
'\"
|
||
|
|
'\" $Header: /user6/ouster/wish/man/RCS/GetPixels.3,v 1.3 93/04/01 09:41:36 ouster Exp $ SPRITE (Berkeley)
|
||
|
|
'\"
|
||
|
|
.so man.macros
|
||
|
|
.HS Tk_GetPixels tkc
|
||
|
|
.BS
|
||
|
|
.SH NAME
|
||
|
|
.VS
|
||
|
|
Tk_GetPixels, Tk_GetScreenMM \- translate between strings and screen units
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.nf
|
||
|
|
\fB#include <tk.h>\fR
|
||
|
|
.sp
|
||
|
|
int
|
||
|
|
\fBTk_GetPixels(\fIinterp, tkwin, string, intPtr\fB)\fR
|
||
|
|
.sp
|
||
|
|
int
|
||
|
|
\fBTk_GetScreenMM(\fIinterp, tkwin, string, doublePtr\fB)\fR
|
||
|
|
.SH ARGUMENTS
|
||
|
|
.AS "Tcl_Interp" *joinPtr
|
||
|
|
.AP Tcl_Interp *interp in
|
||
|
|
Interpreter to use for error reporting.
|
||
|
|
.AP Tk_Window tkwin in
|
||
|
|
Window whose screen geometry determines the conversion between absolute
|
||
|
|
units and pixels.
|
||
|
|
.AP char *string in
|
||
|
|
String that specifies a distance on the screen.
|
||
|
|
.AP int *intPtr out
|
||
|
|
Pointer to location in which to store converted distance in pixels.
|
||
|
|
.AP double *doublePtr out
|
||
|
|
Pointer to location in which to store converted distance in millimeters.
|
||
|
|
.BE
|
||
|
|
|
||
|
|
.SH DESCRIPTION
|
||
|
|
.PP
|
||
|
|
These two procedures take as argument a specification of distance on
|
||
|
|
the screen (\fIstring\fR) and compute the corresponding distance
|
||
|
|
either in integer pixels or floating-point millimeters.
|
||
|
|
In either case, \fIstring\fR specifies a screen distance as a
|
||
|
|
floating-point number followed by one of the following characters
|
||
|
|
that indicates units:
|
||
|
|
.TP
|
||
|
|
<none>
|
||
|
|
The number specifies a distance in pixels.
|
||
|
|
.TP
|
||
|
|
\fBc\fR
|
||
|
|
The number specifies a distance in centimeters on the screen.
|
||
|
|
.TP
|
||
|
|
\fBi\fR
|
||
|
|
The number specifies a distance in inches on the screen.
|
||
|
|
.TP
|
||
|
|
\fBm\fR
|
||
|
|
The number specifies a distance in millimeters on the screen.
|
||
|
|
.TP
|
||
|
|
\fBp\fR
|
||
|
|
The number specifies a distance in printer's points (1/72 inch)
|
||
|
|
on the screen.
|
||
|
|
.PP
|
||
|
|
\fBTk_GetPixels\fR converts \fIstring\fR to the nearest even
|
||
|
|
number of pixels and stores that value at \fI*intPtr\fR.
|
||
|
|
\fBTk_GetScreenMM\fR converts \fIstring\fR to millimeters and
|
||
|
|
stores the double-precision floating-point result at \fI*doublePtr\fR.
|
||
|
|
.PP
|
||
|
|
Both procedures return \fBTCL_OK\fR under normal circumstances.
|
||
|
|
If an error occurs (e.g. \fIstring\fR contains a number followed
|
||
|
|
by a character that isn't one of the ones above) then
|
||
|
|
\fBTCL_ERROR\fR is returned and an error message is left
|
||
|
|
in \fIinterp->result\fR.
|
||
|
|
|
||
|
|
.SH KEYWORDS
|
||
|
|
centimeters, convert, inches, millimeters, pixels, points, screen units
|
||
|
|
.VE
|