archie/tk4.2/doc/GetVRoot.3

50 lines
1.8 KiB
Groff
Raw Normal View History

2024-05-27 16:13:40 +02:00
'\"
'\" Copyright (c) 1990 The Regents of the University of California.
2024-05-27 16:40:40 +02:00
'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
2024-05-27 16:13:40 +02:00
'\"
2024-05-27 16:40:40 +02:00
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
2024-05-27 16:13:40 +02:00
'\"
2024-05-27 16:40:40 +02:00
'\" SCCS: @(#) GetVRoot.3 1.10 96/08/27 13:21:28
2024-05-27 16:13:40 +02:00
'\"
.so man.macros
2024-05-27 16:40:40 +02:00
.TH Tk_GetVRootGeometry 3 4.0 Tk "Tk Library Procedures"
2024-05-27 16:13:40 +02:00
.BS
.SH NAME
Tk_GetVRootGeometry \- Get location and size of virtual root for window
.SH SYNOPSIS
.nf
\fB#include <tk.h>\fR
.sp
2024-05-27 16:40:40 +02:00
\fBTk_GetVRootGeometry(\fItkwin, xPtr, yPtr, widthPtr, heightPtr\fB)\fR
2024-05-27 16:13:40 +02:00
.SH ARGUMENTS
.AS Tk_Window heightPtr
.AP Tk_Window tkwin in
Token for window whose virtual root is to be queried.
.AP int xPtr out
Points to word in which to store x-offset of virtual root.
.AP int yPtr out
Points to word in which to store y-offset of virtual root.
2024-05-27 16:40:40 +02:00
.AP "int" widthPtr out
2024-05-27 16:13:40 +02:00
Points to word in which to store width of virtual root.
2024-05-27 16:40:40 +02:00
.AP "int" heightPtr out
2024-05-27 16:13:40 +02:00
Points to word in which to store height of virtual root.
.BE
.SH DESCRIPTION
.PP
\fBTkGetVRootGeometry\fR returns geometry information about the virtual
root window associated with \fItkwin\fR. The ``associated'' virtual
root is the one in which \fItkwin\fR's nearest top-level ancestor (or
\fItkwin\fR itself if it is a top-level window) has
been reparented by the window manager. This window is identified by
a \fB__SWM_ROOT\fR or \fB__WM_ROOT\fR property placed on the top-level
window by the window manager.
If \fItkwin\fR is not associated with a virtual root (e.g.
because the window manager doesn't use virtual roots) then *\fIxPtr\fR and
*\fIyPtr\fR will be set to 0 and *\fIwidthPtr\fR and *\fIheightPtr\fR
will be set to the dimensions of the screen containing \fItkwin\fR.
.SH KEYWORDS
geometry, height, location, virtual root, width, window manager