home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / languages / tcl / tk3.3b1 / doc / GetVRoot.3 < prev    next >
Encoding:
Text File  |  1993-04-01  |  2.6 KB  |  63 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/GetVRoot.3,v 1.3 93/04/01 09:41:41 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. .so man.macros
  24. .HS Tk_GetVRootGeometry tkc
  25. .BS
  26. .SH NAME
  27. Tk_GetVRootGeometry \- Get location and size of virtual root for window
  28. .SH SYNOPSIS
  29. .nf
  30. \fB#include <tk.h>\fR
  31. .sp
  32. \fBTk_GetVRootGeometry(\fItkwin, xPtr, yPtr, widthPtr, heightPtr\fB)
  33. .SH ARGUMENTS
  34. .AS Tk_Window heightPtr
  35. .AP Tk_Window tkwin in
  36. Token for window whose virtual root is to be queried.
  37. .AP int xPtr out
  38. Points to word in which to store x-offset of virtual root.
  39. .AP int yPtr out
  40. Points to word in which to store y-offset of virtual root.
  41. .AP "unsigned int" widthPtr out
  42. Points to word in which to store width of virtual root.
  43. .AP "unsigned int" heightPtr out
  44. Points to word in which to store height of virtual root.
  45. .BE
  46.  
  47. .SH DESCRIPTION
  48. .PP
  49. \fBTkGetVRootGeometry\fR returns geometry information about the virtual
  50. root window associated with \fItkwin\fR.  The ``associated'' virtual
  51. root is the one in which \fItkwin\fR's nearest top-level ancestor (or
  52. \fItkwin\fR itself if it is a top-level window) has
  53. been reparented by the window manager.  This window is identified by
  54. a \fB__SWM_ROOT\fR or \fB__WM_ROOT\fR property placed on the top-level
  55. window by the window manager.
  56. If \fItkwin\fR is not associated with a virtual root (e.g.
  57. because the window manager doesn't use virtual roots) then *\fIxPtr\fR and
  58. *\fIyPtr\fR will be set to 0 and *\fIwidthPtr\fR and *\fIheightPtr\fR
  59. will be set to the dimensions of the screen containing \fItkwin\fR.
  60.  
  61. .SH KEYWORDS
  62. geometry, height, location, virtual root, width, window manager
  63.