mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
13aa29ef8a
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335349 c90b9560-bf6c-de11-be94-00142212c4b1
88 lines
2.4 KiB
XML
88 lines
2.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.ncurses-ungetmouse" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>ncurses_ungetmouse</refname>
|
|
<refpurpose>Pushes mouse event to queue</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ncurses_ungetmouse</methodname>
|
|
<methodparam><type>array</type><parameter>mevent</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
Pushes a KEY_MOUSE event onto the input queue and associates with this
|
|
event the given state data and screen-relative character cell coordinates,
|
|
specified in <parameter>mevent</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>mevent</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
An associative array specifying the event options:
|
|
<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>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns &false; on success, &true; otherwise.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>ncurses_getmouse</function></member>
|
|
</simplelist>
|
|
</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:"~/.phpdoc/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
|
|
-->
|