tk/doc/focusNext.n

   1 '\"
   2 '\" Copyright (c) 1994 The Regents of the University of California.
   3 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
   4 '\"
   5 '\" See the file "license.terms" for information on usage and redistribution
   6 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   7 '\"
   8 '\" RCS: @(#) $Id$
   9 '\"
  10 .so man.macros
  11 .TH tk_focusNext n 4.0 Tk "Tk Built-In Commands"
  12 .BS
  13 '\" Note:  do not modify the .SH NAME line immediately below!
  14 .SH NAME
  15 tk_focusNext, tk_focusPrev, tk_focusFollowsMouse \- Utility procedures for managing the input focus.
  16 .SH SYNOPSIS
  17 \fBtk_focusNext \fIwindow\fR
  18 .sp
  19 \fBtk_focusPrev \fIwindow\fR
  20 .sp
  21 \fBtk_focusFollowsMouse\fR
  22 .BE
  23
  24 .SH DESCRIPTION
  25 .PP
  26 \fBtk_focusNext\fR is a utility procedure used for keyboard traversal.
  27 It returns the ``next'' window after \fIwindow\fR in focus order.
  28 The focus order is determined by
  29 the stacking order of windows and the structure of the window hierarchy.
  30 Among siblings, the focus order is the same as the stacking order, with the
  31 lowest window being first.
  32 If a window has children, the window is visited first, followed by
  33 its children (recursively), followed by its next sibling.
  34 Top-level windows other than \fIwindow\fR are skipped, so that
  35 \fBtk_focusNext\fR never returns a window in a different top-level
  36 from \fIwindow\fR.
  37 .PP
  38 After computing the next window, \fBtk_focusNext\fR examines the
  39 window's \fB\-takefocus\fR option to see whether it should be skipped.
  40 If so, \fBtk_focusNext\fR continues on to the next window in the focus
  41 order, until it eventually finds a window that will accept the focus
  42 or returns back to \fIwindow\fR.
  43 .PP
  44 \fBtk_focusPrev\fR is similar to \fBtk_focusNext\fR except that it
  45 returns the window just before \fIwindow\fR in the focus order.
  46 .PP
  47 \fBtk_focusFollowsMouse\fR changes the focus model for the application
  48 to an implicit one where the window under the mouse gets the focus.
  49 After this procedure is called, whenever the mouse enters a window
  50 Tk will automatically give it the input focus.
  51 The \fBfocus\fR command may be used to move the focus to a window
  52 other than the one under the mouse, but as soon as the mouse moves
  53 into a new window the focus will jump to that window.
  54 Note: at present there is no built-in support for returning the
  55 application to an explicit focus model;  to do this you'll have
  56 to write a script that deletes the bindings created by
  57 \fBtk_focusFollowsMouse\fR.
  58
  59 .SH KEYWORDS
  60 focus, keyboard traversal, top-level