util/X86LINUX64/man/man3/Tk_SetWindowBorderWidth.3

   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 .TH Tk_ConfigureWindow 3 4.0 Tk "Tk Library Procedures"
   9 .\" The -*- nroff -*- definitions below are for supplemental macros used
  10 .\" in Tcl/Tk 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 ?manpage?
  54 .\"     Start of list of standard options for a Tk widget. The manpage
  55 .\"     argument defines where to look up the standard options; if
  56 .\"     omitted, defaults to "options". The options follow on successive
  57 .\"     lines, in three columns separated 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 .\" .QW arg1 ?arg2?
  72 .\"     Print arg1 in quotes, then arg2 normally (for trailing punctuation).
  73 .\"
  74 .\" .PQ arg1 ?arg2?
  75 .\"     Print an open parenthesis, arg1 in quotes, then arg2 normally
  76 .\"     (for trailing punctuation) and then a closing parenthesis.
  77 .\"
  78 .\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
  79 .if t .wh -1.3i ^B
  80 .nr ^l \n(.l
  81 .ad b
  82 .\"     # Start an argument description
  83 .de AP
  84 .ie !"\\$4"" .TP \\$4
  85 .el \{\
  86 .   ie !"\\$2"" .TP \\n()Cu
  87 .   el          .TP 15
  88 .\}
  89 .ta \\n()Au \\n()Bu
  90 .ie !"\\$3"" \{\
  91 \&\\$1 \\fI\\$2\\fP (\\$3)
  92 .\".b
  93 .\}
  94 .el \{\
  95 .br
  96 .ie !"\\$2"" \{\
  97 \&\\$1  \\fI\\$2\\fP
  98 .\}
  99 .el \{\
 100 \&\\fI\\$1\\fP
 101 .\}
 102 .\}
 103 ..
 104 .\"     # define tabbing values for .AP
 105 .de AS
 106 .nr )A 10n
 107 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 108 .nr )B \\n()Au+15n
 109 .\"
 110 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 111 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 112 ..
 113 .AS Tcl_Interp Tcl_CreateInterp in/out
 114 .\"     # BS - start boxed text
 115 .\"     # ^y = starting y location
 116 .\"     # ^b = 1
 117 .de BS
 118 .br
 119 .mk ^y
 120 .nr ^b 1u
 121 .if n .nf
 122 .if n .ti 0
 123 .if n \l'\\n(.lu\(ul'
 124 .if n .fi
 125 ..
 126 .\"     # BE - end boxed text (draw box now)
 127 .de BE
 128 .nf
 129 .ti 0
 130 .mk ^t
 131 .ie n \l'\\n(^lu\(ul'
 132 .el \{\
 133 .\"     Draw four-sided box normally, but don't draw top of
 134 .\"     box if the box started on an earlier page.
 135 .ie !\\n(^b-1 \{\
 136 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 137 .\}
 138 .el \}\
 139 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 140 .\}
 141 .\}
 142 .fi
 143 .br
 144 .nr ^b 0
 145 ..
 146 .\"     # VS - start vertical sidebar
 147 .\"     # ^Y = starting y location
 148 .\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 149 .de VS
 150 .if !"\\$2"" .br
 151 .mk ^Y
 152 .ie n 'mc \s12\(br\s0
 153 .el .nr ^v 1u
 154 ..
 155 .\"     # VE - end of vertical sidebar
 156 .de VE
 157 .ie n 'mc
 158 .el \{\
 159 .ev 2
 160 .nf
 161 .ti 0
 162 .mk ^t
 163 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 164 .sp -1
 165 .fi
 166 .ev
 167 .\}
 168 .nr ^v 0
 169 ..
 170 .\"     # Special macro to handle page bottom:  finish off current
 171 .\"     # box/sidebar if in box/sidebar mode, then invoked standard
 172 .\"     # page bottom macro.
 173 .de ^B
 174 .ev 2
 175 'ti 0
 176 'nf
 177 .mk ^t
 178 .if \\n(^b \{\
 179 .\"     Draw three-sided box if this is the box's first page,
 180 .\"     draw two sides but no top otherwise.
 181 .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
 182 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 183 .\}
 184 .if \\n(^v \{\
 185 .nr ^x \\n(^tu+1v-\\n(^Yu
 186 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 187 .\}
 188 .bp
 189 'fi
 190 .ev
 191 .if \\n(^b \{\
 192 .mk ^y
 193 .nr ^b 2
 194 .\}
 195 .if \\n(^v \{\
 196 .mk ^Y
 197 .\}
 198 ..
 199 .\"     # DS - begin display
 200 .de DS
 201 .RS
 202 .nf
 203 .sp
 204 ..
 205 .\"     # DE - end display
 206 .de DE
 207 .fi
 208 .RE
 209 .sp
 210 ..
 211 .\"     # SO - start of list of standard options
 212 .de SO
 213 'ie '\\$1'' .ds So \\fBoptions\\fR
 214 'el .ds So \\fB\\$1\\fR
 215 .SH "STANDARD OPTIONS"
 216 .LP
 217 .nf
 218 .ta 5.5c 11c
 219 .ft B
 220 ..
 221 .\"     # SE - end of list of standard options
 222 .de SE
 223 .fi
 224 .ft R
 225 .LP
 226 See the \\*(So manual entry for details on the standard options.
 227 ..
 228 .\"     # OP - start of full description for a single option
 229 .de OP
 230 .LP
 231 .nf
 232 .ta 4c
 233 Command-Line Name:      \\fB\\$1\\fR
 234 Database Name:  \\fB\\$2\\fR
 235 Database Class: \\fB\\$3\\fR
 236 .fi
 237 .IP
 238 ..
 239 .\"     # CS - begin code excerpt
 240 .de CS
 241 .RS
 242 .nf
 243 .ta .25i .5i .75i 1i
 244 ..
 245 .\"     # CE - end code excerpt
 246 .de CE
 247 .fi
 248 .RE
 249 ..
 250 .\"     # UL - underline word
 251 .de UL
 252 \\$1\l'|0\(ul'\\$2
 253 ..
 254 .\"     # QW - apply quotation marks to word
 255 .de QW
 256 .ie '\\*(lq'"' ``\\$1''\\$2
 257 .\"" fix emacs highlighting
 258 .el \\*(lq\\$1\\*(rq\\$2
 259 ..
 260 .\"     # PQ - apply parens and quotation marks to word
 261 .de PQ
 262 .ie '\\*(lq'"' (``\\$1''\\$2)\\$3
 263 .\"" fix emacs highlighting
 264 .el (\\*(lq\\$1\\*(rq\\$2)\\$3
 265 ..
 266 .\"     # QR - quoted range
 267 .de QR
 268 .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
 269 .\"" fix emacs highlighting
 270 .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
 271 ..
 272 .\"     # MT - "empty" string
 273 .de MT
 274 .QW ""
 275 ..
 276 .BS
 277 .SH NAME
 278 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
 279 .SH SYNOPSIS
 280 .nf
 281 \fB#include <tk.h>\fR
 282 .sp
 283 \fBTk_ConfigureWindow\fR(\fItkwin, valueMask, valuePtr\fR)
 284 .sp
 285 \fBTk_MoveWindow\fR(\fItkwin, x, y\fR)
 286 .sp
 287 \fBTk_ResizeWindow\fR(\fItkwin, width, height\fR)
 288 .sp
 289 \fBTk_MoveResizeWindow\fR(\fItkwin, x,  y, width, height\fR)
 290 .sp
 291 \fBTk_SetWindowBorderWidth\fR(\fItkwin, borderWidth\fR)
 292 .sp
 293 \fBTk_ChangeWindowAttributes\fR(\fItkwin, valueMask, attsPtr\fR)
 294 .sp
 295 \fBTk_SetWindowBackground\fR(\fItkwin, pixel\fR)
 296 .sp
 297 \fBTk_SetWindowBackgroundPixmap\fR(\fItkwin, pixmap\fR)
 298 .sp
 299 \fBTk_SetWindowBorder\fR(\fItkwin, pixel\fR)
 300 .sp
 301 \fBTk_SetWindowBorderPixmap\fR(\fItkwin, pixmap\fR)
 302 .sp
 303 \fBTk_SetWindowColormap\fR(\fItkwin, colormap\fR)
 304 .sp
 305 \fBTk_DefineCursor\fR(\fItkwin, cursor\fR)
 306 .sp
 307 \fBTk_UndefineCursor\fR(\fItkwin\fR)
 308 .SH ARGUMENTS
 309 .AS XSetWindowAttributes borderWidth
 310 .AP Tk_Window tkwin in
 311 Token for window.
 312 .AP "unsigned int" valueMask in
 313 OR-ed mask of values like \fBCWX\fR or \fBCWBorderPixel\fR,
 314 indicating which fields of \fI*valuePtr\fR or \fI*attsPtr\fR to use.
 315 .AP XWindowChanges *valuePtr in
 316 Points to a structure containing new values for the configuration
 317 parameters selected by \fIvalueMask\fR.  Fields not selected
 318 by \fIvalueMask\fR are ignored.
 319 .AP int x in
 320 New x-coordinate for \fItkwin\fR's top left pixel (including
 321 border, if any) within tkwin's parent.
 322 .AP int y in
 323 New y-coordinate for \fItkwin\fR's top left pixel (including
 324 border, if any) within tkwin's parent.
 325 .AP "int" width in
 326 New width for \fItkwin\fR (interior, not including border).
 327 .AP "int" height in
 328 New height for \fItkwin\fR (interior, not including border).
 329 .AP "int" borderWidth in
 330 New width for \fItkwin\fR's border.
 331 .AP XSetWindowAttributes *attsPtr in
 332 Points to a structure containing new values for the attributes
 333 given by the \fIvalueMask\fR argument.  Attributes not selected
 334 by \fIvalueMask\fR are ignored.
 335 .AP "unsigned long" pixel in
 336 New background or border color for window.
 337 .AP Pixmap pixmap in
 338 New pixmap to use for background or border of \fItkwin\fR.  WARNING:
 339 cannot necessarily be deleted immediately, as for Xlib calls.  See
 340 note below.
 341 .AP Colormap colormap in
 342 New colormap to use for \fItkwin\fR.
 343 .AP Tk_Cursor cursor in
 344 New cursor to use for \fItkwin\fR.  If \fBNone\fR is specified, then
 345 \fItkwin\fR will not have its own cursor;  it will use the cursor
 346 of its parent.
 347 .BE
 348 .SH DESCRIPTION
 349 .PP
 350 These procedures are analogous to the X library procedures
 351 with similar names, such as \fBXConfigureWindow\fR.  Each
 352 one of the above procedures calls the corresponding X procedure
 353 and also saves the configuration information in Tk's local
 354 structure for the window.  This allows the information to
 355 be retrieved quickly by the application (using macros such
 356 as \fBTk_X\fR and \fBTk_Height\fR) without having to contact
 357 the X server.  In addition, if no X window has actually been
 358 created for \fItkwin\fR yet, these procedures do not issue
 359 X operations or cause event handlers to be invoked;  they save
 360 the information in Tk's local
 361 structure for the window;  when the window is created later,
 362 the saved information will be used to configure the window.
 363 .PP
 364 See the X library documentation for details on what these
 365 procedures do and how they use their arguments.
 366 .PP
 367 In the procedures \fBTk_ConfigureWindow\fR, \fBTk_MoveWindow\fR,
 368 \fBTk_ResizeWindow\fR, \fBTk_MoveResizeWindow\fR, and
 369 \fBTk_SetWindowBorderWidth\fR,
 370 if \fItkwin\fR is an internal window then event handlers interested
 371 in configure events are invoked immediately, before the procedure
 372 returns.  If \fItkwin\fR is a top-level window
 373 then the event handlers will be invoked later, after X has seen
 374 the request and returned an event for it.
 375 .PP
 376 Applications using Tk should never call procedures like
 377 \fBXConfigureWindow\fR directly;  they should always use the
 378 corresponding Tk procedures.
 379 .PP
 380 The size and location of a window should only be modified by the
 381 appropriate geometry manager for that window and never by a window
 382 itself (but see \fBTk_MoveToplevelWindow\fR for moving a top-level
 383 window).
 384 .PP
 385 You may not use \fBTk_ConfigureWindow\fR to change the
 386 stacking order of a window (\fIvalueMask\fR may not contain the
 387 \fBCWSibling\fR or \fBCWStackMode\fR bits).
 388 To change the stacking order, use the procedure \fBTk_RestackWindow\fR.
 389 .PP
 390 The procedure \fBTk_SetWindowColormap\fR will automatically add
 391 \fItkwin\fR to the \fBTK_COLORMAP_WINDOWS\fR property of its
 392 nearest top-level ancestor if the new colormap is different from
 393 that of \fItkwin\fR's parent and \fItkwin\fR is not already in
 394 the \fBTK_COLORMAP_WINDOWS\fR property.
 395 .SH BUGS
 396 .PP
 397 \fBTk_SetWindowBackgroundPixmap\fR and \fBTk_SetWindowBorderPixmap\fR
 398 differ slightly from their Xlib counterparts in that the \fIpixmap\fR
 399 argument may not necessarily be deleted immediately after calling
 400 one of these procedures.  This is because \fItkwin\fR's window
 401 may not exist yet at the time of the call, in which case \fIpixmap\fR
 402 is merely saved and used later when \fItkwin\fR's window is actually
 403 created.  If you wish to delete \fIpixmap\fR, then call
 404 \fBTk_MakeWindowExist\fR first to be sure that \fItkwin\fR's window exists
 405 and \fIpixmap\fR has been passed to the X server.
 406 .PP
 407 A similar problem occurs for the \fIcursor\fR argument passed to
 408 \fBTk_DefineCursor\fR.  The solution is the same as for pixmaps above:
 409 call \fBTk_MakeWindowExist\fR before freeing the cursor.
 410 .SH "SEE ALSO"
 411 Tk_MoveToplevelWindow, Tk_RestackWindow
 412 .SH KEYWORDS
 413 attributes, border, color, configure, height, pixel, pixmap, width, window, x, y