| 1 |
578 |
markom |
'\"
|
| 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 |
|
|
'\" RCS: @(#) $Id: WindowId.3,v 1.1.1.1 2002-01-16 10:25:48 markom Exp $
|
| 9 |
|
|
'\"
|
| 10 |
|
|
.so man.macros
|
| 11 |
|
|
.TH Tk_WindowId 3 "" Tk "Tk Library Procedures"
|
| 12 |
|
|
.BS
|
| 13 |
|
|
.SH NAME
|
| 14 |
|
|
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
|
| 15 |
|
|
.SH SYNOPSIS
|
| 16 |
|
|
.nf
|
| 17 |
|
|
\fB#include \fR
|
| 18 |
|
|
.sp
|
| 19 |
|
|
Window
|
| 20 |
|
|
\fBTk_WindowId\fR(\fItkwin\fR)
|
| 21 |
|
|
.sp
|
| 22 |
|
|
Tk_Window
|
| 23 |
|
|
\fBTk_Parent\fR(\fItkwin\fR)
|
| 24 |
|
|
.sp
|
| 25 |
|
|
Display *
|
| 26 |
|
|
\fBTk_Display\fR(\fItkwin\fR)
|
| 27 |
|
|
.sp
|
| 28 |
|
|
char *
|
| 29 |
|
|
\fBTk_DisplayName\fR(\fItkwin\fR)
|
| 30 |
|
|
.sp
|
| 31 |
|
|
int
|
| 32 |
|
|
\fBTk_ScreenNumber\fR(\fItkwin\fR)
|
| 33 |
|
|
.sp
|
| 34 |
|
|
Screen *
|
| 35 |
|
|
\fBTk_Screen\fR(\fItkwin\fR)
|
| 36 |
|
|
.sp
|
| 37 |
|
|
int
|
| 38 |
|
|
\fBTk_X\fR(\fItkwin\fR)
|
| 39 |
|
|
.sp
|
| 40 |
|
|
int
|
| 41 |
|
|
\fBTk_Y\fR(\fItkwin\fR)
|
| 42 |
|
|
.sp
|
| 43 |
|
|
int
|
| 44 |
|
|
\fBTk_Width\fR(\fItkwin\fR)
|
| 45 |
|
|
.sp
|
| 46 |
|
|
int
|
| 47 |
|
|
\fBTk_Height\fR(\fItkwin\fR)
|
| 48 |
|
|
.sp
|
| 49 |
|
|
XWindowChanges *
|
| 50 |
|
|
\fBTk_Changes\fR(\fItkwin\fR)
|
| 51 |
|
|
.sp
|
| 52 |
|
|
XSetWindowAttributes *
|
| 53 |
|
|
\fBTk_Attributes\fR(\fItkwin\fR)
|
| 54 |
|
|
.sp
|
| 55 |
|
|
int
|
| 56 |
|
|
\fBTk_IsMapped\fR(\fItkwin\fR)
|
| 57 |
|
|
.sp
|
| 58 |
|
|
int
|
| 59 |
|
|
\fBTk_IsTopLevel\fR(\fItkwin\fR)
|
| 60 |
|
|
.sp
|
| 61 |
|
|
int
|
| 62 |
|
|
\fBTk_ReqWidth\fR(\fItkwin\fR)
|
| 63 |
|
|
.sp
|
| 64 |
|
|
int
|
| 65 |
|
|
\fBTk_ReqHeight\fR(\fItkwin\fR)
|
| 66 |
|
|
.sp
|
| 67 |
|
|
int
|
| 68 |
|
|
\fBTk_InternalBorderWidth\fR(\fItkwin\fR)
|
| 69 |
|
|
.sp
|
| 70 |
|
|
Visual *
|
| 71 |
|
|
\fBTk_Visual\fR(\fItkwin\fR)
|
| 72 |
|
|
.sp
|
| 73 |
|
|
int
|
| 74 |
|
|
\fBTk_Depth\fR(\fItkwin\fR)
|
| 75 |
|
|
.sp
|
| 76 |
|
|
Colormap
|
| 77 |
|
|
\fBTk_Colormap\fR(\fItkwin\fR)
|
| 78 |
|
|
.SH ARGUMENTS
|
| 79 |
|
|
.AS Tk_Window tkwin
|
| 80 |
|
|
.AP Tk_Window tkwin in
|
| 81 |
|
|
Token for window.
|
| 82 |
|
|
.BE
|
| 83 |
|
|
|
| 84 |
|
|
.SH DESCRIPTION
|
| 85 |
|
|
.PP
|
| 86 |
|
|
\fBTk_WindowID\fR and the other names listed above are
|
| 87 |
|
|
all macros that return fields from Tk's local data structure
|
| 88 |
|
|
for \fItkwin\fR. None of these macros requires any
|
| 89 |
|
|
interaction with the server; it is safe to assume that
|
| 90 |
|
|
all are fast.
|
| 91 |
|
|
.PP
|
| 92 |
|
|
\fBTk_WindowId\fR returns the X identifier for \fItkwin\fR,
|
| 93 |
|
|
or \fBNULL\fR if no X window has been created for \fItkwin\fR
|
| 94 |
|
|
yet.
|
| 95 |
|
|
.PP
|
| 96 |
|
|
\fBTk_Parent\fR returns Tk's token for the logical parent of
|
| 97 |
|
|
\fItkwin\fR. The parent is the token that was specified when
|
| 98 |
|
|
\fItkwin\fR was created, or NULL for main windows.
|
| 99 |
|
|
.PP
|
| 100 |
|
|
\fBTk_Display\fR returns a pointer to the Xlib display structure
|
| 101 |
|
|
corresponding to \fItkwin\fR. \fBTk_DisplayName\fR returns an
|
| 102 |
|
|
ASCII string identifying \fItkwin\fR's display. \fBTk_ScreenNumber\fR
|
| 103 |
|
|
returns the index of \fItkwin\fR's screen among all the screens
|
| 104 |
|
|
of \fItkwin\fR's display. \fBTk_Screen\fR returns a pointer to
|
| 105 |
|
|
the Xlib structure corresponding to \fItkwin\fR's screen.
|
| 106 |
|
|
.PP
|
| 107 |
|
|
\fBTk_X\fR, \fBTk_Y\fR, \fBTk_Width\fR, and \fBTk_Height\fR
|
| 108 |
|
|
return information about \fItkwin's\fR location within its
|
| 109 |
|
|
parent and its size. The location information refers to the
|
| 110 |
|
|
upper-left pixel in the window, or its border if there is one.
|
| 111 |
|
|
The width and height information refers to the interior size
|
| 112 |
|
|
of the window, not including any border. \fBTk_Changes\fR
|
| 113 |
|
|
returns a pointer to a structure containing all of the above
|
| 114 |
|
|
information plus a few other fields. \fBTk_Attributes\fR
|
| 115 |
|
|
returns a pointer to an XSetWindowAttributes structure describing
|
| 116 |
|
|
all of the attributes of the \fItkwin\fR's window, such as background
|
| 117 |
|
|
pixmap, event mask, and so on (Tk keeps track of all this information
|
| 118 |
|
|
as it is changed by the application). Note: it is essential that
|
| 119 |
|
|
applications use Tk procedures like \fBTk_ResizeWindow\fR instead
|
| 120 |
|
|
of X procedures like \fBXResizeWindow\fR, so that Tk can keep its
|
| 121 |
|
|
data structures up-to-date.
|
| 122 |
|
|
.PP
|
| 123 |
|
|
\fBTk_IsMapped\fR returns a non-zero value if \fItkwin\fR
|
| 124 |
|
|
is mapped and zero if \fItkwin\fR isn't mapped.
|
| 125 |
|
|
.PP
|
| 126 |
|
|
\fBTk_IsTopLevel\fR returns a non-zero value if \fItkwin\fR
|
| 127 |
|
|
is a top-level window (its X parent is the root window of the
|
| 128 |
|
|
screen) and zero if \fItkwin\fR isn't a top-level window.
|
| 129 |
|
|
.PP
|
| 130 |
|
|
\fBTk_ReqWidth\fR and \fBTk_ReqHeight\fR return information about
|
| 131 |
|
|
the window's requested size. These values correspond to the last
|
| 132 |
|
|
call to \fBTk_GeometryRequest\fR for \fItkwin\fR.
|
| 133 |
|
|
.PP
|
| 134 |
|
|
\fBTk_InternalBorderWidth\fR returns the width of internal border
|
| 135 |
|
|
that has been requested for \fItkwin\fR, or 0 if no internal border
|
| 136 |
|
|
was requested. The return value is simply the last value passed
|
| 137 |
|
|
to \fBTk_SetInternalBorder\fR for \fItkwin\fR.
|
| 138 |
|
|
.PP
|
| 139 |
|
|
\fBTk_Visual\fR, \fBTk_Depth\fR, and \fBTk_Colormap\fR return
|
| 140 |
|
|
information about the visual characteristics of a window.
|
| 141 |
|
|
\fBTk_Visual\fR returns the visual type for
|
| 142 |
|
|
the window, \fBTk_Depth\fR returns the number of bits per pixel,
|
| 143 |
|
|
and \fBTk_Colormap\fR returns the current
|
| 144 |
|
|
colormap for the window. The visual characteristics are
|
| 145 |
|
|
normally set from the defaults for the window's screen, but
|
| 146 |
|
|
they may be overridden by calling \fBTk_SetWindowVisual\fR.
|
| 147 |
|
|
|
| 148 |
|
|
.SH KEYWORDS
|
| 149 |
|
|
attributes, colormap, depth, display, height, geometry manager,
|
| 150 |
|
|
identifier, mapped, requested size, screen, top-level,
|
| 151 |
|
|
visual, width, window, x, y
|
