core/ui/gadgets/labelled-gadget.facts

   1 IN: gadgets
   2 USING: help strings ;
   3
   4 HELP: labelled-gadget
   5 { $class-description "A labelled gadget can be created by calling " { $link <labelled-gadget> } "." } ;
   6
   7 HELP: <labelled-gadget>
   8 { $values { "gadget" gadget } { "title" string } { "newgadget" "a new " { $link <labelled-gadget> } } }
   9 { $description "Creates a new " { $link labelled-gadget } " display " { $snippet "gadget" } " with " { $snippet "title" } " on top." } ;
  10
  11 HELP: closable-gadget
  12 { $class-description "A closable gadget displays a title bar with a close box on top of another gadget. Clicking the close box invokes a quotation. Closable gadgets are created by calling " { $link <closable-gadget> } "." } ;
  13
  14 HELP: <closable-gadget>
  15 { $values { "gadget" gadget } { "title" string } { "quot" "a quotation with stack effect " { $snippet "( button -- )" } } }
  16 { $description "Creates a new " { $link closable-gadget } ". Clicking the close box calls " { $snippet "quot" } "." }
  17 { $notes "The quotation can find the " { $link closable-gadget } " instance, or any other parent gadget by calling " { $link find-parent } " with the gadget it receives on the stack." } ;