diff options
| author | Glenn Morris | 2018-12-10 09:43:05 -0800 |
|---|---|---|
| committer | Glenn Morris | 2018-12-10 09:43:05 -0800 |
| commit | 3d353ce585e4f9726b59b054218aaa0923d77fea (patch) | |
| tree | 985b48667adc151eff87dfd85ac598c2c23c3fd0 /doc/lispref | |
| parent | 874f69acecf0c6c3c4886375c092fb389d207241 (diff) | |
| parent | 908af9dfc46f783c89d06cb48d9499eb6a582d3e (diff) | |
| download | emacs-3d353ce585e4f9726b59b054218aaa0923d77fea.tar.gz emacs-3d353ce585e4f9726b59b054218aaa0923d77fea.zip | |
Merge from origin/emacs-26
908af9d Indexing followup to recent changes
505ac9a Improve documentation of cursor-sensor.el (bug#33664)
d817d2c * doc/lispref/commands.texi (Adjusting Point): Bug#33662
18442da Tramp multi-hop methods must be inline
1e3e24d ; * src/xterm.c (x_update_begin): Fix whitespace.
1d743d2 Fix scaling problem in Cairo builds
2b9e993 ; * doc/lispref/text.texi (Special Properties): Fix wording. ...
e568202 * lisp/simple.el (next-line-or-history-element): Use current-...
c7897c2 A few further fixes of window internals description
# Conflicts:
# doc/misc/tramp.texi
Diffstat (limited to 'doc/lispref')
| -rw-r--r-- | doc/lispref/commands.texi | 3 | ||||
| -rw-r--r-- | doc/lispref/internals.texi | 96 | ||||
| -rw-r--r-- | doc/lispref/text.texi | 10 |
3 files changed, 79 insertions, 30 deletions
diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi index 427379bc79c..b6749d0a0cc 100644 --- a/doc/lispref/commands.texi +++ b/doc/lispref/commands.texi | |||
| @@ -1012,7 +1012,8 @@ If the last event came from a keyboard macro, the value is @code{macro}. | |||
| 1012 | sequence of text that has the @code{display} or @code{composition} | 1012 | sequence of text that has the @code{display} or @code{composition} |
| 1013 | property, or is invisible. Therefore, after a command finishes and | 1013 | property, or is invisible. Therefore, after a command finishes and |
| 1014 | returns to the command loop, if point is within such a sequence, the | 1014 | returns to the command loop, if point is within such a sequence, the |
| 1015 | command loop normally moves point to the edge of the sequence. | 1015 | command loop normally moves point to the edge of the sequence, making this |
| 1016 | sequence effectively intangible. | ||
| 1016 | 1017 | ||
| 1017 | A command can inhibit this feature by setting the variable | 1018 | A command can inhibit this feature by setting the variable |
| 1018 | @code{disable-point-adjustment}: | 1019 | @code{disable-point-adjustment}: |
diff --git a/doc/lispref/internals.texi b/doc/lispref/internals.texi index a2f7e8c792b..dddbf38c591 100644 --- a/doc/lispref/internals.texi +++ b/doc/lispref/internals.texi | |||
| @@ -2033,45 +2033,76 @@ if that window no longer displays this buffer. | |||
| 2033 | The frame that this window is on, as a Lisp object. | 2033 | The frame that this window is on, as a Lisp object. |
| 2034 | 2034 | ||
| 2035 | @item mini | 2035 | @item mini |
| 2036 | Non-zero if this window is a minibuffer window. | 2036 | Non-zero if this window is a minibuffer window, a window showing the |
| 2037 | minibuffer or the echo area. | ||
| 2038 | |||
| 2039 | @item pseudo_window_p | ||
| 2040 | @cindex pseudo window | ||
| 2041 | Non-zero if this window is a @dfn{pseudo window}. A pseudo window is | ||
| 2042 | either a window used to display the menu bar or the tool bar (when | ||
| 2043 | Emacs uses toolkits that don't display their own menu bar and tool | ||
| 2044 | bar) or a window showing a tooltip on a tooltip frame. Pseudo windows | ||
| 2045 | are in general not accessible from Lisp code. | ||
| 2037 | 2046 | ||
| 2038 | @item parent | 2047 | @item parent |
| 2039 | Internally, Emacs arranges windows in a tree; each group of siblings has | 2048 | Internally, Emacs arranges windows in a tree; each group of siblings |
| 2040 | a parent window whose area includes all the siblings. This field points | 2049 | has a parent window whose area includes all the siblings. This field |
| 2041 | to a window's parent, as a Lisp object. | 2050 | points to the window's parent in that tree, as a Lisp object. For the |
| 2051 | root window of the tree and a minibuffer window this is always | ||
| 2052 | @code{nil}. | ||
| 2042 | 2053 | ||
| 2043 | Parent windows do not display buffers, and play little role in display | 2054 | Parent windows do not display buffers, and play little role in display |
| 2044 | except to shape their child windows. Emacs Lisp programs usually have | 2055 | except to shape their child windows. Emacs Lisp programs cannot |
| 2045 | no access to the parent windows; they operate on the windows at the | 2056 | directly manipulate parent windows; they operate on the windows at the |
| 2046 | leaves of the tree, which actually display buffers. | 2057 | leaves of the tree, which actually display buffers. |
| 2047 | 2058 | ||
| 2059 | @item contents | ||
| 2060 | For a leaf window and windows showing a tooltip, this is the buffer, | ||
| 2061 | as a Lisp object, that the window is displaying. For an internal | ||
| 2062 | (``parent'') window, this is its first child window. For a pseudo | ||
| 2063 | window showing a menu or tool bar this is @code{nil}. It is also | ||
| 2064 | @code{nil} for a window that has been deleted. | ||
| 2065 | |||
| 2048 | @item next | 2066 | @item next |
| 2049 | @itemx prev | 2067 | @itemx prev |
| 2050 | The next sibling and previous sibling of this window. @code{next} is | 2068 | The next and previous sibling of this window as Lisp objects. |
| 2051 | @code{nil} if the window is the right-most or bottom-most in its group; | 2069 | @code{next} is @code{nil} if the window is the right-most or |
| 2052 | @code{prev} is @code{nil} if it is the left-most or top-most in its | 2070 | bottom-most in its group; @code{prev} is @code{nil} if it is the |
| 2053 | group. Whether the sibling is left/right or up/down is determined by | 2071 | left-most or top-most in its group. Whether the sibling is left/right |
| 2054 | the @code{horizontal} field: if it's non-zero, the siblings are | 2072 | or up/down is determined by the @code{horizontal} field of the |
| 2055 | arranged horizontally. | 2073 | sibling's parent: if it's non-zero, the siblings are arranged |
| 2074 | horizontally. | ||
| 2075 | |||
| 2076 | As a special case, @code{next} of a frame's root window points to the | ||
| 2077 | frame's minibuffer window, provided this is not a minibuffer-only or | ||
| 2078 | minibuffer-less frame. On such frames @code{prev} of the minibuffer | ||
| 2079 | window points to that frame's root window. In any other case, the | ||
| 2080 | root window's @code{next} and the minibuffer window's (if present) | ||
| 2081 | @code{prev} fields are @code{nil}. | ||
| 2056 | 2082 | ||
| 2057 | @item left_col | 2083 | @item left_col |
| 2058 | The left-hand edge of the window, measured in columns, relative to the | 2084 | The left-hand edge of the window, measured in columns, relative to the |
| 2059 | leftmost column in the frame (column 0). | 2085 | leftmost column (column 0) of the window's native frame. |
| 2060 | 2086 | ||
| 2061 | @item top_line | 2087 | @item top_line |
| 2062 | The top edge of the window, measured in lines, relative to the topmost | 2088 | The top edge of the window, measured in lines, relative to the topmost |
| 2063 | line in the frame (line 0). | 2089 | line (line 0) of the window's native frame. |
| 2090 | |||
| 2091 | @item pixel_left | ||
| 2092 | @itemx pixel_top | ||
| 2093 | The left-hand and top edges of this window, measured in pixels, | ||
| 2094 | relative to the top-left corner (0, 0) of the window's native frame. | ||
| 2064 | 2095 | ||
| 2065 | @item total_cols | 2096 | @item total_cols |
| 2066 | @itemx total_lines | 2097 | @itemx total_lines |
| 2067 | The width and height of the window, measured in columns and lines | 2098 | The total width and height of the window, measured in columns and |
| 2068 | respectively. The width includes the scroll bar and fringes, and/or | 2099 | lines respectively. The values include scroll bars and fringes, |
| 2069 | the separator line on the right of the window (if any). | 2100 | dividers and/or the separator line on the right of the window (if |
| 2101 | any). | ||
| 2070 | 2102 | ||
| 2071 | @item contents | 2103 | @item pixel_width; |
| 2072 | For leaf windows, this is the buffer, as a Lisp object, that the | 2104 | @itemx pixel_height; |
| 2073 | window is displaying. For an internal (``parent'') window, this is | 2105 | The total width and height of the window measured in pixels. |
| 2074 | its child window. It can also be @code{nil}, for a pseudo-window. | ||
| 2075 | 2106 | ||
| 2076 | @item start | 2107 | @item start |
| 2077 | A marker pointing to the position in the buffer that is the first | 2108 | A marker pointing to the position in the buffer that is the first |
| @@ -2125,8 +2156,14 @@ in this window. | |||
| 2125 | A non-zero value means the window's buffer was modified when the | 2156 | A non-zero value means the window's buffer was modified when the |
| 2126 | window was last updated. | 2157 | window was last updated. |
| 2127 | 2158 | ||
| 2128 | @item vertical_scroll_bar | 2159 | @item vertical_scroll_bar_type |
| 2129 | This window's vertical scroll bar, a Lisp object. | 2160 | @itemx horizontal_scroll_bar_type |
| 2161 | The types of this window's vertical and horizontal scroll bars. | ||
| 2162 | |||
| 2163 | @item scroll_bar_width | ||
| 2164 | @itemx scroll_bar_height | ||
| 2165 | The width of this window's vertical scroll bar and the height of this | ||
| 2166 | window's horizontal scroll bar, in pixels. | ||
| 2130 | 2167 | ||
| 2131 | @item left_margin_cols | 2168 | @item left_margin_cols |
| 2132 | @itemx right_margin_cols | 2169 | @itemx right_margin_cols |
| @@ -2210,6 +2247,14 @@ Vertical scroll amount, in pixels. Normally, this is 0. | |||
| 2210 | @item dedicated | 2247 | @item dedicated |
| 2211 | Non-@code{nil} if this window is dedicated to its buffer. | 2248 | Non-@code{nil} if this window is dedicated to its buffer. |
| 2212 | 2249 | ||
| 2250 | @item combination_limit | ||
| 2251 | This window's combination limit, meaningful only for a parent window. | ||
| 2252 | If this is @code{t}, then it is not allowed to delete this window and | ||
| 2253 | recombine its child windows with other siblings of this window. | ||
| 2254 | |||
| 2255 | @item window_parameters | ||
| 2256 | The alist of this window's parameters. | ||
| 2257 | |||
| 2213 | @item display_table | 2258 | @item display_table |
| 2214 | The window's display table, or @code{nil} if none is specified for it. | 2259 | The window's display table, or @code{nil} if none is specified for it. |
| 2215 | 2260 | ||
| @@ -2234,11 +2279,6 @@ the line number as long as the window shows that buffer. | |||
| 2234 | The column number currently displayed in this window's mode line, or | 2279 | The column number currently displayed in this window's mode line, or |
| 2235 | @minus{}1 if column numbers are not being displayed. | 2280 | @minus{}1 if column numbers are not being displayed. |
| 2236 | 2281 | ||
| 2237 | @item pseudo_window_p | ||
| 2238 | This is non-zero for windows that display the menu bar and the tool | ||
| 2239 | bar (when Emacs uses toolkits that don't display their own menu bar | ||
| 2240 | and tool bar). | ||
| 2241 | |||
| 2242 | @item current_matrix | 2282 | @item current_matrix |
| 2243 | @itemx desired_matrix | 2283 | @itemx desired_matrix |
| 2244 | Glyph matrices describing the current and desired display of this window. | 2284 | Glyph matrices describing the current and desired display of this window. |
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index 51d2753f404..6d93264758f 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi | |||
| @@ -3496,9 +3496,14 @@ property is obsolete; use the @code{cursor-intangible} property instead. | |||
| 3496 | @kindex cursor-intangible @r{(text property)} | 3496 | @kindex cursor-intangible @r{(text property)} |
| 3497 | @findex cursor-intangible-mode | 3497 | @findex cursor-intangible-mode |
| 3498 | When the minor mode @code{cursor-intangible-mode} is turned on, point | 3498 | When the minor mode @code{cursor-intangible-mode} is turned on, point |
| 3499 | is moved away of any position that has a non-@code{nil} | 3499 | is moved away from any position that has a non-@code{nil} |
| 3500 | @code{cursor-intangible} property, just before redisplay happens. | 3500 | @code{cursor-intangible} property, just before redisplay happens. |
| 3501 | 3501 | ||
| 3502 | @vindex cursor-sensor-inhibit | ||
| 3503 | When the variable @code{cursor-sensor-inhibit} is non-@code{nil}, the | ||
| 3504 | @code{cursor-intangible} property and the | ||
| 3505 | @code{cursor-sensor-functions} property (described below) are ignored. | ||
| 3506 | |||
| 3502 | @item field | 3507 | @item field |
| 3503 | @kindex field @r{(text property)} | 3508 | @kindex field @r{(text property)} |
| 3504 | Consecutive characters with the same @code{field} property constitute a | 3509 | Consecutive characters with the same @code{field} property constitute a |
| @@ -3680,6 +3685,9 @@ depending on whether the cursor is entering the text that has this | |||
| 3680 | property or leaving it. The functions are called only when the minor | 3685 | property or leaving it. The functions are called only when the minor |
| 3681 | mode @code{cursor-sensor-mode} is turned on. | 3686 | mode @code{cursor-sensor-mode} is turned on. |
| 3682 | 3687 | ||
| 3688 | When the variable @code{cursor-sensor-inhibit} is non-@code{nil}, the | ||
| 3689 | @code{cursor-sensor-functions} property is ignored. | ||
| 3690 | |||
| 3683 | @item composition | 3691 | @item composition |
| 3684 | @kindex composition @r{(text property)} | 3692 | @kindex composition @r{(text property)} |
| 3685 | This text property is used to display a sequence of characters as a | 3693 | This text property is used to display a sequence of characters as a |