Generic Function

Summary

Calls a function on each of the descendant panes of a pane.

Package

capi

Signature

map-pane-descendant-children pane function &key visible test reverse leaf-only

Arguments

pane

A CAPI pane.

function

A function of one argument.

visible

A boolean. The default value is nil.

test

A function of one argument, or nil. The default is nil.

reverse

A boolean. The default value is nil.

leaf-only

A generalized boolean. The default value is nil.

Description

The function map-pane-descendant-children applies function to pane 's descendant panes (that is, the children and each of their children recursively), depth first.

If visible is true, then function is applied only to the visible descendant panes.

If test is non-nil, it is a function which is applied first to each descendant pane, and only those for which test returns a true value are then passed to function .

If reverse is non-nil, the order in which the children are processed is reversed.

If leaf-only is true, then function is applied only to those panes which do not have children.

See also

map-pane-children
pane-descendant-child-with-focus
Hierarchy of panes