aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard M. Stallman2004-02-17 00:46:17 +0000
committerRichard M. Stallman2004-02-17 00:46:17 +0000
commit0fe5963523fd53826a281f97fd3b19fbec0f93d6 (patch)
tree421c535e21a7bf4ec561282c6049668a702c4ad2
parent7371cef007664b35e4c038dc7056a0568e814486 (diff)
downloademacs-0fe5963523fd53826a281f97fd3b19fbec0f93d6.tar.gz
emacs-0fe5963523fd53826a281f97fd3b19fbec0f93d6.zip
Minor fixes.
(Parameter Access): frame-parameters arg is optional. modify-frame-parameters handles nil for FRAME. (Window Frame Parameters): menu-bar-lines and tool-bar-lines are all-or-nothing for certain toolkits. Mention parameter wait-for-wm. (Frames and Windows): In frame-first-window and frame-selected-window the arg is optional. (Input Focus): In redirect-frame-focus the second arg is optional. (Window System Selections): Mention selection type CLIPBOARD. Mention data-type UTF8_STRING. Mention numbering of cut buffers. (Resources): Describe x-resource-name.
-rw-r--r--lispref/frames.texi61
1 files changed, 40 insertions, 21 deletions
diff --git a/lispref/frames.texi b/lispref/frames.texi
index a9b29332200..02cc1e68f8d 100644
--- a/lispref/frames.texi
+++ b/lispref/frames.texi
@@ -56,7 +56,7 @@ The frame is displayed on an MS-DOS terminal.
56* Input Focus:: Specifying the selected frame. 56* Input Focus:: Specifying the selected frame.
57* Visibility of Frames:: Frames may be visible or invisible, or icons. 57* Visibility of Frames:: Frames may be visible or invisible, or icons.
58* Raising and Lowering:: Raising a frame makes it hide other windows; 58* Raising and Lowering:: Raising a frame makes it hide other windows;
59 lowering it makes the others hide them. 59 lowering it makes the others hide it.
60* Frame Configurations:: Saving the state of all frames. 60* Frame Configurations:: Saving the state of all frames.
61* Mouse Tracking:: Getting events that say when the mouse moves. 61* Mouse Tracking:: Getting events that say when the mouse moves.
62* Mouse Position:: Asking where the mouse is, or moving it. 62* Mouse Position:: Asking where the mouse is, or moving it.
@@ -212,9 +212,10 @@ of @var{frame}. If @var{frame} is @code{nil}, it returns the
212selected frame's parameter. 212selected frame's parameter.
213@end defun 213@end defun
214 214
215@defun frame-parameters frame 215@defun frame-parameters &optional frame
216The function @code{frame-parameters} returns an alist listing all the 216The function @code{frame-parameters} returns an alist listing all the
217parameters of @var{frame} and their values. 217parameters of @var{frame} and their values. If @var{frame} is
218@code{nil} or omitted, this returns the selected frame's parameters
218@end defun 219@end defun
219 220
220@defun modify-frame-parameters frame alist 221@defun modify-frame-parameters frame alist
@@ -222,7 +223,8 @@ This function alters the parameters of frame @var{frame} based on the
222elements of @var{alist}. Each element of @var{alist} has the form 223elements of @var{alist}. Each element of @var{alist} has the form
223@code{(@var{parm} . @var{value})}, where @var{parm} is a symbol naming a 224@code{(@var{parm} . @var{value})}, where @var{parm} is a symbol naming a
224parameter. If you don't mention a parameter in @var{alist}, its value 225parameter. If you don't mention a parameter in @var{alist}, its value
225doesn't change. 226doesn't change. If @var{frame} is @code{nil}, it defaults to the selected
227frame.
226@end defun 228@end defun
227 229
228@defun modify-all-frames-parameters alist 230@defun modify-all-frames-parameters alist
@@ -505,9 +507,8 @@ Display a horizontal bar @var{width} pixels high.
505 507
506@vindex cursor-type 508@vindex cursor-type
507The buffer-local variable @code{cursor-type} overrides the value of 509The buffer-local variable @code{cursor-type} overrides the value of
508the @code{cursor-type} frame parameter, and can in addition have 510the @code{cursor-type} frame parameter, but if it is @code{t}, that
509values @code{t} (use the cursor specified for the frame) and 511means to use the cursor specified for the frame.
510@code{nil} (don't display a cursor).
511 512
512@item border-width 513@item border-width
513The width in pixels of the window border. 514The width in pixels of the window border.
@@ -542,7 +543,7 @@ iconified. @xref{Visibility of Frames}.
542@item menu-bar-lines 543@item menu-bar-lines
543The number of lines to allocate at the top of the frame for a menu bar. 544The number of lines to allocate at the top of the frame for a menu bar.
544The default is 1. @xref{Menu Bar}. (In Emacs versions that use the X 545The default is 1. @xref{Menu Bar}. (In Emacs versions that use the X
545toolkit, there is only one menu bar line; all that matters about the 546toolkit or GTK, there is only one menu bar line; all that matters about the
546number you specify is whether it is greater than zero.) 547number you specify is whether it is greater than zero.)
547 548
548@item screen-gamma 549@item screen-gamma
@@ -566,7 +567,9 @@ results for LCD color displays.
566 567
567@item tool-bar-lines 568@item tool-bar-lines
568The number of lines to use for the toolbar. A value of @code{nil} means 569The number of lines to use for the toolbar. A value of @code{nil} means
569don't display a tool bar. 570don't display a tool bar. (In Emacs versions that use GTK, there is
571only one tool bar line; all that matters about the number you specify
572is whether it is greater than zero.)
570 573
571@item line-spacing 574@item line-spacing
572Additional space put below text lines in pixels (a positive integer). 575Additional space put below text lines in pixels (a positive integer).
@@ -634,6 +637,12 @@ equivalent to the @code{:foreground} attribute of the
634If non-@code{nil}, the color for the background of scroll bars. It is 637If non-@code{nil}, the color for the background of scroll bars. It is
635equivalent to the @code{:background} attribute of the 638equivalent to the @code{:background} attribute of the
636@code{scroll-bar} face. 639@code{scroll-bar} face.
640
641@item wait-for-wm
642If non-@code{nil}, tell Xt to wait for the window manager to confirm
643geometry changes. Some window managers, including versions of Fvwm2
644and KDE, fail to confirm, so Xt hangs. Set this to @code{nil} to
645prevent hanging with those window managers.
637@end table 646@end table
638 647
639@node Size and Position 648@node Size and Position
@@ -909,8 +918,9 @@ upper left corner, down and to the right, until it reaches the window at
909the lower right corner (always the minibuffer window, if the frame has 918the lower right corner (always the minibuffer window, if the frame has
910one), and then it moves back to the top. @xref{Cyclic Window Ordering}. 919one), and then it moves back to the top. @xref{Cyclic Window Ordering}.
911 920
912@defun frame-first-window frame 921@defun frame-first-window &optional frame
913This returns the topmost, leftmost window of frame @var{frame}. 922This returns the topmost, leftmost window of frame @var{frame}.
923If omitted or @code{nil}, @var{frame} defaults to the selected frame.
914@end defun 924@end defun
915 925
916At any time, exactly one window on any frame is @dfn{selected within the 926At any time, exactly one window on any frame is @dfn{selected within the
@@ -918,9 +928,9 @@ frame}. The significance of this designation is that selecting the
918frame also selects this window. You can get the frame's current 928frame also selects this window. You can get the frame's current
919selected window with @code{frame-selected-window}. 929selected window with @code{frame-selected-window}.
920 930
921@defun frame-selected-window frame 931@defun frame-selected-window &optional frame
922This function returns the window on @var{frame} that is selected within 932This function returns the window on @var{frame} that is selected within
923@var{frame}. 933@var{frame}. If omitted or @code{nil}, @var{frame} defaults to the selected frame.
924@end defun 934@end defun
925 935
926@defun set-frame-selected-window frame window 936@defun set-frame-selected-window frame window
@@ -1026,14 +1036,14 @@ Focus events normally do their job by invoking this command.
1026Don't call it for any other reason. 1036Don't call it for any other reason.
1027@end deffn 1037@end deffn
1028 1038
1029@defun redirect-frame-focus frame focus-frame 1039@defun redirect-frame-focus frame &optional focus-frame
1030This function redirects focus from @var{frame} to @var{focus-frame}. 1040This function redirects focus from @var{frame} to @var{focus-frame}.
1031This means that @var{focus-frame} will receive subsequent keystrokes and 1041This means that @var{focus-frame} will receive subsequent keystrokes and
1032events intended for @var{frame}. After such an event, the value of 1042events intended for @var{frame}. After such an event, the value of
1033@code{last-event-frame} will be @var{focus-frame}. Also, switch-frame 1043@code{last-event-frame} will be @var{focus-frame}. Also, switch-frame
1034events specifying @var{frame} will instead select @var{focus-frame}. 1044events specifying @var{frame} will instead select @var{focus-frame}.
1035 1045
1036If @var{focus-frame} is @code{nil}, that cancels any existing 1046If @var{focus-frame} is omitted or @code{nil}, that cancels any existing
1037redirection for @var{frame}, which therefore once again receives its own 1047redirection for @var{frame}, which therefore once again receives its own
1038events. 1048events.
1039 1049
@@ -1458,9 +1468,10 @@ The argument @var{data} may also be a vector of valid non-vector
1458selection values. 1468selection values.
1459 1469
1460Each possible @var{type} has its own selection value, which changes 1470Each possible @var{type} has its own selection value, which changes
1461independently. The usual values of @var{type} are @code{PRIMARY} and 1471independently. The usual values of @var{type} are @code{PRIMARY},
1462@code{SECONDARY}; these are symbols with upper-case names, in accord 1472@code{SECONDARY} and @code{CLIPBOARD}; these are symbols with upper-case
1463with X Window System conventions. The default is @code{PRIMARY}. 1473names, in accord with X Window System conventions. The default is
1474@code{PRIMARY}.
1464@end defun 1475@end defun
1465 1476
1466@defun x-get-selection &optional type data-type 1477@defun x-get-selection &optional type data-type
@@ -1472,6 +1483,7 @@ clients. It takes two optional arguments, @var{type} and
1472The @var{data-type} argument specifies the form of data conversion to 1483The @var{data-type} argument specifies the form of data conversion to
1473use, to convert the raw data obtained from another X client into Lisp 1484use, to convert the raw data obtained from another X client into Lisp
1474data. Meaningful values include @code{TEXT}, @code{STRING}, 1485data. Meaningful values include @code{TEXT}, @code{STRING},
1486@code{UTF8_STRING},
1475@code{TARGETS}, @code{LENGTH}, @code{DELETE}, @code{FILE_NAME}, 1487@code{TARGETS}, @code{LENGTH}, @code{DELETE}, @code{FILE_NAME},
1476@code{CHARACTER_POSITION}, @code{LINE_NUMBER}, @code{COLUMN_NUMBER}, 1488@code{CHARACTER_POSITION}, @code{LINE_NUMBER}, @code{COLUMN_NUMBER},
1477@code{OWNER_OS}, @code{HOST_NAME}, @code{USER}, @code{CLASS}, 1489@code{OWNER_OS}, @code{HOST_NAME}, @code{USER}, @code{CLASS},
@@ -1481,13 +1493,14 @@ upper-case names in accord with X conventions.) The default for
1481@end defun 1493@end defun
1482 1494
1483@cindex cut buffer 1495@cindex cut buffer
1484The X server also has a set of numbered @dfn{cut buffers} which can 1496The X server also has a set of eight numbered @dfn{cut buffers} which can
1485store text or other data being moved between applications. Cut buffers 1497store text or other data being moved between applications. Cut buffers
1486are considered obsolete, but Emacs supports them for the sake of X 1498are considered obsolete, but Emacs supports them for the sake of X
1487clients that still use them. 1499clients that still use them. Cut buffers are numbered from 0 to 7.
1488 1500
1489@defun x-get-cut-buffer n 1501@defun x-get-cut-buffer &optional n
1490This function returns the contents of cut buffer number @var{n}. 1502This function returns the contents of cut buffer number @var{n}.
1503If omitted @var{n} defaults to 0.
1491@end defun 1504@end defun
1492 1505
1493@defun x-set-cut-buffer string &optional push 1506@defun x-set-cut-buffer string &optional push
@@ -1693,7 +1706,7 @@ instead of an actual name. The format
1693 1706
1694@defun x-get-resource attribute class &optional component subclass 1707@defun x-get-resource attribute class &optional component subclass
1695The function @code{x-get-resource} retrieves a resource value from the X 1708The function @code{x-get-resource} retrieves a resource value from the X
1696Windows defaults database. 1709Window defaults database.
1697 1710
1698Resources are indexed by a combination of a @dfn{key} and a @dfn{class}. 1711Resources are indexed by a combination of a @dfn{key} and a @dfn{class}.
1699This function searches using a key of the form 1712This function searches using a key of the form
@@ -1715,6 +1728,12 @@ resources for application names other than ``Emacs'' by binding this
1715variable to some other string, around a call to @code{x-get-resource}. 1728variable to some other string, around a call to @code{x-get-resource}.
1716@end defvar 1729@end defvar
1717 1730
1731@defvar x-resource-name
1732This variable specifies the instance name that @code{x-get-resource}
1733should look up. The default value is the name Emacs was invoked with,
1734or the value specified with the @samp{-name} or @samp{-rn} switches.
1735@end defvar
1736
1718 @xref{X Resources,, X Resources, emacs, The GNU Emacs Manual}. 1737 @xref{X Resources,, X Resources, emacs, The GNU Emacs Manual}.
1719 1738
1720@node Display Feature Testing 1739@node Display Feature Testing