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

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

<HTML
><HEAD
><TITLE
>ncurses_mousemask</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_mouseinterval"
HREF="function.ncurses-mouseinterval.html"><LINK
REL="NEXT"
TITLE="ncurses_move"
HREF="function.ncurses-move.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-mouseinterval.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-move.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="function.ncurses-mousemask"
></A
>ncurses_mousemask</H1
><DIV
CLASS="refnamediv"
><A
NAME="AEN62652"
></A
><P
>    (PHP 4 &#62;= 4.2.0)</P
>ncurses_mousemask&nbsp;--&nbsp;Sets mouse options</DIV
><DIV
CLASS="refsect1"
><A
NAME="AEN62655"
></A
><H2
>Description</H2
>int <B
CLASS="methodname"
>ncurses_mousemask</B
> ( int newmask, int oldmask)<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;     Function <B
CLASS="function"
>ncurses_mousemask()</B
> will set mouse events
     to be reported. By default no mouse events will be reported. The
     function <B
CLASS="function"
>ncurses_mousemask()</B
> will return a
     mask to indicated which of the in parameter 
     <TT
CLASS="parameter"
><I
>newmask</I
></TT
>
     specified mouse events can be reported. On complete failure, it
     returns 0. In parameter <TT
CLASS="parameter"
><I
>oldmask</I
></TT
>, which is
     passed by reference <B
CLASS="function"
>ncurses_mousemask()</B
>
     returns the previous value of mouse event mask.

     Mouse events are represented bei NCURSES_KEY_MOUSE in the
     <B
CLASS="function"
>ncurses_wgetch()</B
> input stream. To read the
     event data and pop the event of of queue, call
     <A
HREF="function.ncurses-getmouse.html"
><B
CLASS="function"
>ncurses_getmouse()</B
></A
>.
    </P
><P
>&#13;     As a side effect, setting a zero mousemask in
     <TT
CLASS="parameter"
><I
>newmask</I
></TT
> turns off the mouse
     pointer. Setting a non zero value turns mouse pointer on.
    </P
><P
>&#13;     mouse mask options can be set with the following predefined
     constants:
     <P
></P
><UL
><LI
><P
>NCURSES_BUTTON1_PRESSED</P
></LI
><LI
><P
>NCURSES_BUTTON1_RELEASED</P
></LI
><LI
><P
>NCURSES_BUTTON1_CLICKED</P
></LI
><LI
><P
>NCURSES_BUTTON1_DOUBLE_CLICKED</P
></LI
><LI
><P
>NCURSES_BUTTON1_TRIPLE_CLICKED</P
></LI
><LI
><P
>NCURSES_BUTTON2_PRESSED</P
></LI
><LI
><P
>NCURSES_BUTTON2_RELEASED</P
></LI
><LI
><P
>NCURSES_BUTTON2_CLICKED</P
></LI
><LI
><P
>NCURSES_BUTTON2_DOUBLE_CLICKED</P
></LI
><LI
><P
>NCURSES_BUTTON2_TRIPLE_CLICKED</P
></LI
><LI
><P
>NCURSES_BUTTON3_PRESSED</P
></LI
><LI
><P
>NCURSES_BUTTON3_RELEASED</P
></LI
><LI
><P
>NCURSES_BUTTON3_CLICKED</P
></LI
><LI
><P
>NCURSES_BUTTON3_DOUBLE_CLICKED</P
></LI
><LI
><P
>NCURSES_BUTTON3_TRIPLE_CLICKED</P
></LI
><LI
><P
>NCURSES_BUTTON4_PRESSED</P
></LI
><LI
><P
>NCURSES_BUTTON4_RELEASED</P
></LI
><LI
><P
>NCURSES_BUTTON4_CLICKED</P
></LI
><LI
><P
>NCURSES_BUTTON4_DOUBLE_CLICKED</P
></LI
><LI
><P
>NCURSES_BUTTON4_TRIPLE_CLICKED</P
></LI
><LI
><P
>NCURSES_BUTTON_SHIFT&#62;</P
></LI
><LI
><P
>NCURSES_BUTTON_CTRL</P
></LI
><LI
><P
>NCURSES_BUTTON_ALT</P
></LI
><LI
><P
>NCURSES_ALL_MOUSE_EVENTS</P
></LI
><LI
><P
>NCURSES_REPORT_MOUSE_POSITION</P
></LI
></UL
>
    </P
><P
>&#13;     See also: <A
HREF="function.ncurses-getmouse.html"
><B
CLASS="function"
>ncurses_getmouse()</B
></A
>,
               <A
HREF="function.ncurses-ungetmouse.html"
><B
CLASS="function"
>ncurses_ungetmouse()</B
></A
>
               <B
CLASS="function"
>ncurese_getch()</B
>
    </P
><P
>&#13;     <TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
CLASS="EXAMPLE"
><TR
><TD
><DIV
CLASS="example"
><A
NAME="AEN62736"
></A
><P
><B
>Example 1. <B
CLASS="function"
>ncurses_mousemask()</B
> example</B
></P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
CELLPADDING="5"
><TR
><TD
><PRE
CLASS="php"
>$newmask = NCURSES_BUTTON1_CLICKED + NCURSES_BUTTON1_RELEASED;
$mask = ncurses_mousemask($newmask, &#38;$oldmask);
if ($mask &#38; $newmask){
  printf ("All specified mouse options will be supported\n");
}</PRE
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
>    
    </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-mouseinterval.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-move.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>ncurses_mouseinterval</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_move</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>