mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-23 04:18:56 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
129 lines
3.1 KiB
XML
129 lines
3.1 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.ncurses-getmouse" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>ncurses_getmouse</refname>
|
|
<refpurpose>Reads mouse event</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ncurses_getmouse</methodname>
|
|
<methodparam><type>array</type><parameter role="reference">mevent</parameter></methodparam>
|
|
</methodsynopsis>
|
|
&warn.experimental.func;
|
|
<para>
|
|
<function>ncurses_getmouse</function> reads mouse event out of
|
|
queue.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>mevent</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Event options will be delivered in this parameter which has to be an
|
|
array, passed by reference (see example below).
|
|
</para>
|
|
<para>
|
|
On success an associative array with following keys will be delivered:
|
|
<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; if a mouse event is actually visible in the given window,
|
|
otherwise returns &true;.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>ncurses_getmouse</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
switch (ncurses_getch()){
|
|
case NCURSES_KEY_MOUSE:
|
|
if (!ncurses_getmouse($mevent)){
|
|
if ($mevent["mmask"] & NCURSES_MOUSE_BUTTON1_PRESSED){
|
|
$mouse_x = $mevent["x"]; // Save mouse position
|
|
$mouse_y = $mevent["y"];
|
|
}
|
|
}
|
|
break;
|
|
|
|
default:
|
|
/* .... */
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>ncurses_ungetmouse</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
|
|
-->
|