The stumpwm-dynamic-float Reference Manual

Table of Contents

The stumpwm-dynamic-float Reference Manual

This is the stumpwm-dynamic-float Reference Manual, version 2.2.2, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 06:11:54 2022 GMT+0.

1 Systems

The main system appears first, followed by any subsystem dependency.

1.1 stumpwm-dynamic-float

Author

Jin-Cheng Guu <jcguu95@gmail.com>

License

MIT

Description

stumpwm-dynamic-float is an extension to the X window manager "StumpWM". It provides a dynamic-tiling environment based on StumpWM’s floating-group.

Version

2.2.2

Dependency

stumpwm

Source

stumpwm-dynamic-float.asd (file)

Component

src (module)

2 Modules

Modules are listed depth-first from the system components tree.

2.1 stumpwm-dynamic-float/src

Parent

stumpwm-dynamic-float (system)

Location

src/

Components

• package.lisp (file)
• util.lisp (file)
• main.lisp (file)
• gap.lisp (file)
• layout.lisp (file)
• navigation.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 stumpwm-dynamic-float.asd

Location

stumpwm-dynamic-float.asd

Systems

stumpwm-dynamic-float (system)

3.1.2 stumpwm-dynamic-float/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

stumpwm-dynamic-float-group

3.1.3 stumpwm-dynamic-float/src/util.lisp

Parent

src (module)

Location

src/util.lisp

Internal Definitions

• check (function)
• location (function)
• permute (function)
• permute-with-next (function)
• sort-logic (function)

3.1.4 stumpwm-dynamic-float/src/main.lisp

Parent

src (module)

Location

src/main.lisp

Exported Definitions

• *new-window-spec-hooks* (special variable)
• gnew-dyn-float (function)
• gnew-dyn-float-bg (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)

Internal Definitions

• *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 (method)
• (setf dfg-data) (method)
• dfg-datum (class)
• dfg-datum-height (method)
• (setf dfg-datum-height) (method)
• dfg-datum-status (method)
• (setf dfg-datum-status) (method)
• dfg-datum-width (method)
• (setf dfg-datum-width) (method)
• dfg-datum-window-number (method)
• (setf dfg-datum-window-number) (method)
• dfg-datum-x (method)
• (setf dfg-datum-x) (method)
• dfg-datum-xwin-id (method)
• (setf dfg-datum-xwin-id) (method)
• dfg-datum-y (method)
• (setf dfg-datum-y) (method)
• dyn-float-group (class)
• dyn-float-group-p (function)
• gap-info (method)
• (setf gap-info) (method)
• get-dfg-datum (method)
• get-xwin-id (method)
• get-xwin-with-xwin-id (function)
• layout-hist (method)
• (setf layout-hist) (method)
• make-dfg-datum (method)
• master-ratio (method)
• (setf master-ratio) (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)

3.1.5 stumpwm-dynamic-float/src/gap.lisp

Parent

src (module)

Location

src/gap.lisp

Exported Definitions

• *default-gap-size* (special variable)
• *default-gap-step* (special variable)
• gap-decrease (function)
• gap-increase (function)
• gap-set-default (function)
• gap-toggle (function)

Internal Definitions

• defcommand-gap (macro)
• gap-effective-p (method)
• (setf gap-effective-p) (method)
• gap-info (class)
• gap-set (function)
• gap-size (method)
• (setf gap-size) (method)
• gap-step (method)
• (setf gap-step) (method)

3.1.6 stumpwm-dynamic-float/src/layout.lisp

Parent

src (module)

Location

src/layout.lisp

Exported Definitions

• +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)

Internal Definitions

• *default-layout* (special variable)
• defcommand-master-ratio (macro)
• horizontal (function)
• layout-change (function)
• layout-current (function)
• left-vertical (function)

3.1.7 stumpwm-dynamic-float/src/navigation.lisp

Parent

src (module)

Location

src/navigation.lisp

Exported Definitions

• permute-window (function)
• permute-window-reverse (function)
• window-focus-next (function)
• window-focus-prev (function)

Internal Definitions

• defcommand-window-focus (macro)
• permute-tiled-at-point-with-next (function)

4 Packages

Packages are listed by definition order.

4.1 stumpwm-dynamic-float-group

Source

package.lisp (file)

Nicknames

• stumpwm-dynamic-float
• stumpwm-dfg

Use List

• stumpwm
• common-lisp

Exported Definitions

• *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)

Internal Definitions

• *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 function)
• dfg-data (method)
• (setf dfg-data) (method)
• (setf dfg-data) (generic function)
• dfg-datum (class)
• dfg-datum-height (generic function)
• dfg-datum-height (method)
• (setf dfg-datum-height) (method)
• (setf dfg-datum-height) (generic function)
• dfg-datum-status (generic function)
• dfg-datum-status (method)
• (setf dfg-datum-status) (method)
• (setf dfg-datum-status) (generic function)
• dfg-datum-width (generic function)
• dfg-datum-width (method)
• (setf dfg-datum-width) (method)
• (setf dfg-datum-width) (generic function)
• dfg-datum-window-number (generic function)
• dfg-datum-window-number (method)
• (setf dfg-datum-window-number) (method)
• (setf dfg-datum-window-number) (generic function)
• dfg-datum-x (generic function)
• dfg-datum-x (method)
• (setf dfg-datum-x) (method)
• (setf dfg-datum-x) (generic function)
• dfg-datum-xwin-id (generic function)
• dfg-datum-xwin-id (method)
• (setf dfg-datum-xwin-id) (method)
• (setf dfg-datum-xwin-id) (generic function)
• dfg-datum-y (generic function)
• dfg-datum-y (method)
• (setf dfg-datum-y) (method)
• (setf dfg-datum-y) (generic function)
• dyn-float-group (class)
• dyn-float-group-p (function)
• gap-effective-p (generic function)
• gap-effective-p (method)
• (setf gap-effective-p) (method)
• (setf gap-effective-p) (generic function)
• gap-info (generic function)
• gap-info (method)
• (setf gap-info) (method)
• (setf gap-info) (generic function)
• gap-info (class)
• gap-set (function)
• gap-size (generic function)
• gap-size (method)
• (setf gap-size) (method)
• (setf gap-size) (generic function)
• gap-step (generic function)
• gap-step (method)
• (setf gap-step) (method)
• (setf gap-step) (generic function)
• get-dfg-datum (generic function)
• get-dfg-datum (method)
• get-xwin-id (generic function)
• get-xwin-id (method)
• get-xwin-with-xwin-id (function)
• horizontal (function)
• layout-change (function)
• layout-current (function)
• layout-hist (generic function)
• layout-hist (method)
• (setf layout-hist) (method)
• (setf layout-hist) (generic function)
• left-vertical (function)
• location (function)
• make-dfg-datum (generic function)
• make-dfg-datum (method)
• master-ratio (generic function)
• master-ratio (method)
• (setf master-ratio) (method)
• (setf master-ratio) (generic function)
• 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)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *default-gap-size*

Package

stumpwm-dynamic-float-group

Source

gap.lisp (file)

Special Variable: *default-gap-step*

Package

stumpwm-dynamic-float-group

Source

gap.lisp (file)

Special Variable: *new-window-spec-hooks*

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.

Package

stumpwm-dynamic-float-group

Source

main.lisp (file)

Special Variable: +supported-layouts+

Package

stumpwm-dynamic-float-group

Source

layout.lisp (file)

5.1.2 Macros

Macro: deflayout NAME DOCSTRING BODY

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.

Package

stumpwm-dynamic-float-group

Source

layout.lisp (file)

5.1.3 Functions

Function: gap-decrease &optional GROUP

Package

stumpwm-dynamic-float-group

Source

gap.lisp (file)

Function: gap-increase &optional GROUP

Package

stumpwm-dynamic-float-group

Source

gap.lisp (file)

Function: gap-set-default &optional GROUP

Package

stumpwm-dynamic-float-group

Source

gap.lisp (file)

Function: gap-toggle &optional GROUP

Package

stumpwm-dynamic-float-group

Source

gap.lisp (file)

Function: gnew-dyn-float NAME &optional BACKGROUND

Create a new dynamic floating group named NAME.

Package

stumpwm-dynamic-float-group

Source

main.lisp (file)

Function: gnew-dyn-float-bg NAME

Create a new dynamic floating group named NAME in the background.

Package

stumpwm-dynamic-float-group

Source

main.lisp (file)

Function: layout-change-next &optional GROUP

Package

stumpwm-dynamic-float-group

Source

layout.lisp (file)

Function: layout-toggle-fullscreen &optional GROUP

Package

stumpwm-dynamic-float-group

Source

layout.lisp (file)

Function: master-ratio-decrease &optional GROUP

Package

stumpwm-dynamic-float-group

Source

layout.lisp (file)

Function: master-ratio-increase &optional GROUP

Package

stumpwm-dynamic-float-group

Source

layout.lisp (file)

Function: master-ratio-set-default &optional GROUP

Package

stumpwm-dynamic-float-group

Source

layout.lisp (file)

Function: permute-window &optional GROUP

Package

stumpwm-dynamic-float-group

Source

navigation.lisp (file)

Function: permute-window-reverse &optional GROUP

Package

stumpwm-dynamic-float-group

Source

navigation.lisp (file)

Function: window-focus-next &optional GROUP

Package

stumpwm-dynamic-float-group

Source

navigation.lisp (file)

Function: window-focus-prev &optional GROUP

Package

stumpwm-dynamic-float-group

Source

navigation.lisp (file)

Function: window-status-make-all-tiled &optional GROUP

Package

stumpwm-dynamic-float-group

Source

main.lisp (file)

Function: window-status-make-background &optional WINDOW GROUP

Package

stumpwm-dynamic-float-group

Source

main.lisp (file)

Function: window-status-make-foreground &optional WINDOW GROUP

Package

stumpwm-dynamic-float-group

Source

main.lisp (file)

Function: window-status-make-tiled &optional WINDOW GROUP

Package

stumpwm-dynamic-float-group

Source

main.lisp (file)

Function: window-status-tile-at-point &optional WINDOW GROUP

Package

stumpwm-dynamic-float-group

Source

main.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *default-layout*

Package

stumpwm-dynamic-float-group

Source

layout.lisp (file)

Special Variable: *default-master-ratio*

Package

stumpwm-dynamic-float-group

Source

main.lisp (file)

Special Variable: +1-golden-ratio+

Package

stumpwm-dynamic-float-group

Source

main.lisp (file)

Special Variable: +status-list+

Package

stumpwm-dynamic-float-group

Source

main.lisp (file)

5.2.2 Macros

Macro: defcommand-gap OPTIONS

Package

stumpwm-dynamic-float-group

Source

gap.lisp (file)

Macro: defcommand-master-ratio OPTIONS

Package

stumpwm-dynamic-float-group

Source

layout.lisp (file)

Macro: defcommand-window-focus OPTIONS

Package

stumpwm-dynamic-float-group

Source

navigation.lisp (file)

Macro: defcommand-window-status OPTIONS

Package

stumpwm-dynamic-float-group

Source

main.lisp (file)

5.2.3 Functions

Function: apply-data! &optional GROUP

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.

Package

stumpwm-dynamic-float-group

Source

main.lisp (file)

Function: check BOOL

An adhoc unit tester.

Package

stumpwm-dynamic-float-group

Source

util.lisp (file)

Function: count-tiled &optional GROUP

Package

stumpwm-dynamic-float-group

Source

main.lisp (file)

Function: dyn-float-group-p GROUP

The predicate of dyn-float-group.

Package

stumpwm-dynamic-float-group

Source

main.lisp (file)

Function: gap-set N &optional GAP? GROUP

Package

stumpwm-dynamic-float-group

Source

gap.lisp (file)

Function: get-xwin-with-xwin-id XWIN-ID &optional GROUP

Package

stumpwm-dynamic-float-group

Source

main.lisp (file)

Function: horizontal _TH AMOUNT-OF-THE-TILED &optional GROUP SCREEN HEAD

A layout where the master is put on the top.

Package

stumpwm-dynamic-float-group

Source

layout.lisp (file)

Function: layout-change LAYOUT &optional GROUP

Package

stumpwm-dynamic-float-group

Source

layout.lisp (file)

Function: layout-current &optional GROUP

Package

stumpwm-dynamic-float-group

Source

layout.lisp (file)

Function: left-vertical _TH AMOUNT-OF-THE-TILED &optional GROUP SCREEN HEAD

A layout where the master is put on the left.

Package

stumpwm-dynamic-float-group

Source

layout.lisp (file)

Function: location X LIST &key SUCH-THAT IDENTIFIER

Similar to the built-in #’position but different.

Package

stumpwm-dynamic-float-group

Source

util.lisp (file)

Function: new-window-spec WINDOW

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.

Package

stumpwm-dynamic-float-group

Source

main.lisp (file)

Function: override-internal-with-dfg-datum WINDOW

If WINDOW has a nontrivial piece of datum, overwrite the values (x, y, width, height) into the slots of WINDOW internal to StumpWM.

Package

stumpwm-dynamic-float-group

Source

main.lisp (file)

Function: permute X Y LIST

Expect LIST to be a list without repeating elements. Return a new list with X and Y permuted.

Package

stumpwm-dynamic-float-group

Source

util.lisp (file)

Function: permute-tiled-at-point-with-next &optional GROUP &key REVERSE

Package

stumpwm-dynamic-float-group

Source

navigation.lisp (file)

Function: permute-with-next X RING &key REVERSE

Expect RING to be a list with no element being NIL.

Package

stumpwm-dynamic-float-group

Source

util.lisp (file)

Function: sort-logic LIST &key TRANSFORMER IDENTIFIER

Return a binary comparer based on LIST, which dictates the order from small to big. If element is absent, make it the absolutely smallest.

Package

stumpwm-dynamic-float-group

Source

util.lisp (file)

Function: sync! &optional GROUP

Main function of STUMPWM-DFG.

Package

stumpwm-dynamic-float-group

Source

main.lisp (file)

Function: sync-existence &optional GROUP

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.

Package

stumpwm-dynamic-float-group

Source

main.lisp (file)

Function: tiled? DFG-DATUM

Package

stumpwm-dynamic-float-group

Source

main.lisp (file)

Function: update-dfg-data &optional GROUP

Calculate and update the values (x, y, width, height, window-number) in the DFG-DATA of the GROUP.

Package

stumpwm-dynamic-float-group

Source

main.lisp (file)

Function: window-status-change STATUS &optional WINDOW GROUP

Package

stumpwm-dynamic-float-group

Source

main.lisp (file)

5.2.4 Generic functions

Generic Function: dfg-data OBJECT

Generic Function: (setf dfg-data) NEW-VALUE OBJECT

Package

stumpwm-dynamic-float-group

Methods

Method: dfg-data (DYN-FLOAT-GROUP dyn-float-group)

Method: (setf dfg-data) NEW-VALUE (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.

Source

main.lisp (file)

Generic Function: dfg-datum-height OBJECT

Generic Function: (setf dfg-datum-height) NEW-VALUE OBJECT

Package

stumpwm-dynamic-float-group

Methods

Method: dfg-datum-height (DFG-DATUM dfg-datum)

automatically generated reader method

Source

main.lisp (file)

Method: (setf dfg-datum-height) NEW-VALUE (DFG-DATUM dfg-datum)

automatically generated writer method

Source

main.lisp (file)

Generic Function: dfg-datum-status OBJECT

Generic Function: (setf dfg-datum-status) NEW-VALUE OBJECT

Package

stumpwm-dynamic-float-group

Methods

Method: dfg-datum-status (DFG-DATUM dfg-datum)

Method: (setf dfg-datum-status) NEW-VALUE (DFG-DATUM dfg-datum)

This slot is special to
stumpwm-dfg. Its possible values are recorded in *status-list*.

Source

main.lisp (file)

Generic Function: dfg-datum-width OBJECT

Generic Function: (setf dfg-datum-width) NEW-VALUE OBJECT

Package

stumpwm-dynamic-float-group

Methods

Method: dfg-datum-width (DFG-DATUM dfg-datum)

automatically generated reader method

Source

main.lisp (file)

Method: (setf dfg-datum-width) NEW-VALUE (DFG-DATUM dfg-datum)

automatically generated writer method

Source

main.lisp (file)

Generic Function: dfg-datum-window-number OBJECT

Generic Function: (setf dfg-datum-window-number) NEW-VALUE OBJECT

Package

stumpwm-dynamic-float-group

Methods

Method: dfg-datum-window-number (DFG-DATUM dfg-datum)

automatically generated reader method

Source

main.lisp (file)

Method: (setf dfg-datum-window-number) NEW-VALUE (DFG-DATUM dfg-datum)

automatically generated writer method

Source

main.lisp (file)

Generic Function: dfg-datum-x OBJECT

Generic Function: (setf dfg-datum-x) NEW-VALUE OBJECT

Package

stumpwm-dynamic-float-group

Methods

Method: dfg-datum-x (DFG-DATUM dfg-datum)

automatically generated reader method

Source

main.lisp (file)

Method: (setf dfg-datum-x) NEW-VALUE (DFG-DATUM dfg-datum)

automatically generated writer method

Source

main.lisp (file)

Generic Function: dfg-datum-xwin-id OBJECT

Generic Function: (setf dfg-datum-xwin-id) NEW-VALUE OBJECT

Package

stumpwm-dynamic-float-group

Methods

Method: dfg-datum-xwin-id (DFG-DATUM dfg-datum)

automatically generated reader method

Source

main.lisp (file)

Method: (setf dfg-datum-xwin-id) NEW-VALUE (DFG-DATUM dfg-datum)

automatically generated writer method

Source

main.lisp (file)

Generic Function: dfg-datum-y OBJECT

Generic Function: (setf dfg-datum-y) NEW-VALUE OBJECT

Package

stumpwm-dynamic-float-group

Methods

Method: dfg-datum-y (DFG-DATUM dfg-datum)

automatically generated reader method

Source

main.lisp (file)

Method: (setf dfg-datum-y) NEW-VALUE (DFG-DATUM dfg-datum)

automatically generated writer method

Source

main.lisp (file)

Generic Function: gap-effective-p OBJECT

Generic Function: (setf gap-effective-p) NEW-VALUE OBJECT

Package

stumpwm-dynamic-float-group

Methods

Method: gap-effective-p (GAP-INFO gap-info)

Method: (setf gap-effective-p) NEW-VALUE (GAP-INFO gap-info)

Whether gapping is effective: NON-NIL means effective and NIL means ineffective.

Source

gap.lisp (file)

Generic Function: gap-info OBJECT

Generic Function: (setf gap-info) NEW-VALUE OBJECT

Package

stumpwm-dynamic-float-group

Methods

Method: gap-info (DYN-FLOAT-GROUP dyn-float-group)

Method: (setf gap-info) NEW-VALUE (DYN-FLOAT-GROUP dyn-float-group)

Info for gapping.

Source

main.lisp (file)

Generic Function: gap-size OBJECT

Generic Function: (setf gap-size) NEW-VALUE OBJECT

Package

stumpwm-dynamic-float-group

Methods

Method: gap-size (GAP-INFO gap-info)

Method: (setf gap-size) NEW-VALUE (GAP-INFO gap-info)

The gap size between windows.

Source

gap.lisp (file)

Generic Function: gap-step OBJECT

Generic Function: (setf gap-step) NEW-VALUE OBJECT

Package

stumpwm-dynamic-float-group

Methods

Method: gap-step (GAP-INFO gap-info)

Method: (setf gap-step) NEW-VALUE (GAP-INFO gap-info)

The step size taken during gap alternation.

Source

gap.lisp (file)

Generic Function: get-dfg-datum W &optional GROUP

Package

stumpwm-dynamic-float-group

Methods

Method: get-dfg-datum (W float-window) &optional GROUP

Source

main.lisp (file)

Generic Function: get-xwin-id W

Package

stumpwm-dynamic-float-group

Methods

Method: get-xwin-id (W float-window)

Source

main.lisp (file)

Generic Function: layout-hist OBJECT

Generic Function: (setf layout-hist) NEW-VALUE OBJECT

Package

stumpwm-dynamic-float-group

Methods

Method: layout-hist (DYN-FLOAT-GROUP dyn-float-group)

Method: (setf layout-hist) NEW-VALUE (DYN-FLOAT-GROUP dyn-float-group)

The list of layout
histories,where the zeroth element is interpreted as the current layout.

Source

main.lisp (file)

Generic Function: make-dfg-datum WINDOW

Package

stumpwm-dynamic-float-group

Methods

Method: make-dfg-datum (WINDOW float-window)

It should only be called when a new window is created.

Source

main.lisp (file)

Generic Function: master-ratio OBJECT

Generic Function: (setf master-ratio) NEW-VALUE OBJECT

Package

stumpwm-dynamic-float-group

Methods

Method: master-ratio (DYN-FLOAT-GROUP dyn-float-group)

Method: (setf master-ratio) NEW-VALUE (DYN-FLOAT-GROUP dyn-float-group)

Ratio of the master window takes.

Source

main.lisp (file)

5.2.5 Classes

Class: dfg-datum ()

The datum for redrawing and renumbering the windows internal to STUMPWM.

Package

stumpwm-dynamic-float-group

Source

main.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• dfg-datum-status (method)
• dfg-datum-status (method)
• dfg-datum-window-number (method)
• dfg-datum-window-number (method)
• dfg-datum-width (method)
• dfg-datum-width (method)
• dfg-datum-height (method)
• dfg-datum-height (method)
• dfg-datum-y (method)
• dfg-datum-y (method)
• dfg-datum-x (method)
• dfg-datum-x (method)
• dfg-datum-xwin-id (method)
• dfg-datum-xwin-id (method)

Direct slots

Slot: xwin-id

Initargs

:dfg-datum-xwin-id

Readers

dfg-datum-xwin-id (generic function)

Writers

(setf dfg-datum-xwin-id) (generic function)

Slot: x

Initargs

:dfg-datum-x

Readers

dfg-datum-x (generic function)

Writers

(setf dfg-datum-x) (generic function)

Slot: y

Initargs

:dfg-datum-y

Readers

dfg-datum-y (generic function)

Writers

(setf dfg-datum-y) (generic function)

Slot: height

Initargs

:dfg-datum-height

Readers

dfg-datum-height (generic function)

Writers

(setf dfg-datum-height) (generic function)

Slot: width

Initargs

:dfg-datum-width

Readers

dfg-datum-width (generic function)

Writers

(setf dfg-datum-width) (generic function)

Slot: window-number

Initargs

:dfg-datum-window-number

Readers

dfg-datum-window-number (generic function)

Writers

(setf dfg-datum-window-number) (generic function)

Slot: status

This slot is special to
stumpwm-dfg. Its possible values are recorded in *status-list*.

Initargs

:dfg-datum-status

Readers

dfg-datum-status (generic function)

Writers

(setf dfg-datum-status) (generic function)

Class: dyn-float-group ()

Package

stumpwm-dynamic-float-group

Source

main.lisp (file)

Direct superclasses

float-group (class)

Direct methods

• group-button-press (method)
• group-delete-window (method)
• group-add-window (method)
• gap-info (method)
• gap-info (method)
• master-ratio (method)
• master-ratio (method)
• layout-hist (method)
• layout-hist (method)
• dfg-data (method)
• dfg-data (method)

Direct slots

Slot: dfg-data

The main list of dfg-datum used to
hold the information for redrawing and renumbering the windows internal to STUMPWM.

Readers

dfg-data (generic function)

Writers

(setf dfg-data) (generic function)

Slot: layout-hist

The list of layout
histories,where the zeroth element is interpreted as the current layout.

Initform

(list stumpwm-dynamic-float-group::*default-layout*)

Readers

layout-hist (generic function)

Writers

(setf layout-hist) (generic function)

Slot: master-ratio

Ratio of the master window takes.

Initform

stumpwm-dynamic-float-group::*default-master-ratio*

Readers

master-ratio (generic function)

Writers

(setf master-ratio) (generic function)

Slot: gap-info

Info for gapping.

Initform

(make-instance (quote stumpwm-dynamic-float-group::gap-info))

Readers

gap-info (generic function)

Writers

(setf gap-info) (generic function)

Class: gap-info ()

Package

stumpwm-dynamic-float-group

Source

gap.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• gap-effective-p (method)
• gap-effective-p (method)
• gap-step (method)
• gap-step (method)
• gap-size (method)
• gap-size (method)

Direct slots

Slot: gap-size

The gap size between windows.

Initform

stumpwm-dynamic-float-group:*default-gap-size*

Readers

gap-size (generic function)

Writers

(setf gap-size) (generic function)

Slot: gap-step

The step size taken during gap alternation.

Initform

stumpwm-dynamic-float-group:*default-gap-step*

Readers

gap-step (generic function)

Writers

(setf gap-step) (generic function)

Slot: gap-effective-p

Whether gapping is effective: NON-NIL means effective and NIL means ineffective.

Initform

t

Readers

gap-effective-p (generic function)

Writers

(setf gap-effective-p) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types