1.111.3 Instance variables

list_browser <-> cancel_message: code*

Send on drag-select with up outside browser. Forwarding:

@receiver:	The list_browser object.

list_browser <- dict: dict*

Associated dict object (table of items).

list_browser <- focus_border: bool

If @on (default), the list_browser has the look of a text entry field: an outline with rounded corners, drawn in the class variable accent_colour while it has the keyboard focus. Class browser sets it to @off, as there the list_browser fills the window and the window is its frame: the outline then has square corners and does not show the focus.

list_browser <-> drop_unrenderable: bool

If @on (default @off), a dict_item whose style (see list_browser<-styles) has a font that does not provide all characters of the label is deleted from the list_browser<-dict. This is detected when the item is displayed, so fonts are only loaded for the items that are seen. It is used by the combo box of a text_item to show, e.g., font family names in their own font while omitting symbol fonts.

list_browser <- text_image: text_image

Text_image object used for visualisation of the items. Class text_image is also used by class editor. There are many similarities in the architecture of class editor and class list_browser.

list_browser <-> key_binding: key_binding

A key_binding object that maps typing in the list_browser object to actions. The initial value is an empty table that delegates to the predifined table named list_browser. New functions may be added using:

...
send(LB?key_binding, function, Name, Action)
...

These functions are local to this list_browser.

list_browser <- label_text: markup_text*

Markup text object used to display the list_browser<->label. A label that is not a markup is escaped, so it is shown as is. When @nil, no label is displayed (default). The list_browser<-label_text may be accessed directly, but be aware that the layout of the list_browser (i.e. placement and sizes of the list_browser<-scroll_bar, list_browser<-text_image and list_browser<-label_text) will not be updated automatically.

list_browser <- multiple_selection: bool

When @on, any number of items may be in the selected state. When @off (default), only zero or one item may be selected. This flag has consequences for the way events are processed and the selection is communicated.

See also

list_browser-selection

list_browser <-> open_message: code*

This message is send when the user double-clicks an item or selected an item using the keyboard (see also list_browser->enter). During the execution of this message the graphical<-cursor is switched to the wait cursor. The following arguments are forwarded:

@receiver	The browser or list_browser
@arg1	The dict_item object selected

See also list_browser<->select_message

list_browser <-> popup: popup*

There are two ways to associate a popup with a browser. One is to use list_browser->popup. In this case the popup will only be displayed if the right-down event is detected on an item and @arg1 will be bound to the dict_item object on which the right-down was trapped.

Alternatively, one may attach a popup_gesture using ‘Object graphical->recogniser’. In this case the popup will behave as if it were attached to any graphical object.

See also

class popup

list_browser <-> select_message: code*

If not @nil, this message is sent when the user clicks on an item with the left mouse-button. The following arguments are forwarded:

@receiver:	The (list_)browser
@arg1:	The current list_browser<-selection

See also list_browser<->open_message and list_browser->change_selection.

Defaults: @nil (no message is sent)

See also

list_browser-select_middle_message

list_browser-selection: chain|member:dict_item*

The current selection of the list_browser. If list_browser<->multiple_selection equals @on, this is an (empty) chain of dict_items. If list_browser<->multiple_selection equals @off, this is either @nil or a dict_item.

See also

- list_browser-multiple_selection
- list_browser<-selection

list_browser <- size: characters=size

Set the size of the list browser. The list_browser<->width and list_browser<->height attributes of the size are interpreted in characters of the current font.

To resize in pixel units, please see ListBrowser->_size and ListBrowser->set.

list_browser <- start: int

0-based index number of the first visible dict_item object.

list_browser <- styles: sheet

Sheet object mapping logical style-names onto style objects.