NCURSES_MOUSEMASK(3) 1 NCURSES_MOUSEMASK(3)
ncurses_mousemask - Sets mouse options
SYNOPSIS
int ncurses_mousemask (int $newmask, int &$oldmask)
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.
Sets mouse events to be reported. By default no mouse events will be reported.
Mouse events are represented by NCURSES_KEY_MOUSE in the ncurses_wgetch(3) input stream. To read the event data and pop the event of
queue, call ncurses_getmouse(3).
PARAMETERS
o $newmask
- Mouse mask options can be set with the following predefined constants:
oNCURSES_BUTTON1_PRESSED
oNCURSES_BUTTON1_RELEASED
oNCURSES_BUTTON1_CLICKED
oNCURSES_BUTTON1_DOUBLE_CLICKED
oNCURSES_BUTTON1_TRIPLE_CLICKED
oNCURSES_BUTTON2_PRESSED
oNCURSES_BUTTON2_RELEASED
oNCURSES_BUTTON2_CLICKED
oNCURSES_BUTTON2_DOUBLE_CLICKED
oNCURSES_BUTTON2_TRIPLE_CLICKED
oNCURSES_BUTTON3_PRESSED
oNCURSES_BUTTON3_RELEASED
oNCURSES_BUTTON3_CLICKED
oNCURSES_BUTTON3_DOUBLE_CLICKED
oNCURSES_BUTTON3_TRIPLE_CLICKED
oNCURSES_BUTTON4_PRESSED
oNCURSES_BUTTON4_RELEASED
oNCURSES_BUTTON4_CLICKED
oNCURSES_BUTTON4_DOUBLE_CLICKED
oNCURSES_BUTTON4_TRIPLE_CLICKED
oNCURSES_BUTTON_SHIFT>
oNCURSES_BUTTON_CTRL
oNCURSES_BUTTON_ALT
oNCURSES_ALL_MOUSE_EVENTS
oNCURSES_REPORT_MOUSE_POSITION
As a side effect, setting a zero mousemask in $newmask turns off the mouse pointer. Setting a non zero value turns mouse pointer
on.
o $oldmask
- This will be set to the previous value of the mouse event mask.
RETURN VALUES
Returns the mask of reportable events. On complete failure, it returns 0.
EXAMPLES
Example #1
ncurses_mousemask(3) 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
");
}
?>
SEE ALSO
ncurses_getch(3), ncurses_getmouse(3), ncurses_ungetmouse(3).
PHP Documentation Group NCURSES_MOUSEMASK(3)
