Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

Tk_SetCaretPos (3tk)

Name

Tk_SetCaretPos - set the display caret location

Synopsis

#include <tk.h>

int
Tk_SetCaretPos(tkwin, x, y, height)

Description

Tk_SetCaretPos(3tk)          Tk Library Procedures         Tk_SetCaretPos(3tk)



______________________________________________________________________________

NAME
       Tk_SetCaretPos - set the display caret location

SYNOPSIS
       #include <tk.h>

       int
       Tk_SetCaretPos(tkwin, x, y, height)

ARGUMENTS
       Tk_Window tkwin (in)                      Token for window.

       int x (in)                                Window-relative x coordinate.

       int y (in)                                Window-relative y coordinate.

       int h (in)                                Height  of  the  caret in the
                                                 window.
______________________________________________________________________________

DESCRIPTION
       Tk_SetCaretPos sets the caret location for the display of the specified
       Tk_Window tkwin.  The caret is the per-display cursor location used for
       indicating global focus (e.g. to comply  with  Microsoft  Accessibility
       guidelines),  as well as for location of the over-the-spot XIM (X Input
       Methods) or Windows IME windows.

KEYWORDS
       caret, cursor



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