SGI/util/SGI/man/man3/Tk_Y.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 '\" SCCS: @(#) WindowId.3 1.16 97/01/29 08:50:10
   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 '\" SCCS: @(#) man.macros 1.9 97/08/22 18:50:59
  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 .ie !"\\$3"" \{\
  85 .ta \\n()Au \\n()Bu
  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 4c 8c 12c
 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_WindowId 3 "" Tk "Tk Library Procedures"
 247 .BS
 248 .SH NAME
 249 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_IsMapped, Tk_IsTopLevel, Tk_ReqWidth, Tk_ReqHeight, Tk_InternalBorderWidth, Tk_Visual, Tk_Depth, Tk_Colormap  \- retrieve information from Tk's local data structure
 250 .SH SYNOPSIS
 251 .nf
 252 \fB#include <tk.h>\fR
 253 .sp
 254 Window
 255 \fBTk_WindowId\fR(\fItkwin\fR)
 256 .sp
 257 Tk_Window
 258 \fBTk_Parent\fR(\fItkwin\fR)
 259 .sp
 260 Display *
 261 \fBTk_Display\fR(\fItkwin\fR)
 262 .sp
 263 char *
 264 \fBTk_DisplayName\fR(\fItkwin\fR)
 265 .sp
 266 int
 267 \fBTk_ScreenNumber\fR(\fItkwin\fR)
 268 .sp
 269 Screen *
 270 \fBTk_Screen\fR(\fItkwin\fR)
 271 .sp
 272 int
 273 \fBTk_X\fR(\fItkwin\fR)
 274 .sp
 275 int
 276 \fBTk_Y\fR(\fItkwin\fR)
 277 .sp
 278 int
 279 \fBTk_Width\fR(\fItkwin\fR)
 280 .sp
 281 int
 282 \fBTk_Height\fR(\fItkwin\fR)
 283 .sp
 284 XWindowChanges *
 285 \fBTk_Changes\fR(\fItkwin\fR)
 286 .sp
 287 XSetWindowAttributes *
 288 \fBTk_Attributes\fR(\fItkwin\fR)
 289 .sp
 290 int
 291 \fBTk_IsMapped\fR(\fItkwin\fR)
 292 .sp
 293 int
 294 \fBTk_IsTopLevel\fR(\fItkwin\fR)
 295 .sp
 296 int
 297 \fBTk_ReqWidth\fR(\fItkwin\fR)
 298 .sp
 299 int
 300 \fBTk_ReqHeight\fR(\fItkwin\fR)
 301 .sp
 302 int
 303 \fBTk_InternalBorderWidth\fR(\fItkwin\fR)
 304 .sp
 305 Visual *
 306 \fBTk_Visual\fR(\fItkwin\fR)
 307 .sp
 308 int
 309 \fBTk_Depth\fR(\fItkwin\fR)
 310 .sp
 311 Colormap
 312 \fBTk_Colormap\fR(\fItkwin\fR)
 313 .SH ARGUMENTS
 314 .AS Tk_Window tkwin
 315 .AP Tk_Window tkwin in
 316 Token for window.
 317 .BE
 318
 319 .SH DESCRIPTION
 320 .PP
 321 \fBTk_WindowID\fR and the other names listed above are
 322 all macros that return fields from Tk's local data structure
 323 for \fItkwin\fR.  None of these macros requires any
 324 interaction with the server;  it is safe to assume that
 325 all are fast.
 326 .PP
 327 \fBTk_WindowId\fR returns the X identifier for \fItkwin\fR,
 328 or \fBNULL\fR if no X window has been created for \fItkwin\fR
 329 yet.
 330 .PP
 331 \fBTk_Parent\fR returns Tk's token for the logical parent of
 332 \fItkwin\fR.  The parent is the token that was specified when
 333 \fItkwin\fR was created, or NULL for main windows.
 334 .PP
 335 \fBTk_Display\fR returns a pointer to the Xlib display structure
 336 corresponding to \fItkwin\fR.  \fBTk_DisplayName\fR returns an
 337 ASCII string identifying \fItkwin\fR's display.  \fBTk_ScreenNumber\fR
 338 returns the index of \fItkwin\fR's screen among all the screens
 339 of \fItkwin\fR's display.  \fBTk_Screen\fR returns a pointer to
 340 the Xlib structure corresponding to \fItkwin\fR's screen.
 341 .PP
 342 \fBTk_X\fR, \fBTk_Y\fR, \fBTk_Width\fR, and \fBTk_Height\fR
 343 return information about \fItkwin's\fR location within its
 344 parent and its size.  The location information refers to the
 345 upper-left pixel in the window, or its border if there is one.
 346 The width and height information refers to the interior size
 347 of the window, not including any border.  \fBTk_Changes\fR
 348 returns a pointer to a structure containing all of the above
 349 information plus a few other fields.  \fBTk_Attributes\fR
 350 returns a pointer to an XSetWindowAttributes structure describing
 351 all of the attributes of the \fItkwin\fR's window, such as background
 352 pixmap, event mask, and so on (Tk keeps track of all this information
 353 as it is changed by the application).  Note: it is essential that
 354 applications use Tk procedures like \fBTk_ResizeWindow\fR instead
 355 of X procedures like \fBXResizeWindow\fR, so that Tk can keep its
 356 data structures up-to-date.
 357 .PP
 358 \fBTk_IsMapped\fR returns a non-zero value if \fItkwin\fR
 359 is mapped and zero if \fItkwin\fR isn't mapped.
 360 .PP
 361 \fBTk_IsTopLevel\fR returns a non-zero value if \fItkwin\fR
 362 is a top-level window (its X parent is the root window of the
 363 screen) and zero if \fItkwin\fR isn't a top-level window.
 364 .PP
 365 \fBTk_ReqWidth\fR and \fBTk_ReqHeight\fR return information about
 366 the window's requested size.  These values correspond to the last
 367 call to \fBTk_GeometryRequest\fR for \fItkwin\fR.
 368 .PP
 369 \fBTk_InternalBorderWidth\fR returns the width of internal border
 370 that has been requested for \fItkwin\fR, or 0 if no internal border
 371 was requested.  The return value is simply the last value passed
 372 to \fBTk_SetInternalBorder\fR for \fItkwin\fR.
 373 .PP
 374 \fBTk_Visual\fR, \fBTk_Depth\fR, and \fBTk_Colormap\fR return
 375 information about the visual characteristics of a window.
 376 \fBTk_Visual\fR returns the visual type for
 377 the window, \fBTk_Depth\fR returns the number of bits per pixel,
 378 and \fBTk_Colormap\fR returns the current
 379 colormap for the window.  The visual characteristics are
 380 normally set from the defaults for the window's screen, but
 381 they may be overridden by calling \fBTk_SetWindowVisual\fR.
 382
 383 .SH KEYWORDS
 384 attributes, colormap, depth, display, height, geometry manager,
 385 identifier, mapped, requested size, screen, top-level,
 386 visual, width, window, x, y