1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.5 -->
<refentry id="function.ncurses-getmouse">
<refnamediv>
<refname>ncurses_getmouse</refname>
<refpurpose>Reads mouse event</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ncurses_getmouse</methodname>
<methodparam><type>array</type><parameter role="reference">mevent</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>ncurses_getmouse</function> reads mouse event out of
queue. Function <function>ncurses_getmouse</function> will return
;&false; if a mouse event is actually visible in the given
window, otherwise it will return &true;.
Event options will be delivered in parameter
<parameter>mevent</parameter>, which has to be an array, passed
by reference (see example below).
On success an associative array with following keys will be
delivered:
<itemizedlist>
<listitem><para>"id" : Id to distinguish multiple
devices</para></listitem>
<listitem><para>"x" : screen relative x-position in character
cells</para></listitem>
<listitem><para>"y" : screen relative y-position in character
cells</para></listitem>
<listitem><para>"z" : currently not supported</para></listitem>
<listitem><para>"mmask" : Mouse action</para></listitem>
</itemizedlist>
</para>
<para>
<example>
<title><function>ncurses_getmouse</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
switch (ncurses_getch()){
case NCURSES_KEY_MOUSE:
if (!ncurses_getmouse(&$mevent)){
if ($mevent["mmask"] & NCURSES_MOUSE_BUTTON1_PRESSED){
$mouse_x = $mevent["x"]; // Save mouse position
$mouse_y = $mevent["y"];
}
}
break;
default:
/* .... */
}
?>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>ncurses_ungetmouse</function>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
