diff options
| author | Juri Linkov | 2019-10-01 23:15:03 +0300 |
|---|---|---|
| committer | Juri Linkov | 2019-10-01 23:15:03 +0300 |
| commit | 2698d3dba2e9858b026ed127d4de3f86810a5ef3 (patch) | |
| tree | 8e9b8f194cfcad8af83a4174a0105bbc691f06d6 /doc/lispref | |
| parent | 25f45d710e91a7c1049f056ff27bc3e6968f5624 (diff) | |
| parent | 3f981a0a89bca47a207fb362485f07e7322bb145 (diff) | |
| download | emacs-2698d3dba2e9858b026ed127d4de3f86810a5ef3.tar.gz emacs-2698d3dba2e9858b026ed127d4de3f86810a5ef3.zip | |
Merge branch 'feature/tabs'
Diffstat (limited to 'doc/lispref')
| -rw-r--r-- | doc/lispref/commands.texi | 43 | ||||
| -rw-r--r-- | doc/lispref/display.texi | 1 | ||||
| -rw-r--r-- | doc/lispref/windows.texi | 12 |
3 files changed, 37 insertions, 19 deletions
diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi index 1fd56d02841..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, 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{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 or header 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,17 +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 or the header 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 the topmost | 1420 | Row 0 is taken to be the header line if the window has one, or Row 1 |
| 1420 | row of the text area otherwise. Column 0 is taken to be the leftmost | 1421 | if the window also has the tab line, or the topmost row of |
| 1422 | the text area otherwise. Column 0 is taken to be the leftmost | ||
| 1421 | 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 |
| 1422 | 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 |
| 1423 | on fringes or vertical borders, these have no meaningful data. For | 1425 | on fringes or vertical borders, these have no meaningful data. For |
| @@ -2094,7 +2096,8 @@ computed values.) | |||
| 2094 | 2096 | ||
| 2095 | 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 |
| 2096 | window given by @var{position} possesses a header line (@pxref{Header | 2098 | window given by @var{position} possesses a header line (@pxref{Header |
| 2097 | Lines}), it is @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. | ||
| 2098 | @end defun | 2101 | @end defun |
| 2099 | 2102 | ||
| 2100 | @defun posn-actual-col-row position | 2103 | @defun posn-actual-col-row position |
| @@ -2452,12 +2455,14 @@ button-down events entirely. It also reshuffles focus events and | |||
| 2452 | miscellaneous window events so that they never appear in a key sequence | 2455 | miscellaneous window events so that they never appear in a key sequence |
| 2453 | with any other events. | 2456 | with any other events. |
| 2454 | 2457 | ||
| 2458 | @cindex @code{tab-line} prefix key | ||
| 2455 | @cindex @code{header-line} prefix key | 2459 | @cindex @code{header-line} prefix key |
| 2456 | @cindex @code{mode-line} prefix key | 2460 | @cindex @code{mode-line} prefix key |
| 2457 | @cindex @code{vertical-line} prefix key | 2461 | @cindex @code{vertical-line} prefix key |
| 2458 | @cindex @code{horizontal-scroll-bar} prefix key | 2462 | @cindex @code{horizontal-scroll-bar} prefix key |
| 2459 | @cindex @code{vertical-scroll-bar} prefix key | 2463 | @cindex @code{vertical-scroll-bar} prefix key |
| 2460 | @cindex @code{menu-bar} prefix key | 2464 | @cindex @code{menu-bar} prefix key |
| 2465 | @cindex @code{tab-bar} prefix key | ||
| 2461 | @cindex mouse events, in special parts of frame | 2466 | @cindex mouse events, in special parts of frame |
| 2462 | When mouse events occur in special parts of a window, such as a mode | 2467 | When mouse events occur in special parts of a window, such as a mode |
| 2463 | line or a scroll bar, the event type shows nothing special---it is the | 2468 | line or a scroll bar, the event type shows nothing special---it is the |
| @@ -2465,8 +2470,8 @@ same symbol that would normally represent that combination of mouse | |||
| 2465 | button and modifier keys. The information about the window part is kept | 2470 | button and modifier keys. The information about the window part is kept |
| 2466 | elsewhere in the event---in the coordinates. But | 2471 | elsewhere in the event---in the coordinates. But |
| 2467 | @code{read-key-sequence} translates this information into imaginary | 2472 | @code{read-key-sequence} translates this information into imaginary |
| 2468 | prefix keys, all of which are symbols: @code{header-line}, | 2473 | prefix keys, all of which are symbols: @code{tab-line}, @code{header-line}, |
| 2469 | @code{horizontal-scroll-bar}, @code{menu-bar}, @code{mode-line}, | 2474 | @code{horizontal-scroll-bar}, @code{menu-bar}, @code{tab-bar}, @code{mode-line}, |
| 2470 | @code{vertical-line}, and @code{vertical-scroll-bar}. You can define | 2475 | @code{vertical-line}, and @code{vertical-scroll-bar}. You can define |
| 2471 | meanings for mouse clicks in special window parts by defining key | 2476 | meanings for mouse clicks in special window parts by defining key |
| 2472 | sequences using these imaginary prefix keys. | 2477 | sequences using these imaginary prefix keys. |
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index 64b24f712ae..494bf0d3f7e 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -2944,6 +2944,7 @@ If the text lies within the mode line of the selected window, Emacs | |||
| 2944 | applies the @code{mode-line} face. For the mode line of a | 2944 | applies the @code{mode-line} face. For the mode line of a |
| 2945 | non-selected window, Emacs applies the @code{mode-line-inactive} face. | 2945 | non-selected window, Emacs applies the @code{mode-line-inactive} face. |
| 2946 | For a header line, Emacs applies the @code{header-line} face. | 2946 | For a header line, Emacs applies the @code{header-line} face. |
| 2947 | For a tab line, Emacs applies the @code{tab-line} face. | ||
| 2947 | 2948 | ||
| 2948 | @item | 2949 | @item |
| 2949 | If the text comes from an overlay string via @code{before-string} or | 2950 | If the text comes from an overlay string via @code{before-string} or |
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index 39d3960c9a2..f05a6db1761 100644 --- a/doc/lispref/windows.texi +++ b/doc/lispref/windows.texi | |||
| @@ -5558,6 +5558,9 @@ The coordinates are in the mode line of @var{window}. | |||
| 5558 | @item header-line | 5558 | @item header-line |
| 5559 | The coordinates are in the header line of @var{window}. | 5559 | The coordinates are in the header line of @var{window}. |
| 5560 | 5560 | ||
| 5561 | @item tab-line | ||
| 5562 | The coordinates are in the tab line of @var{window}. | ||
| 5563 | |||
| 5561 | @item right-divider | 5564 | @item right-divider |
| 5562 | The coordinates are in the divider separating @var{window} from a | 5565 | The coordinates are in the divider separating @var{window} from a |
| 5563 | window on the right. | 5566 | window on the right. |
| @@ -6115,6 +6118,15 @@ to suppress display of a header line for this window. Display and | |||
| 6115 | contents of the header line on other windows showing this buffer are not | 6118 | contents of the header line on other windows showing this buffer are not |
| 6116 | affected. | 6119 | affected. |
| 6117 | 6120 | ||
| 6121 | @item tab-line-format | ||
| 6122 | @vindex tab-line-format@r{, a window parameter} | ||
| 6123 | This parameter replaces the value of the buffer-local variable | ||
| 6124 | @code{tab-line-format} (@pxref{Mode Line Basics}) of this window's | ||
| 6125 | buffer whenever this window is displayed. The symbol @code{none} means | ||
| 6126 | to suppress display of a tab line for this window. Display and | ||
| 6127 | contents of the tab line on other windows showing this buffer are not | ||
| 6128 | affected. | ||
| 6129 | |||
| 6118 | @item min-margins | 6130 | @item min-margins |
| 6119 | @vindex min-margins@r{, a window parameter} | 6131 | @vindex min-margins@r{, a window parameter} |
| 6120 | The value of this parameter is a cons cell whose @sc{car} and | 6132 | The value of this parameter is a cons cell whose @sc{car} and |