9.2 hierarchical-list-item<%>

► |  | Mr Lib: Extra GUI Libraries

1 | Aligned Pasteboard
2 | Arrow Toggle Snip
3 | Bitmap Label
4 | Cache-image Snip
5 | Close Icon
6 | Expandable Snip
7 | GIF and Animated GIF Writing
8 | Graphs
9 | Hierarchical List Control
10 | Include Bitmap
11 | Interactive Value Port
12 | Name Message
13 | Path Dialog
14 | Plot
15 | Switchable Button
16 | Image Core
17 | Matrix Snip
18 | Snip Canvases
19 | Syntax Browser
20 | Te X Table
21 | Terminal Window
22 | Acknowledgments
| Index

▼ | 9 | Hierarchical List Control

9.1 | hierarchical-list%
9.2 | hierarchical-list-item<%>
9.3 | hierarchical-list-compound-item<%>
9.4 | Snips in a hierarchical-list% Instance

On this page:

get-editor
is-selected?
select
click-select
user-data
get-clickable-snip
get-allow-selection?
set-allow-selection
get-parent

top ← prev up next →

interface hierarchical-list-item<%> : interface?

Instantiate this interface via new-item.

> method (send a-hierarchical-list-item get-editor) → (is-a?/c text%)

Returns a text-editor buffer whose content is the display representation of the item. In other words, fill in this text editor to set the item’s label.

> method (send a-hierarchical-list-item is-selected?) → boolean?

Reports whether the item is selected.

> method (send a-hierarchical-list-item select on?) → void?
> on? : any/c
> (send a-hierarchical-list-item click-select on?) → void?
> on? : any/c

Calls select or click-select. The on? argument can be #f only if allow-deselect in hierarchical-list% allows it.

> method (send a-hierarchical-list-item user-data) → any/c
> (send a-hierarchical-list-item user-data data) → void?
> data : any/c

Gets/sets arbitrary data associated with the item.

> method (send a-hierarchical-list-item get-clickable-snip)
> → (is-a?/c snip%)

Returns the snip that (when clicked) selects this element the list. This method is intended for use with an automatic test suite.

> method (send a-hierarchical-list-item get-allow-selection?)
> → boolean?
> (send a-hierarchical-list-item set-allow-selection allow?)
> → void?
> allow? : any/c

Gets/sets whether this item is allowed to be selected.

> method (send a-hierarchical-list-item get-parent)
> → (or/c (is-a?/c hierarchical-list-compound-item<%>) #f)

Returns the compound list item that contains the item or #f if none exists.
top ← prev up next →