Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

Tk_CoordsToWindow (3tk)

Name

Tk_CoordsToWindow - Find window containing a point

Synopsis

#include <tk.h>

Tk_Window
Tk_CoordsToWindow(rootX, rootY, tkwin)

Description

Tk_CoordsToWindow(3tk)       Tk Library Procedures      Tk_CoordsToWindow(3tk)



______________________________________________________________________________

NAME
       Tk_CoordsToWindow - Find window containing a point

SYNOPSIS
       #include <tk.h>

       Tk_Window
       Tk_CoordsToWindow(rootX, rootY, tkwin)

ARGUMENTS
       int rootX (in)                X-coordinate   (in  root  window  coordi-
                                     nates).

       int rootY (in)                Y-coordinate  (in  root  window   coordi-
                                     nates).

       Tk_Window tkwin (in)          Token for window that identifies applica-
                                     tion.
______________________________________________________________________________

DESCRIPTION
       Tk_CoordsToWindow locates the window that contains a given point.   The
       point  is specified in root coordinates with rootX and rootY (if a vir-
       tual-root window manager is in use then rootX  and  rootY  are  in  the
       coordinate  system  of the virtual root window).  The return value from
       the procedure is a token for the window that contains the given  point.
       If  the  point is not in any window, or if the containing window is not
       in the same application as tkwin, then NULL is returned.

       The containing window is decided using the same  rules  that  determine
       which  window  contains the mouse cursor:  if a parent and a child both
       contain the point then the child gets preference, and if  two  siblings
       both contain the point then the highest one in the stacking order (i.e.
       the one that's visible on the screen) gets preference.

KEYWORDS
       containing, coordinates, root window



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                                                      Tk_CoordsToWindow(3tk)