wrapping

Generic Function

Package: cg

ToC

DocOverview

CGDoc

RelNotes

FAQ

Index

PermutedIndex

Allegro CL version 8.2
Unrevised from 8.1 to 8.2.
8.1 version

wrapping

Arguments: widget

Returns the value of the wrapping property of the argument. wrapping is a property of the following classes:

The meaning is different for up-down-control than for the other classes. The default value is t for static-text and scrolling-static-text and is nil for the others.

The wrapping property cannot be modified on an existing control by calling (setf wrapping). Instead it must be specified by passing the :wrapping initarg to make-instance when creating the control. (When using the inspector to interactively edit controls on a form, the inspector can still make such modifications because it internally recreates the control's window to reflect the change and creates the make-instance form to create the control in the actual application.)

up-down-control

An up-down-control allows the user to change the (typically) numeric value in an editable-text control by clicking on an up arrow or a down arrow displayed on the up-down control. The issue with wrapping is what happens when the user clicks the up arrow when the value is at the top of the range or clicks the down arrow when the value is at the bottom of the range.

If the wrapping property is true, clicking the up arrow when the value is at the top of the range changes the value to the bottom of the range while clicking the down arrow at the bottom changes the value to the top. If wrapping is nil, clicking an arrow when the value is at the extreme of the range has no effect.

static-text and the various button controls

If the wrapping property on one of these controls is true (the default for static-text and scrolling-static-text but not for the others), the text (in the title of the various button controls and the value of static-text controls) is automatically wrapped at spaces as necessary to prevent the text from extending beyond the right edge of the control. If nil, the text is displayed on a single line up to the point where the text is clipped at the right edge of the control. Turning this property off can be useful for a static-text that displays only a single line of text so that a long word that would otherwise be wrapped to the next (unseen) line will instead remain on the first line to be visible up to the point where it is clipped by the right edge of the control.

GTK Note

This property is not supported by the GTK check-box and radio-button widgets. You can, however, add explicit newline characters into the title string, and the text will always wrap there.