diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/commands.texi | 38 |
1 files changed, 20 insertions, 18 deletions
diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi index 541a97f8add..a351917b852 100644 --- a/doc/lispref/commands.texi +++ b/doc/lispref/commands.texi | |||
| @@ -1348,8 +1348,8 @@ button. @xref{Repeat Events}. | |||
| 1348 | @var{position} slot of a click event, you should typically use the | 1348 | @var{position} slot of a click event, you should typically use the |
| 1349 | functions documented in @ref{Accessing Mouse}. The explicit format of | 1349 | functions documented in @ref{Accessing Mouse}. The explicit format of |
| 1350 | the list depends on where the click occurred. For clicks in the text | 1350 | the list depends on where the click occurred. For clicks in the text |
| 1351 | area, mode line, header line, tab line, or in the fringe or marginal areas, the | 1351 | area, mode line, header line, tab line, or in the fringe or marginal |
| 1352 | mouse position list has the form | 1352 | areas, the mouse position list has the form |
| 1353 | 1353 | ||
| 1354 | @example | 1354 | @example |
| 1355 | (@var{window} @var{pos-or-area} (@var{x} . @var{y}) @var{timestamp} | 1355 | (@var{window} @var{pos-or-area} (@var{x} . @var{y}) @var{timestamp} |
| @@ -1368,8 +1368,9 @@ The window in which the click occurred. | |||
| 1368 | The buffer position of the character clicked on in the text area; or, | 1368 | The buffer position of the character clicked on in the text area; or, |
| 1369 | if the click was outside the text area, the window area where it | 1369 | if the click was outside the text area, the window area where it |
| 1370 | occurred. It is one of the symbols @code{mode-line}, | 1370 | occurred. It is one of the symbols @code{mode-line}, |
| 1371 | @code{header-line}, @code{tab-line}, @code{vertical-line}, @code{left-margin}, | 1371 | @code{header-line}, @code{tab-line}, @code{vertical-line}, |
| 1372 | @code{right-margin}, @code{left-fringe}, or @code{right-fringe}. | 1372 | @code{left-margin}, @code{right-margin}, @code{left-fringe}, or |
| 1373 | @code{right-fringe}. | ||
| 1373 | 1374 | ||
| 1374 | In one special case, @var{pos-or-area} is a list containing a symbol | 1375 | In one special case, @var{pos-or-area} is a list containing a symbol |
| 1375 | (one of the symbols listed above) instead of just the symbol. This | 1376 | (one of the symbols listed above) instead of just the symbol. This |
| @@ -1380,12 +1381,12 @@ by Emacs. @xref{Key Sequence Input}. | |||
| 1380 | The relative pixel coordinates of the click. For clicks in the text | 1381 | The relative pixel coordinates of the click. For clicks in the text |
| 1381 | area of a window, the coordinate origin @code{(0 . 0)} is taken to be | 1382 | area of a window, the coordinate origin @code{(0 . 0)} is taken to be |
| 1382 | the top left corner of the text area. @xref{Window Sizes}. For | 1383 | the top left corner of the text area. @xref{Window Sizes}. For |
| 1383 | clicks in a mode line, header line or tab line, the coordinate origin is the top | 1384 | clicks in a mode line, header line or tab line, the coordinate origin |
| 1384 | left corner of the window itself. For fringes, margins, and the | 1385 | is the top left corner of the window itself. For fringes, margins, |
| 1385 | vertical border, @var{x} does not have meaningful data. For fringes | 1386 | and the vertical border, @var{x} does not have meaningful data. |
| 1386 | and margins, @var{y} is relative to the bottom edge of the header | 1387 | For fringes and margins, @var{y} is relative to the bottom edge of the |
| 1387 | line. In all cases, the @var{x} and @var{y} coordinates increase | 1388 | header line. In all cases, the @var{x} and @var{y} coordinates |
| 1388 | rightward and downward respectively. | 1389 | increase rightward and downward respectively. |
| 1389 | 1390 | ||
| 1390 | @item @var{timestamp} | 1391 | @item @var{timestamp} |
| 1391 | The time at which the event occurred, as an integer number of | 1392 | The time at which the event occurred, as an integer number of |
| @@ -1407,18 +1408,18 @@ The position in the string where the click occurred. | |||
| 1407 | @item @var{text-pos} | 1408 | @item @var{text-pos} |
| 1408 | For clicks on a marginal area or on a fringe, this is the buffer | 1409 | For clicks on a marginal area or on a fringe, this is the buffer |
| 1409 | position of the first visible character in the corresponding line in | 1410 | position of the first visible character in the corresponding line in |
| 1410 | the window. For clicks on the mode line, the header line or the tab line, this is | 1411 | the window. For clicks on the mode line, the header line or the tab |
| 1411 | @code{nil}. For other events, it is the buffer position closest to | 1412 | line, this is @code{nil}. For other events, it is the buffer position |
| 1412 | the click. | 1413 | closest to the click. |
| 1413 | 1414 | ||
| 1414 | @item @var{col}, @var{row} | 1415 | @item @var{col}, @var{row} |
| 1415 | These are the actual column and row coordinate numbers of the glyph | 1416 | These are the actual column and row coordinate numbers of the glyph |
| 1416 | under the @var{x}, @var{y} position. If @var{x} lies beyond the last | 1417 | under the @var{x}, @var{y} position. If @var{x} lies beyond the last |
| 1417 | column of actual text on its line, @var{col} is reported by adding | 1418 | column of actual text on its line, @var{col} is reported by adding |
| 1418 | fictional extra columns that have the default character width. Row 0 | 1419 | fictional extra columns that have the default character width. |
| 1419 | is taken to be the header line if the window has one, or Row 1 | 1420 | Row 0 is taken to be the header line if the window has one, or Row 1 |
| 1420 | if the window also has the tab line, or the topmost | 1421 | if the window also has the tab line, or the topmost row of |
| 1421 | row of the text area otherwise. Column 0 is taken to be the leftmost | 1422 | the text area otherwise. Column 0 is taken to be the leftmost |
| 1422 | column of the text area for clicks on a window text area, or the | 1423 | column of the text area for clicks on a window text area, or the |
| 1423 | leftmost mode line or header line column for clicks there. For clicks | 1424 | leftmost mode line or header line column for clicks there. For clicks |
| 1424 | on fringes or vertical borders, these have no meaningful data. For | 1425 | on fringes or vertical borders, these have no meaningful data. For |
| @@ -2095,7 +2096,8 @@ computed values.) | |||
| 2095 | 2096 | ||
| 2096 | Note that @var{row} is counted from the top of the text area. If the | 2097 | Note that @var{row} is counted from the top of the text area. If the |
| 2097 | window given by @var{position} possesses a header line (@pxref{Header | 2098 | window given by @var{position} possesses a header line (@pxref{Header |
| 2098 | Lines}) or a tab line, they are @emph{not} included in the @var{row} count. | 2099 | Lines}) or a tab line, they are @emph{not} included in the @var{row} |
| 2100 | count. | ||
| 2099 | @end defun | 2101 | @end defun |
| 2100 | 2102 | ||
| 2101 | @defun posn-actual-col-row position | 2103 | @defun posn-actual-col-row position |