diff options
| author | Eli Zaretskii | 2013-10-03 22:10:34 +0300 |
|---|---|---|
| committer | Eli Zaretskii | 2013-10-03 22:10:34 +0300 |
| commit | 981b26a63adc88532c7a39f87c871e98d6a59602 (patch) | |
| tree | 4002cd36b337d28f628f2585e62da7db85d43d4b /doc | |
| parent | ac776dae2e511be5a4241e79b514ad96798e20f3 (diff) | |
| download | emacs-981b26a63adc88532c7a39f87c871e98d6a59602.tar.gz emacs-981b26a63adc88532c7a39f87c871e98d6a59602.zip | |
More updates for documentation.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/ChangeLog | 8 | ||||
| -rw-r--r-- | doc/lispref/frames.texi | 35 | ||||
| -rw-r--r-- | doc/lispref/keymaps.texi | 33 |
3 files changed, 45 insertions, 31 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 2fa3fc13e31..c93f1b7c659 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,3 +1,11 @@ | |||
| 1 | 2013-10-03 Eli Zaretskii <eliz@gnu.org> | ||
| 2 | |||
| 3 | * keymaps.texi (Defining Menus, Mouse Menus, Menu Bar): Modify | ||
| 4 | wording to the effect that menus are supported on TTYs. | ||
| 5 | |||
| 6 | * frames.texi (Pop-Up Menus, Dialog Boxes) | ||
| 7 | (Display Feature Testing): Update for menu support on TTYs. | ||
| 8 | |||
| 1 | 2013-09-22 Xue Fuqiao <xfq.free@gmail.com> | 9 | 2013-09-22 Xue Fuqiao <xfq.free@gmail.com> |
| 2 | 10 | ||
| 3 | * nonascii.texi (Default Coding Systems): Typo fix. | 11 | * nonascii.texi (Default Coding Systems): Typo fix. |
diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi index 370098c8b62..4935534d6eb 100644 --- a/doc/lispref/frames.texi +++ b/doc/lispref/frames.texi | |||
| @@ -1741,8 +1741,10 @@ allows to know if the pointer has been hidden. | |||
| 1741 | @node Pop-Up Menus | 1741 | @node Pop-Up Menus |
| 1742 | @section Pop-Up Menus | 1742 | @section Pop-Up Menus |
| 1743 | 1743 | ||
| 1744 | When using a window system, a Lisp program can pop up a menu so that | 1744 | A Lisp program can pop up a menu so that the user can choose an |
| 1745 | the user can choose an alternative with the mouse. | 1745 | alternative with the mouse. On a text terminal, if the mouse is not |
| 1746 | available, the user can choose an alternative using the keyboard | ||
| 1747 | motion keys---@kbd{C-n}, @kbd{C-p}, or up- and down-arrow keys. | ||
| 1746 | 1748 | ||
| 1747 | @defun x-popup-menu position menu | 1749 | @defun x-popup-menu position menu |
| 1748 | This function displays a pop-up menu and returns an indication of | 1750 | This function displays a pop-up menu and returns an indication of |
| @@ -1763,20 +1765,22 @@ pixels, counting from the top left corner of @var{window}. @var{window} | |||
| 1763 | may be a window or a frame. | 1765 | may be a window or a frame. |
| 1764 | 1766 | ||
| 1765 | If @var{position} is @code{t}, it means to use the current mouse | 1767 | If @var{position} is @code{t}, it means to use the current mouse |
| 1766 | position. If @var{position} is @code{nil}, it means to precompute the | 1768 | position (or the top-left corner of the frame if the mouse is not |
| 1767 | key binding equivalents for the keymaps specified in @var{menu}, | 1769 | available on a text terminal). If @var{position} is @code{nil}, it |
| 1768 | without actually displaying or popping up the menu. | 1770 | means to precompute the key binding equivalents for the keymaps |
| 1771 | specified in @var{menu}, without actually displaying or popping up the | ||
| 1772 | menu. | ||
| 1769 | 1773 | ||
| 1770 | The argument @var{menu} says what to display in the menu. It can be a | 1774 | The argument @var{menu} says what to display in the menu. It can be a |
| 1771 | keymap or a list of keymaps (@pxref{Menu Keymaps}). In this case, the | 1775 | keymap or a list of keymaps (@pxref{Menu Keymaps}). In this case, the |
| 1772 | return value is the list of events corresponding to the user's choice. | 1776 | return value is the list of events corresponding to the user's choice. |
| 1773 | This list has more than one element if the choice occurred in a | 1777 | This list has more than one element if the choice occurred in a |
| 1774 | submenu. (Note that @code{x-popup-menu} does not actually execute the | 1778 | submenu. (Note that @code{x-popup-menu} does not actually execute the |
| 1775 | command bound to that sequence of events.) On toolkits that support | 1779 | command bound to that sequence of events.) On text terminals and |
| 1776 | menu titles, the title is taken from the prompt string of @var{menu} | 1780 | toolkits that support menu titles, the title is taken from the prompt |
| 1777 | if @var{menu} is a keymap, or from the prompt string of the first | 1781 | string of @var{menu} if @var{menu} is a keymap, or from the prompt |
| 1778 | keymap in @var{menu} if it is a list of keymaps (@pxref{Defining | 1782 | string of the first keymap in @var{menu} if it is a list of keymaps |
| 1779 | Menus}). | 1783 | (@pxref{Defining Menus}). |
| 1780 | 1784 | ||
| 1781 | Alternatively, @var{menu} can have the following form: | 1785 | Alternatively, @var{menu} can have the following form: |
| 1782 | 1786 | ||
| @@ -1800,7 +1804,7 @@ cell; this makes a non-selectable menu item. | |||
| 1800 | 1804 | ||
| 1801 | If the user gets rid of the menu without making a valid choice, for | 1805 | If the user gets rid of the menu without making a valid choice, for |
| 1802 | instance by clicking the mouse away from a valid choice or by typing | 1806 | instance by clicking the mouse away from a valid choice or by typing |
| 1803 | keyboard input, then this normally results in a quit and | 1807 | @kbd{C-g}, then this normally results in a quit and |
| 1804 | @code{x-popup-menu} does not return. But if @var{position} is a mouse | 1808 | @code{x-popup-menu} does not return. But if @var{position} is a mouse |
| 1805 | button event (indicating that the user invoked the menu with the | 1809 | button event (indicating that the user invoked the menu with the |
| 1806 | mouse) then no quit occurs and @code{x-popup-menu} returns @code{nil}. | 1810 | mouse) then no quit occurs and @code{x-popup-menu} returns @code{nil}. |
| @@ -1872,7 +1876,8 @@ window don't matter; only the frame matters. | |||
| 1872 | 1876 | ||
| 1873 | If @var{header} is non-@code{nil}, the frame title for the box is | 1877 | If @var{header} is non-@code{nil}, the frame title for the box is |
| 1874 | @samp{Information}, otherwise it is @samp{Question}. The former is used | 1878 | @samp{Information}, otherwise it is @samp{Question}. The former is used |
| 1875 | for @code{message-box} (@pxref{message-box}). | 1879 | for @code{message-box} (@pxref{message-box}). (On text terminals, the |
| 1880 | box title is not displayed.) | ||
| 1876 | 1881 | ||
| 1877 | In some configurations, Emacs cannot display a real dialog box; so | 1882 | In some configurations, Emacs cannot display a real dialog box; so |
| 1878 | instead it displays the same items in a pop-up menu in the center of the | 1883 | instead it displays the same items in a pop-up menu in the center of the |
| @@ -2284,9 +2289,9 @@ obtain information about displays. | |||
| 2284 | 2289 | ||
| 2285 | @defun display-popup-menus-p &optional display | 2290 | @defun display-popup-menus-p &optional display |
| 2286 | This function returns @code{t} if popup menus are supported on | 2291 | This function returns @code{t} if popup menus are supported on |
| 2287 | @var{display}, @code{nil} if not. Support for popup menus requires that | 2292 | @var{display}, @code{nil} if not. Support for popup menus requires |
| 2288 | the mouse be available, since the user cannot choose menu items without | 2293 | that the mouse be available, since the menu is popped up by clicking |
| 2289 | a mouse. | 2294 | the mouse on some portion of the Emacs display. |
| 2290 | @end defun | 2295 | @end defun |
| 2291 | 2296 | ||
| 2292 | @defun display-graphic-p &optional display | 2297 | @defun display-graphic-p &optional display |
diff --git a/doc/lispref/keymaps.texi b/doc/lispref/keymaps.texi index ef020364082..73d869d59fd 100644 --- a/doc/lispref/keymaps.texi +++ b/doc/lispref/keymaps.texi | |||
| @@ -2023,7 +2023,7 @@ which is a string that appears as an element of the keymap. | |||
| 2023 | the menu's commands. Emacs displays the overall prompt string as the | 2023 | the menu's commands. Emacs displays the overall prompt string as the |
| 2024 | menu title in some cases, depending on the toolkit (if any) used for | 2024 | menu title in some cases, depending on the toolkit (if any) used for |
| 2025 | displaying menus.@footnote{It is required for menus which do not use a | 2025 | displaying menus.@footnote{It is required for menus which do not use a |
| 2026 | toolkit, e.g., under MS-DOS.} Keyboard menus also display the | 2026 | toolkit, e.g., on a text terminal.} Keyboard menus also display the |
| 2027 | overall prompt string. | 2027 | overall prompt string. |
| 2028 | 2028 | ||
| 2029 | The easiest way to construct a keymap with a prompt string is to | 2029 | The easiest way to construct a keymap with a prompt string is to |
| @@ -2371,16 +2371,17 @@ if the menu keymap contains a single nested keymap and no other menu | |||
| 2371 | items, the menu shows the contents of the nested keymap directly, not | 2371 | items, the menu shows the contents of the nested keymap directly, not |
| 2372 | as a submenu. | 2372 | as a submenu. |
| 2373 | 2373 | ||
| 2374 | However, if Emacs is compiled without X toolkit support, submenus | 2374 | However, if Emacs is compiled without X toolkit support, or on text |
| 2375 | are not supported. Each nested keymap is shown as a menu item, but | 2375 | terminals, submenus are not supported. Each nested keymap is shown as |
| 2376 | clicking on it does not automatically pop up the submenu. If you wish | 2376 | a menu item, but clicking on it does not automatically pop up the |
| 2377 | to imitate the effect of submenus, you can do that by giving a nested | 2377 | submenu. If you wish to imitate the effect of submenus, you can do |
| 2378 | keymap an item string which starts with @samp{@@}. This causes Emacs | 2378 | that by giving a nested keymap an item string which starts with |
| 2379 | to display the nested keymap using a separate @dfn{menu pane}; the | 2379 | @samp{@@}. This causes Emacs to display the nested keymap using a |
| 2380 | rest of the item string after the @samp{@@} is the pane label. If | 2380 | separate @dfn{menu pane}; the rest of the item string after the |
| 2381 | Emacs is compiled without X toolkit support, menu panes are not used; | 2381 | @samp{@@} is the pane label. If Emacs is compiled without X toolkit |
| 2382 | in that case, a @samp{@@} at the beginning of an item string is | 2382 | support, or if a menu is displayed on a text terminal, menu panes are |
| 2383 | omitted when the menu label is displayed, and has no other effect. | 2383 | not used; in that case, a @samp{@@} at the beginning of an item string |
| 2384 | is omitted when the menu label is displayed, and has no other effect. | ||
| 2384 | 2385 | ||
| 2385 | @node Keyboard Menus | 2386 | @node Keyboard Menus |
| 2386 | @subsection Menus and the Keyboard | 2387 | @subsection Menus and the Keyboard |
| @@ -2485,10 +2486,10 @@ can do it this way: | |||
| 2485 | @subsection The Menu Bar | 2486 | @subsection The Menu Bar |
| 2486 | @cindex menu bar | 2487 | @cindex menu bar |
| 2487 | 2488 | ||
| 2488 | On graphical displays, there is usually a @dfn{menu bar} at the top | 2489 | Emacs usually shows a @dfn{menu bar} at the top of each frame. |
| 2489 | of each frame. @xref{Menu Bars,,,emacs, The GNU Emacs Manual}. Menu | 2490 | @xref{Menu Bars,,,emacs, The GNU Emacs Manual}. Menu bar items are |
| 2490 | bar items are subcommands of the fake ``function key'' | 2491 | subcommands of the fake ``function key'' @code{menu-bar}, as defined |
| 2491 | @code{menu-bar}, as defined in the active keymaps. | 2492 | in the active keymaps. |
| 2492 | 2493 | ||
| 2493 | To add an item to the menu bar, invent a fake ``function key'' of your | 2494 | To add an item to the menu bar, invent a fake ``function key'' of your |
| 2494 | own (let's call it @var{key}), and make a binding for the key sequence | 2495 | own (let's call it @var{key}), and make a binding for the key sequence |
| @@ -2575,7 +2576,7 @@ in Documentation}. | |||
| 2575 | 2576 | ||
| 2576 | A @dfn{tool bar} is a row of clickable icons at the top of a frame, | 2577 | A @dfn{tool bar} is a row of clickable icons at the top of a frame, |
| 2577 | just below the menu bar. @xref{Tool Bars,,,emacs, The GNU Emacs | 2578 | just below the menu bar. @xref{Tool Bars,,,emacs, The GNU Emacs |
| 2578 | Manual}. | 2579 | Manual}. Emacs normally shows a tool bar on graphical displays. |
| 2579 | 2580 | ||
| 2580 | On each frame, the frame parameter @code{tool-bar-lines} controls | 2581 | On each frame, the frame parameter @code{tool-bar-lines} controls |
| 2581 | how many lines' worth of height to reserve for the tool bar. A zero | 2582 | how many lines' worth of height to reserve for the tool bar. A zero |