summaryrefslogtreecommitdiffstats
path: root/doc/GetRootCrd.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/GetRootCrd.3')
-rw-r--r--doc/GetRootCrd.343
1 files changed, 43 insertions, 0 deletions
diff --git a/doc/GetRootCrd.3 b/doc/GetRootCrd.3
new file mode 100644
index 0000000..c9dea3c
--- /dev/null
+++ b/doc/GetRootCrd.3
@@ -0,0 +1,43 @@
+'\"
+'\" Copyright (c) 1990 The Regents of the University of California.
+'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
+'\"
+'\" See the file "license.terms" for information on usage and redistribution
+'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
+'\"
+'\" SCCS: @(#) GetRootCrd.3 1.9 96/03/26 18:12:16
+'\"
+.so man.macros
+.TH Tk_GetRootCoords 3 "" Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_GetRootCoords \- Compute root-window coordinates of window
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+\fBTk_GetRootCoords\fR(\fItkwin, xPtr, yPtr\fR)
+.SH ARGUMENTS
+.AS Tk_Window tkwin
+.AP Tk_Window tkwin in
+Token for window.
+.AP int *xPtr out
+Pointer to location in which to store root-window x-coordinate
+corresponding to left edge of \fItkwin\fR's border.
+.AP int *yPtr out
+Pointer to location in which to store root-window y-coordinate
+corresponding to top edge of \fItkwin\fR's border.
+.BE
+
+.SH DESCRIPTION
+.PP
+This procedure scans through the structural information maintained
+by Tk to compute the root-window coordinates corresponding to
+the upper-left corner of \fItkwin\fR's border. If \fItkwin\fR has
+no border, then \fBTk_GetRootCoords\fR returns the root-window
+coordinates corresponding to location (0,0) in \fItkwin\fR.
+\fBTk_GetRootCoords\fR is relatively efficient, since it doesn't have to
+communicate with the X server.
+
+.SH KEYWORDS
+coordinates, root window