This is the stumpwm-dynamic-float Reference Manual, version 2.2.3, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Nov 06 14:59:34 2023 GMT+0.
stumpwm-dynamic-float/stumpwm-dynamic-float.asdstumpwm-dynamic-float/src/package.lispstumpwm-dynamic-float/src/util.lispstumpwm-dynamic-float/src/main.lispstumpwm-dynamic-float/src/gap.lispstumpwm-dynamic-float/src/layout.lispstumpwm-dynamic-float/src/navigation.lispThe main system appears first, followed by any subsystem dependency.
stumpwm-dynamic-floatstumpwm-dynamic-float is an extension to the X window manager "StumpWM". It provides a dynamic-tiling environment based on StumpWM’s floating-group.
Jin-Cheng Guu <jcguu95@gmail.com>
MIT
2.2.3
stumpwm (system).
src (module).
Modules are listed depth-first from the system components tree.
stumpwm-dynamic-float/srcstumpwm-dynamic-float (system).
package.lisp (file).
util.lisp (file).
main.lisp (file).
gap.lisp (file).
layout.lisp (file).
navigation.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
stumpwm-dynamic-float/stumpwm-dynamic-float.asdstumpwm-dynamic-float/src/package.lispstumpwm-dynamic-float/src/util.lispstumpwm-dynamic-float/src/main.lispstumpwm-dynamic-float/src/gap.lispstumpwm-dynamic-float/src/layout.lispstumpwm-dynamic-float/src/navigation.lispstumpwm-dynamic-float/stumpwm-dynamic-float.asdstumpwm-dynamic-float (system).
stumpwm-dynamic-float/src/util.lispsrc (module).
check (function).
location (function).
permute (function).
permute-with-next (function).
sort-logic (function).
stumpwm-dynamic-float/src/main.lispsrc (module).
*new-window-spec-hooks* (special variable).
gnew-dyn-float (function).
gnew-dyn-float-bg (function).
group-add-window (method).
group-button-press (method).
group-delete-window (method).
window-status-make-all-tiled (function).
window-status-make-background (function).
window-status-make-foreground (function).
window-status-make-tiled (function).
window-status-tile-at-point (function).
*default-master-ratio* (special variable).
+1-golden-ratio+ (special variable).
+status-list+ (special variable).
apply-data! (function).
count-tiled (function).
defcommand-window-status (macro).
dfg-data (reader method).
(setf dfg-data) (writer method).
dfg-datum (class).
dfg-datum-height (reader method).
(setf dfg-datum-height) (writer method).
dfg-datum-status (reader method).
(setf dfg-datum-status) (writer method).
dfg-datum-width (reader method).
(setf dfg-datum-width) (writer method).
dfg-datum-window-number (reader method).
(setf dfg-datum-window-number) (writer method).
dfg-datum-x (reader method).
(setf dfg-datum-x) (writer method).
dfg-datum-xwin-id (reader method).
(setf dfg-datum-xwin-id) (writer method).
dfg-datum-y (reader method).
(setf dfg-datum-y) (writer method).
dyn-float-group (class).
dyn-float-group-p (function).
gap-info (reader method).
(setf gap-info) (writer method).
get-dfg-datum (method).
get-xwin-id (method).
get-xwin-with-xwin-id (function).
layout-hist (reader method).
(setf layout-hist) (writer method).
make-dfg-datum (method).
master-ratio (reader method).
(setf master-ratio) (writer method).
new-window-spec (function).
override-internal-with-dfg-datum (function).
sync! (function).
sync-existence (function).
tiled? (function).
update-dfg-data (function).
window-status-change (function).
stumpwm-dynamic-float/src/gap.lispsrc (module).
*default-gap-size* (special variable).
*default-gap-step* (special variable).
gap-decrease (function).
gap-increase (function).
gap-set-default (function).
gap-toggle (function).
defcommand-gap (macro).
gap-effective-p (reader method).
(setf gap-effective-p) (writer method).
gap-info (class).
gap-set (function).
gap-size (reader method).
(setf gap-size) (writer method).
gap-step (reader method).
(setf gap-step) (writer method).
stumpwm-dynamic-float/src/layout.lispsrc (module).
+supported-layouts+ (special variable).
deflayout (macro).
layout-change-next (function).
layout-toggle-fullscreen (function).
master-ratio-decrease (function).
master-ratio-increase (function).
master-ratio-set-default (function).
*default-layout* (special variable).
defcommand-master-ratio (macro).
horizontal (function).
layout-change (function).
layout-current (function).
left-vertical (function).
Packages are listed by definition order.
stumpwm-dynamic-float-groupstumpwm-dynamic-float
stumpwm-dfg
common-lisp.
stumpwm.
*default-gap-size* (special variable).
*default-gap-step* (special variable).
*new-window-spec-hooks* (special variable).
+supported-layouts+ (special variable).
deflayout (macro).
gap-decrease (function).
gap-increase (function).
gap-set-default (function).
gap-toggle (function).
gnew-dyn-float (function).
gnew-dyn-float-bg (function).
layout-change-next (function).
layout-toggle-fullscreen (function).
master-ratio-decrease (function).
master-ratio-increase (function).
master-ratio-set-default (function).
permute-window (function).
permute-window-reverse (function).
window-focus-next (function).
window-focus-prev (function).
window-status-make-all-tiled (function).
window-status-make-background (function).
window-status-make-foreground (function).
window-status-make-tiled (function).
window-status-tile-at-point (function).
*default-layout* (special variable).
*default-master-ratio* (special variable).
+1-golden-ratio+ (special variable).
+status-list+ (special variable).
apply-data! (function).
check (function).
count-tiled (function).
defcommand-gap (macro).
defcommand-master-ratio (macro).
defcommand-window-focus (macro).
defcommand-window-status (macro).
dfg-data (generic reader).
(setf dfg-data) (generic writer).
dfg-datum (class).
dfg-datum-height (generic reader).
(setf dfg-datum-height) (generic writer).
dfg-datum-status (generic reader).
(setf dfg-datum-status) (generic writer).
dfg-datum-width (generic reader).
(setf dfg-datum-width) (generic writer).
dfg-datum-window-number (generic reader).
(setf dfg-datum-window-number) (generic writer).
dfg-datum-x (generic reader).
(setf dfg-datum-x) (generic writer).
dfg-datum-xwin-id (generic reader).
(setf dfg-datum-xwin-id) (generic writer).
dfg-datum-y (generic reader).
(setf dfg-datum-y) (generic writer).
dyn-float-group (class).
dyn-float-group-p (function).
gap-effective-p (generic reader).
(setf gap-effective-p) (generic writer).
gap-info (generic reader).
(setf gap-info) (generic writer).
gap-info (class).
gap-set (function).
gap-size (generic reader).
(setf gap-size) (generic writer).
gap-step (generic reader).
(setf gap-step) (generic writer).
get-dfg-datum (generic function).
get-xwin-id (generic function).
get-xwin-with-xwin-id (function).
horizontal (function).
layout-change (function).
layout-current (function).
layout-hist (generic reader).
(setf layout-hist) (generic writer).
left-vertical (function).
location (function).
make-dfg-datum (generic function).
master-ratio (generic reader).
(setf master-ratio) (generic writer).
new-window-spec (function).
override-internal-with-dfg-datum (function).
permute (function).
permute-tiled-at-point-with-next (function).
permute-with-next (function).
sort-logic (function).
sync! (function).
sync-existence (function).
tiled? (function).
update-dfg-data (function).
window-status-change (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Hooks for specifying spec for new windows satisfying
customizable predicates. For each new window, the hooks are
called one by one by #’NEW-WINDOW-SPEC until it succeeds. For
example, when its value is
(list (cons (lambda (w) (equal 0 (search "[TOP]" (window-title w)))) (list :x 300 :y 300 :height 300 :width 300 :status ’foreground)))
Then all new windows that satisfy the predicate (namely, those
whose titles start with "[TOP]") will be assigned to the
spec.
The macro for STUMPWM-DFG for defining layout. To learn the DSL, consult the examples or read the slots in LET* form. The defined layouts should return a plist (:x x :y y :width width :height height) that describes the geometry of the kth tiled windows among the N of them.
Create a new dynamic floating group named NAME.
Create a new dynamic floating group named NAME in the background.
dyn-float-group) window &key raise &allow-other-keys) ¶stumpwm.
dyn-float-group) button x y (window float-window)) ¶Free the window if it’s pressed at the boarder or with *float-window-modifier*.
stumpwm.
dyn-float-group) (window float-window)) ¶stumpwm.
Renumber and redraw the windows in the internal list using the data in DFG-DATA of the GROUP. Warning: Calling this directly may crashes STUMPWM. It should be called after #’sync-existence.
An adhoc unit tester.
The predicate of dyn-float-group.
A layout where the master is put on the top.
A layout where the master is put on the left.
Similar to the built-in #’position but different.
Generate spec for new windows WINDOW based on the customizable hooks in *NEW-WINDOW-SPEC-HOOKS*. It calls the hooks one by one, and breaks the loop once a predicate is satisfied. NIL is returned if no hook succeeds.
If WINDOW has a nontrivial piece of datum, overwrite the values (x, y, width, height) into the slots of WINDOW internal to StumpWM.
Expect LIST to be a list without repeating elements. Return a new list with X and Y permuted.
Expect RING to be a list with no element being NIL.
Return a binary comparer based on LIST, which dictates the order from small to big. If element is absent, make it the absolutely smallest.
Main function of STUMPWM-DFG.
Sync the existence data between the window list (internal to
STUMPWM) and the DFG-DATA of the GROUP in the following (ordered)
manner:
1. For each window in the internal list, ensure the existence
of its datum in the DFG-DATUM.
2. Remove each datum in the DFG-DATUM that does not correspond to a window in the internal list.
Calculate and update the values (x, y, width, height, window-number) in the DFG-DATA of the GROUP.
dyn-float-group)) ¶dyn-float-group)) ¶The main list of dfg-datum used to
hold the information for redrawing and renumbering
the windows internal to STUMPWM.
dyn-float-group)) ¶dyn-float-group)) ¶Info for gapping.
dyn-float-group)) ¶dyn-float-group)) ¶The list of layout
histories,where the zeroth element is interpreted
as the current layout.
dyn-float-group)) ¶dyn-float-group)) ¶Ratio of the master window takes.
The datum for redrawing and renumbering the windows internal to STUMPWM.
:dfg-datum-xwin-id
:dfg-datum-x
:dfg-datum-y
:dfg-datum-height
:dfg-datum-width
stumpwm.
:dfg-datum-window-number
This slot is special to
stumpwm-dfg. Its possible values are recorded in
*status-list*.
:dfg-datum-status
float-group.
The main list of dfg-datum used to
hold the information for redrawing and renumbering
the windows internal to STUMPWM.
The list of layout
histories,where the zeroth element is interpreted
as the current layout.
(list stumpwm-dynamic-float-group::*default-layout*)
Ratio of the master window takes.
stumpwm-dynamic-float-group::*default-master-ratio*
Info for gapping.
(make-instance (quote stumpwm-dynamic-float-group::gap-info))
The gap size between windows.
stumpwm-dynamic-float-group:*default-gap-size*
The step size taken during gap alternation.
stumpwm-dynamic-float-group:*default-gap-step*
Whether gapping is effective: NON-NIL means effective and NIL means ineffective.
t
| Jump to: | (
A C D F G H L M N O P S T U W |
|---|
| Jump to: | (
A C D F G H L M N O P S T U W |
|---|
| Jump to: | *
+
D G H L M S W X Y |
|---|
| Jump to: | *
+
D G H L M S W X Y |
|---|
| Jump to: | C D F G L M N P S U |
|---|
| Jump to: | C D F G L M N P S U |
|---|