core/ui/gadgets/labels.facts

   1 IN: gadgets-labels
   2 USING: help strings gadgets models ;
   3
   4 HELP: label
   5 { $class-description "A label displays a piece of text, either a single line string or an array of line strings. Labels are created by calling " { $link <label> } "." }
   6 { $see-also label-string set-label-string <label-control> } ;
   7
   8 HELP: <label>
   9 { $values { "string" string } { "label" "a new " { $link label } } }
  10 { $description "Creates a new " { $link label } " gadget. The string is permitted to contain line breaks." }
  11 { $see-also label-string set-label-string <label-control> } ;
  12
  13 HELP: label-string
  14 { $values { "label" label } { "string" string } }
  15 { $description "Outputs the string currently displayed by the label." } ;
  16
  17 HELP: set-label-string
  18 { $values { "label" label } { "string" string } }
  19 { $description "Sets the string currently displayed by the label. The string is permitted to contain line breaks. After calling this word, you must also call " { $link relayout } " on the label." } ;
  20
  21 HELP: <label-control>
  22 { $values { "model" model } }
  23 { $description "Creates a " { $link control } " which displays the value of " { $snippet "model" } ", which is required to be a string. The label control is automatically updated when the model value changes." } ;