<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Sets mouse options</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.ncurses-mouseinterval.html">ncurses_mouseinterval</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.ncurses-move-panel.html">ncurses_move_panel</a></div> <div class="up"><a href="ref.ncurses.html">Ncurses Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.ncurses-mousemask" class="refentry"> <div class="refnamediv"> <h1 class="refname">ncurses_mousemask</h1> <p class="verinfo">(PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)</p><p class="refpurpose"><span class="refname">ncurses_mousemask</span> — <span class="dc-title">Sets mouse options</span></p> </div> <div class="refsect1 description" id="refsect1-function.ncurses-mousemask-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">int</span> <span class="methodname"><strong>ncurses_mousemask</strong></span> ( <span class="methodparam"><span class="type">int</span> <code class="parameter">$newmask</code></span> , <span class="methodparam"><span class="type">int</span> <code class="parameter reference">&$oldmask</code></span> )</div> <div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function is <em class="emphasis">EXPERIMENTAL</em>. The behaviour of this function, its name, and surrounding documentation may change without notice in a future release of PHP. This function should be used at your own risk. </p></div> <p class="para"> Sets mouse events to be reported. By default no mouse events will be reported. </p> <p class="para"> Mouse events are represented by <strong><code>NCURSES_KEY_MOUSE</code></strong> in the <span class="function"><a href="function.ncurses-wgetch.html" class="function">ncurses_wgetch()</a></span> input stream. To read the event data and pop the event of queue, call <span class="function"><a href="function.ncurses-getmouse.html" class="function">ncurses_getmouse()</a></span>. </p> </div> <div class="refsect1 parameters" id="refsect1-function.ncurses-mousemask-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">newmask</code></em></span> <dd> <p class="para"> Mouse mask options can be set with the following predefined constants: <ul class="itemizedlist"> <li class="listitem"><p class="para">NCURSES_BUTTON1_PRESSED</p></li> <li class="listitem"><p class="para">NCURSES_BUTTON1_RELEASED</p></li> <li class="listitem"><p class="para">NCURSES_BUTTON1_CLICKED</p></li> <li class="listitem"><p class="para">NCURSES_BUTTON1_DOUBLE_CLICKED</p></li> <li class="listitem"><p class="para">NCURSES_BUTTON1_TRIPLE_CLICKED</p></li> <li class="listitem"><p class="para">NCURSES_BUTTON2_PRESSED</p></li> <li class="listitem"><p class="para">NCURSES_BUTTON2_RELEASED</p></li> <li class="listitem"><p class="para">NCURSES_BUTTON2_CLICKED</p></li> <li class="listitem"><p class="para">NCURSES_BUTTON2_DOUBLE_CLICKED</p></li> <li class="listitem"><p class="para">NCURSES_BUTTON2_TRIPLE_CLICKED</p></li> <li class="listitem"><p class="para">NCURSES_BUTTON3_PRESSED</p></li> <li class="listitem"><p class="para">NCURSES_BUTTON3_RELEASED</p></li> <li class="listitem"><p class="para">NCURSES_BUTTON3_CLICKED</p></li> <li class="listitem"><p class="para">NCURSES_BUTTON3_DOUBLE_CLICKED</p></li> <li class="listitem"><p class="para">NCURSES_BUTTON3_TRIPLE_CLICKED</p></li> <li class="listitem"><p class="para">NCURSES_BUTTON4_PRESSED</p></li> <li class="listitem"><p class="para">NCURSES_BUTTON4_RELEASED</p></li> <li class="listitem"><p class="para">NCURSES_BUTTON4_CLICKED</p></li> <li class="listitem"><p class="para">NCURSES_BUTTON4_DOUBLE_CLICKED</p></li> <li class="listitem"><p class="para">NCURSES_BUTTON4_TRIPLE_CLICKED</p></li> <li class="listitem"><p class="para">NCURSES_BUTTON_SHIFT></p></li> <li class="listitem"><p class="para">NCURSES_BUTTON_CTRL</p></li> <li class="listitem"><p class="para">NCURSES_BUTTON_ALT</p></li> <li class="listitem"><p class="para">NCURSES_ALL_MOUSE_EVENTS</p></li> <li class="listitem"><p class="para">NCURSES_REPORT_MOUSE_POSITION</p></li> </ul> </p> <p class="para"> As a side effect, setting a zero mousemask in <em><code class="parameter">newmask</code></em> turns off the mouse pointer. Setting a non zero value turns mouse pointer on. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">oldmask</code></em></span> <dd> <p class="para"> This will be set to the previous value of the mouse event mask. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.ncurses-mousemask-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns a mask to indicated which of the in parameter <em><code class="parameter">newmask</code></em> specified mouse events can be reported. On complete failure, it returns 0. </p> </div> <div class="refsect1 examples" id="refsect1-function.ncurses-mousemask-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-632"> <p><strong>Example #1 <span class="function"><strong>ncurses_mousemask()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$newmask </span><span style="color: #007700">= </span><span style="color: #0000BB">NCURSES_BUTTON1_CLICKED </span><span style="color: #007700">+ </span><span style="color: #0000BB">NCURSES_BUTTON1_RELEASED</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$mask </span><span style="color: #007700">= </span><span style="color: #0000BB">ncurses_mousemask</span><span style="color: #007700">(</span><span style="color: #0000BB">$newmask</span><span style="color: #007700">, </span><span style="color: #0000BB">$oldmask</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$mask </span><span style="color: #007700">& </span><span style="color: #0000BB">$newmask</span><span style="color: #007700">){<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"All specified mouse options will be supported\n"</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-function.ncurses-mousemask-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.ncurses-getch.html" class="function" rel="rdfs-seeAlso">ncurses_getch()</a> - Read a character from keyboard</span></li> <li class="member"> <span class="function"><a href="function.ncurses-getmouse.html" class="function" rel="rdfs-seeAlso">ncurses_getmouse()</a> - Reads mouse event</span></li> <li class="member"> <span class="function"><a href="function.ncurses-ungetmouse.html" class="function" rel="rdfs-seeAlso">ncurses_ungetmouse()</a> - Pushes mouse event to queue</span></li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.ncurses-mouseinterval.html">ncurses_mouseinterval</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.ncurses-move-panel.html">ncurses_move_panel</a></div> <div class="up"><a href="ref.ncurses.html">Ncurses Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>