doc/focusNext.n

   1 '\"
   2 '\" Copyright (c) 1994 The Regents of the University of California.
   3 '\" Copyright (c) 1994-1995 Sun Microsystems, Inc.
   4 '\" Copyright (c) 1996-1999 Christian Werner
   5 '\"
   6 '\" See the file "license.terms" for information on usage and redistribution
   7 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   8 '\"
   9 .so man.macros
  10 .TH ck_focusNext n 8.0 Ck "Ck Built-In Commands"
  11 .BS
  12 '\" Note:  do not modify the .SH NAME line immediately below!
  13 .SH NAME
  14 ck_focusNext, ck_focusPrev \- Utility procedures for managing the input focus.
  15 .SH SYNOPSIS
  16 \fBck_focusNext \fIwindow\fR
  17 .br
  18 \fBck_focusPrev \fIwindow\fR
  19 .BE
  20
  21 .SH DESCRIPTION
  22 .PP
  23 \fBck_focusNext\fR is a utility procedure used for keyboard traversal.
  24 It returns the ``next'' window after \fIwindow\fR in focus order.
  25 The focus order is determined by
  26 the stacking order of windows and the structure of the window hierarchy.
  27 Among siblings, the focus order is the same as the stacking order, with the
  28 lowest window being first.
  29 If a window has children, the window is visited first, followed by
  30 its children (recursively), followed by its next sibling.
  31 Top-level windows other than \fIwindow\fR are skipped, so that
  32 \fBck_focusNext\fR never returns a window in a different top-level
  33 from \fIwindow\fR.
  34 .PP
  35 After computing the next window, \fBck_focusNext\fR examines the
  36 window's \fB\-takefocus\fR option to see whether it should be skipped.
  37 If so, \fBck_focusNext\fR continues on to the next window in the focus
  38 order, until it eventually finds a window that will accept the focus
  39 or returns back to \fIwindow\fR.
  40 .PP
  41 \fBck_focusPrev\fR is similar to \fBck_focusNext\fR except that it
  42 returns the window just before \fIwindow\fR in the focus order.
  43
  44 .SH KEYWORDS
  45 focus, keyboard traversal, toplevel