diff options
| author | Richard M. Stallman | 2005-02-03 07:04:29 +0000 |
|---|---|---|
| committer | Richard M. Stallman | 2005-02-03 07:04:29 +0000 |
| commit | 8dc22b869ee51262cdf08a4d92c7f79e19dc9e9c (patch) | |
| tree | dd88ded524ab555bff92567d435c6398d1a094fc | |
| parent | 16bf330f413566714d4e62a3c515bc3dcecc89fc (diff) | |
| download | emacs-8dc22b869ee51262cdf08a4d92c7f79e19dc9e9c.tar.gz emacs-8dc22b869ee51262cdf08a4d92c7f79e19dc9e9c.zip | |
(Window Frame Parameters): Explain pixel=char on tty.
(Pop-Up Menus): Fix typo.
(Color Names): Explain all types of color names.
Explain color-values on B&W terminal.
(Text Terminal Colors): Explain "rgb values" are lists. Fix arg names.
| -rw-r--r-- | lispref/frames.texi | 63 |
1 files changed, 37 insertions, 26 deletions
diff --git a/lispref/frames.texi b/lispref/frames.texi index 655232a8869..a33c5b356be 100644 --- a/lispref/frames.texi +++ b/lispref/frames.texi | |||
| @@ -310,12 +310,14 @@ The GNU Emacs Manual}. | |||
| 310 | @node Window Frame Parameters | 310 | @node Window Frame Parameters |
| 311 | @subsection Window Frame Parameters | 311 | @subsection Window Frame Parameters |
| 312 | 312 | ||
| 313 | Just what parameters a frame has depends on what display mechanism it | 313 | Just what parameters a frame has depends on what display mechanism it |
| 314 | uses. Here is a table of the parameters that have special meanings in a | 314 | uses. Here is a table of the parameters that have special meanings in a |
| 315 | window frame; of these, @code{name}, @code{title}, @code{height}, | 315 | window frame; of these, @code{name}, @code{title}, @code{height}, |
| 316 | @code{width}, @code{buffer-list} and @code{buffer-predicate} provide | 316 | @code{width}, @code{buffer-list} and @code{buffer-predicate} provide |
| 317 | meaningful information in terminal frames, and @code{tty-color-mode} | 317 | meaningful information in terminal frames, and @code{tty-color-mode} |
| 318 | is meaningful @emph{only} in terminal frames. | 318 | is meaningful @emph{only} in terminal frames. Frame parameter whose |
| 319 | values measured in pixels, when used on text-only terminals, count | ||
| 320 | characters or lines instead. | ||
| 319 | 321 | ||
| 320 | @table @code | 322 | @table @code |
| 321 | @item display | 323 | @item display |
| @@ -1407,7 +1409,7 @@ that it calls @code{x-popup-menu}. Therefore, if you try to implement a | |||
| 1407 | submenu using @code{x-popup-menu}, it cannot work with the menu bar in | 1409 | submenu using @code{x-popup-menu}, it cannot work with the menu bar in |
| 1408 | an integrated fashion. This is why all menu bar submenus are | 1410 | an integrated fashion. This is why all menu bar submenus are |
| 1409 | implemented with menu keymaps within the parent menu, and never with | 1411 | implemented with menu keymaps within the parent menu, and never with |
| 1410 | @code{x-popup-menu}. @xref{Menu Bar}, | 1412 | @code{x-popup-menu}. @xref{Menu Bar}. |
| 1411 | 1413 | ||
| 1412 | If you want a menu bar submenu to have contents that vary, you should | 1414 | If you want a menu bar submenu to have contents that vary, you should |
| 1413 | still use a menu keymap to implement it. To make the contents vary, add | 1415 | still use a menu keymap to implement it. To make the contents vary, add |
| @@ -1586,6 +1588,17 @@ but @code{t} on MS-Windows. | |||
| 1586 | @node Color Names | 1588 | @node Color Names |
| 1587 | @section Color Names | 1589 | @section Color Names |
| 1588 | 1590 | ||
| 1591 | A color name is text (usually in a string) that specifies a color. | ||
| 1592 | Symbolic names such as @samp{black}, @samp{white}, @samp{red}, etc., | ||
| 1593 | are allowed; use @kbd{M-x list-colors-display} to see a list of | ||
| 1594 | defined names. You can also specify colors numerically in forms such | ||
| 1595 | as @samp{#@var{rgb}} and @samp{RGB:@var{r}/@var{g}/@var{b}}, where | ||
| 1596 | @var{r} specifies the red level, @var{g} specifies the green level, | ||
| 1597 | and @var{b} specifies the blue level. You can use either one, two, | ||
| 1598 | three, or four hex digits for @var{r}; then you must use the same | ||
| 1599 | number of hex digits for all @var{g} and @var{b} as well, making | ||
| 1600 | either 3, 6, 9 or 12 hex digits in all. | ||
| 1601 | |||
| 1589 | These functions provide a way to determine which color names are | 1602 | These functions provide a way to determine which color names are |
| 1590 | valid, and what they look like. In some cases, the value depends on the | 1603 | valid, and what they look like. In some cases, the value depends on the |
| 1591 | @dfn{selected frame}, as described below; see @ref{Input Focus}, for the | 1604 | @dfn{selected frame}, as described below; see @ref{Input Focus}, for the |
| @@ -1666,9 +1679,10 @@ If @var{color} is not defined, the value is @code{nil}. | |||
| 1666 | @result{} nil | 1679 | @result{} nil |
| 1667 | @end example | 1680 | @end example |
| 1668 | 1681 | ||
| 1669 | The color values are returned for @var{frame}'s display. If @var{frame} | 1682 | The color values are returned for @var{frame}'s display. If |
| 1670 | is omitted or @code{nil}, the information is returned for the selected | 1683 | @var{frame} is omitted or @code{nil}, the information is returned for |
| 1671 | frame's display. | 1684 | the selected frame's display. If the frame cannot display colors, the |
| 1685 | value is @code{nil}. | ||
| 1672 | 1686 | ||
| 1673 | @findex x-color-values | 1687 | @findex x-color-values |
| 1674 | This function used to be called @code{x-color-values}, | 1688 | This function used to be called @code{x-color-values}, |
| @@ -1701,26 +1715,26 @@ terminal) as an optional argument. We hope in the future to make Emacs | |||
| 1701 | support more than one text-only terminal at one time; then this argument | 1715 | support more than one text-only terminal at one time; then this argument |
| 1702 | will specify which terminal to operate on (the default being the | 1716 | will specify which terminal to operate on (the default being the |
| 1703 | selected frame's terminal; @pxref{Input Focus}). At present, though, | 1717 | selected frame's terminal; @pxref{Input Focus}). At present, though, |
| 1704 | the @var{display} argument has no effect. | 1718 | the @var{frame} argument has no effect. |
| 1705 | 1719 | ||
| 1706 | @defun tty-color-define name number &optional rgb display | 1720 | @defun tty-color-define name number &optional rgb frame |
| 1707 | @tindex tty-color-define | 1721 | @tindex tty-color-define |
| 1708 | This function associates the color name @var{name} with | 1722 | This function associates the color name @var{name} with |
| 1709 | color number @var{number} on the terminal. | 1723 | color number @var{number} on the terminal. |
| 1710 | 1724 | ||
| 1711 | The optional argument @var{rgb}, if specified, is an rgb value; it says | 1725 | The optional argument @var{rgb}, if specified, is an rgb value, a list |
| 1712 | what the color actually looks like. If you do not specify @var{rgb}, | 1726 | of three numbers that specify what what the color actually looks like. |
| 1713 | then this color cannot be used by @code{tty-color-approximate} to | 1727 | If you do not specify @var{rgb}, then this color cannot be used by |
| 1714 | approximate other colors, because Emacs does not know what it looks | 1728 | @code{tty-color-approximate} to approximate other colors, because |
| 1715 | like. | 1729 | Emacs will not know what it looks like. |
| 1716 | @end defun | 1730 | @end defun |
| 1717 | 1731 | ||
| 1718 | @defun tty-color-clear &optional display | 1732 | @defun tty-color-clear &optional frame |
| 1719 | @tindex tty-color-clear | 1733 | @tindex tty-color-clear |
| 1720 | This function clears the table of defined colors for a text-only terminal. | 1734 | This function clears the table of defined colors for a text-only terminal. |
| 1721 | @end defun | 1735 | @end defun |
| 1722 | 1736 | ||
| 1723 | @defun tty-color-alist &optional display | 1737 | @defun tty-color-alist &optional frame |
| 1724 | @tindex tty-color-alist | 1738 | @tindex tty-color-alist |
| 1725 | This function returns an alist recording the known colors supported by a | 1739 | This function returns an alist recording the known colors supported by a |
| 1726 | text-only terminal. | 1740 | text-only terminal. |
| @@ -1728,26 +1742,23 @@ text-only terminal. | |||
| 1728 | Each element has the form @code{(@var{name} @var{number} . @var{rgb})} | 1742 | Each element has the form @code{(@var{name} @var{number} . @var{rgb})} |
| 1729 | or @code{(@var{name} @var{number})}. Here, @var{name} is the color | 1743 | or @code{(@var{name} @var{number})}. Here, @var{name} is the color |
| 1730 | name, @var{number} is the number used to specify it to the terminal. | 1744 | name, @var{number} is the number used to specify it to the terminal. |
| 1731 | If present, @var{rgb} is an rgb value that says what the color | 1745 | If present, @var{rgb} is a list of three color values (for red, green, |
| 1732 | actually looks like. | 1746 | and blue) that says what the color actually looks like. |
| 1733 | @end defun | 1747 | @end defun |
| 1734 | 1748 | ||
| 1735 | @defun tty-color-approximate rgb &optional display | 1749 | @defun tty-color-approximate rgb &optional frame |
| 1736 | @tindex tty-color-approximate | 1750 | @tindex tty-color-approximate |
| 1737 | This function finds the closest color, among the known colors supported | 1751 | This function finds the closest color, among the known colors |
| 1738 | for @var{display}, to that described by the rgb value @var{rgb}. | 1752 | supported for @var{display}, to that described by the rgb value |
| 1739 | The return value is an element of @code{tty-color-alist}. | 1753 | @var{rgb} (a list of color values). The return value is an element of |
| 1754 | @code{tty-color-alist}. | ||
| 1740 | @end defun | 1755 | @end defun |
| 1741 | 1756 | ||
| 1742 | @defun tty-color-translate color &optional display | 1757 | @defun tty-color-translate color &optional frame |
| 1743 | @tindex tty-color-translate | 1758 | @tindex tty-color-translate |
| 1744 | This function finds the closest color to @var{color} among the known | 1759 | This function finds the closest color to @var{color} among the known |
| 1745 | colors supported for @var{display} and returns its index (an integer). | 1760 | colors supported for @var{display} and returns its index (an integer). |
| 1746 | If the name @var{color} is not defined, the value is @code{nil}. | 1761 | If the name @var{color} is not defined, the value is @code{nil}. |
| 1747 | |||
| 1748 | @var{color} can be an X-style @code{"#@var{xxxyyyzzz}"} specification | ||
| 1749 | instead of an actual name. The format | ||
| 1750 | @code{"RGB:@var{xx}/@var{yy}/@var{zz}"} is also supported. | ||
| 1751 | @end defun | 1762 | @end defun |
| 1752 | 1763 | ||
| 1753 | @node Resources | 1764 | @node Resources |