4.2 Redisplay

All Manuals > CAPI User Guide and Reference Manual > 4 General Considerations

4.2 Redisplay

The setting of any CAPI property that should affect the display causes CAPI to redisplay the relevant elements. However, when what is displayed depends on a state which is not a CAPI state, and this state changes, you may need to cause CAPI to redisplay.

For example, you may have a list-panel where the items are some objects, and the print-function generates a string for each object, based on some property of the object (typically a slot value). If that property changes then the display also needs to change, but there is no way for CAPI to know that so you need to tell CAPI explicitly.

A simple way to achieve this is to set a CAPI state which will cause redisplay. For example, doing


(setf (capi:collection-items 
my-pane
) (capi:collection-items 
my-pane
))

leaves my-pane 's items unchanged, but because the value is set CAPI redisplays all of the items. This approach, however, is both computationally expensive when done often with large number of items, and causes flickering on screen that can be avoided.

Instead you can use one of the following functions.

To update specific items in a choice, use redisplay-collection-item.
To update menus and buttons in a window, use redisplay-interface.
To update part of a pinboard-layout, use redraw-pinboard-layout.
To update specific pinboard objects, use redraw-pinboard-object.
In a tree-view, you can also use tree-view-update-item in cases when the update involves moving the child in its parent or completely removing the child.

4.2.1 Atomic redisplay

Often you need several distinct updates to the display to appear simultaneously. For example when you set the text in several elements at the same time, or you set the text of an element and then also set the background. To ensure that multiple updates appear together, wrap the macro with-atomic-redisplay around the updates.

CAPI User Guide and Reference Manual (Windows version) - 3 Aug 2017