1 |
578 |
markom |
'\"
|
2 |
|
|
'\" Copyright (c) 1990 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: GetVRoot.3,v 1.1.1.1 2002-01-16 10:25:48 markom Exp $
|
9 |
|
|
'\"
|
10 |
|
|
.so man.macros
|
11 |
|
|
.TH Tk_GetVRootGeometry 3 4.0 Tk "Tk Library Procedures"
|
12 |
|
|
.BS
|
13 |
|
|
.SH NAME
|
14 |
|
|
Tk_GetVRootGeometry \- Get location and size of virtual root for window
|
15 |
|
|
.SH SYNOPSIS
|
16 |
|
|
.nf
|
17 |
|
|
\fB#include \fR
|
18 |
|
|
.sp
|
19 |
|
|
\fBTk_GetVRootGeometry(\fItkwin, xPtr, yPtr, widthPtr, heightPtr\fB)\fR
|
20 |
|
|
.SH ARGUMENTS
|
21 |
|
|
.AS Tk_Window heightPtr
|
22 |
|
|
.AP Tk_Window tkwin in
|
23 |
|
|
Token for window whose virtual root is to be queried.
|
24 |
|
|
.AP int xPtr out
|
25 |
|
|
Points to word in which to store x-offset of virtual root.
|
26 |
|
|
.AP int yPtr out
|
27 |
|
|
Points to word in which to store y-offset of virtual root.
|
28 |
|
|
.AP "int" widthPtr out
|
29 |
|
|
Points to word in which to store width of virtual root.
|
30 |
|
|
.AP "int" heightPtr out
|
31 |
|
|
Points to word in which to store height of virtual root.
|
32 |
|
|
.BE
|
33 |
|
|
|
34 |
|
|
.SH DESCRIPTION
|
35 |
|
|
.PP
|
36 |
|
|
\fBTkGetVRootGeometry\fR returns geometry information about the virtual
|
37 |
|
|
root window associated with \fItkwin\fR. The ``associated'' virtual
|
38 |
|
|
root is the one in which \fItkwin\fR's nearest top-level ancestor (or
|
39 |
|
|
\fItkwin\fR itself if it is a top-level window) has
|
40 |
|
|
been reparented by the window manager. This window is identified by
|
41 |
|
|
a \fB__SWM_ROOT\fR or \fB__WM_ROOT\fR property placed on the top-level
|
42 |
|
|
window by the window manager.
|
43 |
|
|
If \fItkwin\fR is not associated with a virtual root (e.g.
|
44 |
|
|
because the window manager doesn't use virtual roots) then *\fIxPtr\fR and
|
45 |
|
|
*\fIyPtr\fR will be set to 0 and *\fIwidthPtr\fR and *\fIheightPtr\fR
|
46 |
|
|
will be set to the dimensions of the screen containing \fItkwin\fR.
|
47 |
|
|
|
48 |
|
|
.SH KEYWORDS
|
49 |
|
|
geometry, height, location, virtual root, width, window manager
|