Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

Tk_GetVRootGeometry (3tk)

Name

Tk_GetVRootGeometry - Get location and size of virtual root for window

Synopsis

#include <tk.h>

Tk_GetVRootGeometry(tkwin, xPtr, yPtr, widthPtr, heightPtr)

Description

Tk_GetVRootGeometry(3tk)     Tk Library Procedures    Tk_GetVRootGeometry(3tk)



______________________________________________________________________________

NAME
       Tk_GetVRootGeometry - Get location and size of virtual root for window

SYNOPSIS
       #include <tk.h>

       Tk_GetVRootGeometry(tkwin, xPtr, yPtr, widthPtr, heightPtr)

ARGUMENTS
       Tk_Window tkwin (in)              Token  for  window whose virtual root
                                         is to be queried.

       int xPtr (out)                    Points to word in which to  store  x-
                                         offset of virtual root.

       int yPtr (out)                    Points  to  word in which to store y-
                                         offset of virtual root.

       int widthPtr (out)                Points to  word  in  which  to  store
                                         width of virtual root.

       int heightPtr (out)               Points  to  word  in  which  to store
                                         height of virtual root.
______________________________________________________________________________

DESCRIPTION
       Tk_GetVRootGeometry returns geometry information about the virtual root
       window associated with tkwin.  The "associated" virtual root is the one
       in which tkwin's nearest top-level ancestor (or tkwin itself if it is a
       top-level window) has been reparented by the window manager.  This win-
       dow is identified by a __SWM_ROOT or __WM_ROOT property placed  on  the
       top-level  window  by  the  window manager.  If tkwin is not associated
       with a virtual root (e.g.  because the window manager does not use vir-
       tual  roots)  then  *xPtr  and *yPtr will be set to 0 and *widthPtr and
       *heightPtr will be set to  the  dimensions  of  the  screen  containing
       tkwin.

KEYWORDS
       geometry, height, location, virtual root, width, window manager



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | runtime/tk-8     |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source        was        downloaded        from         https://source-
       forge.net/projects/tcl/files/Tcl/8.6.7/tk8.6.7-src.tar.gz/download.

       Further information about this software can be found on the open source
       community website at https://www.tcl.tk/.



Tk                                    4.0             Tk_GetVRootGeometry(3tk)