aboutsummaryrefslogtreecommitdiffstats
path: root/lispref/frames.texi
diff options
context:
space:
mode:
authorKaroly Lorentey2006-07-14 05:56:32 +0000
committerKaroly Lorentey2006-07-14 05:56:32 +0000
commit99715bbc447eb633e45ffa23b87284771ce3ac74 (patch)
tree3a8a53dfe3dbdd9f8e36965e9f043eae522d3c0e /lispref/frames.texi
parent556b89447234f15d1784a23dadbfe429464463a8 (diff)
parent763bb2d43615bc3ae816422f965d76d5e1ae4bdd (diff)
downloademacs-99715bbc447eb633e45ffa23b87284771ce3ac74.tar.gz
emacs-99715bbc447eb633e45ffa23b87284771ce3ac74.zip
Merged from emacs@sv.gnu.org.
Patches applied: * emacs@sv.gnu.org/emacs--devo--0--patch-331 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-332 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-333 Merge from gnus--rel--5.10 * emacs@sv.gnu.org/emacs--devo--0--patch-334 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-335 Add note about "link" button-class to etc/TODO * emacs@sv.gnu.org/emacs--devo--0--patch-336 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-337 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-338 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-339 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-340 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-341 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-342 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-343 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-344 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-345 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-346 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-347 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-348 Update for ERC 5.1.3. * emacs@sv.gnu.org/emacs--devo--0--patch-349 Update from CVS * emacs@sv.gnu.org/emacs--devo--0--patch-350 Merge from gnus--rel--5.10 * emacs@sv.gnu.org/gnus--rel--5.10--patch-111 Update from CVS: texi/gnus.texi (Summary Buffer Lines): Fix typo. * emacs@sv.gnu.org/gnus--rel--5.10--patch-112 Update from CVS * emacs@sv.gnu.org/gnus--rel--5.10--patch-113 Merge from emacs--devo--0 * emacs@sv.gnu.org/gnus--rel--5.10--patch-114 Update from CVS git-archimport-id: lorentey@elte.hu--2004/emacs--multi-tty--0--patch-572
Diffstat (limited to 'lispref/frames.texi')
-rw-r--r--lispref/frames.texi69
1 files changed, 33 insertions, 36 deletions
diff --git a/lispref/frames.texi b/lispref/frames.texi
index a433203a93e..6652c0d6eb7 100644
--- a/lispref/frames.texi
+++ b/lispref/frames.texi
@@ -8,10 +8,16 @@
8@chapter Frames 8@chapter Frames
9@cindex frame 9@cindex frame
10 10
11 A @dfn{frame} is a rectangle on the screen that contains one or more 11 In Emacs editing, A @dfn{frame} is a screen object that contains one
12Emacs windows. A frame initially contains a single main window (plus 12or more Emacs windows. It's the kind of object that is called a
13perhaps a minibuffer window), which you can subdivide vertically or 13``window'' in the terminology of graphical environments; but we can't
14horizontally into smaller windows. 14call it a ``window'' here, because Emacs uses that word in a different
15way.
16
17 A frame initially contains a single main window and/or a minibuffer
18window; you can subdivide the main window vertically or horizontally
19into smaller windows. In Emacs Lisp, a @dfn{frame object} is a Lisp
20object that represents a frame on the screen.
15 21
16@cindex terminal frame 22@cindex terminal frame
17 When Emacs runs on a text-only terminal, it starts with one 23 When Emacs runs on a text-only terminal, it starts with one
@@ -107,7 +113,6 @@ frame.
107@end defvar 113@end defvar
108 114
109@defvar after-make-frame-functions 115@defvar after-make-frame-functions
110@tindex after-make-frame-functions
111An abnormal hook run by @code{make-frame} after it creates the frame. 116An abnormal hook run by @code{make-frame} after it creates the frame.
112Each function in @code{after-make-frame-functions} receives one argument, the 117Each function in @code{after-make-frame-functions} receives one argument, the
113frame just created. 118frame just created.
@@ -216,7 +221,6 @@ These functions let you read and change the parameter values of a
216frame. 221frame.
217 222
218@defun frame-parameter frame parameter 223@defun frame-parameter frame parameter
219@tindex frame-parameter
220This function returns the value of the parameter @var{parameter} (a 224This function returns the value of the parameter @var{parameter} (a
221symbol) of @var{frame}. If @var{frame} is @code{nil}, it returns the 225symbol) of @var{frame}. If @var{frame} is @code{nil}, it returns the
222selected frame's parameter. If @var{frame} has no setting for 226selected frame's parameter. If @var{frame} has no setting for
@@ -1553,7 +1557,7 @@ window don't matter; only the frame matters.
1553 1557
1554If @var{header} is non-@code{nil}, the frame title for the box is 1558If @var{header} is non-@code{nil}, the frame title for the box is
1555@samp{Information}, otherwise it is @samp{Question}. The former is used 1559@samp{Information}, otherwise it is @samp{Question}. The former is used
1556for @code{message-box} (@pxref{The Echo Area}). 1560for @code{message-box} (@pxref{message-box}).
1557 1561
1558In some configurations, Emacs cannot display a real dialog box; so 1562In some configurations, Emacs cannot display a real dialog box; so
1559instead it displays the same items in a pop-up menu in the center of the 1563instead it displays the same items in a pop-up menu in the center of the
@@ -1583,7 +1587,6 @@ of the buffer contents), the mouse pointer usually uses the
1583those above) by setting @code{void-text-area-pointer}. 1587those above) by setting @code{void-text-area-pointer}.
1584 1588
1585@defvar void-text-area-pointer 1589@defvar void-text-area-pointer
1586@tindex void-text-area-pointer
1587This variable specifies the mouse pointer style for void text areas. 1590This variable specifies the mouse pointer style for void text areas.
1588These include the areas after the end of a line or below the last line 1591These include the areas after the end of a line or below the last line
1589in the buffer. The default is to use the @code{arrow} (non-text) 1592in the buffer. The default is to use the @code{arrow} (non-text)
@@ -1697,12 +1700,33 @@ and @code{x-set-selection} on MS-Windows support the text data type
1697only; if the clipboard holds other types of data, Emacs treats the 1700only; if the clipboard holds other types of data, Emacs treats the
1698clipboard as empty. 1701clipboard as empty.
1699 1702
1703@cindex scrap support (for Mac OS)
1704On Mac OS, selection-like data transfer between applications is
1705performed through a mechanism called @dfn{scraps}. The clipboard is a
1706particular scrap named @code{com.apple.scrap.clipboard}. Types of scrap
1707data are called @dfn{scrap flavor types}, which are identified by
1708four-char codes such as @code{TEXT}. Emacs associates a selection with
1709a scrap, and a selection type with a scrap flavor type via
1710@code{mac-scrap-name} and @code{mac-ostype} properties, respectively.
1711
1712@example
1713(get 'CLIPBOARD 'mac-scrap-name)
1714 @result{} "com.apple.scrap.clipboard"
1715(get 'com.apple.traditional-mac-plain-text 'mac-ostype)
1716 @result{} "TEXT"
1717@end example
1718
1719Conventionally, selection types for scrap flavor types on Mac OS have
1720the form of @acronym{UTI, Uniform Type Identifier} such as
1721@code{com.apple.traditional-mac-plain-text},
1722@code{public.utf16-plain-text}, and @code{public.file-url}.
1723
1700@defopt x-select-enable-clipboard 1724@defopt x-select-enable-clipboard
1701If this is non-@code{nil}, the Emacs yank functions consult the 1725If this is non-@code{nil}, the Emacs yank functions consult the
1702clipboard before the primary selection, and the kill functions store in 1726clipboard before the primary selection, and the kill functions store in
1703the clipboard as well as the primary selection. Otherwise they do not 1727the clipboard as well as the primary selection. Otherwise they do not
1704access the clipboard at all. The default is @code{nil} on most systems, 1728access the clipboard at all. The default is @code{nil} on most systems,
1705but @code{t} on MS-Windows. 1729but @code{t} on MS-Windows and Mac.
1706@end defopt 1730@end defopt
1707 1731
1708@node Drag and Drop 1732@node Drag and Drop
@@ -1759,7 +1783,6 @@ valid, and what they look like. In some cases, the value depends on the
1759meaning of the term ``selected frame''. 1783meaning of the term ``selected frame''.
1760 1784
1761@defun color-defined-p color &optional frame 1785@defun color-defined-p color &optional frame
1762@tindex color-defined-p
1763This function reports whether a color name is meaningful. It returns 1786This function reports whether a color name is meaningful. It returns
1764@code{t} if so; otherwise, @code{nil}. The argument @var{frame} says 1787@code{t} if so; otherwise, @code{nil}. The argument @var{frame} says
1765which frame's display to ask about; if @var{frame} is omitted or 1788which frame's display to ask about; if @var{frame} is omitted or
@@ -1777,7 +1800,6 @@ and that name is still supported as an alias.
1777@end defun 1800@end defun
1778 1801
1779@defun defined-colors &optional frame 1802@defun defined-colors &optional frame
1780@tindex defined-colors
1781This function returns a list of the color names that are defined 1803This function returns a list of the color names that are defined
1782and supported on frame @var{frame} (default, the selected frame). 1804and supported on frame @var{frame} (default, the selected frame).
1783If @var{frame} does not support colors, the value is @code{nil}. 1805If @var{frame} does not support colors, the value is @code{nil}.
@@ -1788,7 +1810,6 @@ and that name is still supported as an alias.
1788@end defun 1810@end defun
1789 1811
1790@defun color-supported-p color &optional frame background-p 1812@defun color-supported-p color &optional frame background-p
1791@tindex color-supported-p
1792This returns @code{t} if @var{frame} can really display the color 1813This returns @code{t} if @var{frame} can really display the color
1793@var{color} (or at least something close to it). If @var{frame} is 1814@var{color} (or at least something close to it). If @var{frame} is
1794omitted or @code{nil}, the question applies to the selected frame. 1815omitted or @code{nil}, the question applies to the selected frame.
@@ -1802,7 +1823,6 @@ The argument @var{color} must be a valid color name.
1802@end defun 1823@end defun
1803 1824
1804@defun color-gray-p color &optional frame 1825@defun color-gray-p color &optional frame
1805@tindex color-gray-p
1806This returns @code{t} if @var{color} is a shade of gray, as defined on 1826This returns @code{t} if @var{color} is a shade of gray, as defined on
1807@var{frame}'s display. If @var{frame} is omitted or @code{nil}, the 1827@var{frame}'s display. If @var{frame} is omitted or @code{nil}, the
1808question applies to the selected frame. If @var{color} is not a valid 1828question applies to the selected frame. If @var{color} is not a valid
@@ -1810,7 +1830,6 @@ color name, this function returns @code{nil}.
1810@end defun 1830@end defun
1811 1831
1812@defun color-values color &optional frame 1832@defun color-values color &optional frame
1813@tindex color-values
1814@cindex rgb value 1833@cindex rgb value
1815This function returns a value that describes what @var{color} should 1834This function returns a value that describes what @var{color} should
1816ideally look like on @var{frame}. If @var{color} is defined, the 1835ideally look like on @var{frame}. If @var{color} is defined, the
@@ -1870,7 +1889,6 @@ selected frame's terminal; @pxref{Input Focus}). At present, though,
1870the @var{frame} argument has no effect. 1889the @var{frame} argument has no effect.
1871 1890
1872@defun tty-color-define name number &optional rgb frame 1891@defun tty-color-define name number &optional rgb frame
1873@tindex tty-color-define
1874This function associates the color name @var{name} with 1892This function associates the color name @var{name} with
1875color number @var{number} on the terminal. 1893color number @var{number} on the terminal.
1876 1894
@@ -1882,12 +1900,10 @@ Emacs will not know what it looks like.
1882@end defun 1900@end defun
1883 1901
1884@defun tty-color-clear &optional frame 1902@defun tty-color-clear &optional frame
1885@tindex tty-color-clear
1886This function clears the table of defined colors for a text-only terminal. 1903This function clears the table of defined colors for a text-only terminal.
1887@end defun 1904@end defun
1888 1905
1889@defun tty-color-alist &optional frame 1906@defun tty-color-alist &optional frame
1890@tindex tty-color-alist
1891This function returns an alist recording the known colors supported by a 1907This function returns an alist recording the known colors supported by a
1892text-only terminal. 1908text-only terminal.
1893 1909
@@ -1899,7 +1915,6 @@ and blue) that says what the color actually looks like.
1899@end defun 1915@end defun
1900 1916
1901@defun tty-color-approximate rgb &optional frame 1917@defun tty-color-approximate rgb &optional frame
1902@tindex tty-color-approximate
1903This function finds the closest color, among the known colors 1918This function finds the closest color, among the known colors
1904supported for @var{display}, to that described by the rgb value 1919supported for @var{display}, to that described by the rgb value
1905@var{rgb} (a list of color values). The return value is an element of 1920@var{rgb} (a list of color values). The return value is an element of
@@ -1907,7 +1922,6 @@ supported for @var{display}, to that described by the rgb value
1907@end defun 1922@end defun
1908 1923
1909@defun tty-color-translate color &optional frame 1924@defun tty-color-translate color &optional frame
1910@tindex tty-color-translate
1911This function finds the closest color to @var{color} among the known 1925This function finds the closest color to @var{color} among the known
1912colors supported for @var{display} and returns its index (an integer). 1926colors supported for @var{display} and returns its index (an integer).
1913If the name @var{color} is not defined, the value is @code{nil}. 1927If the name @var{color} is not defined, the value is @code{nil}.
@@ -1989,7 +2003,6 @@ refers to the selected frame's display, @pxref{Input Focus}).
1989obtain information about displays. 2003obtain information about displays.
1990 2004
1991@defun display-popup-menus-p &optional display 2005@defun display-popup-menus-p &optional display
1992@tindex display-popup-menus-p
1993This function returns @code{t} if popup menus are supported on 2006This function returns @code{t} if popup menus are supported on
1994@var{display}, @code{nil} if not. Support for popup menus requires that 2007@var{display}, @code{nil} if not. Support for popup menus requires that
1995the mouse be available, since the user cannot choose menu items without 2008the mouse be available, since the user cannot choose menu items without
@@ -1997,7 +2010,6 @@ a mouse.
1997@end defun 2010@end defun
1998 2011
1999@defun display-graphic-p &optional display 2012@defun display-graphic-p &optional display
2000@tindex display-graphic-p
2001@cindex frames, more than one on display 2013@cindex frames, more than one on display
2002@cindex fonts, more than one on display 2014@cindex fonts, more than one on display
2003This function returns @code{t} if @var{display} is a graphic display 2015This function returns @code{t} if @var{display} is a graphic display
@@ -2007,14 +2019,12 @@ false for text-only terminals.
2007@end defun 2019@end defun
2008 2020
2009@defun display-mouse-p &optional display 2021@defun display-mouse-p &optional display
2010@tindex display-mouse-p
2011@cindex mouse, availability 2022@cindex mouse, availability
2012This function returns @code{t} if @var{display} has a mouse available, 2023This function returns @code{t} if @var{display} has a mouse available,
2013@code{nil} if not. 2024@code{nil} if not.
2014@end defun 2025@end defun
2015 2026
2016@defun display-color-p &optional display 2027@defun display-color-p &optional display
2017@tindex display-color-p
2018@findex x-display-color-p 2028@findex x-display-color-p
2019This function returns @code{t} if the screen is a color screen. 2029This function returns @code{t} if the screen is a color screen.
2020It used to be called @code{x-display-color-p}, and that name 2030It used to be called @code{x-display-color-p}, and that name
@@ -2022,14 +2032,12 @@ is still supported as an alias.
2022@end defun 2032@end defun
2023 2033
2024@defun display-grayscale-p &optional display 2034@defun display-grayscale-p &optional display
2025@tindex display-grayscale-p
2026This function returns @code{t} if the screen can display shades of gray. 2035This function returns @code{t} if the screen can display shades of gray.
2027(All color displays can do this.) 2036(All color displays can do this.)
2028@end defun 2037@end defun
2029 2038
2030@defun display-supports-face-attributes-p attributes &optional display 2039@defun display-supports-face-attributes-p attributes &optional display
2031@anchor{Display Face Attribute Testing} 2040@anchor{Display Face Attribute Testing}
2032@tindex display-supports-face-attributes-p
2033This function returns non-@code{nil} if all the face attributes in 2041This function returns non-@code{nil} if all the face attributes in
2034@var{attributes} are supported (@pxref{Face Attributes}). 2042@var{attributes} are supported (@pxref{Face Attributes}).
2035 2043
@@ -2055,7 +2063,6 @@ italic.
2055@end defun 2063@end defun
2056 2064
2057@defun display-selections-p &optional display 2065@defun display-selections-p &optional display
2058@tindex display-selections-p
2059This function returns @code{t} if @var{display} supports selections. 2066This function returns @code{t} if @var{display} supports selections.
2060Windowed displays normally support selections, but they may also be 2067Windowed displays normally support selections, but they may also be
2061supported in some other cases. 2068supported in some other cases.
@@ -2069,36 +2076,30 @@ images, Emacs cannot display a tool bar.
2069@end defun 2076@end defun
2070 2077
2071@defun display-screens &optional display 2078@defun display-screens &optional display
2072@tindex display-screens
2073This function returns the number of screens associated with the display. 2079This function returns the number of screens associated with the display.
2074@end defun 2080@end defun
2075 2081
2076@defun display-pixel-height &optional display 2082@defun display-pixel-height &optional display
2077@tindex display-pixel-height
2078This function returns the height of the screen in pixels. 2083This function returns the height of the screen in pixels.
2079On a character terminal, it gives the height in characters. 2084On a character terminal, it gives the height in characters.
2080@end defun 2085@end defun
2081 2086
2082@defun display-mm-height &optional display 2087@defun display-mm-height &optional display
2083@tindex display-mm-height
2084This function returns the height of the screen in millimeters, 2088This function returns the height of the screen in millimeters,
2085or @code{nil} if Emacs cannot get that information. 2089or @code{nil} if Emacs cannot get that information.
2086@end defun 2090@end defun
2087 2091
2088@defun display-pixel-width &optional display 2092@defun display-pixel-width &optional display
2089@tindex display-pixel-width
2090This function returns the width of the screen in pixels. 2093This function returns the width of the screen in pixels.
2091On a character terminal, it gives the width in characters. 2094On a character terminal, it gives the width in characters.
2092@end defun 2095@end defun
2093 2096
2094@defun display-mm-width &optional display 2097@defun display-mm-width &optional display
2095@tindex display-mm-width
2096This function returns the width of the screen in millimeters, 2098This function returns the width of the screen in millimeters,
2097or @code{nil} if Emacs cannot get that information. 2099or @code{nil} if Emacs cannot get that information.
2098@end defun 2100@end defun
2099 2101
2100@defun display-backing-store &optional display 2102@defun display-backing-store &optional display
2101@tindex display-backing-store
2102This function returns the backing store capability of the display. 2103This function returns the backing store capability of the display.
2103Backing store means recording the pixels of windows (and parts of 2104Backing store means recording the pixels of windows (and parts of
2104windows) that are not exposed, so that when exposed they can be 2105windows) that are not exposed, so that when exposed they can be
@@ -2110,7 +2111,6 @@ when the question is inapplicable to a certain kind of display.
2110@end defun 2111@end defun
2111 2112
2112@defun display-save-under &optional display 2113@defun display-save-under &optional display
2113@tindex display-save-under
2114This function returns non-@code{nil} if the display supports the 2114This function returns non-@code{nil} if the display supports the
2115SaveUnder feature. That feature is used by pop-up windows 2115SaveUnder feature. That feature is used by pop-up windows
2116to save the pixels they obscure, so that they can pop down 2116to save the pixels they obscure, so that they can pop down
@@ -2118,14 +2118,12 @@ quickly.
2118@end defun 2118@end defun
2119 2119
2120@defun display-planes &optional display 2120@defun display-planes &optional display
2121@tindex display-planes
2122This function returns the number of planes the display supports. 2121This function returns the number of planes the display supports.
2123This is typically the number of bits per pixel. 2122This is typically the number of bits per pixel.
2124For a tty display, it is log to base two of the number of colors supported. 2123For a tty display, it is log to base two of the number of colors supported.
2125@end defun 2124@end defun
2126 2125
2127@defun display-visual-class &optional display 2126@defun display-visual-class &optional display
2128@tindex display-visual-class
2129This function returns the visual class for the screen. The value is one 2127This function returns the visual class for the screen. The value is one
2130of the symbols @code{static-gray}, @code{gray-scale}, 2128of the symbols @code{static-gray}, @code{gray-scale},
2131@code{static-color}, @code{pseudo-color}, @code{true-color}, and 2129@code{static-color}, @code{pseudo-color}, @code{true-color}, and
@@ -2133,7 +2131,6 @@ of the symbols @code{static-gray}, @code{gray-scale},
2133@end defun 2131@end defun
2134 2132
2135@defun display-color-cells &optional display 2133@defun display-color-cells &optional display
2136@tindex display-color-cells
2137This function returns the number of color cells the screen supports. 2134This function returns the number of color cells the screen supports.
2138@end defun 2135@end defun
2139 2136