| 1 | '\" |
| 2 | '\" Copyright (c) 1990 The Regents of the University of California. |
| 3 | '\" Copyright (c) 1994-1996 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: CrtWindow.3,v 1.6 2002/08/05 04:30:38 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_CreateWindow 3 4.2 Tk "Tk Library Procedures" |
| 247 | .BS |
| 248 | .SH NAME |
| 249 | Tk_CreateWindow, Tk_CreateWindowFromPath, Tk_DestroyWindow, Tk_MakeWindowExist \- create or delete window |
| 250 | .SH SYNOPSIS |
| 251 | .nf |
| 252 | \fB#include <tk.h>\fR |
| 253 | .sp |
| 254 | Tk_Window |
| 255 | \fBTk_CreateWindow\fR(\fIinterp, parent, name, topLevScreen\fR) |
| 256 | .sp |
| 257 | Tk_Window |
| 258 | \fBTk_CreateAnonymousWindow\fR(\fIinterp, parent, topLevScreen\fR) |
| 259 | .sp |
| 260 | Tk_Window |
| 261 | \fBTk_CreateWindowFromPath\fR(\fIinterp, tkwin, pathName, topLevScreen\fR) |
| 262 | .sp |
| 263 | \fBTk_DestroyWindow\fR(\fItkwin\fR) |
| 264 | .sp |
| 265 | \fBTk_MakeWindowExist\fR(\fItkwin\fR) |
| 266 | .SH ARGUMENTS |
| 267 | .AS Tcl_Interp *topLevScreen |
| 268 | .AP Tcl_Interp *interp out |
| 269 | Tcl interpreter to use for error reporting. If no error occurs, |
| 270 | then \fI*interp\fR isn't modified. |
| 271 | .AP Tk_Window parent in |
| 272 | Token for the window that is to serve as the logical parent of |
| 273 | the new window. |
| 274 | .AP "CONST char" *name in |
| 275 | Name to use for this window. Must be unique among all children of |
| 276 | the same \fIparent\fR. |
| 277 | .AP "CONST char" *topLevScreen in |
| 278 | Has same format as \fIscreenName\fR. If NULL, then new window is |
| 279 | created as an internal window. If non-NULL, new window is created as |
| 280 | a top-level window on screen \fItopLevScreen\fR. If \fItopLevScreen\fR |
| 281 | is an empty string (``'') then new |
| 282 | window is created as top-level window of \fIparent\fR's screen. |
| 283 | .AP Tk_Window tkwin in |
| 284 | Token for window. |
| 285 | .AP "CONST char" *pathName in |
| 286 | Name of new window, specified as path name within application |
| 287 | (e.g. \fB.a.b.c\fR). |
| 288 | .BE |
| 289 | |
| 290 | .SH DESCRIPTION |
| 291 | .PP |
| 292 | The procedures \fBTk_CreateWindow\fR, |
| 293 | .VS |
| 294 | \fBTk_CreateAnonymousWindow\fR, and \fBTk_CreateWindowFromPath\fR |
| 295 | are used to create new windows for |
| 296 | use in Tk-based applications. Each of the procedures returns a token |
| 297 | that can be used to manipulate the window in other calls to the Tk |
| 298 | library. If the window couldn't be created successfully, then NULL |
| 299 | is returned and \fIinterp->result\fR is modified to hold an error |
| 300 | message. |
| 301 | .PP |
| 302 | Tk supports two different kinds of windows: internal |
| 303 | windows and top-level windows. |
| 304 | .VE |
| 305 | An internal window is an interior window of a Tk application, such as a |
| 306 | scrollbar or menu bar or button. A top-level window is one that is |
| 307 | created as a child of a screen's root window, rather than as an |
| 308 | interior window, but which is logically part of some existing main |
| 309 | window. Examples of top-level windows are pop-up menus and dialog boxes. |
| 310 | .PP |
| 311 | New windows may be created by calling |
| 312 | \fBTk_CreateWindow\fR. If the \fItopLevScreen\fR argument is |
| 313 | NULL, then the new window will be an internal window. If |
| 314 | \fItopLevScreen\fR is non-NULL, then the new window will be a |
| 315 | top-level window: \fItopLevScreen\fR indicates the name of |
| 316 | a screen and the new window will be created as a child of the |
| 317 | root window of \fItopLevScreen\fR. In either case Tk will |
| 318 | consider the new window to be the logical child of \fIparent\fR: |
| 319 | the new window's path name will reflect this fact, options may |
| 320 | be specified for the new window under this assumption, and so on. |
| 321 | The only difference is that new X window for a top-level window |
| 322 | will not be a child of \fIparent\fR's X window. For example, a pull-down |
| 323 | menu's \fIparent\fR would be the button-like window used to invoke it, |
| 324 | which would in turn be a child of the menu bar window. A dialog box might |
| 325 | have the application's main window as its parent. |
| 326 | .PP |
| 327 | \fBTk_CreateAnonymousWindow\fR differs from \fBTk_CreateWindow\fR in |
| 328 | that it creates an unnamed window. This window will be manipulable |
| 329 | only using C interfaces, and will not be visible to Tcl scripts. Both |
| 330 | interior windows and top-level windows may be created with |
| 331 | \fBTk_CreateAnonymousWindow\fR. |
| 332 | .PP |
| 333 | \fBTk_CreateWindowFromPath\fR offers an alternate way of specifying |
| 334 | new windows. In \fBTk_CreateWindowFromPath\fR the new |
| 335 | window is specified with a token for any window in the target |
| 336 | application (\fItkwin\fR), plus a path name for the new window. |
| 337 | It produces the same effect as \fBTk_CreateWindow\fR and allows |
| 338 | both top-level and internal windows to be created, depending on |
| 339 | the value of \fItopLevScreen\fR. In calls to \fBTk_CreateWindowFromPath\fR, |
| 340 | as in calls to \fBTk_CreateWindow\fR, the parent of the new window |
| 341 | must exist at the time of the call, but the new window must not |
| 342 | already exist. |
| 343 | .PP |
| 344 | The window creation procedures don't |
| 345 | actually issue the command to X to create a window. |
| 346 | Instead, they create a local data structure associated with |
| 347 | the window and defer the creation of the X window. |
| 348 | The window will actually be created by the first call to |
| 349 | \fBTk_MapWindow\fR. Deferred window creation allows various |
| 350 | aspects of the window (such as its size, background color, |
| 351 | etc.) to be modified after its creation without incurring |
| 352 | any overhead in the X server. When the window is finally |
| 353 | mapped all of the window attributes can be set while creating |
| 354 | the window. |
| 355 | .PP |
| 356 | The value returned by a window-creation procedure is not the |
| 357 | X token for the window (it can't be, since X hasn't been |
| 358 | asked to create the window yet). Instead, it is a token |
| 359 | for Tk's local data structure for the window. Most |
| 360 | of the Tk library procedures take Tk_Window tokens, rather |
| 361 | than X identifiers. The actual |
| 362 | X window identifier can be retrieved from the local |
| 363 | data structure using the \fBTk_WindowId\fR macro; see |
| 364 | the manual entry for \fBTk_WindowId\fR for details. |
| 365 | .PP |
| 366 | \fBTk_DestroyWindow\fR deletes a window and all the data |
| 367 | structures associated with it, including any event handlers |
| 368 | created with \fBTk_CreateEventHandler\fR. In addition, |
| 369 | \fBTk_DestroyWindow\fR will delete any children of \fItkwin\fR |
| 370 | recursively (where children are defined in the Tk sense, consisting |
| 371 | of all windows that were created with the given window as \fIparent\fR). |
| 372 | If \fItkwin\fR is an internal window, then event |
| 373 | handlers interested in destroy events |
| 374 | are invoked immediately. If \fItkwin\fR is a top-level or main window, |
| 375 | then the event handlers will be invoked later, after X has seen |
| 376 | the request and returned an event for it. |
| 377 | .PP |
| 378 | If a window has been created |
| 379 | but hasn't been mapped, so no X window exists, it is |
| 380 | possible to force the creation of the X window by |
| 381 | calling \fBTk_MakeWindowExist\fR. This procedure issues |
| 382 | the X commands to instantiate the window given by \fItkwin\fR. |
| 383 | |
| 384 | .SH KEYWORDS |
| 385 | create, deferred creation, destroy, display, internal window, |
| 386 | screen, top-level window, window |