Commit | Line | Data |
---|---|---|
920dae64 AT |
1 | '\" |
2 | '\" Copyright (c) 1990-1993 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: ConfigWind.3,v 1.2 1998/09/14 18:22:46 stanton 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_ConfigureWindow 3 4.0 Tk "Tk Library Procedures" | |
247 | .BS | |
248 | .SH NAME | |
249 | Tk_ConfigureWindow, Tk_MoveWindow, Tk_ResizeWindow, Tk_MoveResizeWindow, Tk_SetWindowBorderWidth, Tk_ChangeWindowAttributes, Tk_SetWindowBackground, Tk_SetWindowBackgroundPixmap, Tk_SetWindowBorder, Tk_SetWindowBorderPixmap, Tk_SetWindowColormap, Tk_DefineCursor, Tk_UndefineCursor \- change window configuration or attributes | |
250 | .SH SYNOPSIS | |
251 | .nf | |
252 | \fB#include <tk.h>\fR | |
253 | .sp | |
254 | \fBTk_ConfigureWindow\fR(\fItkwin, valueMask, valuePtr\fR) | |
255 | .sp | |
256 | \fBTk_MoveWindow\fR(\fItkwin, x, y\fR) | |
257 | .sp | |
258 | \fBTk_ResizeWindow\fR(\fItkwin, width, height\fR) | |
259 | .sp | |
260 | \fBTk_MoveResizeWindow\fR(\fItkwin, x, y, width, height\fR) | |
261 | .sp | |
262 | \fBTk_SetWindowBorderWidth\fR(\fItkwin, borderWidth\fR) | |
263 | .sp | |
264 | \fBTk_ChangeWindowAttributes\fR(\fItkwin, valueMask, attsPtr\fR) | |
265 | .sp | |
266 | \fBTk_SetWindowBackground\fR(\fItkwin, pixel\fR) | |
267 | .sp | |
268 | \fBTk_SetWindowBackgroundPixmap\fR(\fItkwin, pixmap\fR) | |
269 | .sp | |
270 | \fBTk_SetWindowBorder\fR(\fItkwin, pixel\fR) | |
271 | .sp | |
272 | \fBTk_SetWindowBorderPixmap\fR(\fItkwin, pixmap\fR) | |
273 | .sp | |
274 | \fBTk_SetWindowColormap\fR(\fItkwin, colormap\fR) | |
275 | .sp | |
276 | \fBTk_DefineCursor\fR(\fItkwin, cursor\fR) | |
277 | .sp | |
278 | \fBTk_UndefineCursor\fR(\fItkwin\fR) | |
279 | .SH ARGUMENTS | |
280 | .AS XSetWindowAttributes borderWidth | |
281 | .AP Tk_Window tkwin in | |
282 | Token for window. | |
283 | .AP "unsigned int" valueMask in | |
284 | OR-ed mask of values like \fBCWX\fR or \fBCWBorderPixel\fR, | |
285 | indicating which fields of \fI*valuePtr\fR or \fI*attsPtr\fR to use. | |
286 | .AP XWindowChanges *valuePtr in | |
287 | Points to a structure containing new values for the configuration | |
288 | parameters selected by \fIvalueMask\fR. Fields not selected | |
289 | by \fIvalueMask\fR are ignored. | |
290 | .AP int x in | |
291 | New x-coordinate for \fItkwin\fR's top left pixel (including | |
292 | border, if any) within tkwin's parent. | |
293 | .AP int y in | |
294 | New y-coordinate for \fItkwin\fR's top left pixel (including | |
295 | border, if any) within tkwin's parent. | |
296 | .AP "int" width in | |
297 | New width for \fItkwin\fR (interior, not including border). | |
298 | .AP "int" height in | |
299 | New height for \fItkwin\fR (interior, not including border). | |
300 | .AP "int" borderWidth in | |
301 | New width for \fItkwin\fR's border. | |
302 | .AP XSetWindowAttributes *attsPtr in | |
303 | Points to a structure containing new values for the attributes | |
304 | given by the \fIvalueMask\fR argument. Attributes not selected | |
305 | by \fIvalueMask\fR are ignored. | |
306 | .AP "unsigned long" pixel in | |
307 | New background or border color for window. | |
308 | .AP Pixmap pixmap in | |
309 | New pixmap to use for background or border of \fItkwin\fR. WARNING: | |
310 | cannot necessarily be deleted immediately, as for Xlib calls. See | |
311 | note below. | |
312 | .AP Colormap colormap in | |
313 | New colormap to use for \fItkwin\fR. | |
314 | .AP Tk_Cursor cursor in | |
315 | New cursor to use for \fItkwin\fR. If \fBNone\fR is specified, then | |
316 | \fItkwin\fR will not have its own cursor; it will use the cursor | |
317 | of its parent. | |
318 | .BE | |
319 | ||
320 | .SH DESCRIPTION | |
321 | .PP | |
322 | These procedures are analogous to the X library procedures | |
323 | with similar names, such as \fBXConfigureWindow\fR. Each | |
324 | one of the above procedures calls the corresponding X procedure | |
325 | and also saves the configuration information in Tk's local | |
326 | structure for the window. This allows the information to | |
327 | be retrieved quickly by the application (using macros such | |
328 | as \fBTk_X\fR and \fBTk_Height\fR) without having to contact | |
329 | the X server. In addition, if no X window has actually been | |
330 | created for \fItkwin\fR yet, these procedures do not issue | |
331 | X operations or cause event handlers to be invoked; they save | |
332 | the information in Tk's local | |
333 | structure for the window; when the window is created later, | |
334 | the saved information will be used to configure the window. | |
335 | .PP | |
336 | See the X library documentation for details on what these | |
337 | procedures do and how they use their arguments. | |
338 | .PP | |
339 | In the procedures \fBTk_ConfigureWindow\fR, \fBTk_MoveWindow\fR, | |
340 | \fBTk_ResizeWindow\fR, \fBTk_MoveResizeWindow\fR, and | |
341 | \fBTk_SetWindowBorderWidth\fR, | |
342 | if \fItkwin\fR is an internal window then event handlers interested | |
343 | in configure events are invoked immediately, before the procedure | |
344 | returns. If \fItkwin\fR is a top-level window | |
345 | then the event handlers will be invoked later, after X has seen | |
346 | the request and returned an event for it. | |
347 | .PP | |
348 | Applications using Tk should never call procedures like | |
349 | \fBXConfigureWindow\fR directly; they should always use the | |
350 | corresponding Tk procedures. | |
351 | .PP | |
352 | The size and location of a window should only be modified by the | |
353 | appropriate geometry manager for that window and never by a window | |
354 | itself (but see \fBTk_MoveToplevelWindow\fR for moving a top-level | |
355 | window). | |
356 | .PP | |
357 | You may not use \fBTk_ConfigureWindow\fR to change the | |
358 | stacking order of a window (\fIvalueMask\fR may not contain the | |
359 | \fBCWSibling\fR or \fBCWStackMode\fR bits). | |
360 | To change the stacking order, use the procedure \fBTk_RestackWindow\fR. | |
361 | .PP | |
362 | The procedure \fBTk_SetWindowColormap\fR will automatically add | |
363 | \fItkwin\fR to the \fBTK_COLORMAP_WINDOWS\fR property of its | |
364 | nearest top-level ancestor if the new colormap is different from | |
365 | that of \fItkwin\fR's parent and \fItkwin\fR isn't already in | |
366 | the \fBTK_COLORMAP_WINDOWS\fR property. | |
367 | ||
368 | .SH BUGS | |
369 | .PP | |
370 | \fBTk_SetWindowBackgroundPixmap\fR and \fBTk_SetWindowBorderPixmap\fR | |
371 | differ slightly from their Xlib counterparts in that the \fIpixmap\fR | |
372 | argument may not necessarily be deleted immediately after calling | |
373 | one of these procedures. This is because \fItkwin\fR's window | |
374 | may not exist yet at the time of the call, in which case \fIpixmap\fR | |
375 | is merely saved and used later when \fItkwin\fR's window is actually | |
376 | created. If you wish to delete \fIpixmap\fR, then call | |
377 | \fBTk_MakeWindowExist\fR first to be sure that \fItkwin\fR's window exists | |
378 | and \fIpixmap\fR has been passed to the X server. | |
379 | .PP | |
380 | A similar problem occurs for the \fIcursor\fR argument passed to | |
381 | \fBTk_DefineCursor\fR. The solution is the same as for pixmaps above: | |
382 | call \fBTk_MakeWindowExist\fR before freeing the cursor. | |
383 | ||
384 | .SH "SEE ALSO" | |
385 | Tk_MoveToplevelWindow, Tk_RestackWindow | |
386 | ||
387 | .SH KEYWORDS | |
388 | attributes, border, color, configure, height, pixel, pixmap, width, window, x, y |