]> gitweb.factorcode.org Git - factor.git/blob - extra/ui/gadgets/comboboxes/comboboxes-docs.factor
ui.gadgets.comboboxes: add docs
[factor.git] / extra / ui / gadgets / comboboxes / comboboxes-docs.factor
1 ! Copyright (C) 2023 Your name.
2 ! See https://factorcode.org/license.txt for BSD license.
3 USING: help.markup help.syntax kernel sequences strings ui.gadgets.tables 
4 models ;
5 IN: ui.gadgets.comboboxes
6
7 HELP: <combobox>
8 { $values
9     { "options" { "a " { $link sequence } " of " { $link string } "s" } }
10     { "combobox" object }
11 }
12 { $description "Creates a combo box from a list of strings." } ;
13
14 HELP: combo-table
15 { $class-description "Class that po" } ;
16
17 HELP: combobox
18 { $class-description "The class of comboboxes. The combobox dropdown is a "
19 { $link table } " with clickable elements." } ;
20
21 ARTICLE: "ui.gadgets.comboboxes" "ui.gadgets.comboboxes"
22 "Comboboxes are UI elements that provide a dropdown menu for selecting from a "
23 "list of set options."
24 $nl
25 "Factor comboboxes use the " { $link model } " present in its inherited model "
26 "slot to indicate updates to the combobox label value."
27 ;
28
29 ABOUT: "ui.gadgets.comboboxes"