ncurses_mouseinterval
ncurses_move_panel
Ncurses Funktionen
PHP Manual

# ncurses_mousemask

(PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)

ncurses_mousemask — Sets mouse options

### Beschreibung

int ncurses_mousemask ( int `$newmask` , int `&$oldmask` )
Warnung

Diese Funktion ist EXPERIMENTELL. Das Verhalten, der Funktionsname und alles Andere, was hier dokumentiert ist, kann sich in zukünftigen PHP-Versionen ohne Ankündigung ändern. Seien Sie gewarnt und verwenden Sie diese Funktion auf eigenes Risiko.

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() input stream. To read the event data and pop the event of queue, call ncurses_getmouse().

### Parameter-Liste

`newmask`

  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

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

`oldmask`

  This will be set to the previous value of the mouse event mask.

### Rückgabewerte

Returns a mask to indicated which of the in parameter `newmask` specified mouse events can be reported. On complete failure, it returns 0.

### Beispiele

Beispiel #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");
}
?>`

### Siehe auch

- ncurses_getch() - Read a character from keyboard
- ncurses_getmouse() - Reads mouse event
- ncurses_ungetmouse() - Pushes mouse event to queue

ncurses_mouseinterval
ncurses_move_panel
Ncurses Funktionen
PHP Manual