home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / languages / tcl / tk3.3b1 / doc / GetRootCrd.3 < prev    next >
Encoding:
Text File  |  1993-04-01  |  2.2 KB  |  57 lines
  1. '\"
  2. '\" Copyright (c) 1990 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/wish/man/RCS/GetRootCrd.3,v 1.5 93/04/01 09:41:38 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. .so man.macros
  24. .HS Tk_GetRootCoords tkc
  25. .BS
  26. .SH NAME
  27. Tk_GetRootCoords \- Compute root-window coordinates of window
  28. .SH SYNOPSIS
  29. .nf
  30. \fB#include <tk.h>\fR
  31. .sp
  32. \fBTk_GetRootCoords\fR(\fItkwin, xPtr, yPtr\fR)
  33. .SH ARGUMENTS
  34. .AS Tk_Window tkwin
  35. .AP Tk_Window tkwin in
  36. Token for window.
  37. .AP int *xPtr out
  38. Pointer to location in which to store root-window x-coordinate
  39. corresponding to left edge of \fItkwin\fR's border.
  40. .AP int *yPtr out
  41. Pointer to location in which to store root-window y-coordinate
  42. corresponding to top edge of \fItkwin\fR's border.
  43. .BE
  44.  
  45. .SH DESCRIPTION
  46. .PP
  47. This procedure scans through the structural information maintained
  48. by Tk to compute the root-window coordinates corresponding to
  49. the upper-left corner of \fItkwin\fR's border.  If \fItkwin\fR has
  50. no border, then \fBTk_GetRootCoords\fR returns the root-window
  51. coordinates corresponding to location (0,0) in \fItkwin\fR.
  52. \fBTk_GetRootCoords\fR is relatively efficient, since it doesn't have to
  53. communicate with the X server.
  54.  
  55. .SH KEYWORDS
  56. coordinates, root window
  57.