php man page for ncurses_getmouse

NCURSES_GETMOUSE(3)							 1						       NCURSES_GETMOUSE(3)

ncurses_getmouse - Reads mouse event

SYNOPSIS
       bool ncurses_getmouse (array  &$mevent)

DESCRIPTION
       Warning

	      This  function is EXPERIMENTAL. The behaviour of this function, its name, and surrounding documentation may change without notice in
	      a future release of PHP. This function should be used at your own risk.

       ncurses_getmouse(3) reads mouse event out of queue.

PARAMETERS
	      o $mevent
		- Event options will be delivered in this parameter which has to be an array, passed by reference (see example below).	On success
		an associative array with following keys will be delivered:

		     o "id" : Id to distinguish multiple devices

		     o "x" : screen relative x-position in character cells

		     o "y" : screen relative y-position in character cells

		     o "z" : currently not supported

		     o "mmask" : Mouse action

RETURN VALUES
	Returns FALSE if a mouse event is actually visible in the given window, otherwise returns TRUE.

EXAMPLES
       Example #1

	      ncurses_getmouse(3) example

	      <?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:
		  /* .... */
	      }
	      ?>

SEE ALSO
       ncurses_ungetmouse(3).

PHP Documentation Group 												       NCURSES_GETMOUSE(3)