projects / OpenSPARC-T2-DV / blame
? search:
summary | tags | clone url | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man3 / Tk::grab.3
CommitLineData
86530b38
AT		 1.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v
15.if n .sp
16..
17.de Vb \" Begin verbatim text
18.ft CW
19.nf
20.ne \\$1
21..
22.de Ve \" End verbatim text
23.ft R
24.fi
25..
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
43'br\}
44.el\{\
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
49'br\}
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
58..
59. nr % 0
60. rr F
61.\}
62.\"
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff
71.if n \{\
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
77.\}
78.if t \{\
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
84.\}
85. \" simple accents for nroff and troff
86.if n \{\
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
93.\}
94.if t \{\
95. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101.\}
102. \" troff and (daisy-wheel) nroff accents
103.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110.ds ae a\h'-(\w'a'u*4/10)'e
111.ds Ae A\h'-(\w'A'u*4/10)'E
112. \" corrections for vroff
113.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115. \" for low resolution devices (crt and lpr)
116.if \n(.H>23 .if \n(.V>19 \
117\{\
118. ds : e
119. ds 8 ss
120. ds o a
121. ds d- d\h'-1'\(ga
122. ds D- D\h'-1'\(hy
123. ds th \o'bp'
124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
127.\}
128.rm #[ #] #H #V #F C
129.\" ========================================================================
130.\"
131.IX Title "GRAB 1"
132.TH GRAB 1 "2000-12-30" "perl v5.8.0" "User Contributed Perl Documentation"
133.SH "NAME"
134grab \- Confine pointer and keyboard events to a window sub\-tree
135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS"
137\&\fI$widget\fR\->\fBgrab\fR
138.PP
139\&\fI$widget\fR\->\fBgrab\fR\fIOption\fR
140.SH "DESCRIPTION"
141.IX Header "DESCRIPTION"
142This set of methods implement simple pointer and keyboard grabs for Tk.
143Tk's grabs are different than the grabs
144described in the Xlib documentation.
145When a grab is set for a particular window, Tk restricts all pointer
146events to the grab window and its descendants in Tk's window hierarchy.
147Whenever the pointer is within the grab window's subtree, the pointer
148will behave exactly the same as if there had been no grab at all
149and all events will be reported in the normal fashion.
150When the pointer is outside \fI$widget\fR's tree, button presses and
151releases and
152mouse motion events are reported to \fI$widget\fR, and window entry
153and window exit events are ignored.
154The grab subtree ``owns'' the pointer:
155windows outside the grab subtree will be visible on the screen
156but they will be insensitive until the grab is released.
157The tree of windows underneath the grab window can include top-level
158windows, in which case all of those top-level windows
159and their descendants will continue to receive mouse events
160during the grab.
161.PP
162Two forms of grabs are possible: local and global.
163A local grab affects only the grabbing application: events will
164be reported to other applications as if the grab had never occurred.
165Grabs are local by default.
166A global grab locks out all applications on the screen,
167so that only the given subtree of the grabbing application will be
168sensitive to pointer events (mouse button presses, mouse button releases,
169pointer motions, window entries, and window exits).
170During global grabs the window manager will not receive pointer
171events either.
172.PP
173During local grabs, keyboard events (key presses and key releases)
174are delivered as usual: the window
175manager controls which application receives keyboard events, and
176if they are sent to any window in the grabbing application then they are
177redirected to the focus window.
178During a global grab Tk grabs the keyboard so that all keyboard events
179are always sent to the grabbing application.
180The \fBfocus\fR method is still used to determine which window in the
181application receives the keyboard events.
182The keyboard grab is released when the grab is released.
183.PP
184Grabs apply to particular displays. If an application has windows
185on multiple displays then it can establish a separate grab on each
186display.
187The grab on a particular display affects only the windows on
188that display.
189It is possible for different applications on a single display to have
190simultaneous local grabs, but only one application can have a global
191grab on a given display at once.
192.PP
193The \fBgrab\fR methods take any of the following forms:
194.IP "\fI$widget\fR\->\fBgrabCurrent\fR" 4
195.IX Item "$widget->grabCurrent"
196Returns the current grab
197window in this application for \fI$widget\fR's display, or an empty
198string if there is no such window.
199.IP "\fI$widget\fR\->\fBgrabs\fR" 4
200.IX Item "$widget->grabs"
201Returns a list whose elements
202are all of the windows grabbed by this application for all displays,
203or an empty string if the application has no grabs.
204.Sp
205\&\fINot implemented yet!\fR
206.IP "\fI$widget\fR\->\fBgrabRelease\fR" 4
207.IX Item "$widget->grabRelease"
208Releases the grab on \fI$widget\fR if there is one, otherwise does
209nothing. Returns an empty string.
210.IP "\fI$widget\fR\->\fBgrab\fR" 4
211.IX Item "$widget->grab"
212Sets a local grab on \fI$widget\fR.
213If a grab was already in effect for this application on
214\&\fI$widget\fR's display then it is automatically released.
215If there is already a local grab on \fI$widget\fR, then the command
216does nothing. Returns an empty string.
217.IP "\fI$widget\fR\->\fBgrabGlobal\fR" 4
218.IX Item "$widget->grabGlobal"
219Sets a global grab on \fI$widget\fR.
220If a grab was already in effect for this application on
221\&\fI$widget\fR's display then it is automatically released.
222If there is already a global grab on \fI$widget\fR,
223then the command does nothing. Returns an empty string.
224.IP "\fI$widget\fR\->\fBgrabStatus\fR" 4
225.IX Item "$widget->grabStatus"
226Returns \fBnone\fR if no grab is currently set on \fI$widget\fR,
227\&\fBlocal\fR if a local grab is set on \fI$widget\fR, and
228\&\fBglobal\fR if a global grab is set.
229.SH "BUGS"
230.IX Header "BUGS"
231It took an incredibly complex and gross implementation to produce
232the simple grab effect described above.
233Given the current implementation, it isn't safe for applications
234to use the Xlib grab facilities at all except through the Tk grab
235procedures.
236If applications try to manipulate X's grab mechanisms directly,
237things will probably break.
238.PP
239If a single process is managing several different Tk applications,
240only one of those applications can have a local grab for a given
241display at any given time. If the applications are in different
242processes, this restriction doesn't exist.
243.SH "KEYWORDS"
244.IX Header "KEYWORDS"
245grab, keyboard events, pointer events, window
Full OpenSPARC design & verification tarball including full HDL.