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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.5 -->
<refentry id="function.ncurses-mousemask">
<refnamediv>
<refname>ncurses_mousemask</refname>
<refpurpose>Sets mouse options</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>ncurses_mousemask</methodname>
<methodparam><type>int</type><parameter>newmask</parameter></methodparam>
<methodparam><type>int</type><parameter role="reference">oldmask</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
Function <function>ncurses_mousemask</function> will set mouse events
to be reported. By default no mouse events will be reported. The
function <function>ncurses_mousemask</function> will return a
mask to indicated which of the in parameter
<parameter>newmask</parameter>
specified mouse events can be reported. On complete failure, it
returns 0. In parameter <parameter>oldmask</parameter>, which is
passed by reference <function>ncurses_mousemask</function>
returns the previous value of mouse event mask.
Mouse events are represented by NCURSES_KEY_MOUSE in the
<function>ncurses_wgetch</function> input stream. To read the
event data and pop the event of queue, call
<function>ncurses_getmouse</function>.
</para>
<para>
As a side effect, setting a zero mousemask in
<parameter>newmask</parameter> turns off the mouse
pointer. Setting a non zero value turns mouse pointer on.
</para>
<para>
mouse mask options can be set with the following predefined
constants:
<itemizedlist>
<listitem><para>NCURSES_BUTTON1_PRESSED</para></listitem>
<listitem><para>NCURSES_BUTTON1_RELEASED</para></listitem>
<listitem><para>NCURSES_BUTTON1_CLICKED</para></listitem>
<listitem><para>NCURSES_BUTTON1_DOUBLE_CLICKED</para></listitem>
<listitem><para>NCURSES_BUTTON1_TRIPLE_CLICKED</para></listitem>
<listitem><para>NCURSES_BUTTON2_PRESSED</para></listitem>
<listitem><para>NCURSES_BUTTON2_RELEASED</para></listitem>
<listitem><para>NCURSES_BUTTON2_CLICKED</para></listitem>
<listitem><para>NCURSES_BUTTON2_DOUBLE_CLICKED</para></listitem>
<listitem><para>NCURSES_BUTTON2_TRIPLE_CLICKED</para></listitem>
<listitem><para>NCURSES_BUTTON3_PRESSED</para></listitem>
<listitem><para>NCURSES_BUTTON3_RELEASED</para></listitem>
<listitem><para>NCURSES_BUTTON3_CLICKED</para></listitem>
<listitem><para>NCURSES_BUTTON3_DOUBLE_CLICKED</para></listitem>
<listitem><para>NCURSES_BUTTON3_TRIPLE_CLICKED</para></listitem>
<listitem><para>NCURSES_BUTTON4_PRESSED</para></listitem>
<listitem><para>NCURSES_BUTTON4_RELEASED</para></listitem>
<listitem><para>NCURSES_BUTTON4_CLICKED</para></listitem>
<listitem><para>NCURSES_BUTTON4_DOUBLE_CLICKED</para></listitem>
<listitem><para>NCURSES_BUTTON4_TRIPLE_CLICKED</para></listitem>
<listitem><para>NCURSES_BUTTON_SHIFT></para></listitem>
<listitem><para>NCURSES_BUTTON_CTRL</para></listitem>
<listitem><para>NCURSES_BUTTON_ALT</para></listitem>
<listitem><para>NCURSES_ALL_MOUSE_EVENTS</para></listitem>
<listitem><para>NCURSES_REPORT_MOUSE_POSITION</para></listitem>
</itemizedlist>
</para>
<para>
<example>
<title><function>ncurses_mousemask</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$newmask = NCURSES_BUTTON1_CLICKED + NCURSES_BUTTON1_RELEASED;
$mask = ncurses_mousemask($newmask, &$oldmask);
if ($mask & $newmask){
printf ("All specified mouse options will be supported\n");
}
?>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>ncurses_getmouse</function>,
<function>ncurses_ungetmouse</function> and
<function>ncurese_getch</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
-->
|
