unmaintained/ui/gadgets/controls/controls-docs.factor

   1 USING: accessors help.markup help.syntax ui.gadgets.buttons
   2 ui.gadgets.editors models ui.gadgets ;
   3 IN: ui.gadgets.controls
   4
   5 HELP: <model-btn>
   6 { $values { "gadget" "the button's label" } { "button" button } }
   7 { $description "Creates an button whose signal updates on clicks.  " } ;
   8
   9 HELP: <model-border-btn>
  10 { $values { "text" "the button's label" } { "button" button } }
  11 { $description "Creates an button whose signal updates on clicks.  " } ;
  12
  13 HELP: <table>
  14 { $values { "model" "values the table is to display" } { "table" table } }
  15 { $description "Creates an " { $link table } } ;
  16
  17 HELP: <table*>
  18 { $values { "table" table } }
  19 { $description "Creates an " { $link table } " with no initial values to display" } ;
  20
  21 HELP: <list>
  22 { $values { "column-model" "values the table is to display" } { "table" table } }
  23 { $description "Creates an " { $link table } " with a val-quot that renders each element as its own row" } ;
  24
  25 HELP: <list*>
  26 { $values { "table" table } }
  27 { $description "Creates an model-list with no initial values to display" } ;
  28
  29 HELP: indexed
  30 { $values { "table" table } }
  31 { $description "Sets the output model of an table to the selected-index, rather than the selected-value" } ;
  32
  33 HELP: <model-field>
  34 { $values { "model" model } { "gadget" model-field } }
  35 { $description "Creates a field with an initial value" } ;
  36
  37 HELP: <model-field*>
  38 { $values { "field" model-field } }
  39 { $description "Creates a field with an empty initial value" } ;
  40
  41 HELP: <empty-field>
  42 { $values { "model" model } { "field" model-field } }
  43 { $description "Creates a field with an empty initial value that switches to another signal on its update" } ;
  44
  45 HELP: <model-editor>
  46 { $values { "model" model } { "gadget" model-field } }
  47 { $description "Creates an editor with an initial value" } ;
  48
  49 HELP: <model-editor*>
  50 { $values { "editor" "an editor" } }
  51 { $description "Creates a editor with an empty initial value" } ;
  52
  53 HELP: <empty-editor>
  54 { $values { "model" model } { "editor" "an editor" } }
  55 { $description "Creates a field with an empty initial value that switches to another signal on its update" } ;
  56
  57 HELP: <model-action-field>
  58 { $values { "field" action-field } }
  59 { $description "Field that updates its model with its contents when the user hits the return key" } ;
  60
  61 HELP: IMG-MODEL-BTN:
  62 { $syntax "IMAGE-MODEL-BTN: filename" }
  63 { $description "Creates a button using a tiff image named as specified found in the icons subdirectory of the vocabulary path" } ;
  64
  65 HELP: IMG-BTN:
  66 { $syntax "[ do-something ] IMAGE-BTN: filename" }
  67 { $description "Creates a button using a tiff image named as specified found in the icons subdirectory of the vocabulary path, calling the specified quotation on click" } ;
  68
  69 HELP: output-model
  70 { $values { "gadget" gadget } { "model" model } }
  71 { $description "Returns the model a gadget uses for output. Often the same as " { $link model>> } } ;