util/X86LINUX64/man/man3/Tk_Colormap.3

   1 '\"
   2 '\" Copyright (c) 1990-1993 The Regents of the University of California.
   3 '\" Copyright (c) 1994-1997 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_WindowId 3 "8.4" 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_WindowId, Tk_Parent, Tk_Display, Tk_DisplayName, Tk_ScreenNumber, Tk_Screen, Tk_X, Tk_Y, Tk_Width, Tk_Height, Tk_Changes, Tk_Attributes, Tk_IsContainer, Tk_IsEmbedded, Tk_IsMapped, Tk_IsTopLevel, Tk_ReqWidth, Tk_ReqHeight, Tk_MinReqWidth, Tk_MinReqHeight, Tk_InternalBorderLeft, Tk_InternalBorderRight, Tk_InternalBorderTop, Tk_InternalBorderBottom, Tk_Visual, Tk_Depth, Tk_Colormap, Tk_Interp  \- retrieve information from Tk's local data structure
 279 .SH SYNOPSIS
 280 .nf
 281 \fB#include <tk.h>\fR
 282 .sp
 283 Window
 284 \fBTk_WindowId\fR(\fItkwin\fR)
 285 .sp
 286 Tk_Window
 287 \fBTk_Parent\fR(\fItkwin\fR)
 288 .sp
 289 Display *
 290 \fBTk_Display\fR(\fItkwin\fR)
 291 .sp
 292 const char *
 293 \fBTk_DisplayName\fR(\fItkwin\fR)
 294 .sp
 295 int
 296 \fBTk_ScreenNumber\fR(\fItkwin\fR)
 297 .sp
 298 Screen *
 299 \fBTk_Screen\fR(\fItkwin\fR)
 300 .sp
 301 int
 302 \fBTk_X\fR(\fItkwin\fR)
 303 .sp
 304 int
 305 \fBTk_Y\fR(\fItkwin\fR)
 306 .sp
 307 int
 308 \fBTk_Width\fR(\fItkwin\fR)
 309 .sp
 310 int
 311 \fBTk_Height\fR(\fItkwin\fR)
 312 .sp
 313 XWindowChanges *
 314 \fBTk_Changes\fR(\fItkwin\fR)
 315 .sp
 316 XSetWindowAttributes *
 317 \fBTk_Attributes\fR(\fItkwin\fR)
 318 .sp
 319 int
 320 \fBTk_IsContainer\fR(\fItkwin\fR)
 321 .sp
 322 int
 323 \fBTk_IsEmbedded\fR(\fItkwin\fR)
 324 .sp
 325 int
 326 \fBTk_IsMapped\fR(\fItkwin\fR)
 327 .sp
 328 int
 329 \fBTk_IsTopLevel\fR(\fItkwin\fR)
 330 .sp
 331 int
 332 \fBTk_ReqWidth\fR(\fItkwin\fR)
 333 .sp
 334 int
 335 \fBTk_ReqHeight\fR(\fItkwin\fR)
 336 .sp
 337 int
 338 \fBTk_MinReqWidth\fR(\fItkwin\fR)
 339 .sp
 340 int
 341 \fBTk_MinReqHeight\fR(\fItkwin\fR)
 342 .sp
 343 int
 344 \fBTk_InternalBorderLeft\fR(\fItkwin\fR)
 345 .sp
 346 int
 347 \fBTk_InternalBorderRight\fR(\fItkwin\fR)
 348 .sp
 349 int
 350 \fBTk_InternalBorderTop\fR(\fItkwin\fR)
 351 .sp
 352 int
 353 \fBTk_InternalBorderBottom\fR(\fItkwin\fR)
 354 .sp
 355 Visual *
 356 \fBTk_Visual\fR(\fItkwin\fR)
 357 .sp
 358 int
 359 \fBTk_Depth\fR(\fItkwin\fR)
 360 .sp
 361 Colormap
 362 \fBTk_Colormap\fR(\fItkwin\fR)
 363 .sp
 364 Tcl_Interp *
 365 \fBTk_Interp\fR(\fItkwin\fR)
 366 .SH ARGUMENTS
 367 .AS Tk_Window tkwin
 368 .AP Tk_Window tkwin in
 369 Token for window.
 370 .BE
 371 .SH DESCRIPTION
 372 .PP
 373 \fBTk_WindowId\fR and the other names listed above are
 374 all macros that return fields from Tk's local data structure
 375 for \fItkwin\fR.  None of these macros requires any
 376 interaction with the server;  it is safe to assume that
 377 all are fast.
 378 .PP
 379 \fBTk_WindowId\fR returns the X identifier for \fItkwin\fR,
 380 or \fBNULL\fR if no X window has been created for \fItkwin\fR
 381 yet.
 382 .PP
 383 \fBTk_Parent\fR returns Tk's token for the logical parent of
 384 \fItkwin\fR.  The parent is the token that was specified when
 385 \fItkwin\fR was created, or NULL for main windows.
 386 .PP
 387 \fBTk_Interp\fR returns the Tcl interpreter associated with a
 388 \fItkwin\fR or NULL if there is an error.
 389 .PP
 390 \fBTk_Display\fR returns a pointer to the Xlib display structure
 391 corresponding to \fItkwin\fR.  \fBTk_DisplayName\fR returns an
 392 ASCII string identifying \fItkwin\fR's display.  \fBTk_ScreenNumber\fR
 393 returns the index of \fItkwin\fR's screen among all the screens
 394 of \fItkwin\fR's display.  \fBTk_Screen\fR returns a pointer to
 395 the Xlib structure corresponding to \fItkwin\fR's screen.
 396 .PP
 397 \fBTk_X\fR, \fBTk_Y\fR, \fBTk_Width\fR, and \fBTk_Height\fR
 398 return information about \fItkwin's\fR location within its
 399 parent and its size.  The location information refers to the
 400 upper-left pixel in the window, or its border if there is one.
 401 The width and height information refers to the interior size
 402 of the window, not including any border.  \fBTk_Changes\fR
 403 returns a pointer to a structure containing all of the above
 404 information plus a few other fields.  \fBTk_Attributes\fR
 405 returns a pointer to an XSetWindowAttributes structure describing
 406 all of the attributes of the \fItkwin\fR's window, such as background
 407 pixmap, event mask, and so on (Tk keeps track of all this information
 408 as it is changed by the application).  Note: it is essential that
 409 applications use Tk procedures like \fBTk_ResizeWindow\fR instead
 410 of X procedures like \fBXResizeWindow\fR, so that Tk can keep its
 411 data structures up-to-date.
 412 .PP
 413 \fBTk_IsContainer\fR returns a non-zero value if \fItkwin\fR
 414 is a container, and that some other application may be embedding
 415 itself inside \fItkwin\fR.
 416 .PP
 417 \fBTk_IsEmbedded\fR returns a non-zero value if \fItkwin\fR
 418 is not a free-standing window, but rather is embedded in some
 419 other application.
 420 .PP
 421 \fBTk_IsMapped\fR returns a non-zero value if \fItkwin\fR
 422 is mapped and zero if \fItkwin\fR is not mapped.
 423 .PP
 424 \fBTk_IsTopLevel\fR returns a non-zero value if \fItkwin\fR
 425 is a top-level window (its X parent is the root window of the
 426 screen) and zero if \fItkwin\fR is not a top-level window.
 427 .PP
 428 \fBTk_ReqWidth\fR and \fBTk_ReqHeight\fR return information about
 429 the window's requested size.  These values correspond to the last
 430 call to \fBTk_GeometryRequest\fR for \fItkwin\fR.
 431 .PP
 432 \fBTk_MinReqWidth\fR and \fBTk_MinReqHeight\fR return information about
 433 the window's minimum requested size.  These values correspond to the last
 434 call to \fBTk_SetMinimumRequestSize\fR for \fItkwin\fR.
 435 .PP
 436 \fBTk_InternalBorderLeft\fR, \fBTk_InternalBorderRight\fR,
 437 \fBTk_InternalBorderTop\fR and \fBTk_InternalBorderBottom\fR
 438 return the width of one side of the internal border
 439 that has been requested for \fItkwin\fR, or 0 if no internal border was
 440 requested.  The return value is simply the last value passed to
 441 \fBTk_SetInternalBorder\fR or \fBTk_SetInternalBorderEx\fR for \fItkwin\fR.
 442 .PP
 443 \fBTk_Visual\fR, \fBTk_Depth\fR, and \fBTk_Colormap\fR return
 444 information about the visual characteristics of a window.
 445 \fBTk_Visual\fR returns the visual type for
 446 the window, \fBTk_Depth\fR returns the number of bits per pixel,
 447 and \fBTk_Colormap\fR returns the current
 448 colormap for the window.  The visual characteristics are
 449 normally set from the defaults for the window's screen, but
 450 they may be overridden by calling \fBTk_SetWindowVisual\fR.
 451 .SH KEYWORDS
 452 attributes, colormap, depth, display, height, geometry manager,
 453 identifier, mapped, requested size, screen, top-level,
 454 visual, width, window, x, y