extra/ui/gadgets/labels/labels-docs.factor

   1 USING: ui.gadgets.controls help.markup
   2 help.syntax strings ui.gadgets models ;
   3 IN: ui.gadgets.labels
   4
   5 HELP: label
   6 { $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> } "." } ;
   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
  12 HELP: label-string
  13 { $values { "label" label } { "string" string } }
  14 { $description "Outputs the string currently displayed by the label." } ;
  15
  16 HELP: set-label-string
  17 { $values { "label" label } { "string" string } }
  18 { $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." } ;
  19
  20 HELP: <label-control>
  21 { $values { "model" model } { "gadget" "a new " { $link gadget } } }
  22 { $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." } ;
  23
  24 { label-string set-label-string } related-words
  25 { <label> <label-control> } related-words
  26
  27 ARTICLE: "ui.gadgets.labels" "Label gadgets"
  28 "A label displays a piece of text, either a single line string or an array of line strings."
  29 { $subsection label }
  30 { $subsection <label> }
  31 { $subsection <label-control> }
  32 { $subsection label-string }
  33 { $subsection set-label-string } ;
  34
  35 ABOUT: "ui.gadgets.labels"