» google_pagerank()
  » preg_replace()
  » imagecreatefrompng()
  » site_pageranks()
  » imagepng()
  » imagedestroy()
  » imagestring()
  » imagecolorallocate()
  » htmlentities()
  » preg_match()
  » fopen()
  » header()
  » getimagesize()
  » preg_match_all()
  » session_start()
  » htmlspecialchars()
  » ob_start()
  » ob_flush()
  » strstr()
  » flush()
  » strpos()
  » setcookie()
  » str_replace()
  » array2vars()
  » nl2br()
  » preg_split()
  » ereg()
  » ereg_replace()
  » urlencode()
  » readgzfile()

Become a sponsor for $15/month. Link is sitewide - PR5 homepage, 20+ PR4 pages, 90+ PR3 pages. Email dave[AT]icemelon[D0T]c0m.

(PHP 4 >= 4.2.0, PHP 5)

ncurses_mousemask -- Sets mouse options

Description

int ncurses_mousemask ( int newmask, int &oldmask )

Warning

This function is EXPERIMENTAL . 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.

Function ncurses_mousemask() will set mouse events to be reported. By default no mouse events will be reported. The function ncurses_mousemask() will return a mask to indicated which of the in parameter newmask specified mouse events can be reported. On complete failure, it returns 0. In parameter oldmask , which is passed by reference ncurses_mousemask() returns the previous value of mouse event mask. Mouse events are represented by NCURSES_KEY_MOUSE in the ncurses_wgetch() input stream. To read the event data and pop the event of queue, call ncurses_getmouse() .

As a side effect, setting a zero mousemask in newmask turns off the mouse pointer. Setting a non zero value turns mouse pointer on.

mouse mask options can be set with the following predefined constants:

NCURSES_BUTTON1_PRESSED

NCURSES_BUTTON1_RELEASED

NCURSES_BUTTON1_CLICKED

NCURSES_BUTTON1_DOUBLE_CLICKED

NCURSES_BUTTON1_TRIPLE_CLICKED

NCURSES_BUTTON2_PRESSED

NCURSES_BUTTON2_RELEASED

NCURSES_BUTTON2_CLICKED

NCURSES_BUTTON2_DOUBLE_CLICKED

NCURSES_BUTTON2_TRIPLE_CLICKED

NCURSES_BUTTON3_PRESSED

NCURSES_BUTTON3_RELEASED

NCURSES_BUTTON3_CLICKED

NCURSES_BUTTON3_DOUBLE_CLICKED

NCURSES_BUTTON3_TRIPLE_CLICKED

NCURSES_BUTTON4_PRESSED

NCURSES_BUTTON4_RELEASED

NCURSES_BUTTON4_CLICKED

NCURSES_BUTTON4_DOUBLE_CLICKED

NCURSES_BUTTON4_TRIPLE_CLICKED

NCURSES_BUTTON_SHIFT>

NCURSES_BUTTON_CTRL

NCURSES_BUTTON_ALT

NCURSES_ALL_MOUSE_EVENTS

NCURSES_REPORT_MOUSE_POSITION

Example 1. ncurses_mousemask() example

<?php
$newmask = NCURSES_BUTTON1_CLICKED + NCURSES_BUTTON1_RELEASED;
$mask = ncurses_mousemask($newmask, &$oldmask);
if ($mask & $newmask){
  printf ("All specified mouse options will be supported\n");
}
?>

Related Function(s)

ncurses_wgetch()

ncurses_getmouse()

ncurses_ungetmouse()