]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - doc/html/man/curs_mouse.3x.html
projects / ncurses.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
ncurses 6.4 - patch 20230805
[ncurses.git] / doc / html / man / curs_mouse.3x.html
diff --git a/doc/html/man/curs_mouse.3x.html b/doc/html/man/curs_mouse.3x.html
index 1d2a45de3f13430f648d234a1150a7c628fbb40f..cf5ce974c7f58d267a84aa285ace82d1a5a03a81 100644 (file)
--- a/doc/html/man/curs_mouse.3x.html
+++ b/doc/html/man/curs_mouse.3x.html
@@ -1,7 +1,8 @@
-<!-- 
+<!--
   * t
   ****************************************************************************
   * t
   ****************************************************************************
-  * Copyright (c) 1998-2018,2019 Free Software Foundation, Inc.              *
+  * Copyright 2018-2022,2023 Thomas E. Dickey                                *
+  * Copyright 1998-2015,2017 Free Software Foundation, Inc.                  *
   *                                                                          *
   * Permission is hereby granted, free of charge, to any person obtaining a  *
   * copy of this software and associated documentation files (the            *
   *                                                                          *
   * Permission is hereby granted, free of charge, to any person obtaining a  *
   * copy of this software and associated documentation files (the            *
@@ -27,21 +28,21 @@
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: curs_mouse.3x,v 1.51 2019/07/13 23:45:12 tom Exp @
+  * @Id: curs_mouse.3x,v 1.64 2023/07/01 15:43:20 tom Exp @
 -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
 <HEAD>
 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
 -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
 <HEAD>
 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>curs_mouse 3x</TITLE>
+<TITLE>curs_mouse 3x 2023-07-01 ncurses 6.4 Library calls</TITLE>
 <link rel="author" href="mailto:bug-ncurses@gnu.org">
 <link rel="author" href="mailto:bug-ncurses@gnu.org">
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+
 </HEAD>
 <BODY>
 </HEAD>
 <BODY>
-<H1 class="no-header">curs_mouse 3x</H1>
+<H1 class="no-header">curs_mouse 3x 2023-07-01 ncurses 6.4 Library calls</H1>
 <PRE>
 <PRE>
-<STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>                                                  <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>
+<STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>                   Library calls                  <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>
 
 
 
 
 
 
@@ -63,13 +64,18 @@
        <STRONG>}</STRONG> <STRONG>MEVENT;</STRONG>
 
        <STRONG>bool</STRONG> <STRONG>has_mouse(void);</STRONG>
        <STRONG>}</STRONG> <STRONG>MEVENT;</STRONG>
 
        <STRONG>bool</STRONG> <STRONG>has_mouse(void);</STRONG>
+
        <STRONG>int</STRONG> <STRONG>getmouse(MEVENT</STRONG> <STRONG>*</STRONG><EM>event</EM><STRONG>);</STRONG>
        <STRONG>int</STRONG> <STRONG>ungetmouse(MEVENT</STRONG> <STRONG>*</STRONG><EM>event</EM><STRONG>);</STRONG>
        <STRONG>int</STRONG> <STRONG>getmouse(MEVENT</STRONG> <STRONG>*</STRONG><EM>event</EM><STRONG>);</STRONG>
        <STRONG>int</STRONG> <STRONG>ungetmouse(MEVENT</STRONG> <STRONG>*</STRONG><EM>event</EM><STRONG>);</STRONG>
+
        <STRONG>mmask_t</STRONG> <STRONG>mousemask(mmask_t</STRONG> <EM>newmask</EM><STRONG>,</STRONG> <STRONG>mmask_t</STRONG> <STRONG>*</STRONG><EM>oldmask</EM><STRONG>);</STRONG>
        <STRONG>mmask_t</STRONG> <STRONG>mousemask(mmask_t</STRONG> <EM>newmask</EM><STRONG>,</STRONG> <STRONG>mmask_t</STRONG> <STRONG>*</STRONG><EM>oldmask</EM><STRONG>);</STRONG>
+
        <STRONG>bool</STRONG> <STRONG>wenclose(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>);</STRONG>
        <STRONG>bool</STRONG> <STRONG>wenclose(const</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>);</STRONG>
+
        <STRONG>bool</STRONG> <STRONG>mouse_trafo(int*</STRONG> <EM>pY</EM><STRONG>,</STRONG> <STRONG>int*</STRONG> <EM>pX</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>to</EM><STRONG>_</STRONG><EM>screen</EM><STRONG>);</STRONG>
        <STRONG>bool</STRONG> <STRONG>mouse_trafo(int*</STRONG> <EM>pY</EM><STRONG>,</STRONG> <STRONG>int*</STRONG> <EM>pX</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>to</EM><STRONG>_</STRONG><EM>screen</EM><STRONG>);</STRONG>
-       <STRONG>bool</STRONG> <STRONG>wmouse_trafo(const</STRONG> <STRONG>WINDOW*</STRONG> <EM>win</EM><STRONG>,</STRONG> <STRONG>int*</STRONG> <EM>pY</EM><STRONG>,</STRONG> <STRONG>int*</STRONG> <EM>pX</EM><STRONG>,</STRONG>
-            <STRONG>bool</STRONG> <EM>to</EM><STRONG>_</STRONG><EM>screen</EM><STRONG>);</STRONG>
+       <STRONG>bool</STRONG> <STRONG>wmouse_trafo(const</STRONG> <STRONG>WINDOW*</STRONG> <EM>win</EM><STRONG>,</STRONG>
+                         <STRONG>int*</STRONG> <EM>pY</EM><STRONG>,</STRONG> <STRONG>int*</STRONG> <EM>pX</EM><STRONG>,</STRONG> <STRONG>bool</STRONG> <EM>to</EM><STRONG>_</STRONG><EM>screen</EM><STRONG>);</STRONG>
+
        <STRONG>int</STRONG> <STRONG>mouseinterval(int</STRONG> <EM>erval</EM><STRONG>);</STRONG>
 
 
        <STRONG>int</STRONG> <STRONG>mouseinterval(int</STRONG> <EM>erval</EM><STRONG>);</STRONG>
 
 
@@ -80,12 +86,18 @@
 
 
 </PRE><H3><a name="h3-mousemask">mousemask</a></H3><PRE>
 
 
 </PRE><H3><a name="h3-mousemask">mousemask</a></H3><PRE>
-       To make mouse events visible, use the <STRONG>mousemask</STRONG>  function.   This  will
-       set  the  mouse events to be reported.  By default, no mouse events are
-       reported.  The function will return a mask to  indicate  which  of  the
-       specified  mouse events can be reported; on complete failure it returns
-       0.  If oldmask is non-NULL, this function fills the indicated  location
-       with the previous value of the given window's mouse event mask.
+       To make mouse events visible, use the <STRONG>mousemask</STRONG>  function.   This  sets
+       the  mouse  events to be reported.  By default, no mouse events are re-
+       ported.
+
+       <STRONG>o</STRONG>   The function returns an updated copy of <EM>newmask</EM> to  indicate  which
+           of the specified mouse events can be reported.
+
+           If the screen has not been initialized, or if the terminal does not
+           support mouse-events, this function returns 0.
+
+       <STRONG>o</STRONG>   If <EM>oldmask</EM> is non-NULL, this function fills the indicated  location
+           with the previous value of the current screen's mouse event mask.
 
        As  a  side  effect,  setting  a  zero mousemask may turn off the mouse
        pointer; setting a nonzero mask may turn it on.  Whether  this  happens
 
        As  a  side  effect,  setting  a  zero mousemask may turn off the mouse
        pointer; setting a nonzero mask may turn it on.  Whether  this  happens
@@ -95,11 +107,12 @@
 </PRE><H3><a name="h3-Mouse-events">Mouse events</a></H3><PRE>
        Here are the mouse event type masks which may be defined:
 
 </PRE><H3><a name="h3-Mouse-events">Mouse events</a></H3><PRE>
        Here are the mouse event type masks which may be defined:
 
-       <EM>Name</EM>                     <EM>Description</EM>
+       <STRONG>Name</STRONG>                     <STRONG>Description</STRONG>
        ---------------------------------------------------------------------
        BUTTON1_PRESSED          mouse button 1 down
        BUTTON1_RELEASED         mouse button 1 up
        BUTTON1_CLICKED          mouse button 1 clicked
        ---------------------------------------------------------------------
        BUTTON1_PRESSED          mouse button 1 down
        BUTTON1_RELEASED         mouse button 1 up
        BUTTON1_CLICKED          mouse button 1 clicked
+
        BUTTON1_DOUBLE_CLICKED   mouse button 1 double clicked
        BUTTON1_TRIPLE_CLICKED   mouse button 1 triple clicked
        ---------------------------------------------------------------------
        BUTTON1_DOUBLE_CLICKED   mouse button 1 double clicked
        BUTTON1_TRIPLE_CLICKED   mouse button 1 triple clicked
        ---------------------------------------------------------------------
@@ -111,7 +124,6 @@
        ---------------------------------------------------------------------
        BUTTON3_PRESSED          mouse button 3 down
        BUTTON3_RELEASED         mouse button 3 up
        ---------------------------------------------------------------------
        BUTTON3_PRESSED          mouse button 3 down
        BUTTON3_RELEASED         mouse button 3 up
-
        BUTTON3_CLICKED          mouse button 3 clicked
        BUTTON3_DOUBLE_CLICKED   mouse button 3 double clicked
        BUTTON3_TRIPLE_CLICKED   mouse button 3 triple clicked
        BUTTON3_CLICKED          mouse button 3 clicked
        BUTTON3_DOUBLE_CLICKED   mouse button 3 double clicked
        BUTTON3_TRIPLE_CLICKED   mouse button 3 triple clicked
@@ -171,8 +183,8 @@
        reserve lines on top or bottom of the screen for  other  purposes  (see
        the <STRONG>ripoffline</STRONG> and <STRONG><A HREF="curs_slk.3x.html">slk_init(3x)</A></STRONG> calls, for example).
 
        reserve lines on top or bottom of the screen for  other  purposes  (see
        the <STRONG>ripoffline</STRONG> and <STRONG><A HREF="curs_slk.3x.html">slk_init(3x)</A></STRONG> calls, for example).
 
-       <STRONG>o</STRONG>   If the parameter <STRONG>to_screen</STRONG> is <STRONG>TRUE</STRONG>, the pointers <STRONG>pY,</STRONG> <STRONG>pX</STRONG> must refer-
-           ence the coordinates of a location inside the window <STRONG>win</STRONG>.  They are
+       <STRONG>o</STRONG>   If the parameter <EM>to</EM><STRONG>_</STRONG><EM>screen</EM> is <STRONG>TRUE</STRONG>, the pointers <EM>pY,</EM> <EM>pX</EM> must refer-
+           ence the coordinates of a location inside the window <EM>win</EM>.  They are
            converted  to  window-relative coordinates and returned through the
            pointers.  If the conversion was successful, the  function  returns
            <STRONG>TRUE</STRONG>.
            converted  to  window-relative coordinates and returned through the
            pointers.  If the conversion was successful, the  function  returns
            <STRONG>TRUE</STRONG>.
@@ -180,9 +192,9 @@
        <STRONG>o</STRONG>   If one of the parameters was NULL or the location is not inside the
            window, <STRONG>FALSE</STRONG> is returned.
 
        <STRONG>o</STRONG>   If one of the parameters was NULL or the location is not inside the
            window, <STRONG>FALSE</STRONG> is returned.
 
-       <STRONG>o</STRONG>   If <STRONG>to_screen</STRONG> is <STRONG>FALSE</STRONG>, the pointers <STRONG>pY,</STRONG> <STRONG>pX</STRONG> must  reference  window-
+       <STRONG>o</STRONG>   If <EM>to</EM><STRONG>_</STRONG><EM>screen</EM> is <STRONG>FALSE</STRONG>, the pointers <EM>pY,</EM> <EM>pX</EM> must  reference  window-
            relative  coordinates.  They are converted to stdscr-relative coor-
            relative  coordinates.  They are converted to stdscr-relative coor-
-           dinates if the window <STRONG>win</STRONG> encloses this point.  In  this  case  the
+           dinates if the window <EM>win</EM> encloses this point.  In  this  case  the
            function returns <STRONG>TRUE</STRONG>.
 
        <STRONG>o</STRONG>   If  one  of  the  parameters is NULL or the point is not inside the
            function returns <STRONG>TRUE</STRONG>.
 
        <STRONG>o</STRONG>   If  one  of  the  parameters is NULL or the point is not inside the
@@ -193,7 +205,7 @@
 
 </PRE><H3><a name="h3-mouse_trafo">mouse_trafo</a></H3><PRE>
        The <STRONG>mouse_trafo</STRONG> function performs the same translation as <STRONG>wmouse_trafo</STRONG>,
 
 </PRE><H3><a name="h3-mouse_trafo">mouse_trafo</a></H3><PRE>
        The <STRONG>mouse_trafo</STRONG> function performs the same translation as <STRONG>wmouse_trafo</STRONG>,
-       using stdscr for <STRONG>win</STRONG>.
+       using stdscr for <EM>win</EM>.
 
 
 </PRE><H3><a name="h3-mouseinterval">mouseinterval</a></H3><PRE>
 
 
 </PRE><H3><a name="h3-mouseinterval">mouseinterval</a></H3><PRE>
@@ -225,6 +237,9 @@
           <STRONG>o</STRONG>   If  no mouse driver was initialized, or if the mask parameter is
               zero,
 
           <STRONG>o</STRONG>   If  no mouse driver was initialized, or if the mask parameter is
               zero,
 
+          <STRONG>o</STRONG>   It returns an error if a mouse event was detected which did  not
+              match the current <EM>mousemask</EM>.
+
           <STRONG>o</STRONG>   It also returns an error if no more events remain in the queue.
 
           <STRONG>ungetmouse</STRONG>
           <STRONG>o</STRONG>   It also returns an error if no more events remain in the queue.
 
           <STRONG>ungetmouse</STRONG>
@@ -232,8 +247,8 @@
 
        <STRONG>mousemask</STRONG> returns the mask of reportable events.
 
 
        <STRONG>mousemask</STRONG> returns the mask of reportable events.
 
-       <STRONG>mouseinterval</STRONG> returns the previous interval value, unless the  terminal
-       was  not  initialized.   In  that case, it returns the maximum interval
+       <STRONG>mouseinterval</STRONG>  returns the previous interval value, unless the terminal
+       was not initialized.  In that case, it  returns  the  maximum  interval
        value (166).
 
        <STRONG>wenclose</STRONG> and <STRONG>wmouse_trafo</STRONG> are boolean functions returning <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>
        value (166).
 
        <STRONG>wenclose</STRONG> and <STRONG>wmouse_trafo</STRONG> are boolean functions returning <STRONG>TRUE</STRONG> or <STRONG>FALSE</STRONG>
@@ -241,13 +256,13 @@
 
 
 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 
 
 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
-       These  calls  were  designed for <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, and are not found in SVr4
+       These calls were designed for <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, and are not  found  in  SVr4
        curses, 4.4BSD curses, or any other previous version of curses.
 
        curses, 4.4BSD curses, or any other previous version of curses.
 
-       SVr4 curses had support for the mouse in a variant  of  <STRONG>xterm</STRONG>.   It  is
+       SVr4  curses had support for the mouse in a variant of <STRONG>xterm(1)</STRONG>.  It is
        mentioned in a few places, but with no supporting documentation:
 
        mentioned in a few places, but with no supporting documentation:
 
-       <STRONG>o</STRONG>   the  "libcurses" manual page lists functions for this feature which
+       <STRONG>o</STRONG>   the "libcurses" manual page lists functions for this feature  which
            are prototyped in <STRONG>curses.h</STRONG>:
 
                extern int mouse_set(long int);
            are prototyped in <STRONG>curses.h</STRONG>:
 
                extern int mouse_set(long int);
@@ -266,40 +281,40 @@
                mouse_info        minfo   Mi       Mouse status information
                req_mouse_pos     reqmp   RQ       Request mouse position report
 
                mouse_info        minfo   Mi       Mouse status information
                req_mouse_pos     reqmp   RQ       Request mouse position report
 
-       <STRONG>o</STRONG>   the interface made assumptions (as does ncurses) about  the  escape
+       <STRONG>o</STRONG>   the  interface  made assumptions (as does ncurses) about the escape
            sequences sent to and received from the terminal.
 
            sequences sent to and received from the terminal.
 
-           For  instance the SVr4 curses library used the <STRONG>get_mouse</STRONG> capability
-           to tell the terminal which mouse  button  events  it  should  send,
-           passing  the mouse-button bit-mask to the terminal.  Also, it could
-           ask the terminal where the mouse was using the <STRONG>req_mouse_pos</STRONG>  capa-
+           For instance the SVr4 curses library used the <STRONG>get_mouse</STRONG>  capability
+           to  tell  the  terminal  which  mouse button events it should send,
+           passing the mouse-button bit-mask to the terminal.  Also, it  could
+           ask  the terminal where the mouse was using the <STRONG>req_mouse_pos</STRONG> capa-
            bility.
 
            bility.
 
-           Those  features required a terminal which had been modified to work
+           Those features required a terminal which had been modified to  work
            with curses.  They were not part of the X Consortium's xterm.
 
            with curses.  They were not part of the X Consortium's xterm.
 
-       When developing the xterm mouse support for ncurses in September  1995,
-       Eric  Raymond  was  uninterested in using the same interface due to its
+       When  developing the xterm mouse support for ncurses in September 1995,
+       Eric Raymond was uninterested in using the same interface  due  to  its
        lack of documentation.  Later, in 1998, Mark Hesseling provided support
        lack of documentation.  Later, in 1998, Mark Hesseling provided support
-       in  PDCurses 2.3 using the SVr4 interface.  PDCurses, however, does not
-       use video terminals, making it unnecessary to be concerned  about  com-
+       in PDCurses 2.3 using the SVr4 interface.  PDCurses, however, does  not
+       use  video  terminals, making it unnecessary to be concerned about com-
        patibility with the escape sequences.
 
        The feature macro <STRONG>NCURSES_MOUSE_VERSION</STRONG> is provided so the preprocessor
        patibility with the escape sequences.
 
        The feature macro <STRONG>NCURSES_MOUSE_VERSION</STRONG> is provided so the preprocessor
-       can be used to test whether these features are present.  If the  inter-
-       face  is changed, the value of <STRONG>NCURSES_MOUSE_VERSION</STRONG> will be increment-
-       ed.  These values for <STRONG>NCURSES_MOUSE_VERSION</STRONG> may be specified when  con-
+       can  be used to test whether these features are present.  If the inter-
+       face is changed, the value of <STRONG>NCURSES_MOUSE_VERSION</STRONG> will be  increment-
+       ed.   These values for <STRONG>NCURSES_MOUSE_VERSION</STRONG> may be specified when con-
        figuring ncurses:
 
           1  has definitions for reserved events.  The mask uses 28 bits.
 
        figuring ncurses:
 
           1  has definitions for reserved events.  The mask uses 28 bits.
 
-          2  adds  definitions  for  button 5, removes the definitions for re-
+          2  adds definitions for button 5, removes the  definitions  for  re-
              served events.  The mask uses 29 bits.
 
        The order of the <STRONG>MEVENT</STRONG> structure members is not guaranteed.  Addition-
        al fields may be added to the structure in the future.
 
              served events.  The mask uses 29 bits.
 
        The order of the <STRONG>MEVENT</STRONG> structure members is not guaranteed.  Addition-
        al fields may be added to the structure in the future.
 
-       Under  <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>,  these  calls  are implemented using either xterm's
+       Under <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, these calls are  implemented  using  either  xterm's
        built-in mouse-tracking API or platform-specific drivers including
 
           <STRONG>o</STRONG>   Alessandro Rubini's gpm server
        built-in mouse-tracking API or platform-specific drivers including
 
           <STRONG>o</STRONG>   Alessandro Rubini's gpm server
@@ -309,12 +324,12 @@
           <STRONG>o</STRONG>   OS/2 EMX
 
        If you are using an unsupported configuration, mouse events will not be
           <STRONG>o</STRONG>   OS/2 EMX
 
        If you are using an unsupported configuration, mouse events will not be
-       visible  to  <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> (and the <STRONG>mousemask</STRONG> function will always return
+       visible to <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> (and the <STRONG>mousemask</STRONG> function will  always  return
        <STRONG>0</STRONG>).
 
        <STRONG>0</STRONG>).
 
-       If the terminfo entry contains a <STRONG>XM</STRONG> string, this is used in  the  xterm
-       mouse  driver  to control the way the terminal is initialized for mouse
-       operation.  The default, if <STRONG>XM</STRONG> is not  found,  corresponds  to  private
+       If  the  terminfo entry contains a <STRONG>XM</STRONG> string, this is used in the xterm
+       mouse driver to control the way the terminal is initialized  for  mouse
+       operation.   The  default,  if  <STRONG>XM</STRONG> is not found, corresponds to private
        mode 1000 of xterm:
 
           \E[?1000%?%p1%{1}%=%th%el%;
        mode 1000 of xterm:
 
           \E[?1000%?%p1%{1}%=%th%el%;
@@ -323,43 +338,44 @@
 
           \E[?1006;1000%?%p1%{1}%=%th%el%;
 
 
           \E[?1006;1000%?%p1%{1}%=%th%el%;
 
-       The  <EM>z</EM>  member in the event structure is not presently used.  It is in-
-       tended for use with touch screens (which may be pressure-sensitive)  or
+       The <EM>z</EM> member in the event structure is not presently used.  It  is  in-
+       tended  for use with touch screens (which may be pressure-sensitive) or
        with 3D-mice/trackballs/power gloves.
 
        with 3D-mice/trackballs/power gloves.
 
-       The  <STRONG>ALL_MOUSE_EVENTS</STRONG>  class  does  not  include <STRONG>REPORT_MOUSE_POSITION</STRONG>.
-       They are distinct.  For example, in xterm,  wheel/scrolling  mice  send
-       position  reports  as  a  sequence of presses of buttons 4 or 5 without
+       The <STRONG>ALL_MOUSE_EVENTS</STRONG>  class  does  not  include  <STRONG>REPORT_MOUSE_POSITION</STRONG>.
+       They  are  distinct.   For example, in xterm, wheel/scrolling mice send
+       position reports as a sequence of presses of buttons  4  or  5  without
        matching button-releases.
 
 
 </PRE><H2><a name="h2-BUGS">BUGS</a></H2><PRE>
        matching button-releases.
 
 
 </PRE><H2><a name="h2-BUGS">BUGS</a></H2><PRE>
-       Mouse events under xterm will not in  fact  be  ignored  during  cooked
+       Mouse  events  under  xterm  will  not in fact be ignored during cooked
        mode, if they have been enabled by <STRONG>mousemask</STRONG>.  Instead, the xterm mouse
        report sequence will appear in the string read.
 
        mode, if they have been enabled by <STRONG>mousemask</STRONG>.  Instead, the xterm mouse
        report sequence will appear in the string read.
 
-       Mouse events under xterm will not be detected  correctly  in  a  window
-       with  its  keypad  bit  off, since they are interpreted as a variety of
-       function key.  Your terminfo  description  should  have  <STRONG>kmous</STRONG>  set  to
-       "\E[M"  (the  beginning  of  the response from xterm for mouse clicks).
-       Other values for <STRONG>kmous</STRONG> are permitted, but under  the  same  assumption,
+       Mouse  events  under  xterm  will not be detected correctly in a window
+       with its keypad bit off, since they are interpreted  as  a  variety  of
+       function  key.   Your  terminfo  description  should  have <STRONG>kmous</STRONG> set to
+       "\E[M" (the beginning of the response from  xterm  for  mouse  clicks).
+       Other  values  for  <STRONG>kmous</STRONG> are permitted, but under the same assumption,
        i.e., it is the beginning of the response.
 
        i.e., it is the beginning of the response.
 
-       Because  there  are  no standard terminal responses that would serve to
-       identify terminals which support the xterm mouse protocol, <STRONG>ncurses</STRONG>  as-
-       sumes  that  if <STRONG>kmous</STRONG> is defined in the terminal description, or if the
-       terminal description's primary  name  or  aliases  contain  the  string
+       Because there are no standard terminal responses that  would  serve  to
+       identify  terminals which support the xterm mouse protocol, <STRONG>ncurses</STRONG> as-
+       sumes that if <STRONG>kmous</STRONG> is defined in the terminal description, or  if  the
+       terminal  description's  primary  name  or  aliases  contain the string
        "xterm", then the terminal may send mouse events.  The <STRONG>kmous</STRONG> capability
        "xterm", then the terminal may send mouse events.  The <STRONG>kmous</STRONG> capability
-       is checked first, allowing the use of newer xterm mouse protocols  such
+       is  checked first, allowing the use of newer xterm mouse protocols such
        as xterm's private mode 1006.
 
 
 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
        as xterm's private mode 1006.
 
 
 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
-       <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>, <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>.
+       <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>, <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>, <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>,  <STRONG>curs_vari-</STRONG>
+       <STRONG><A HREF="curs_variables.3x.html">ables(3x)</A></STRONG>.
 
 
 
 
 
 
-                                                                <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>
+ncurses 6.4                       2023-07-01                    <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>
 </PRE>
 <div class="nav">
 <ul>
 </PRE>
 <div class="nav">
 <ul>
ncurses, with patches starting at ncurses-5.6; new users should use https://github.com/ThomasDickey/ncurses-snapshots/