php-doc-en/reference/ncurses/functions/ncurses-ungetmouse.xml
Hartmut Holzgraefe 5b9fc29465 revision tags added
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@78496 c90b9560-bf6c-de11-be94-00142212c4b1
2002-04-17 06:45:35 +00:00

64 lines
2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- splitted from ./en/functions/ncurses.xml, last change in rev 1.1 -->
<refentry id="function.ncurses-ungetmouse">
<refnamediv>
<refname>ncurses_ungetmouse</refname>
<refpurpose>Pushes mouse event to queue</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>ncurses_ungetmouse</methodname>
<methodparam><type>array</type><parameter>mevent</parameter></methodparam>
</methodsynopsis>
&warn.experimental.func;
<para>
<function>ncurses_getmouse</function> 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 <parameter>mevent</parameter>.
Event options will be specified in associative array
<parameter>mevent</parameter>:
<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>
<function>ncurses_ungetmouse</function> returns &false; on
success, otherwise &true;.
</para>
<para>
See also: <function>ncurses_getmouse</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
-->