| 1 | '\" |
| 2 | '\" Copyright (c) 1994-1996 Sun Microsystems, Inc. |
| 3 | '\" |
| 4 | '\" See the file "license.terms" for information on usage and redistribution |
| 5 | '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. |
| 6 | '\" |
| 7 | '\" RCS: @(#) $Id: CanvTkwin.3,v 1.3 2002/01/25 21:09:36 dgp Exp $ |
| 8 | '\" |
| 9 | '\" The definitions below are for supplemental macros used in Tcl/Tk |
| 10 | '\" manual entries. |
| 11 | '\" |
| 12 | '\" .AP type name in/out ?indent? |
| 13 | '\" Start paragraph describing an argument to a library procedure. |
| 14 | '\" type is type of argument (int, etc.), in/out is either "in", "out", |
| 15 | '\" or "in/out" to describe whether procedure reads or modifies arg, |
| 16 | '\" and indent is equivalent to second arg of .IP (shouldn't ever be |
| 17 | '\" needed; use .AS below instead) |
| 18 | '\" |
| 19 | '\" .AS ?type? ?name? |
| 20 | '\" Give maximum sizes of arguments for setting tab stops. Type and |
| 21 | '\" name are examples of largest possible arguments that will be passed |
| 22 | '\" to .AP later. If args are omitted, default tab stops are used. |
| 23 | '\" |
| 24 | '\" .BS |
| 25 | '\" Start box enclosure. From here until next .BE, everything will be |
| 26 | '\" enclosed in one large box. |
| 27 | '\" |
| 28 | '\" .BE |
| 29 | '\" End of box enclosure. |
| 30 | '\" |
| 31 | '\" .CS |
| 32 | '\" Begin code excerpt. |
| 33 | '\" |
| 34 | '\" .CE |
| 35 | '\" End code excerpt. |
| 36 | '\" |
| 37 | '\" .VS ?version? ?br? |
| 38 | '\" Begin vertical sidebar, for use in marking newly-changed parts |
| 39 | '\" of man pages. The first argument is ignored and used for recording |
| 40 | '\" the version when the .VS was added, so that the sidebars can be |
| 41 | '\" found and removed when they reach a certain age. If another argument |
| 42 | '\" is present, then a line break is forced before starting the sidebar. |
| 43 | '\" |
| 44 | '\" .VE |
| 45 | '\" End of vertical sidebar. |
| 46 | '\" |
| 47 | '\" .DS |
| 48 | '\" Begin an indented unfilled display. |
| 49 | '\" |
| 50 | '\" .DE |
| 51 | '\" End of indented unfilled display. |
| 52 | '\" |
| 53 | '\" .SO |
| 54 | '\" Start of list of standard options for a Tk widget. The |
| 55 | '\" options follow on successive lines, in four columns separated |
| 56 | '\" by tabs. |
| 57 | '\" |
| 58 | '\" .SE |
| 59 | '\" End of list of standard options for a Tk widget. |
| 60 | '\" |
| 61 | '\" .OP cmdName dbName dbClass |
| 62 | '\" Start of description of a specific option. cmdName gives the |
| 63 | '\" option's name as specified in the class command, dbName gives |
| 64 | '\" the option's name in the option database, and dbClass gives |
| 65 | '\" the option's class in the option database. |
| 66 | '\" |
| 67 | '\" .UL arg1 arg2 |
| 68 | '\" Print arg1 underlined, then print arg2 normally. |
| 69 | '\" |
| 70 | '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $ |
| 71 | '\" |
| 72 | '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. |
| 73 | .if t .wh -1.3i ^B |
| 74 | .nr ^l \n(.l |
| 75 | .ad b |
| 76 | '\" # Start an argument description |
| 77 | .de AP |
| 78 | .ie !"\\$4"" .TP \\$4 |
| 79 | .el \{\ |
| 80 | . ie !"\\$2"" .TP \\n()Cu |
| 81 | . el .TP 15 |
| 82 | .\} |
| 83 | .ta \\n()Au \\n()Bu |
| 84 | .ie !"\\$3"" \{\ |
| 85 | \&\\$1 \\fI\\$2\\fP (\\$3) |
| 86 | .\".b |
| 87 | .\} |
| 88 | .el \{\ |
| 89 | .br |
| 90 | .ie !"\\$2"" \{\ |
| 91 | \&\\$1 \\fI\\$2\\fP |
| 92 | .\} |
| 93 | .el \{\ |
| 94 | \&\\fI\\$1\\fP |
| 95 | .\} |
| 96 | .\} |
| 97 | .. |
| 98 | '\" # define tabbing values for .AP |
| 99 | .de AS |
| 100 | .nr )A 10n |
| 101 | .if !"\\$1"" .nr )A \\w'\\$1'u+3n |
| 102 | .nr )B \\n()Au+15n |
| 103 | .\" |
| 104 | .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n |
| 105 | .nr )C \\n()Bu+\\w'(in/out)'u+2n |
| 106 | .. |
| 107 | .AS Tcl_Interp Tcl_CreateInterp in/out |
| 108 | '\" # BS - start boxed text |
| 109 | '\" # ^y = starting y location |
| 110 | '\" # ^b = 1 |
| 111 | .de BS |
| 112 | .br |
| 113 | .mk ^y |
| 114 | .nr ^b 1u |
| 115 | .if n .nf |
| 116 | .if n .ti 0 |
| 117 | .if n \l'\\n(.lu\(ul' |
| 118 | .if n .fi |
| 119 | .. |
| 120 | '\" # BE - end boxed text (draw box now) |
| 121 | .de BE |
| 122 | .nf |
| 123 | .ti 0 |
| 124 | .mk ^t |
| 125 | .ie n \l'\\n(^lu\(ul' |
| 126 | .el \{\ |
| 127 | .\" Draw four-sided box normally, but don't draw top of |
| 128 | .\" box if the box started on an earlier page. |
| 129 | .ie !\\n(^b-1 \{\ |
| 130 | \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
| 131 | .\} |
| 132 | .el \}\ |
| 133 | \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
| 134 | .\} |
| 135 | .\} |
| 136 | .fi |
| 137 | .br |
| 138 | .nr ^b 0 |
| 139 | .. |
| 140 | '\" # VS - start vertical sidebar |
| 141 | '\" # ^Y = starting y location |
| 142 | '\" # ^v = 1 (for troff; for nroff this doesn't matter) |
| 143 | .de VS |
| 144 | .if !"\\$2"" .br |
| 145 | .mk ^Y |
| 146 | .ie n 'mc \s12\(br\s0 |
| 147 | .el .nr ^v 1u |
| 148 | .. |
| 149 | '\" # VE - end of vertical sidebar |
| 150 | .de VE |
| 151 | .ie n 'mc |
| 152 | .el \{\ |
| 153 | .ev 2 |
| 154 | .nf |
| 155 | .ti 0 |
| 156 | .mk ^t |
| 157 | \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' |
| 158 | .sp -1 |
| 159 | .fi |
| 160 | .ev |
| 161 | .\} |
| 162 | .nr ^v 0 |
| 163 | .. |
| 164 | '\" # Special macro to handle page bottom: finish off current |
| 165 | '\" # box/sidebar if in box/sidebar mode, then invoked standard |
| 166 | '\" # page bottom macro. |
| 167 | .de ^B |
| 168 | .ev 2 |
| 169 | 'ti 0 |
| 170 | 'nf |
| 171 | .mk ^t |
| 172 | .if \\n(^b \{\ |
| 173 | .\" Draw three-sided box if this is the box's first page, |
| 174 | .\" draw two sides but no top otherwise. |
| 175 | .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 |
| 176 | .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c |
| 177 | .\} |
| 178 | .if \\n(^v \{\ |
| 179 | .nr ^x \\n(^tu+1v-\\n(^Yu |
| 180 | \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c |
| 181 | .\} |
| 182 | .bp |
| 183 | 'fi |
| 184 | .ev |
| 185 | .if \\n(^b \{\ |
| 186 | .mk ^y |
| 187 | .nr ^b 2 |
| 188 | .\} |
| 189 | .if \\n(^v \{\ |
| 190 | .mk ^Y |
| 191 | .\} |
| 192 | .. |
| 193 | '\" # DS - begin display |
| 194 | .de DS |
| 195 | .RS |
| 196 | .nf |
| 197 | .sp |
| 198 | .. |
| 199 | '\" # DE - end display |
| 200 | .de DE |
| 201 | .fi |
| 202 | .RE |
| 203 | .sp |
| 204 | .. |
| 205 | '\" # SO - start of list of standard options |
| 206 | .de SO |
| 207 | .SH "STANDARD OPTIONS" |
| 208 | .LP |
| 209 | .nf |
| 210 | .ta 5.5c 11c |
| 211 | .ft B |
| 212 | .. |
| 213 | '\" # SE - end of list of standard options |
| 214 | .de SE |
| 215 | .fi |
| 216 | .ft R |
| 217 | .LP |
| 218 | See the \\fBoptions\\fR manual entry for details on the standard options. |
| 219 | .. |
| 220 | '\" # OP - start of full description for a single option |
| 221 | .de OP |
| 222 | .LP |
| 223 | .nf |
| 224 | .ta 4c |
| 225 | Command-Line Name: \\fB\\$1\\fR |
| 226 | Database Name: \\fB\\$2\\fR |
| 227 | Database Class: \\fB\\$3\\fR |
| 228 | .fi |
| 229 | .IP |
| 230 | .. |
| 231 | '\" # CS - begin code excerpt |
| 232 | .de CS |
| 233 | .RS |
| 234 | .nf |
| 235 | .ta .25i .5i .75i 1i |
| 236 | .. |
| 237 | '\" # CE - end code excerpt |
| 238 | .de CE |
| 239 | .fi |
| 240 | .RE |
| 241 | .. |
| 242 | .de UL |
| 243 | \\$1\l'|0\(ul'\\$2 |
| 244 | .. |
| 245 | .TH Tk_CanvasTkwin 3 4.1 Tk "Tk Library Procedures" |
| 246 | .BS |
| 247 | .SH NAME |
| 248 | Tk_CanvasTkwin, Tk_CanvasGetCoord, Tk_CanvasDrawableCoords, Tk_CanvasSetStippleOrigin, Tk_CanvasWindowCoords, Tk_CanvasEventuallyRedraw, Tk_CanvasTagsOption \- utility procedures for canvas type managers |
| 249 | .SH SYNOPSIS |
| 250 | .nf |
| 251 | \fB#include <tk.h>\fR |
| 252 | .sp |
| 253 | Tk_Window |
| 254 | \fBTk_CanvasTkwin\fR(\fIcanvas\fR) |
| 255 | .sp |
| 256 | int |
| 257 | \fBTk_CanvasGetCoord\fR(\fIinterp, canvas, string, doublePtr\fR) |
| 258 | .sp |
| 259 | \fBTk_CanvasDrawableCoords\fR(\fIcanvas, x, y, drawableXPtr, drawableYPtr\fR) |
| 260 | .sp |
| 261 | \fBTk_CanvasSetStippleOrigin\fR(\fIcanvas, gc\fR) |
| 262 | .sp |
| 263 | \fBTk_CanvasWindowCoords\fR(\fIcanvas, x, y, screenXPtr, screenYPtr\fR) |
| 264 | .sp |
| 265 | \fBTk_CanvasEventuallyRedraw\fR(\fIcanvas, x1, y1, x2, y2\fR) |
| 266 | .sp |
| 267 | Tk_OptionParseProc *\fBTk_CanvasTagsParseProc\fR; |
| 268 | .sp |
| 269 | Tk_OptionPrintProc *\fBTk_CanvasTagsPrintProc\fR; |
| 270 | .SH ARGUMENTS |
| 271 | .AS Tk_ItemType *drawableXPtr |
| 272 | .AP Tk_Canvas canvas in |
| 273 | A token that identifies a canvas widget. |
| 274 | .AP Tcl_Interp *interp in/out |
| 275 | Interpreter to use for error reporting. |
| 276 | .AP "CONST char" *string in |
| 277 | Textual description of a canvas coordinate. |
| 278 | .AP double *doublePtr out |
| 279 | Points to place to store a converted coordinate. |
| 280 | .AP double x in |
| 281 | An x coordinate in the space of the canvas. |
| 282 | .AP double y in |
| 283 | A y coordinate in the space of the canvas. |
| 284 | .AP short *drawableXPtr out |
| 285 | Pointer to a location in which to store an x coordinate in the space |
| 286 | of the drawable currently being used to redisplay the canvas. |
| 287 | .AP short *drawableYPtr out |
| 288 | Pointer to a location in which to store a y coordinate in the space |
| 289 | of the drawable currently being used to redisplay the canvas. |
| 290 | .AP GC gc out |
| 291 | Graphics context to modify. |
| 292 | .AP short *screenXPtr out |
| 293 | Points to a location in which to store the screen coordinate in the |
| 294 | canvas window that corresponds to \fIx\fR. |
| 295 | .AP short *screenYPtr out |
| 296 | Points to a location in which to store the screen coordinate in the |
| 297 | canvas window that corresponds to \fIy\fR. |
| 298 | .AP int x1 in |
| 299 | Left edge of the region that needs redisplay. Only pixels at or to |
| 300 | the right of this coordinate need to be redisplayed. |
| 301 | .AP int y1 in |
| 302 | Top edge of the region that needs redisplay. Only pixels at or below |
| 303 | this coordinate need to be redisplayed. |
| 304 | .AP int x2 in |
| 305 | Right edge of the region that needs redisplay. Only pixels to |
| 306 | the left of this coordinate need to be redisplayed. |
| 307 | .AP int y2 in |
| 308 | Bottom edge of the region that needs redisplay. Only pixels above |
| 309 | this coordinate need to be redisplayed. |
| 310 | .BE |
| 311 | |
| 312 | .SH DESCRIPTION |
| 313 | .PP |
| 314 | These procedures are called by canvas type managers to perform various |
| 315 | utility functions. |
| 316 | .PP |
| 317 | \fBTk_CanvasTkwin\fR returns the Tk_Window associated with a particular |
| 318 | canvas. |
| 319 | .PP |
| 320 | \fBTk_CanvasGetCoord\fR translates a string specification of a |
| 321 | coordinate (such as \fB2p\fR or \fB1.6c\fR) into a double-precision |
| 322 | canvas coordinate. |
| 323 | If \fIstring\fR is a valid coordinate description then \fBTk_CanvasGetCoord\fR |
| 324 | stores the corresponding canvas coordinate at *\fIdoublePtr\fR |
| 325 | and returns TCL_OK. |
| 326 | Otherwise it stores an error message in \fIinterp->result\fR and |
| 327 | returns TCL_ERROR. |
| 328 | .PP |
| 329 | \fBTk_CanvasDrawableCoords\fR is called by type managers during |
| 330 | redisplay to compute where to draw things. |
| 331 | Given \fIx\fR and \fIy\fR coordinates in the space of the |
| 332 | canvas, \fBTk_CanvasDrawableCoords\fR computes the corresponding |
| 333 | pixel in the drawable that is currently being used for redisplay; |
| 334 | it returns those coordinates in *\fIdrawableXPtr\fR and *\fIdrawableYPtr\fR. |
| 335 | This procedure should not be invoked except during redisplay. |
| 336 | .PP |
| 337 | \fBTk_CanvasSetStippleOrigin\fR is also used during redisplay. |
| 338 | It sets the stipple origin in \fIgc\fR so that stipples drawn |
| 339 | with \fIgc\fR in the current offscreen pixmap will line up |
| 340 | with stipples drawn with origin (0,0) in the canvas's actual |
| 341 | window. |
| 342 | \fBTk_CanvasSetStippleOrigin\fR is needed in order to guarantee |
| 343 | that stipple patterns line up properly when the canvas is |
| 344 | redisplayed in small pieces. |
| 345 | Redisplays are carried out in double-buffered fashion where a |
| 346 | piece of the canvas is redrawn in an offscreen pixmap and then |
| 347 | copied back onto the screen. |
| 348 | In this approach the stipple origins in graphics contexts need to |
| 349 | be adjusted during each redisplay to compensate for the position |
| 350 | of the off-screen pixmap relative to the window. |
| 351 | If an item is being drawn with stipples, its type manager typically |
| 352 | calls \fBTk_CanvasSetStippleOrigin\fR just before using \fIgc\fR |
| 353 | to draw something; after it is finished drawing, the type manager |
| 354 | calls \fBXSetTSOrigin\fR to restore the origin in \fIgc\fR back to (0,0) |
| 355 | (the restore is needed because graphics contexts are shared, so |
| 356 | they cannot be modified permanently). |
| 357 | .PP |
| 358 | \fBTk_CanvasWindowCoords\fR is similar to \fBTk_CanvasDrawableCoords\fR |
| 359 | except that it returns coordinates in the canvas's window on the |
| 360 | screen, instead of coordinates in an off-screen pixmap. |
| 361 | .PP |
| 362 | \fBTk_CanvasEventuallyRedraw\fR may be invoked by a type manager |
| 363 | to inform Tk that a portion of a canvas needs to be redrawn. |
| 364 | The \fIx1\fR, \fIy1\fR, \fIx2\fR, and \fIy2\fR arguments |
| 365 | specify the region that needs to be redrawn, in canvas coordinates. |
| 366 | Type managers rarely need to invoke \fBTk_CanvasEventuallyRedraw\fR, |
| 367 | since Tk can normally figure out when an item has changed and make |
| 368 | the redisplay request on its behalf (this happens, for example |
| 369 | whenever Tk calls a \fIconfigureProc\fR or \fIscaleProc\fR). |
| 370 | The only time that a type manager needs to call |
| 371 | \fBTk_CanvasEventuallyRedraw\fR is if an item has changed on its own |
| 372 | without being invoked through one of the procedures in its Tk_ItemType; |
| 373 | this could happen, for example, in an image item if the image is |
| 374 | modified using image commands. |
| 375 | .PP |
| 376 | \fBTk_CanvasTagsParseProc\fR and \fBTk_CanvasTagsPrintProc\fR are |
| 377 | procedures that handle the \fB\-tags\fR option for canvas items. |
| 378 | The code of a canvas type manager won't call these procedures |
| 379 | directly, but will use their addresses to create a \fBTk_CustomOption\fR |
| 380 | structure for the \fB\-tags\fR option. The code typically looks |
| 381 | like this: |
| 382 | .CS |
| 383 | static Tk_CustomOption tagsOption = {Tk_CanvasTagsParseProc, |
| 384 | Tk_CanvasTagsPrintProc, (ClientData) NULL |
| 385 | }; |
| 386 | |
| 387 | static Tk_ConfigSpec configSpecs[] = { |
| 388 | ... |
| 389 | {TK_CONFIG_CUSTOM, "\-tags", (char *) NULL, (char *) NULL, |
| 390 | (char *) NULL, 0, TK_CONFIG_NULL_OK, &tagsOption}, |
| 391 | ... |
| 392 | }; |
| 393 | .CE |
| 394 | |
| 395 | .SH KEYWORDS |
| 396 | canvas, focus, item type, redisplay, selection, type manager |