All Manuals > CAPI User Guide and Reference Manual > 21 CAPI Reference Entries

docking-layout-pane-docked-p Accessor

Summary

Used to indicate whether a pane is currently docked in a docking-layout.

Package

capi

Signature

docking-layout-pane-docked-p docking-layout pane &key anywhere => dockedp

(setf docking-layout-pane-docked-p) dockedp docking-layout pane &key anywhere => dockedp

Arguments
docking-layout
An instance of docking-layout or a subclass.
pane
A pane.
anywhere
A boolean.
dockedp
A boolean.
Values
dockedp
A boolean.
Description

The accessor docking-layout-pane-docked-p accesses a boolean indicating whether pane is currently docked.

If anywhere is t, dockedp is true if pane is docked in any member of the Docking Group of docking-layout. If anywhere is nil, dockedp is true only if pane is docked in docking-layout itself. The default value of anywhere is nil.

(setf docking-layout-pane-docked-p) may be used to change the docking state of pane in docking-layout only when pane is dockable in the Docking Group of docking-layout, that is, it was added to the items of any of the docking-layouts in the group.

See also

docking-layout


CAPI User Guide and Reference Manual (Unix version) - 01 Dec 2021 19:32:42