summaryrefslogtreecommitdiffstats
path: root/doc/GetPixels.3
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2005-04-06 21:11:49 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2005-04-06 21:11:49 (GMT)
commitaf0c6996b5dd46e602fa5da6542a4ccb4e45656c (patch)
tree4703569bae4ea9053243ae2a3bd9823280c478ec /doc/GetPixels.3
parent19b266b312edc253fa16d04f6fab6c7a6e2c0494 (diff)
downloadtk-af0c6996b5dd46e602fa5da6542a4ccb4e45656c.zip
tk-af0c6996b5dd46e602fa5da6542a4ccb4e45656c.tar.gz
tk-af0c6996b5dd46e602fa5da6542a4ccb4e45656c.tar.bz2
Purge old and inaccurate .VS/.VE macros.
Diffstat (limited to 'doc/GetPixels.3')
-rw-r--r--doc/GetPixels.314
1 files changed, 1 insertions, 13 deletions
diff --git a/doc/GetPixels.3 b/doc/GetPixels.3
index 7330018..99b8a73 100644
--- a/doc/GetPixels.3
+++ b/doc/GetPixels.3
@@ -5,7 +5,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: GetPixels.3,v 1.4 2002/01/25 21:09:36 dgp Exp $
+'\" RCS: @(#) $Id: GetPixels.3,v 1.5 2005/04/06 21:11:54 dkf Exp $
'\"
.so man.macros
.TH Tk_GetPixelsFromObj 3 8.1 Tk "Tk Library Procedures"
@@ -16,18 +16,14 @@ Tk_GetPixelsFromObj, Tk_GetPixels, Tk_GetMMFromObj, Tk_GetScreenMM \- translate
.nf
\fB#include <tk.h>\fR
.sp
-.VS 8.1
int
\fBTk_GetPixelsFromObj(\fIinterp, tkwin, objPtr, intPtr\fB)\fR
-.VE
.sp
int
\fBTk_GetPixels(\fIinterp, tkwin, string, intPtr\fB)\fR
.sp
-.VS 8.1
int
\fBTk_GetMMFromObj(\fIinterp, tkwin, objPtr, doublePtr\fB)\fR
-.VE
.sp
int
\fBTk_GetScreenMM(\fIinterp, tkwin, string, doublePtr\fB)\fR
@@ -38,14 +34,12 @@ Interpreter to use for error reporting.
.AP Tk_Window tkwin in
Window whose screen geometry determines the conversion between absolute
units and pixels.
-.VS 8.1 br
.AP Tcl_Obj *objPtr in/out
String value specifies a distance on the screen;
internal rep will be modified to cache converted distance.
.AP "CONST char" *string in
Same as \fIobjPtr\fR except specification of distance is passed as
a string.
-.VE
.AP int *intPtr out
Pointer to location in which to store converted distance in pixels.
.AP double *doublePtr out
@@ -55,14 +49,10 @@ Pointer to location in which to store converted distance in millimeters.
.SH DESCRIPTION
.PP
These procedures take as argument a specification of distance on
-.VS 8.1
the screen (\fIobjPtr\fR or \fIstring\fR) and compute the
-.VE
corresponding distance either in integer pixels or floating-point millimeters.
In either case,
-.VS 8.1
\fIobjPtr\fR or \fIstring\fR
-.VE
specifies a screen distance as a
floating-point number followed by one of the following characters
that indicates units:
@@ -83,7 +73,6 @@ The number specifies a distance in millimeters on the screen.
The number specifies a distance in printer's points (1/72 inch)
on the screen.
.PP
-.VS 8.1
\fBTk_GetPixelsFromObj\fR converts the value of \fIobjPtr\fR to the
nearest even number of pixels and stores that value at \fI*intPtr\fR.
It returns \fBTCL_OK\fR under normal circumstances.
@@ -105,7 +94,6 @@ return value, so \fBTk_GetAnchor\fR is less efficient than
\fBTk_GetPixelsFromObj\fR and \fBTk_GetPixels\fR (respectively) except
that they convert the screen distance to millimeters and
store a double-precision floating-point result at \fI*doublePtr\fR.
-.VE
.SH KEYWORDS
centimeters, convert, inches, millimeters, pixels, points, screen units