7.3 DUIM-Layouts Module

compose-space

Generic function

Summary

Returns the amount of space required for a specified child of a composite pane.

Signature

compose-space pane #key width height => space-req

Arguments

pane: An instance of type <sheet>.
width: An instance of type <integer>>.
height: An instance of type <integer>.

Values

space-req: An instance of type <space-requirement>.

Library

duim-layouts

Module

duim-layouts

Description

Returns the amount of space required for pane, which is a child of a composite pane. During the space composition pass, a composite pane will typically ask each of its children how much space it requires by calling compose-space. They answer by returning instances of <space-requirement>. The composite pane then forms its own space requirement by composing the space requirements of its children according to its own rules for laying out its children.

The value returned by compose-space is an instance of <space-requirement> that represents how much space pane requires.

The width and height arguments are real numbers that the compose-space method for a pane may use as "recommended" values for the width and height of the pane. These are used to drive top-down layout.

This function actually calls do-compose-space to perform the space calculations. Client code may specialize do-compose-space but should not call it. Call compose-space instead.