tk/doc/SetCaret.3

   1 '\"
   2 '\" Copyright (c) 2002 ActiveState Corporation.
   3 '\"
   4 '\" See the file "license.terms" for information on usage and redistribution
   5 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   6 '\"
   7 '\" RCS: @(#) $Id$
   8 '\"
   9 .so man.macros
  10 .TH Tk_SetCaretPos 3 8.4 Tk "Tk Library Procedures"
  11 .BS
  12 .SH NAME
  13 Tk_SetCaretPos \- set the display caret location
  14 .SH SYNOPSIS
  15 .nf
  16 \fB#include <tk.h>\fR
  17 .sp
  18 int
  19 \fBTk_SetCaretPos\fR(\fItkwin, x, y, height\fR)
  20 .SH ARGUMENTS
  21 .AP Tk_Window tkwin in
  22 Token for window.
  23 .AP int x in
  24 Window-relative x coordinate.
  25 .AP int y in
  26 Window-relative y coordinate.
  27 .AP int h in
  28 Height of the caret in the window.
  29 .BE
  30
  31 .SH DESCRIPTION
  32 .PP
  33 \fBTk_SetCaretPos\fR sets the caret location for the display of the
  34 specified Tk_Window \fItkwin\fR.  The caret is the per-display cursor
  35 location used for indicating global focus (e.g. to comply with Microsoft
  36 Accessibility guidelines), as well as for location of the over-the-spot XIM
  37 (X Input Methods) or Windows IME windows.
  38
  39 .SH KEYWORDS
  40 caret, cursor