I386LINUX/util/I386LINUX/man/man3/GetPixels.3

   1 '\"
   2 '\" Copyright (c) 1990 The Regents of the University of California.
   3 '\" Copyright (c) 1994-1998 Sun Microsystems, Inc.
   4 '\"
   5 '\" See the file "license.terms" for information on usage and redistribution
   6 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   7 '\"
   8 '\" RCS: @(#) $Id: GetPixels.3,v 1.4 2002/01/25 21:09:36 dgp Exp $
   9 '\"
  10 '\" The definitions below are for supplemental macros used in Tcl/Tk
  11 '\" manual entries.
  12 '\"
  13 '\" .AP type name in/out ?indent?
  14 '\"     Start paragraph describing an argument to a library procedure.
  15 '\"     type is type of argument (int, etc.), in/out is either "in", "out",
  16 '\"     or "in/out" to describe whether procedure reads or modifies arg,
  17 '\"     and indent is equivalent to second arg of .IP (shouldn't ever be
  18 '\"     needed;  use .AS below instead)
  19 '\"
  20 '\" .AS ?type? ?name?
  21 '\"     Give maximum sizes of arguments for setting tab stops.  Type and
  22 '\"     name are examples of largest possible arguments that will be passed
  23 '\"     to .AP later.  If args are omitted, default tab stops are used.
  24 '\"
  25 '\" .BS
  26 '\"     Start box enclosure.  From here until next .BE, everything will be
  27 '\"     enclosed in one large box.
  28 '\"
  29 '\" .BE
  30 '\"     End of box enclosure.
  31 '\"
  32 '\" .CS
  33 '\"     Begin code excerpt.
  34 '\"
  35 '\" .CE
  36 '\"     End code excerpt.
  37 '\"
  38 '\" .VS ?version? ?br?
  39 '\"     Begin vertical sidebar, for use in marking newly-changed parts
  40 '\"     of man pages.  The first argument is ignored and used for recording
  41 '\"     the version when the .VS was added, so that the sidebars can be
  42 '\"     found and removed when they reach a certain age.  If another argument
  43 '\"     is present, then a line break is forced before starting the sidebar.
  44 '\"
  45 '\" .VE
  46 '\"     End of vertical sidebar.
  47 '\"
  48 '\" .DS
  49 '\"     Begin an indented unfilled display.
  50 '\"
  51 '\" .DE
  52 '\"     End of indented unfilled display.
  53 '\"
  54 '\" .SO
  55 '\"     Start of list of standard options for a Tk widget.  The
  56 '\"     options follow on successive lines, in four columns separated
  57 '\"     by tabs.
  58 '\"
  59 '\" .SE
  60 '\"     End of list of standard options for a Tk widget.
  61 '\"
  62 '\" .OP cmdName dbName dbClass
  63 '\"     Start of description of a specific option.  cmdName gives the
  64 '\"     option's name as specified in the class command, dbName gives
  65 '\"     the option's name in the option database, and dbClass gives
  66 '\"     the option's class in the option database.
  67 '\"
  68 '\" .UL arg1 arg2
  69 '\"     Print arg1 underlined, then print arg2 normally.
  70 '\"
  71 '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
  72 '\"
  73 '\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
  74 .if t .wh -1.3i ^B
  75 .nr ^l \n(.l
  76 .ad b
  77 '\"     # Start an argument description
  78 .de AP
  79 .ie !"\\$4"" .TP \\$4
  80 .el \{\
  81 .   ie !"\\$2"" .TP \\n()Cu
  82 .   el          .TP 15
  83 .\}
  84 .ta \\n()Au \\n()Bu
  85 .ie !"\\$3"" \{\
  86 \&\\$1  \\fI\\$2\\fP    (\\$3)
  87 .\".b
  88 .\}
  89 .el \{\
  90 .br
  91 .ie !"\\$2"" \{\
  92 \&\\$1  \\fI\\$2\\fP
  93 .\}
  94 .el \{\
  95 \&\\fI\\$1\\fP
  96 .\}
  97 .\}
  98 ..
  99 '\"     # define tabbing values for .AP
 100 .de AS
 101 .nr )A 10n
 102 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 103 .nr )B \\n()Au+15n
 104 .\"
 105 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 106 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 107 ..
 108 .AS Tcl_Interp Tcl_CreateInterp in/out
 109 '\"     # BS - start boxed text
 110 '\"     # ^y = starting y location
 111 '\"     # ^b = 1
 112 .de BS
 113 .br
 114 .mk ^y
 115 .nr ^b 1u
 116 .if n .nf
 117 .if n .ti 0
 118 .if n \l'\\n(.lu\(ul'
 119 .if n .fi
 120 ..
 121 '\"     # BE - end boxed text (draw box now)
 122 .de BE
 123 .nf
 124 .ti 0
 125 .mk ^t
 126 .ie n \l'\\n(^lu\(ul'
 127 .el \{\
 128 .\"     Draw four-sided box normally, but don't draw top of
 129 .\"     box if the box started on an earlier page.
 130 .ie !\\n(^b-1 \{\
 131 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 132 .\}
 133 .el \}\
 134 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 135 .\}
 136 .\}
 137 .fi
 138 .br
 139 .nr ^b 0
 140 ..
 141 '\"     # VS - start vertical sidebar
 142 '\"     # ^Y = starting y location
 143 '\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 144 .de VS
 145 .if !"\\$2"" .br
 146 .mk ^Y
 147 .ie n 'mc \s12\(br\s0
 148 .el .nr ^v 1u
 149 ..
 150 '\"     # VE - end of vertical sidebar
 151 .de VE
 152 .ie n 'mc
 153 .el \{\
 154 .ev 2
 155 .nf
 156 .ti 0
 157 .mk ^t
 158 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 159 .sp -1
 160 .fi
 161 .ev
 162 .\}
 163 .nr ^v 0
 164 ..
 165 '\"     # Special macro to handle page bottom:  finish off current
 166 '\"     # box/sidebar if in box/sidebar mode, then invoked standard
 167 '\"     # page bottom macro.
 168 .de ^B
 169 .ev 2
 170 'ti 0
 171 'nf
 172 .mk ^t
 173 .if \\n(^b \{\
 174 .\"     Draw three-sided box if this is the box's first page,
 175 .\"     draw two sides but no top otherwise.
 176 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 177 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 178 .\}
 179 .if \\n(^v \{\
 180 .nr ^x \\n(^tu+1v-\\n(^Yu
 181 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 182 .\}
 183 .bp
 184 'fi
 185 .ev
 186 .if \\n(^b \{\
 187 .mk ^y
 188 .nr ^b 2
 189 .\}
 190 .if \\n(^v \{\
 191 .mk ^Y
 192 .\}
 193 ..
 194 '\"     # DS - begin display
 195 .de DS
 196 .RS
 197 .nf
 198 .sp
 199 ..
 200 '\"     # DE - end display
 201 .de DE
 202 .fi
 203 .RE
 204 .sp
 205 ..
 206 '\"     # SO - start of list of standard options
 207 .de SO
 208 .SH "STANDARD OPTIONS"
 209 .LP
 210 .nf
 211 .ta 5.5c 11c
 212 .ft B
 213 ..
 214 '\"     # SE - end of list of standard options
 215 .de SE
 216 .fi
 217 .ft R
 218 .LP
 219 See the \\fBoptions\\fR manual entry for details on the standard options.
 220 ..
 221 '\"     # OP - start of full description for a single option
 222 .de OP
 223 .LP
 224 .nf
 225 .ta 4c
 226 Command-Line Name:      \\fB\\$1\\fR
 227 Database Name:  \\fB\\$2\\fR
 228 Database Class: \\fB\\$3\\fR
 229 .fi
 230 .IP
 231 ..
 232 '\"     # CS - begin code excerpt
 233 .de CS
 234 .RS
 235 .nf
 236 .ta .25i .5i .75i 1i
 237 ..
 238 '\"     # CE - end code excerpt
 239 .de CE
 240 .fi
 241 .RE
 242 ..
 243 .de UL
 244 \\$1\l'|0\(ul'\\$2
 245 ..
 246 .TH Tk_GetPixelsFromObj 3 8.1 Tk "Tk Library Procedures"
 247 .BS
 248 .SH NAME
 249 Tk_GetPixelsFromObj, Tk_GetPixels, Tk_GetMMFromObj, Tk_GetScreenMM \- translate between strings and screen units
 250 .SH SYNOPSIS
 251 .nf
 252 \fB#include <tk.h>\fR
 253 .sp
 254 .VS 8.1
 255 int
 256 \fBTk_GetPixelsFromObj(\fIinterp, tkwin, objPtr, intPtr\fB)\fR
 257 .VE
 258 .sp
 259 int
 260 \fBTk_GetPixels(\fIinterp, tkwin, string, intPtr\fB)\fR
 261 .sp
 262 .VS 8.1
 263 int
 264 \fBTk_GetMMFromObj(\fIinterp, tkwin, objPtr, doublePtr\fB)\fR
 265 .VE
 266 .sp
 267 int
 268 \fBTk_GetScreenMM(\fIinterp, tkwin, string, doublePtr\fB)\fR
 269 .SH ARGUMENTS
 270 .AS "Tcl_Interp" *joinPtr
 271 .AP Tcl_Interp *interp in
 272 Interpreter to use for error reporting.
 273 .AP Tk_Window tkwin in
 274 Window whose screen geometry determines the conversion between absolute
 275 units and pixels.
 276 .VS 8.1 br
 277 .AP Tcl_Obj *objPtr in/out
 278 String value specifies a distance on the screen;
 279 internal rep will be modified to cache converted distance.
 280 .AP "CONST char" *string in
 281 Same as \fIobjPtr\fR except specification of distance is passed as
 282 a string.
 283 .VE
 284 .AP int *intPtr out
 285 Pointer to location in which to store converted distance in pixels.
 286 .AP double *doublePtr out
 287 Pointer to location in which to store converted distance in millimeters.
 288 .BE
 289
 290 .SH DESCRIPTION
 291 .PP
 292 These procedures take as argument a specification of distance on
 293 .VS 8.1
 294 the screen (\fIobjPtr\fR or \fIstring\fR) and compute the
 295 .VE
 296 corresponding distance either in integer pixels or floating-point millimeters.
 297 In either case,
 298 .VS 8.1
 299 \fIobjPtr\fR or \fIstring\fR
 300 .VE
 301 specifies a screen distance as a
 302 floating-point number followed by one of the following characters
 303 that indicates units:
 304 .TP
 305 <none>
 306 The number specifies a distance in pixels.
 307 .TP
 308 \fBc\fR
 309 The number specifies a distance in centimeters on the screen.
 310 .TP
 311 \fBi\fR
 312 The number specifies a distance in inches on the screen.
 313 .TP
 314 \fBm\fR
 315 The number specifies a distance in millimeters on the screen.
 316 .TP
 317 \fBp\fR
 318 The number specifies a distance in printer's points (1/72 inch)
 319 on the screen.
 320 .PP
 321 .VS 8.1
 322 \fBTk_GetPixelsFromObj\fR converts the value of \fIobjPtr\fR to the
 323 nearest even number of pixels and stores that value at \fI*intPtr\fR.
 324 It returns \fBTCL_OK\fR under normal circumstances.
 325 If an error occurs (e.g. \fIobjPtr\fR contains a number followed
 326 by a character that isn't one of the ones above) then
 327 \fBTCL_ERROR\fR is returned and an error message is left
 328 in \fIinterp\fR's result if \fIinterp\fR isn't NULL.
 329 \fBTk_GetPixelsFromObj\fR caches information about the return
 330 value in \fIobjPtr\fR, which speeds up future calls to
 331 \fBTk_GetPixelsFromObj\fR with the same \fIobjPtr\fR.
 332 .PP
 333 \fBTk_GetPixels\fR is identical to \fBTk_GetPixelsFromObj\fR except
 334 that the screen distance is specified with a string instead
 335 of an object.  This prevents \fBTk_GetPixels\fR from caching the
 336 return value, so \fBTk_GetAnchor\fR is less efficient than
 337 \fBTk_GetPixelsFromObj\fR.
 338 .PP
 339 \fBTk_GetMMFromObj\fR and \fBTk_GetScreenMM\fR are similar to
 340 \fBTk_GetPixelsFromObj\fR and \fBTk_GetPixels\fR (respectively) except
 341 that they convert the screen distance to millimeters and
 342 store a double-precision floating-point result at \fI*doublePtr\fR.
 343 .VE
 344
 345 .SH KEYWORDS
 346 centimeters, convert, inches, millimeters, pixels, points, screen units