aboutsummaryrefslogtreecommitdiffstats
path: root/lisp/frameset.el
diff options
context:
space:
mode:
authorJuanma Barranquero2013-08-08 03:19:11 +0200
committerJuanma Barranquero2013-08-08 03:19:11 +0200
commit3677ffeb2844f86cb0aa2852a1cb495c49ff9f81 (patch)
tree6c0b7e869460d0c29ce415ae845ac07224d75d37 /lisp/frameset.el
parent6585d561aa30fa91135cbd4c145906abd4d66a51 (diff)
downloademacs-3677ffeb2844f86cb0aa2852a1cb495c49ff9f81.tar.gz
emacs-3677ffeb2844f86cb0aa2852a1cb495c49ff9f81.zip
lisp/frameset.el (frameset-restore): Doc fix.
Diffstat (limited to 'lisp/frameset.el')
-rw-r--r--lisp/frameset.el18
1 files changed, 9 insertions, 9 deletions
diff --git a/lisp/frameset.el b/lisp/frameset.el
index ad58a17c840..88fb2634b9d 100644
--- a/lisp/frameset.el
+++ b/lisp/frameset.el
@@ -55,21 +55,21 @@ It contains the following slots, which can be accessed with
55 of the frameset struct. Currently its value is 1. 55 of the frameset struct. Currently its value is 1.
56 timestamp A read-only timestamp, the output of `current-time'. 56 timestamp A read-only timestamp, the output of `current-time'.
57 app A symbol, or a list whose first element is a symbol, which 57 app A symbol, or a list whose first element is a symbol, which
58 identifies the creator of the frameset and related info; 58 identifies the creator of the frameset and related info;
59 for example, desktop.el sets this slot to a list 59 for example, desktop.el sets this slot to a list
60 `(desktop . ,desktop-file-version). 60 `(desktop . ,desktop-file-version).
61 name A string, the name of the frameset instance. 61 name A string, the name of the frameset instance.
62 description A string, a description for user consumption (to show in 62 description A string, a description for user consumption (to show in
63 menus, messages, etc). 63 menus, messages, etc).
64 properties A property list, to store both frameset-specific and 64 properties A property list, to store both frameset-specific and
65 user-defined serializable data. 65 user-defined serializable data.
66 states A list of items (FRAME-PARAMETERS . WINDOW-STATE), in no 66 states A list of items (FRAME-PARAMETERS . WINDOW-STATE), in no
67 particular order. Each item represents a frame to be 67 particular order. Each item represents a frame to be
68 restored. FRAME-PARAMETERS is a frame's parameter alist, 68 restored. FRAME-PARAMETERS is a frame's parameter alist,
69 extracted with (frame-parameters FRAME) and filtered 69 extracted with (frame-parameters FRAME) and filtered
70 through `frameset-filter-params'. 70 through `frameset-filter-params'.
71 WINDOW-STATE is the output of `window-state-get' applied 71 WINDOW-STATE is the output of `window-state-get' applied
72 to the root window of the frame. 72 to the root window of the frame.
73 73
74To avoid collisions, it is recommended that applications wanting to add 74To avoid collisions, it is recommended that applications wanting to add
75private serializable data to `properties' either store all info under a 75private serializable data to `properties' either store all info under a
@@ -969,7 +969,7 @@ For the meaning of FORCE-DISPLAY, see `frameset-restore'."
969;;;###autoload 969;;;###autoload
970(cl-defun frameset-restore (frameset 970(cl-defun frameset-restore (frameset
971 &key predicate filters reuse-frames 971 &key predicate filters reuse-frames
972 force-display force-onscreen) 972 force-display force-onscreen)
973 "Restore a FRAMESET into the current display(s). 973 "Restore a FRAMESET into the current display(s).
974 974
975PREDICATE is a function called with two arguments, the parameter alist 975PREDICATE is a function called with two arguments, the parameter alist
@@ -1009,8 +1009,8 @@ FORCE-ONSCREEN can be:
1009 It must return non-nil to force the frame onscreen, nil otherwise. 1009 It must return non-nil to force the frame onscreen, nil otherwise.
1010 1010
1011Note the timing and scope of the operations described above: REUSE-FRAMES 1011Note the timing and scope of the operations described above: REUSE-FRAMES
1012affects existing frames, FILTERS and FORCE-DISPLAY affect the frame being 1012affects existing frames; PREDICATE, FILTERS and FORCE-DISPLAY affect the frame
1013restored before that happens, and FORCE-ONSCREEN affects the frame once 1013being restored before that happens; and FORCE-ONSCREEN affects the frame once
1014it has been restored. 1014it has been restored.
1015 1015
1016All keyword parameters default to nil." 1016All keyword parameters default to nil."