Generic Function

Summary

Calls a function on each of a layout's children.

Syntax

map-pane-children layout function &key visible test sorted sort-function reverse

Description

map-pane-children applies function to layout 's immediate children. This works only after the layout-description of layout has been parsed, which generally happens just before a window is displayed on the screen. The order in which the children are processed is not necessarily the same order that they are placed into layout 's description.

layout

A layout.

function

A function of one argument, a CAPI pane object.

test

A function of one argument which restricts applicable panes to those satisfying test. The default is identity .

visible

Controls whether the applicable panes are restricted to the visible children of layout . The default is nil .

sort-function

A function of two arguments, both CAPI panes. The default is geometry-coordinates-< .

sorted

A boolean. A non- nil value means process the children in the order sorted by sort-function . The default is nil .

reverse

A boolean. A non- nil value means process the children in reverse order. The default is nil .

Example

(setq column (capi:contain

               (make-instance

                'capi:column-layout

                :children (list

                            (make-instance

                             'capi:title-pane

                             :text "Title 1")

                            (make-instance

                             'capi:title-pane

                             :text "Title 2")

                            (make-instance

                             'capi:title-pane

                             :text "A third title")

                           ))))

(capi:map-pane-children column

  #'(lambda (pane)

     (format t "~&~S: ~S" pane

       (capi:title-pane-text pane))))

See also

layout