diff options
| author | Eli Zaretskii | 2006-07-08 18:11:49 +0000 |
|---|---|---|
| committer | Eli Zaretskii | 2006-07-08 18:11:49 +0000 |
| commit | 986ce8de186642c85dd078df4e780df1309086e2 (patch) | |
| tree | 8a1c212888b84e0035db1a37565bfb4f389cb83d | |
| parent | 00c44593e73ad3fa1ba6629344bfe977682839e2 (diff) | |
| download | emacs-986ce8de186642c85dd078df4e780df1309086e2.tar.gz emacs-986ce8de186642c85dd078df4e780df1309086e2.zip | |
(Forcing Redisplay, Displaying Messages, Temporary Displays, Font Selection,
Auto Faces, Font Lookup, Fringe Indicators, Display Margins, Image Descriptors,
Showing Images, Image Cache, Button Types, Making Buttons, Manipulating
Buttons, Button Buffer Commands, Display Table Format, Glyphs): Remove
@tindex.
| -rw-r--r-- | lispref/display.texi | 59 |
1 files changed, 1 insertions, 58 deletions
diff --git a/lispref/display.texi b/lispref/display.texi index b99a6f4f553..641511fe66e 100644 --- a/lispref/display.texi +++ b/lispref/display.texi | |||
| @@ -94,7 +94,6 @@ at all if input is available before it starts. Most of the time, this | |||
| 94 | is exactly what you want. However, you can prevent preemption by | 94 | is exactly what you want. However, you can prevent preemption by |
| 95 | binding @code{redisplay-dont-pause} to a non-@code{nil} value. | 95 | binding @code{redisplay-dont-pause} to a non-@code{nil} value. |
| 96 | 96 | ||
| 97 | @tindex redisplay-preemption-period | ||
| 98 | @defvar redisplay-preemption-period | 97 | @defvar redisplay-preemption-period |
| 99 | This variable specifies how many seconds Emacs waits between checks | 98 | This variable specifies how many seconds Emacs waits between checks |
| 100 | for new input during redisplay. (The default is 0.1 seconds.) If | 99 | for new input during redisplay. (The default is 0.1 seconds.) If |
| @@ -108,14 +107,13 @@ redisplay, and redisplay cannot be preempted by input. | |||
| 108 | with support for sub-second timers. | 107 | with support for sub-second timers. |
| 109 | @end defvar | 108 | @end defvar |
| 110 | 109 | ||
| 111 | @tindex redisplay-dont-pause | ||
| 112 | @defvar redisplay-dont-pause | 110 | @defvar redisplay-dont-pause |
| 113 | If this variable is non-@code{nil}, pending input does not | 111 | If this variable is non-@code{nil}, pending input does not |
| 114 | prevent or halt redisplay; redisplay occurs, and finishes, | 112 | prevent or halt redisplay; redisplay occurs, and finishes, |
| 115 | regardless of whether input is available. | 113 | regardless of whether input is available. |
| 116 | @end defvar | 114 | @end defvar |
| 117 | 115 | ||
| 118 | @tindex sit-for | 116 | @findex sit-for |
| 119 | You can request a display update, but only if no input is pending, | 117 | You can request a display update, but only if no input is pending, |
| 120 | with @code{(sit-for 0)}. To force a display update even when input is | 118 | with @code{(sit-for 0)}. To force a display update even when input is |
| 121 | pending, use @code{(sit-for -1)}. | 119 | pending, use @code{(sit-for -1)}. |
| @@ -257,7 +255,6 @@ To automatically display a message in the echo area or in a pop-buffer, | |||
| 257 | depending on its size, use @code{display-message-or-buffer} (see below). | 255 | depending on its size, use @code{display-message-or-buffer} (see below). |
| 258 | @end defun | 256 | @end defun |
| 259 | 257 | ||
| 260 | @tindex with-temp-message | ||
| 261 | @defmac with-temp-message message &rest body | 258 | @defmac with-temp-message message &rest body |
| 262 | This construct displays a message in the echo area temporarily, during | 259 | This construct displays a message in the echo area temporarily, during |
| 263 | the execution of @var{body}. It displays @var{message}, executes | 260 | the execution of @var{body}. It displays @var{message}, executes |
| @@ -288,7 +285,6 @@ support them, then @code{message-box} uses the echo area, like | |||
| 288 | @end defun | 285 | @end defun |
| 289 | 286 | ||
| 290 | @defun display-message-or-buffer message &optional buffer-name not-this-window frame | 287 | @defun display-message-or-buffer message &optional buffer-name not-this-window frame |
| 291 | @tindex display-message-or-buffer | ||
| 292 | This function displays the message @var{message}, which may be either a | 288 | This function displays the message @var{message}, which may be either a |
| 293 | string or a buffer. If it is shorter than the maximum height of the | 289 | string or a buffer. If it is shorter than the maximum height of the |
| 294 | echo area, as defined by @code{max-mini-window-height}, it is displayed | 290 | echo area, as defined by @code{max-mini-window-height}, it is displayed |
| @@ -1027,7 +1023,6 @@ selected. | |||
| 1027 | @end defvar | 1023 | @end defvar |
| 1028 | 1024 | ||
| 1029 | @defvar temp-buffer-setup-hook | 1025 | @defvar temp-buffer-setup-hook |
| 1030 | @tindex temp-buffer-setup-hook | ||
| 1031 | This normal hook is run by @code{with-output-to-temp-buffer} before | 1026 | This normal hook is run by @code{with-output-to-temp-buffer} before |
| 1032 | evaluating @var{body}. When the hook runs, the temporary buffer is | 1027 | evaluating @var{body}. When the hook runs, the temporary buffer is |
| 1033 | current. This hook is normally set up with a function to put the | 1028 | current. This hook is normally set up with a function to put the |
| @@ -2055,7 +2050,6 @@ functions. If you specify @var{frame}, they affect just that frame; | |||
| 2055 | otherwise, they affect all frames as well as the defaults that apply to | 2050 | otherwise, they affect all frames as well as the defaults that apply to |
| 2056 | new frames. | 2051 | new frames. |
| 2057 | 2052 | ||
| 2058 | @tindex set-face-attribute | ||
| 2059 | @defun set-face-attribute face frame &rest arguments | 2053 | @defun set-face-attribute face frame &rest arguments |
| 2060 | This function sets one or more attributes of face @var{face} | 2054 | This function sets one or more attributes of face @var{face} |
| 2061 | for frame @var{frame}. If @var{frame} is @code{nil}, it sets | 2055 | for frame @var{frame}. If @var{frame} is @code{nil}, it sets |
| @@ -2078,7 +2072,6 @@ sets the attributes @code{:width}, @code{:weight} and @code{:underline} | |||
| 2078 | to the corresponding values. | 2072 | to the corresponding values. |
| 2079 | @end defun | 2073 | @end defun |
| 2080 | 2074 | ||
| 2081 | @tindex face-attribute | ||
| 2082 | @defun face-attribute face attribute &optional frame inherit | 2075 | @defun face-attribute face attribute &optional frame inherit |
| 2083 | This returns the value of the @var{attribute} attribute of face | 2076 | This returns the value of the @var{attribute} attribute of face |
| 2084 | @var{face} on @var{frame}. If @var{frame} is @code{nil}, | 2077 | @var{face} on @var{frame}. If @var{frame} is @code{nil}, |
| @@ -2114,7 +2107,6 @@ For example, | |||
| 2114 | with older Emacs versions, you can use the following functions to set | 2107 | with older Emacs versions, you can use the following functions to set |
| 2115 | and examine the face attributes which existed in those versions. | 2108 | and examine the face attributes which existed in those versions. |
| 2116 | 2109 | ||
| 2117 | @tindex face-attribute-relative-p | ||
| 2118 | @defun face-attribute-relative-p attribute value | 2110 | @defun face-attribute-relative-p attribute value |
| 2119 | This function returns non-@code{nil} if @var{value}, when used as the | 2111 | This function returns non-@code{nil} if @var{value}, when used as the |
| 2120 | value of the face attribute @var{attribute}, is relative. This means | 2112 | value of the face attribute @var{attribute}, is relative. This means |
| @@ -2134,7 +2126,6 @@ For example: | |||
| 2134 | prompts with @samp{Describe face (default = `default' face): }. | 2126 | prompts with @samp{Describe face (default = `default' face): }. |
| 2135 | @end defun | 2127 | @end defun |
| 2136 | 2128 | ||
| 2137 | @tindex merge-face-attribute | ||
| 2138 | @defun merge-face-attribute attribute value1 value2 | 2129 | @defun merge-face-attribute attribute value1 value2 |
| 2139 | If @var{value1} is a relative value for the face attribute | 2130 | If @var{value1} is a relative value for the face attribute |
| 2140 | @var{attribute}, returns it merged with the underlying value | 2131 | @var{attribute}, returns it merged with the underlying value |
| @@ -2323,7 +2314,6 @@ not available, you can specify a set of mappings for alternatives to | |||
| 2323 | try. | 2314 | try. |
| 2324 | 2315 | ||
| 2325 | @defvar face-font-selection-order | 2316 | @defvar face-font-selection-order |
| 2326 | @tindex face-font-selection-order | ||
| 2327 | This variable specifies the order of importance of the face attributes | 2317 | This variable specifies the order of importance of the face attributes |
| 2328 | @code{:width}, @code{:height}, @code{:weight}, and @code{:slant}. The | 2318 | @code{:width}, @code{:height}, @code{:weight}, and @code{:slant}. The |
| 2329 | value should be a list containing those four symbols, in order of | 2319 | value should be a list containing those four symbols, in order of |
| @@ -2353,7 +2343,6 @@ quite right. | |||
| 2353 | @end defvar | 2343 | @end defvar |
| 2354 | 2344 | ||
| 2355 | @defvar face-font-family-alternatives | 2345 | @defvar face-font-family-alternatives |
| 2356 | @tindex face-font-family-alternatives | ||
| 2357 | This variable lets you specify alternative font families to try, if a | 2346 | This variable lets you specify alternative font families to try, if a |
| 2358 | given family is specified and doesn't exist. Each element should have | 2347 | given family is specified and doesn't exist. Each element should have |
| 2359 | this form: | 2348 | this form: |
| @@ -2368,7 +2357,6 @@ family that does exist. | |||
| 2368 | @end defvar | 2357 | @end defvar |
| 2369 | 2358 | ||
| 2370 | @defvar face-font-registry-alternatives | 2359 | @defvar face-font-registry-alternatives |
| 2371 | @tindex face-font-registry-alternatives | ||
| 2372 | This variable lets you specify alternative font registries to try, if a | 2360 | This variable lets you specify alternative font registries to try, if a |
| 2373 | given registry is specified and doesn't exist. Each element should have | 2361 | given registry is specified and doesn't exist. Each element should have |
| 2374 | this form: | 2362 | this form: |
| @@ -2387,7 +2375,6 @@ them, since the use of too many or too big scalable fonts can crash | |||
| 2387 | XFree86 servers. | 2375 | XFree86 servers. |
| 2388 | 2376 | ||
| 2389 | @defvar scalable-fonts-allowed | 2377 | @defvar scalable-fonts-allowed |
| 2390 | @tindex scalable-fonts-allowed | ||
| 2391 | This variable controls which scalable fonts to use. A value of | 2378 | This variable controls which scalable fonts to use. A value of |
| 2392 | @code{nil}, the default, means do not use scalable fonts. @code{t} | 2379 | @code{nil}, the default, means do not use scalable fonts. @code{t} |
| 2393 | means to use any scalable font that seems appropriate for the text. | 2380 | means to use any scalable font that seems appropriate for the text. |
| @@ -2488,7 +2475,6 @@ makes @code{modeline} an alias for the @code{mode-line} face. | |||
| 2488 | This hook is used for automatically assigning faces to text in the | 2475 | This hook is used for automatically assigning faces to text in the |
| 2489 | buffer. It is part of the implementation of Font-Lock mode. | 2476 | buffer. It is part of the implementation of Font-Lock mode. |
| 2490 | 2477 | ||
| 2491 | @tindex fontification-functions | ||
| 2492 | @defvar fontification-functions | 2478 | @defvar fontification-functions |
| 2493 | This variable holds a list of functions that are called by Emacs | 2479 | This variable holds a list of functions that are called by Emacs |
| 2494 | redisplay as needed to assign faces automatically to text in the buffer. | 2480 | redisplay as needed to assign faces automatically to text in the buffer. |
| @@ -2538,7 +2524,6 @@ many fonts match the pattern. | |||
| 2538 | @end defun | 2524 | @end defun |
| 2539 | 2525 | ||
| 2540 | @defun x-family-fonts &optional family frame | 2526 | @defun x-family-fonts &optional family frame |
| 2541 | @tindex x-family-fonts | ||
| 2542 | This function returns a list describing the available fonts for family | 2527 | This function returns a list describing the available fonts for family |
| 2543 | @var{family} on @var{frame}. If @var{family} is omitted or @code{nil}, | 2528 | @var{family} on @var{frame}. If @var{family} is omitted or @code{nil}, |
| 2544 | this list applies to all families, and therefore, it contains all | 2529 | this list applies to all families, and therefore, it contains all |
| @@ -2569,7 +2554,6 @@ The result list is sorted according to the current face font sort order. | |||
| 2569 | @end defun | 2554 | @end defun |
| 2570 | 2555 | ||
| 2571 | @defun x-font-family-list &optional frame | 2556 | @defun x-font-family-list &optional frame |
| 2572 | @tindex x-font-family-list | ||
| 2573 | This function returns a list of the font families available for | 2557 | This function returns a list of the font families available for |
| 2574 | @var{frame}'s display. If @var{frame} is omitted or @code{nil}, it | 2558 | @var{frame}'s display. If @var{frame} is omitted or @code{nil}, it |
| 2575 | describes the selected frame's display (@pxref{Input Focus}). | 2559 | describes the selected frame's display (@pxref{Input Focus}). |
| @@ -2586,7 +2570,6 @@ non-@code{nil} if fonts of that family are fixed-pitch. | |||
| 2586 | @end defun | 2570 | @end defun |
| 2587 | 2571 | ||
| 2588 | @defvar font-list-limit | 2572 | @defvar font-list-limit |
| 2589 | @tindex font-list-limit | ||
| 2590 | This variable specifies maximum number of fonts to consider in font | 2573 | This variable specifies maximum number of fonts to consider in font |
| 2591 | matching. The function @code{x-family-fonts} will not return more than | 2574 | matching. The function @code{x-family-fonts} will not return more than |
| 2592 | that many fonts, and font selection will consider only that many fonts | 2575 | that many fonts, and font selection will consider only that many fonts |
| @@ -2803,7 +2786,6 @@ window fringe (on a graphic display) to indicate truncated or | |||
| 2803 | continued lines, buffer boundaries, overlay arrow, etc. | 2786 | continued lines, buffer boundaries, overlay arrow, etc. |
| 2804 | 2787 | ||
| 2805 | @defopt indicate-empty-lines | 2788 | @defopt indicate-empty-lines |
| 2806 | @tindex indicate-empty-lines | ||
| 2807 | @cindex fringes, and empty line indication | 2789 | @cindex fringes, and empty line indication |
| 2808 | When this is non-@code{nil}, Emacs displays a special glyph in the | 2790 | When this is non-@code{nil}, Emacs displays a special glyph in the |
| 2809 | fringe of each empty line at the end of the buffer, on graphical | 2791 | fringe of each empty line at the end of the buffer, on graphical |
| @@ -3533,13 +3515,11 @@ them a nonzero width. The usual way to do that is to set these | |||
| 3533 | variables: | 3515 | variables: |
| 3534 | 3516 | ||
| 3535 | @defvar left-margin-width | 3517 | @defvar left-margin-width |
| 3536 | @tindex left-margin-width | ||
| 3537 | This variable specifies the width of the left margin. | 3518 | This variable specifies the width of the left margin. |
| 3538 | It is buffer-local in all buffers. | 3519 | It is buffer-local in all buffers. |
| 3539 | @end defvar | 3520 | @end defvar |
| 3540 | 3521 | ||
| 3541 | @defvar right-margin-width | 3522 | @defvar right-margin-width |
| 3542 | @tindex right-margin-width | ||
| 3543 | This variable specifies the width of the right margin. | 3523 | This variable specifies the width of the right margin. |
| 3544 | It is buffer-local in all buffers. | 3524 | It is buffer-local in all buffers. |
| 3545 | @end defvar | 3525 | @end defvar |
| @@ -3552,14 +3532,12 @@ Thus, you can make changes take effect by calling | |||
| 3552 | You can also set the margin widths immediately. | 3532 | You can also set the margin widths immediately. |
| 3553 | 3533 | ||
| 3554 | @defun set-window-margins window left &optional right | 3534 | @defun set-window-margins window left &optional right |
| 3555 | @tindex set-window-margins | ||
| 3556 | This function specifies the margin widths for window @var{window}. | 3535 | This function specifies the margin widths for window @var{window}. |
| 3557 | The argument @var{left} controls the left margin and | 3536 | The argument @var{left} controls the left margin and |
| 3558 | @var{right} controls the right margin (default @code{0}). | 3537 | @var{right} controls the right margin (default @code{0}). |
| 3559 | @end defun | 3538 | @end defun |
| 3560 | 3539 | ||
| 3561 | @defun window-margins &optional window | 3540 | @defun window-margins &optional window |
| 3562 | @tindex window-margins | ||
| 3563 | This function returns the left and right margins of @var{window} | 3541 | This function returns the left and right margins of @var{window} |
| 3564 | as a cons cell of the form @code{(@var{left} . @var{right})}. | 3542 | as a cons cell of the form @code{(@var{left} . @var{right})}. |
| 3565 | If @var{window} is @code{nil}, the selected window is used. | 3543 | If @var{window} is @code{nil}, the selected window is used. |
| @@ -3842,7 +3820,6 @@ mouse event; for instance, @code{[area4 mouse-1]} if the hot-spot's | |||
| 3842 | @end table | 3820 | @end table |
| 3843 | 3821 | ||
| 3844 | @defun image-mask-p spec &optional frame | 3822 | @defun image-mask-p spec &optional frame |
| 3845 | @tindex image-mask-p | ||
| 3846 | This function returns @code{t} if image @var{spec} has a mask bitmap. | 3823 | This function returns @code{t} if image @var{spec} has a mask bitmap. |
| 3847 | @var{frame} is the frame on which the image will be displayed. | 3824 | @var{frame} is the frame on which the image will be displayed. |
| 3848 | @var{frame} @code{nil} or omitted means to use the selected frame | 3825 | @var{frame} @code{nil} or omitted means to use the selected frame |
| @@ -4026,7 +4003,6 @@ background color. | |||
| 4026 | @code{find-image} provide convenient ways to create image descriptors. | 4003 | @code{find-image} provide convenient ways to create image descriptors. |
| 4027 | 4004 | ||
| 4028 | @defun create-image file-or-data &optional type data-p &rest props | 4005 | @defun create-image file-or-data &optional type data-p &rest props |
| 4029 | @tindex create-image | ||
| 4030 | This function creates and returns an image descriptor which uses the | 4006 | This function creates and returns an image descriptor which uses the |
| 4031 | data in @var{file-or-data}. @var{file-or-data} can be a file name or | 4007 | data in @var{file-or-data}. @var{file-or-data} can be a file name or |
| 4032 | a string containing the image data; @var{data-p} should be @code{nil} | 4008 | a string containing the image data; @var{data-p} should be @code{nil} |
| @@ -4049,7 +4025,6 @@ supported. Otherwise it returns an image descriptor. | |||
| 4049 | @end defun | 4025 | @end defun |
| 4050 | 4026 | ||
| 4051 | @defmac defimage symbol specs &optional doc | 4027 | @defmac defimage symbol specs &optional doc |
| 4052 | @tindex defimage | ||
| 4053 | This macro defines @var{symbol} as an image name. The arguments | 4028 | This macro defines @var{symbol} as an image name. The arguments |
| 4054 | @var{specs} is a list which specifies how to display the image. | 4029 | @var{specs} is a list which specifies how to display the image. |
| 4055 | The third argument, @var{doc}, is an optional documentation string. | 4030 | The third argument, @var{doc}, is an optional documentation string. |
| @@ -4078,7 +4053,6 @@ as @code{nil}. | |||
| 4078 | @end defmac | 4053 | @end defmac |
| 4079 | 4054 | ||
| 4080 | @defun find-image specs | 4055 | @defun find-image specs |
| 4081 | @tindex find-image | ||
| 4082 | This function provides a convenient way to find an image satisfying one | 4056 | This function provides a convenient way to find an image satisfying one |
| 4083 | of a list of image specifications @var{specs}. | 4057 | of a list of image specifications @var{specs}. |
| 4084 | 4058 | ||
| @@ -4096,7 +4070,6 @@ The image is looked for in @code{image-load-path}. | |||
| 4096 | @end defun | 4070 | @end defun |
| 4097 | 4071 | ||
| 4098 | @defvar image-load-path | 4072 | @defvar image-load-path |
| 4099 | @tindex image-load-path | ||
| 4100 | This variable's value is a list of locations in which to search for | 4073 | This variable's value is a list of locations in which to search for |
| 4101 | image files. If an element is a string or a variable symbol whose | 4074 | image files. If an element is a string or a variable symbol whose |
| 4102 | value is a string, the string is taken to be the name of a directory | 4075 | value is a string, the string is taken to be the name of a directory |
| @@ -4118,7 +4091,6 @@ should specify the image as follows: | |||
| 4118 | @end defvar | 4091 | @end defvar |
| 4119 | 4092 | ||
| 4120 | @defun image-load-path-for-library library image &optional path no-error | 4093 | @defun image-load-path-for-library library image &optional path no-error |
| 4121 | @tindex image-load-path-for-library | ||
| 4122 | This function returns a suitable search path for images used by the | 4094 | This function returns a suitable search path for images used by the |
| 4123 | Lisp package @var{library}. | 4095 | Lisp package @var{library}. |
| 4124 | 4096 | ||
| @@ -4225,7 +4197,6 @@ This removes only images that were put into @var{buffer} the way | |||
| 4225 | @end defun | 4197 | @end defun |
| 4226 | 4198 | ||
| 4227 | @defun image-size spec &optional pixels frame | 4199 | @defun image-size spec &optional pixels frame |
| 4228 | @tindex image-size | ||
| 4229 | This function returns the size of an image as a pair | 4200 | This function returns the size of an image as a pair |
| 4230 | @w{@code{(@var{width} . @var{height})}}. @var{spec} is an image | 4201 | @w{@code{(@var{width} . @var{height})}}. @var{spec} is an image |
| 4231 | specification. @var{pixels} non-@code{nil} means return sizes | 4202 | specification. @var{pixels} non-@code{nil} means return sizes |
| @@ -4237,7 +4208,6 @@ Focus}). | |||
| 4237 | @end defun | 4208 | @end defun |
| 4238 | 4209 | ||
| 4239 | @defvar max-image-size | 4210 | @defvar max-image-size |
| 4240 | @tindex max-image-size | ||
| 4241 | This variable is used to define the maximum size of image that Emacs | 4211 | This variable is used to define the maximum size of image that Emacs |
| 4242 | will load. Emacs will refuse to load (and display) any image that is | 4212 | will load. Emacs will refuse to load (and display) any image that is |
| 4243 | larger than this limit. | 4213 | larger than this limit. |
| @@ -4267,7 +4237,6 @@ with cached image specifications using @code{equal}. This means that | |||
| 4267 | all images with equal specifications share the same image in the cache. | 4237 | all images with equal specifications share the same image in the cache. |
| 4268 | 4238 | ||
| 4269 | @defvar image-cache-eviction-delay | 4239 | @defvar image-cache-eviction-delay |
| 4270 | @tindex image-cache-eviction-delay | ||
| 4271 | This variable specifies the number of seconds an image can remain in the | 4240 | This variable specifies the number of seconds an image can remain in the |
| 4272 | cache without being displayed. When an image is not displayed for this | 4241 | cache without being displayed. When an image is not displayed for this |
| 4273 | length of time, Emacs removes it from the image cache. | 4242 | length of time, Emacs removes it from the image cache. |
| @@ -4278,7 +4247,6 @@ debugging. | |||
| 4278 | @end defvar | 4247 | @end defvar |
| 4279 | 4248 | ||
| 4280 | @defun clear-image-cache &optional frame | 4249 | @defun clear-image-cache &optional frame |
| 4281 | @tindex clear-image-cache | ||
| 4282 | This function clears the image cache. If @var{frame} is non-@code{nil}, | 4250 | This function clears the image cache. If @var{frame} is non-@code{nil}, |
| 4283 | only the cache for that frame is cleared. Otherwise all frames' caches | 4251 | only the cache for that frame is cleared. Otherwise all frames' caches |
| 4284 | are cleared. | 4252 | are cleared. |
| @@ -4400,7 +4368,6 @@ so that it's easy to define special-purpose types of buttons for | |||
| 4400 | specific tasks. | 4368 | specific tasks. |
| 4401 | 4369 | ||
| 4402 | @defun define-button-type name &rest properties | 4370 | @defun define-button-type name &rest properties |
| 4403 | @tindex define-button-type | ||
| 4404 | Define a `button type' called @var{name}. The remaining arguments | 4371 | Define a `button type' called @var{name}. The remaining arguments |
| 4405 | form a sequence of @var{property value} pairs, specifying default | 4372 | form a sequence of @var{property value} pairs, specifying default |
| 4406 | property values for buttons with this type (a button's type may be set | 4373 | property values for buttons with this type (a button's type may be set |
| @@ -4449,13 +4416,11 @@ defines such a property). | |||
| 4449 | (@pxref{Overlays}) to hold the button properties: | 4416 | (@pxref{Overlays}) to hold the button properties: |
| 4450 | 4417 | ||
| 4451 | @defun make-button beg end &rest properties | 4418 | @defun make-button beg end &rest properties |
| 4452 | @tindex make-button | ||
| 4453 | This makes a button from @var{beg} to @var{end} in the | 4419 | This makes a button from @var{beg} to @var{end} in the |
| 4454 | current buffer, and returns it. | 4420 | current buffer, and returns it. |
| 4455 | @end defun | 4421 | @end defun |
| 4456 | 4422 | ||
| 4457 | @defun insert-button label &rest properties | 4423 | @defun insert-button label &rest properties |
| 4458 | @tindex insert-button | ||
| 4459 | This insert a button with the label @var{label} at point, | 4424 | This insert a button with the label @var{label} at point, |
| 4460 | and returns it. | 4425 | and returns it. |
| 4461 | @end defun | 4426 | @end defun |
| @@ -4469,13 +4434,11 @@ numbers of buttons. Both functions return the position of the start | |||
| 4469 | of the new button: | 4434 | of the new button: |
| 4470 | 4435 | ||
| 4471 | @defun make-text-button beg end &rest properties | 4436 | @defun make-text-button beg end &rest properties |
| 4472 | @tindex make-text-button | ||
| 4473 | This makes a button from @var{beg} to @var{end} in the current buffer, using | 4437 | This makes a button from @var{beg} to @var{end} in the current buffer, using |
| 4474 | text properties. | 4438 | text properties. |
| 4475 | @end defun | 4439 | @end defun |
| 4476 | 4440 | ||
| 4477 | @defun insert-text-button label &rest properties | 4441 | @defun insert-text-button label &rest properties |
| 4478 | @tindex insert-text-button | ||
| 4479 | This inserts a button with the label @var{label} at point, using text | 4442 | This inserts a button with the label @var{label} at point, using text |
| 4480 | properties. | 4443 | properties. |
| 4481 | @end defun | 4444 | @end defun |
| @@ -4495,27 +4458,22 @@ Such an object is passed as the first argument to a button's | |||
| 4495 | invocation function when it is invoked. | 4458 | invocation function when it is invoked. |
| 4496 | 4459 | ||
| 4497 | @defun button-start button | 4460 | @defun button-start button |
| 4498 | @tindex button-start | ||
| 4499 | Return the position at which @var{button} starts. | 4461 | Return the position at which @var{button} starts. |
| 4500 | @end defun | 4462 | @end defun |
| 4501 | 4463 | ||
| 4502 | @defun button-end button | 4464 | @defun button-end button |
| 4503 | @tindex button-end | ||
| 4504 | Return the position at which @var{button} ends. | 4465 | Return the position at which @var{button} ends. |
| 4505 | @end defun | 4466 | @end defun |
| 4506 | 4467 | ||
| 4507 | @defun button-get button prop | 4468 | @defun button-get button prop |
| 4508 | @tindex button-get | ||
| 4509 | Get the property of button @var{button} named @var{prop}. | 4469 | Get the property of button @var{button} named @var{prop}. |
| 4510 | @end defun | 4470 | @end defun |
| 4511 | 4471 | ||
| 4512 | @defun button-put button prop val | 4472 | @defun button-put button prop val |
| 4513 | @tindex button-put | ||
| 4514 | Set @var{button}'s @var{prop} property to @var{val}. | 4473 | Set @var{button}'s @var{prop} property to @var{val}. |
| 4515 | @end defun | 4474 | @end defun |
| 4516 | 4475 | ||
| 4517 | @defun button-activate button &optional use-mouse-action | 4476 | @defun button-activate button &optional use-mouse-action |
| 4518 | @tindex button-activate | ||
| 4519 | Call @var{button}'s @code{action} property (i.e., invoke it). If | 4477 | Call @var{button}'s @code{action} property (i.e., invoke it). If |
| 4520 | @var{use-mouse-action} is non-@code{nil}, try to invoke the button's | 4478 | @var{use-mouse-action} is non-@code{nil}, try to invoke the button's |
| 4521 | @code{mouse-action} property instead of @code{action}; if the button | 4479 | @code{mouse-action} property instead of @code{action}; if the button |
| @@ -4523,38 +4481,31 @@ has no @code{mouse-action} property, use @code{action} as normal. | |||
| 4523 | @end defun | 4481 | @end defun |
| 4524 | 4482 | ||
| 4525 | @defun button-label button | 4483 | @defun button-label button |
| 4526 | @tindex button-label | ||
| 4527 | Return @var{button}'s text label. | 4484 | Return @var{button}'s text label. |
| 4528 | @end defun | 4485 | @end defun |
| 4529 | 4486 | ||
| 4530 | @defun button-type button | 4487 | @defun button-type button |
| 4531 | @tindex button-type | ||
| 4532 | Return @var{button}'s button-type. | 4488 | Return @var{button}'s button-type. |
| 4533 | @end defun | 4489 | @end defun |
| 4534 | 4490 | ||
| 4535 | @defun button-has-type-p button type | 4491 | @defun button-has-type-p button type |
| 4536 | @tindex button-has-type-p | ||
| 4537 | Return @code{t} if @var{button} has button-type @var{type}, or one of | 4492 | Return @code{t} if @var{button} has button-type @var{type}, or one of |
| 4538 | @var{type}'s subtypes. | 4493 | @var{type}'s subtypes. |
| 4539 | @end defun | 4494 | @end defun |
| 4540 | 4495 | ||
| 4541 | @defun button-at pos | 4496 | @defun button-at pos |
| 4542 | @tindex button-at | ||
| 4543 | Return the button at position @var{pos} in the current buffer, or @code{nil}. | 4497 | Return the button at position @var{pos} in the current buffer, or @code{nil}. |
| 4544 | @end defun | 4498 | @end defun |
| 4545 | 4499 | ||
| 4546 | @defun button-type-put type prop val | 4500 | @defun button-type-put type prop val |
| 4547 | @tindex button-type-put | ||
| 4548 | Set the button-type @var{type}'s @var{prop} property to @var{val}. | 4501 | Set the button-type @var{type}'s @var{prop} property to @var{val}. |
| 4549 | @end defun | 4502 | @end defun |
| 4550 | 4503 | ||
| 4551 | @defun button-type-get type prop | 4504 | @defun button-type-get type prop |
| 4552 | @tindex button-type-get | ||
| 4553 | Get the property of button-type @var{type} named @var{prop}. | 4505 | Get the property of button-type @var{type} named @var{prop}. |
| 4554 | @end defun | 4506 | @end defun |
| 4555 | 4507 | ||
| 4556 | @defun button-type-subtype-p type supertype | 4508 | @defun button-type-subtype-p type supertype |
| 4557 | @tindex button-type-subtype-p | ||
| 4558 | Return @code{t} if button-type @var{type} is a subtype of @var{supertype}. | 4509 | Return @code{t} if button-type @var{type} is a subtype of @var{supertype}. |
| 4559 | @end defun | 4510 | @end defun |
| 4560 | 4511 | ||
| @@ -4580,7 +4531,6 @@ will also activate the @code{push-button} command. | |||
| 4580 | @xref{Links and Mouse-1}. | 4531 | @xref{Links and Mouse-1}. |
| 4581 | 4532 | ||
| 4582 | @deffn Command push-button &optional pos use-mouse-action | 4533 | @deffn Command push-button &optional pos use-mouse-action |
| 4583 | @tindex push-button | ||
| 4584 | Perform the action specified by a button at location @var{pos}. | 4534 | Perform the action specified by a button at location @var{pos}. |
| 4585 | @var{pos} may be either a buffer position or a mouse-event. If | 4535 | @var{pos} may be either a buffer position or a mouse-event. If |
| 4586 | @var{use-mouse-action} is non-@code{nil}, or @var{pos} is a | 4536 | @var{use-mouse-action} is non-@code{nil}, or @var{pos} is a |
| @@ -4594,7 +4544,6 @@ nothing and return @code{nil}, otherwise return @code{t}. | |||
| 4594 | @end deffn | 4544 | @end deffn |
| 4595 | 4545 | ||
| 4596 | @deffn Command forward-button n &optional wrap display-message | 4546 | @deffn Command forward-button n &optional wrap display-message |
| 4597 | @tindex forward-button | ||
| 4598 | Move to the @var{n}th next button, or @var{n}th previous button if | 4547 | Move to the @var{n}th next button, or @var{n}th previous button if |
| 4599 | @var{n} is negative. If @var{n} is zero, move to the start of any | 4548 | @var{n} is negative. If @var{n} is zero, move to the start of any |
| 4600 | button at point. If @var{wrap} is non-@code{nil}, moving past either | 4549 | button at point. If @var{wrap} is non-@code{nil}, moving past either |
| @@ -4605,7 +4554,6 @@ is skipped over. Returns the button found. | |||
| 4605 | @end deffn | 4554 | @end deffn |
| 4606 | 4555 | ||
| 4607 | @deffn Command backward-button n &optional wrap display-message | 4556 | @deffn Command backward-button n &optional wrap display-message |
| 4608 | @tindex backward-button | ||
| 4609 | Move to the @var{n}th previous button, or @var{n}th next button if | 4557 | Move to the @var{n}th previous button, or @var{n}th next button if |
| 4610 | @var{n} is negative. If @var{n} is zero, move to the start of any | 4558 | @var{n} is negative. If @var{n} is zero, move to the start of any |
| 4611 | button at point. If @var{wrap} is non-@code{nil}, moving past either | 4559 | button at point. If @var{wrap} is non-@code{nil}, moving past either |
| @@ -4616,14 +4564,12 @@ is skipped over. Returns the button found. | |||
| 4616 | @end deffn | 4564 | @end deffn |
| 4617 | 4565 | ||
| 4618 | @defun next-button pos &optional count-current | 4566 | @defun next-button pos &optional count-current |
| 4619 | @tindex next-button | ||
| 4620 | Return the next button after position @var{pos} in the current buffer. | 4567 | Return the next button after position @var{pos} in the current buffer. |
| 4621 | If @var{count-current} is non-@code{nil}, count any button at | 4568 | If @var{count-current} is non-@code{nil}, count any button at |
| 4622 | @var{pos} in the search, instead of starting at the next button. | 4569 | @var{pos} in the search, instead of starting at the next button. |
| 4623 | @end defun | 4570 | @end defun |
| 4624 | 4571 | ||
| 4625 | @defun previous-button pos &optional count-current | 4572 | @defun previous-button pos &optional count-current |
| 4626 | @tindex previous-button | ||
| 4627 | Return the @var{n}th button before position @var{pos} in the current | 4573 | Return the @var{n}th button before position @var{pos} in the current |
| 4628 | buffer. If @var{count-current} is non-@code{nil}, count any button at | 4574 | buffer. If @var{count-current} is non-@code{nil}, count any button at |
| 4629 | @var{pos} in the search, instead of starting at the next button. | 4575 | @var{pos} in the search, instead of starting at the next button. |
| @@ -5216,13 +5162,11 @@ This function stores @var{value} in the extra slot @var{slot} of | |||
| 5216 | @end defun | 5162 | @end defun |
| 5217 | 5163 | ||
| 5218 | @defun describe-display-table display-table | 5164 | @defun describe-display-table display-table |
| 5219 | @tindex describe-display-table | ||
| 5220 | This function displays a description of the display table | 5165 | This function displays a description of the display table |
| 5221 | @var{display-table} in a help buffer. | 5166 | @var{display-table} in a help buffer. |
| 5222 | @end defun | 5167 | @end defun |
| 5223 | 5168 | ||
| 5224 | @deffn Command describe-current-display-table | 5169 | @deffn Command describe-current-display-table |
| 5225 | @tindex describe-current-display-table | ||
| 5226 | This command displays a description of the current display table in a | 5170 | This command displays a description of the current display table in a |
| 5227 | help buffer. | 5171 | help buffer. |
| 5228 | @end deffn | 5172 | @end deffn |
| @@ -5328,7 +5272,6 @@ This glyph is simple. | |||
| 5328 | @end table | 5272 | @end table |
| 5329 | 5273 | ||
| 5330 | @defun create-glyph string | 5274 | @defun create-glyph string |
| 5331 | @tindex create-glyph | ||
| 5332 | This function returns a newly-allocated glyph code which is set up to | 5275 | This function returns a newly-allocated glyph code which is set up to |
| 5333 | display by sending @var{string} to the terminal. | 5276 | display by sending @var{string} to the terminal. |
| 5334 | @end defun | 5277 | @end defun |