emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge +popup-define's documentation into :popup setting's

Browse source 
Users are more likely to view :popup's documentation for information on
defining popup rules (they shouldn't be using +popup-define!).
This commit is contained in:
Henrik Lissner 2018-05-26 14:20:23 +02:00
parent dc86b61704
commit 4e2beb8b7e
No known key found for this signature in database
GPG key ID: 5F6C0EA160557395
1 changed files with 21 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

48
modules/ui/popup/autoload.el
View file

@ -5,16 +5,27 @@
;;;###autoload
(def-setting! :popup (condition &optional alist parameters)
"Register a popup rule.
"Define a popup rule.
CONDITION can be a regexp string or a function. See `display-buffer' for a list
of possible entries for ALIST, which tells the display system how to initialize
the popup window. PARAMETERS is an alist of window parameters. See
`+popup-window-parameters' for a list of custom parameters provided by the popup
module.
CONDITION can be a regexp string or a function.
ALIST supports one custom parameter: `size', which will resolve to
`window-height' or `window-width' depending on `side'."
For ALIST, see `display-buffer' and `display-buffer-alist' for a list of
possible entries, which instruct the display system how to initialize the popup
window.
ALIST also supports the `size' parameter, which will be translated to
`window-width' or `window-height' depending on `side'.
PARAMETERS is an alist of window parameters. See `+popup-window-parameters' for
a list of custom parameters provided by the popup module.
If certain attributes/parameters are omitted, the ones from
`+popup-default-alist' and `+popup-default-parameters' will be used.
The buffers of new windows displayed by `pop-to-buffer' and `display-buffer'
will be tested against CONDITION, which is either a) a regexp string (which is
matched against the buffer's name) or b) a function that takes no arguments and
returns a boolean."
`(progn
(+popup-define ,condition ,alist ,parameters)
(when (bound-and-true-p +popup-mode)
@ -23,8 +34,8 @@ ALIST supports one custom parameter: `size', which will resolve to
;;;###autoload
(def-setting! :popups (&rest rules)
"Register multiple popup rules with :popup setting (`doom--set:popup'). For
example:
"Define multiple popup rules. See `doom--set:popup' for the specifications of
each individual rule.
(set! :popups
(\"^ \\*\" '((slot . 1) (vslot . -1) (size . +popup-shrink-to-fit)))
@ -37,23 +48,6 @@ example:
;;;###autoload
(defsubst +popup-define (condition &optional alist parameters)
"Define a popup rule.
The buffers of new windows displayed by `pop-to-buffer' and `display-buffer'
will be tested against CONDITION, which is either a) a regexp string (which is
matched against the buffer's name) or b) a function that takes no arguments and
returns a boolean.
If CONDITION is met, the buffer will be displayed in a popup window with ALIST
and window PARAMETERS. See `display-buffer-alist' for details on what ALIST may
contain and `+popup-window-parameters' for what window parameters that the popup
module supports.
ALIST also supports the `size' parameter, which will be translated to
`window-width' or `window-height' depending on `side'.
If certain attributes/parameters are omitted, the ones from
`+popup-default-alist' and `+popup-default-parameters' will be used."
(declare (indent 1))
(push (if (eq alist :ignore)
(list condition nil)