~ubuntu-branches/ubuntu/hoary/scilab/hoary

« back to all changes in this revision

Viewing changes to man/graphics/xclick.man

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2005-01-09 22:58:21 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050109225821-473xr8vhgugxxx5j
Tags: 3.0-12
changed configure.in to build scilab's own malloc.o, closes: #255869

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH xclick 2 "April 1993" "Scilab Group" "Scilab Function"
2
 
.so ../sci.an
3
 
.SH NAME
4
 
xclick - wait for a mouse click
5
 
.SH CALLING SEQUENCE
6
 
.nf
7
 
[c_i,c_x,c_y,c_w,c_m]=xclick([flag])
8
 
.fi
9
 
.SH PARAMETERS
10
 
.TP 9
11
 
c_i
12
 
: integer, mouse button number.
13
 
.TP
14
 
c_x,c_y
15
 
: real scalars, position of the mouse.
16
 
.TP 
17
 
c_w
18
 
: integer, window number.
19
 
.TP 
20
 
c_m
21
 
: string, menu callback.
22
 
.TP
23
 
flag
24
 
: integer. If present, the click event queue is not cleared when entering 
25
 
xclick.
26
 
.SH DESCRIPTION
27
 
\fVxclick\fR waits for a mouse click in the graphics window.
28
 
 
29
 
If it is called with 3 left hand side arguments, it waits for a mouse click 
30
 
in the current graphics window.
31
 
.LP
32
 
If it is called with 4 or 5 left hand side arguments, it waits for a mouse 
33
 
click in any graphics window.
34
 
.LP
35
 
The returned values are described below.
36
 
.TP 9
37
 
c_i 
38
 
: an integer which gives the number of the mouse button that was pressed 
39
 
0, 1 or 2 (for left, middle and right) or -1 in case of problems with xclick.
40
 
.TP
41
 
c_x,c_y
42
 
: the coordinates of the position of the mouse click in the current graphics 
43
 
scale.
44
 
.TP 
45
 
c_w
46
 
: the window number where the click has occurred.
47
 
.TP 
48
 
c_m
49
 
: string associated with a dynamic menu. If xclick returns
50
 
due to a click on a menu, \fVc_i\fR, \fVc_x\fR, \fVc_y,\fR and \fVc_w\fR take
51
 
arbitrary values.
52
 
.SH KNOWN TROUBLES
53
 
\fVxclick\fR can return the message 
54
 
"Can't grab the pointer" if the graphics window is iconified when 
55
 
calling it.
56
 
.SH SEE ALSO
57
 
locate, xgetmouse
58
 
.SH AUTHOR
59
 
J.Ph.C.