Sophie: php-manual-en-4.3.0-2mdk noarch

php-manual-en-4.3.0-2mdk.noarch.rpm

<HTML
><HEAD
><TITLE
>ncurses_getmouse</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
REL="HOME"
TITLE="PHP Manual"
HREF="index.html"><LINK
REL="UP"
TITLE="Ncurses terminal screen control functions"
HREF="ref.ncurses.html"><LINK
REL="PREVIOUS"
TITLE="ncurses_getch"
HREF="function.ncurses-getch.html"><LINK
REL="NEXT"
TITLE="ncurses_halfdelay"
HREF="function.ncurses-halfdelay.html"><META
HTTP-EQUIV="Content-type"
CONTENT="text/html; charset=ISO-8859-1"></HEAD
><BODY
CLASS="refentry"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>PHP Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="function.ncurses-getch.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="function.ncurses-halfdelay.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="function.ncurses-getmouse"
></A
>ncurses_getmouse</H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN62234"
></A
><P
>    (PHP 4 &#62;= 4.2.0)</P
>ncurses_getmouse&nbsp;--&nbsp;Reads mouse event</DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN62237"
></A
><H2
>Description</H2
>bool <B
CLASS="methodname"
>ncurses_getmouse</B
> ( array mevent)<BR
></BR
><DIV
CLASS="warning"
><P
></P
><TABLE
CLASS="warning"
BORDER="1"
WIDTH="100%"
><TR
><TD
ALIGN="CENTER"
><B
>Warning</B
></TD
></TR
><TR
><TD
ALIGN="LEFT"
><P
>This function is
<SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>EXPERIMENTAL</I
></SPAN
>. The behaviour of this function, the
name of this function, and anything else documented about this
function may change without notice in a future release of PHP. 
Use this function at your own risk.</P
></TD
></TR
></TABLE
></DIV
><P
>&#13;     <B
CLASS="function"
>ncurses_getmouse()</B
> reads mouse event out of
     queue. Function <B
CLASS="function"
>ncurses_getmouse()</B
> will return
     ;<TT
CLASS="constant"
><B
>FALSE</B
></TT
> if a mouse event is actually visible in the given
     window, otherwise it will return <TT
CLASS="constant"
><B
>TRUE</B
></TT
>.
     Event options will be delivered in parameter
     <TT
CLASS="parameter"
><I
>mevent</I
></TT
>, which has to be an array, passed
     by reference (see example below).
     On success an associative array with following keys will be
     delivered:
     <P
></P
><UL
><LI
><P
>"id" : Id to distinguish multiple
       devices</P
></LI
><LI
><P
>"x" : screen relative x-position in character
       cells</P
></LI
><LI
><P
>"y" : screen relative y-position in character
       cells</P
></LI
><LI
><P
>"z" : currently not supported</P
></LI
><LI
><P
>"mmask" : Mouse action</P
></LI
></UL
>
    </P
><P
>&#13;    <TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN62266"
></A
><P
><B
>Example 1. <B
CLASS="function"
>ncurses_getmouse()</B
> example</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
CELLPADDING="5"
><TR
><TD
><PRE
CLASS="php"
>switch (ncurses_getch){
  case NCURSES_KEY_MOUSE:
    if (!ncurses_getmouse(&#38;$mevent)){
      if ($mevent["mmask"] &#38; NCURSES_MOUSE_BUTTON1_PRESSED){
        $mouse_x = $mevent["x"]; // Save mouse position
        $mouse_y = $mevent["y"];
      }
    }
  break;

  default:
    ....
}</PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
>    
    </P
><P
>&#13;     See also: <A
HREF="function.ncurses-ungetmouse.html"
><B
CLASS="function"
>ncurses_ungetmouse()</B
></A
>
    </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="function.ncurses-getch.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="function.ncurses-halfdelay.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>ncurses_getch</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="ref.ncurses.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>ncurses_halfdelay</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>