aboutsummaryrefslogtreecommitdiffstats
path: root/doc/lispref
diff options
context:
space:
mode:
authorJuri Linkov2019-10-01 23:15:03 +0300
committerJuri Linkov2019-10-01 23:15:03 +0300
commit2698d3dba2e9858b026ed127d4de3f86810a5ef3 (patch)
tree8e9b8f194cfcad8af83a4174a0105bbc691f06d6 /doc/lispref
parent25f45d710e91a7c1049f056ff27bc3e6968f5624 (diff)
parent3f981a0a89bca47a207fb362485f07e7322bb145 (diff)
downloademacs-2698d3dba2e9858b026ed127d4de3f86810a5ef3.tar.gz
emacs-2698d3dba2e9858b026ed127d4de3f86810a5ef3.zip
Merge branch 'feature/tabs'
Diffstat (limited to 'doc/lispref')
-rw-r--r--doc/lispref/commands.texi43
-rw-r--r--doc/lispref/display.texi1
-rw-r--r--doc/lispref/windows.texi12
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
1349functions documented in @ref{Accessing Mouse}. The explicit format of 1349functions documented in @ref{Accessing Mouse}. The explicit format of
1350the list depends on where the click occurred. For clicks in the text 1350the list depends on where the click occurred. For clicks in the text
1351area, mode line, header line, or in the fringe or marginal areas, the 1351area, mode line, header line, tab line, or in the fringe or marginal
1352mouse position list has the form 1352areas, 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.
1368The buffer position of the character clicked on in the text area; or, 1368The buffer position of the character clicked on in the text area; or,
1369if the click was outside the text area, the window area where it 1369if the click was outside the text area, the window area where it
1370occurred. It is one of the symbols @code{mode-line}, 1370occurred. 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
1374In one special case, @var{pos-or-area} is a list containing a symbol 1375In 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}.
1380The relative pixel coordinates of the click. For clicks in the text 1381The relative pixel coordinates of the click. For clicks in the text
1381area of a window, the coordinate origin @code{(0 . 0)} is taken to be 1382area of a window, the coordinate origin @code{(0 . 0)} is taken to be
1382the top left corner of the text area. @xref{Window Sizes}. For 1383the top left corner of the text area. @xref{Window Sizes}. For
1383clicks in a mode line or header line, the coordinate origin is the top 1384clicks in a mode line, header line or tab line, the coordinate origin
1384left corner of the window itself. For fringes, margins, and the 1385is the top left corner of the window itself. For fringes, margins,
1385vertical border, @var{x} does not have meaningful data. For fringes 1386and the vertical border, @var{x} does not have meaningful data.
1386and margins, @var{y} is relative to the bottom edge of the header 1387For fringes and margins, @var{y} is relative to the bottom edge of the
1387line. In all cases, the @var{x} and @var{y} coordinates increase 1388header line. In all cases, the @var{x} and @var{y} coordinates
1388rightward and downward respectively. 1389increase rightward and downward respectively.
1389 1390
1390@item @var{timestamp} 1391@item @var{timestamp}
1391The time at which the event occurred, as an integer number of 1392The 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}
1408For clicks on a marginal area or on a fringe, this is the buffer 1409For clicks on a marginal area or on a fringe, this is the buffer
1409position of the first visible character in the corresponding line in 1410position of the first visible character in the corresponding line in
1410the window. For clicks on the mode line or the header line, this is 1411the 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 1412line, this is @code{nil}. For other events, it is the buffer position
1412the click. 1413closest to the click.
1413 1414
1414@item @var{col}, @var{row} 1415@item @var{col}, @var{row}
1415These are the actual column and row coordinate numbers of the glyph 1416These are the actual column and row coordinate numbers of the glyph
1416under the @var{x}, @var{y} position. If @var{x} lies beyond the last 1417under the @var{x}, @var{y} position. If @var{x} lies beyond the last
1417column of actual text on its line, @var{col} is reported by adding 1418column of actual text on its line, @var{col} is reported by adding
1418fictional extra columns that have the default character width. Row 0 1419fictional extra columns that have the default character width.
1419is taken to be the header line if the window has one, or the topmost 1420Row 0 is taken to be the header line if the window has one, or Row 1
1420row of the text area otherwise. Column 0 is taken to be the leftmost 1421if the window also has the tab line, or the topmost row of
1422the text area otherwise. Column 0 is taken to be the leftmost
1421column of the text area for clicks on a window text area, or the 1423column of the text area for clicks on a window text area, or the
1422leftmost mode line or header line column for clicks there. For clicks 1424leftmost mode line or header line column for clicks there. For clicks
1423on fringes or vertical borders, these have no meaningful data. For 1425on fringes or vertical borders, these have no meaningful data. For
@@ -2094,7 +2096,8 @@ computed values.)
2094 2096
2095Note that @var{row} is counted from the top of the text area. If the 2097Note that @var{row} is counted from the top of the text area. If the
2096window given by @var{position} possesses a header line (@pxref{Header 2098window given by @var{position} possesses a header line (@pxref{Header
2097Lines}), it is @emph{not} included in the @var{row} count. 2099Lines}) or a tab line, they are @emph{not} included in the @var{row}
2100count.
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
2452miscellaneous window events so that they never appear in a key sequence 2455miscellaneous window events so that they never appear in a key sequence
2453with any other events. 2456with 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
2462When mouse events occur in special parts of a window, such as a mode 2467When mouse events occur in special parts of a window, such as a mode
2463line or a scroll bar, the event type shows nothing special---it is the 2468line 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
2465button and modifier keys. The information about the window part is kept 2470button and modifier keys. The information about the window part is kept
2466elsewhere in the event---in the coordinates. But 2471elsewhere 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
2468prefix keys, all of which are symbols: @code{header-line}, 2473prefix 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
2471meanings for mouse clicks in special window parts by defining key 2476meanings for mouse clicks in special window parts by defining key
2472sequences using these imaginary prefix keys. 2477sequences 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
2944applies the @code{mode-line} face. For the mode line of a 2944applies the @code{mode-line} face. For the mode line of a
2945non-selected window, Emacs applies the @code{mode-line-inactive} face. 2945non-selected window, Emacs applies the @code{mode-line-inactive} face.
2946For a header line, Emacs applies the @code{header-line} face. 2946For a header line, Emacs applies the @code{header-line} face.
2947For a tab line, Emacs applies the @code{tab-line} face.
2947 2948
2948@item 2949@item
2949If the text comes from an overlay string via @code{before-string} or 2950If 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
5559The coordinates are in the header line of @var{window}. 5559The coordinates are in the header line of @var{window}.
5560 5560
5561@item tab-line
5562The coordinates are in the tab line of @var{window}.
5563
5561@item right-divider 5564@item right-divider
5562The coordinates are in the divider separating @var{window} from a 5565The coordinates are in the divider separating @var{window} from a
5563window on the right. 5566window on the right.
@@ -6115,6 +6118,15 @@ to suppress display of a header line for this window. Display and
6115contents of the header line on other windows showing this buffer are not 6118contents of the header line on other windows showing this buffer are not
6116affected. 6119affected.
6117 6120
6121@item tab-line-format
6122@vindex tab-line-format@r{, a window parameter}
6123This parameter replaces the value of the buffer-local variable
6124@code{tab-line-format} (@pxref{Mode Line Basics}) of this window's
6125buffer whenever this window is displayed. The symbol @code{none} means
6126to suppress display of a tab line for this window. Display and
6127contents of the tab line on other windows showing this buffer are not
6128affected.
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}
6120The value of this parameter is a cons cell whose @sc{car} and 6132The value of this parameter is a cons cell whose @sc{car} and