<!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>Pushes mouse event to queue</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ncurses-ungetch.html">ncurses_ungetch</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ncurses-update-panels.html">ncurses_update_panels</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-ungetmouse" class="refentry">
<div class="refnamediv">
<h1 class="refname">ncurses_ungetmouse</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_ungetmouse</span> — <span class="dc-title">Pushes mouse event to queue</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ncurses-ungetmouse-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>ncurses_ungetmouse</strong></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$mevent</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">
Pushes a KEY_MOUSE event onto the unput queue and associates with this
event the given state sata and screen-relative character cell coordinates,
specified in <em><code class="parameter">mevent</code></em>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ncurses-ungetmouse-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">mevent</code></em></span>
<dd>
<p class="para">
An associative array specifying the event options:
<ul class="itemizedlist">
<li class="listitem">
<p class="para">"id" : Id to distinguish multiple devices</p>
</li>
<li class="listitem">
<p class="para">"x" : screen relative x-position in character cells</p>
</li>
<li class="listitem">
<p class="para">"y" : screen relative y-position in character cells</p>
</li>
<li class="listitem">
<p class="para">"z" : currently not supported</p>
</li>
<li class="listitem">
<p class="para">"mmask" : Mouse action</p>
</li>
</ul>
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ncurses-ungetmouse-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>FALSE</code></strong> on success, <strong><code>TRUE</code></strong> otherwise.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.ncurses-ungetmouse-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<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>
</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-ungetch.html">ncurses_ungetch</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ncurses-update-panels.html">ncurses_update_panels</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>
