Generic Function

Summary

The pane-adjusted-offset generic function calculates the offset required to place a pane correctly in a layout.

Package

capi

Signature

pane-adjusted-offset pane adjust available-size actual-size &key &allow-other-keys

Description

This function calculates the offset required by the adjust keyword so that the pane pane is placed correctly within the available space in its parent layout. It is called by all of the layouts that inherit from x-y-adjustable-layout to interpret the values of x-adjust and y-adjust .

Typically the value of adjust will be a keyword or a list of the form ( keyword n ) where n is an integer. These values of adjust are interpreted as by pane-adjusted-position.

However, new methods can accept alternative values for adjust where required and can also add extra keywords. For example, grid-layout allows adjust to be a list of adjust values, and then passes the offset into this list as an additional keyword.

Notes

Only a keyword value for adjust should be supplied when pane is a column-layout or row-layout.

Example

(setq button-panel (make-instance 'capi:button-panel

                                  :items '(1 2 3)))

(capi:pane-adjusted-offset button-panel

                           :center 200 100)

(capi:pane-adjusted-offset button-panel

                           :left 200 100)

(capi:pane-adjusted-offset button-panel

                           :right 200 100)

See also

layout
x-y-adjustable-layout