Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / src / nas,5.n2.os.2 / lib / python / man / mann / focus.n
CommitLineData
86530b38
AT
1'\"
2'\" Copyright (c) 1990-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: focus.n,v 1.2.26.1 2004/10/28 10:19:29 dkf Exp $
9'\"
10'\" The definitions below are for supplemental macros used in Tcl/Tk
11'\" manual entries.
12'\"
13'\" .AP type name in/out ?indent?
14'\" Start paragraph describing an argument to a library procedure.
15'\" type is type of argument (int, etc.), in/out is either "in", "out",
16'\" or "in/out" to describe whether procedure reads or modifies arg,
17'\" and indent is equivalent to second arg of .IP (shouldn't ever be
18'\" needed; use .AS below instead)
19'\"
20'\" .AS ?type? ?name?
21'\" Give maximum sizes of arguments for setting tab stops. Type and
22'\" name are examples of largest possible arguments that will be passed
23'\" to .AP later. If args are omitted, default tab stops are used.
24'\"
25'\" .BS
26'\" Start box enclosure. From here until next .BE, everything will be
27'\" enclosed in one large box.
28'\"
29'\" .BE
30'\" End of box enclosure.
31'\"
32'\" .CS
33'\" Begin code excerpt.
34'\"
35'\" .CE
36'\" End code excerpt.
37'\"
38'\" .VS ?version? ?br?
39'\" Begin vertical sidebar, for use in marking newly-changed parts
40'\" of man pages. The first argument is ignored and used for recording
41'\" the version when the .VS was added, so that the sidebars can be
42'\" found and removed when they reach a certain age. If another argument
43'\" is present, then a line break is forced before starting the sidebar.
44'\"
45'\" .VE
46'\" End of vertical sidebar.
47'\"
48'\" .DS
49'\" Begin an indented unfilled display.
50'\"
51'\" .DE
52'\" End of indented unfilled display.
53'\"
54'\" .SO
55'\" Start of list of standard options for a Tk widget. The
56'\" options follow on successive lines, in four columns separated
57'\" by tabs.
58'\"
59'\" .SE
60'\" End of list of standard options for a Tk widget.
61'\"
62'\" .OP cmdName dbName dbClass
63'\" Start of description of a specific option. cmdName gives the
64'\" option's name as specified in the class command, dbName gives
65'\" the option's name in the option database, and dbClass gives
66'\" the option's class in the option database.
67'\"
68'\" .UL arg1 arg2
69'\" Print arg1 underlined, then print arg2 normally.
70'\"
71'\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
72'\"
73'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
74.if t .wh -1.3i ^B
75.nr ^l \n(.l
76.ad b
77'\" # Start an argument description
78.de AP
79.ie !"\\$4"" .TP \\$4
80.el \{\
81. ie !"\\$2"" .TP \\n()Cu
82. el .TP 15
83.\}
84.ta \\n()Au \\n()Bu
85.ie !"\\$3"" \{\
86\&\\$1 \\fI\\$2\\fP (\\$3)
87.\".b
88.\}
89.el \{\
90.br
91.ie !"\\$2"" \{\
92\&\\$1 \\fI\\$2\\fP
93.\}
94.el \{\
95\&\\fI\\$1\\fP
96.\}
97.\}
98..
99'\" # define tabbing values for .AP
100.de AS
101.nr )A 10n
102.if !"\\$1"" .nr )A \\w'\\$1'u+3n
103.nr )B \\n()Au+15n
104.\"
105.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
106.nr )C \\n()Bu+\\w'(in/out)'u+2n
107..
108.AS Tcl_Interp Tcl_CreateInterp in/out
109'\" # BS - start boxed text
110'\" # ^y = starting y location
111'\" # ^b = 1
112.de BS
113.br
114.mk ^y
115.nr ^b 1u
116.if n .nf
117.if n .ti 0
118.if n \l'\\n(.lu\(ul'
119.if n .fi
120..
121'\" # BE - end boxed text (draw box now)
122.de BE
123.nf
124.ti 0
125.mk ^t
126.ie n \l'\\n(^lu\(ul'
127.el \{\
128.\" Draw four-sided box normally, but don't draw top of
129.\" box if the box started on an earlier page.
130.ie !\\n(^b-1 \{\
131\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
132.\}
133.el \}\
134\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
135.\}
136.\}
137.fi
138.br
139.nr ^b 0
140..
141'\" # VS - start vertical sidebar
142'\" # ^Y = starting y location
143'\" # ^v = 1 (for troff; for nroff this doesn't matter)
144.de VS
145.if !"\\$2"" .br
146.mk ^Y
147.ie n 'mc \s12\(br\s0
148.el .nr ^v 1u
149..
150'\" # VE - end of vertical sidebar
151.de VE
152.ie n 'mc
153.el \{\
154.ev 2
155.nf
156.ti 0
157.mk ^t
158\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
159.sp -1
160.fi
161.ev
162.\}
163.nr ^v 0
164..
165'\" # Special macro to handle page bottom: finish off current
166'\" # box/sidebar if in box/sidebar mode, then invoked standard
167'\" # page bottom macro.
168.de ^B
169.ev 2
170'ti 0
171'nf
172.mk ^t
173.if \\n(^b \{\
174.\" Draw three-sided box if this is the box's first page,
175.\" draw two sides but no top otherwise.
176.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
177.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
178.\}
179.if \\n(^v \{\
180.nr ^x \\n(^tu+1v-\\n(^Yu
181\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
182.\}
183.bp
184'fi
185.ev
186.if \\n(^b \{\
187.mk ^y
188.nr ^b 2
189.\}
190.if \\n(^v \{\
191.mk ^Y
192.\}
193..
194'\" # DS - begin display
195.de DS
196.RS
197.nf
198.sp
199..
200'\" # DE - end display
201.de DE
202.fi
203.RE
204.sp
205..
206'\" # SO - start of list of standard options
207.de SO
208.SH "STANDARD OPTIONS"
209.LP
210.nf
211.ta 5.5c 11c
212.ft B
213..
214'\" # SE - end of list of standard options
215.de SE
216.fi
217.ft R
218.LP
219See the \\fBoptions\\fR manual entry for details on the standard options.
220..
221'\" # OP - start of full description for a single option
222.de OP
223.LP
224.nf
225.ta 4c
226Command-Line Name: \\fB\\$1\\fR
227Database Name: \\fB\\$2\\fR
228Database Class: \\fB\\$3\\fR
229.fi
230.IP
231..
232'\" # CS - begin code excerpt
233.de CS
234.RS
235.nf
236.ta .25i .5i .75i 1i
237..
238'\" # CE - end code excerpt
239.de CE
240.fi
241.RE
242..
243.de UL
244\\$1\l'|0\(ul'\\$2
245..
246.TH focus n 4.0 Tk "Tk Built-In Commands"
247.BS
248'\" Note: do not modify the .SH NAME line immediately below!
249.SH NAME
250focus \- Manage the input focus
251.SH SYNOPSIS
252.nf
253\fBfocus\fR
254\fBfocus \fIwindow\fR
255\fBfocus \fIoption\fR ?\fIarg arg ...\fR?
256.fi
257.BE
258
259.SH DESCRIPTION
260.PP
261The \fBfocus\fR command is used to manage the Tk input focus.
262At any given time, one window on each display is designated as
263the \fIfocus window\fR; any key press or key release events for the
264display are sent to that window.
265It is normally up to the window manager to redirect the focus among the
266top-level windows of a display. For example, some window managers
267automatically set the input focus to a top-level window whenever
268the mouse enters it; others redirect the input focus only when
269the user clicks on a window.
270Usually the window manager will set the focus
271only to top-level windows, leaving it up to the application to
272redirect the focus among the children of the top-level.
273.PP
274Tk remembers one focus window for each top-level (the most recent
275descendant of that top-level to receive the focus); when the window
276manager gives the focus
277to a top-level, Tk automatically redirects it to the remembered
278window. Within a top-level Tk uses an \fIexplicit\fR focus model
279by default. Moving the mouse within a top-level does not normally
280change the focus; the focus changes only when a widget
281decides explicitly to claim the focus (e.g., because of a button
282click), or when the user types a key such as Tab that moves the
283focus.
284.PP
285The Tcl procedure \fBtk_focusFollowsMouse\fR may be invoked to
286create an \fIimplicit\fR focus model: it reconfigures Tk so that
287the focus is set to a window whenever the mouse enters it.
288The Tcl procedures \fBtk_focusNext\fR and \fBtk_focusPrev\fR
289implement a focus order among the windows of a top-level; they
290are used in the default bindings for Tab and Shift-Tab, among other
291things.
292.PP
293The \fBfocus\fR command can take any of the following forms:
294.TP
295\fBfocus\fR
296Returns the path name of the focus window on the display containing
297the application's main window, or an empty string if no window in
298this application has the focus on that display. Note: it is
299better to specify the display explicitly using \fB\-displayof\fR
300(see below) so that the code will work in applications using multiple
301displays.
302.TP
303\fBfocus \fIwindow\fR
304If the application currently has the input focus on \fIwindow\fR's
305display, this command resets the input focus for \fIwindow\fR's display
306to \fIwindow\fR and returns an empty string.
307If the application doesn't currently have the input focus on
308\fIwindow\fR's display, \fIwindow\fR will be remembered as the focus
309for its top-level; the next time the focus arrives at the top-level,
310Tk will redirect it to \fIwindow\fR.
311If \fIwindow\fR is an empty string then the command does nothing.
312.TP
313\fBfocus \-displayof\fR \fIwindow\fR
314Returns the name of the focus window on the display containing \fIwindow\fR.
315If the focus window for \fIwindow\fR's display isn't in this
316application, the return value is an empty string.
317.TP
318\fBfocus \-force \fIwindow\fR
319Sets the focus of \fIwindow\fR's display to \fIwindow\fR, even if
320the application doesn't currently have the input focus for the display.
321This command should be used sparingly, if at all.
322In normal usage, an application should not claim the focus for
323itself; instead, it should wait for the window manager to give it
324the focus.
325If \fIwindow\fR is an empty string then the command does nothing.
326.TP
327\fBfocus \-lastfor\fR \fIwindow\fR
328Returns the name of the most recent window to have the input focus
329among all the windows in the same top-level as \fIwindow\fR.
330If no window in that top-level has ever had the input focus, or
331if the most recent focus window has been deleted, then the name
332of the top-level is returned. The return value is the window that
333will receive the input focus the next time the window manager gives
334the focus to the top-level.
335.SH "QUIRKS"
336.PP
337When an internal window receives the input focus, Tk doesn't actually
338set the X focus to that window; as far as X is concerned, the focus
339will stay on the top-level window containing the window with the focus.
340However, Tk generates FocusIn and FocusOut events just as if the X
341focus were on the internal window. This approach gets around a
342number of problems that would occur if the X focus were actually moved;
343the fact that the X focus is on the top-level is invisible unless
344you use C code to query the X server directly.
345.SH "EXAMPLE"
346To make a window that only participates in the focus traversal ring
347when a variable is set, add the following bindings to the widgets
348\fIbefore\fR and \fIafter\fR it in that focus ring:
349.CS
350button .before -text "Before"
351button .middle -text "Middle"
352button .after -text "After"
353checkbutton .flag -variable traverseToMiddle -takefocus 0
354pack .flag -side left
355pack .before .middle .after
356bind .before <Tab> {
357 if {!$traverseToMiddle} {
358 \fBfocus\fR .after
359 break
360 }
361}
362bind .after <Shift-Tab> {
363 if {!$traverseToMiddle} {
364 \fBfocus\fR .before
365 break
366 }
367}
368\fBfocus\fR .before
369.CE
370
371.SH KEYWORDS
372events, focus, keyboard, top-level, window manager