]> gitweb.factorcode.org Git - factor.git/blobdiff - basis/ui/render/render-docs.factor
help.markup: adding a $slots word to document slots, use it.
[factor.git] / basis / ui / render / render-docs.factor
index 737a1a63559a63bf39bc5e00ccfb324803276dbb..2c59df783093bfa023eab9434993c4e52e265e5b 100644 (file)
@@ -12,19 +12,19 @@ HELP: draw-gadget*
 
 HELP: gadget
 { $class-description "An object which displays itself on the screen and acts on user input gestures. Gadgets have the following slots:"
-    { $list
-        { { $slot "pref-dim" } " - a cached value for " { $link pref-dim } "; do not read or write this slot directly." }
-        { { $slot "parent" } " - the gadget containing this one, or " { $link f } " if this gadget is not part of the visible gadget hierarchy." }
-        { { $slot "children" } " - a vector of child gadgets. Do not modify this vector directly, instead use " { $link add-gadget } ", " { $link add-gadgets } ", " { $link unparent } " or " { $link clear-gadget } "." }
-        { { $slot "graft-state" } { " - a pair of " { $link boolean } " values that represent the current graft state of the gadget and what its next state will become." } }
-        { { $slot "orientation" } " - an orientation specifier. This slot is used by layout gadgets." }
-        { { $slot "layout-state" } " - stores the layout state of the gadget. Do not read or write this slot directly, instead call " { $link relayout } " and " { $link relayout-1 } " if the gadget needs to be re-laid out." }
-        { { $slot "visible?" } " - a boolean indicating if the gadget should display and receive user input." }
-        { { $slot "root?" } " - if set to " { $link t } ", layout changes in this gadget will not propagate to the gadget's parent." }
-        { { $slot "clipped?" } " - a boolean indicating if clipping will be enabled when drawing this gadget's children." }
-        { { $slot "interior" } " - an implementation of the " { $link "ui-pen-protocol" } }
-        { { $slot "boundary" } " - an implementation of the " { $link "ui-pen-protocol" } }
-        { { $slot "model" } " - a " { $link model } " or " { $link f } "; see " { $link "ui-control-impl" } }
+    { $slots
+        { "pref-dim" { "a cached value for " { $link pref-dim } "; do not read or write this slot directly." } }
+        { "parent" { "the gadget containing this one, or " { $link f } " if this gadget is not part of the visible gadget hierarchy." } }
+        { "children" { "a vector of child gadgets. Do not modify this vector directly, instead use " { $link add-gadget } ", " { $link add-gadgets } ", " { $link unparent } " or " { $link clear-gadget } "." } }
+        { "graft-state" { "a pair of " { $link boolean } " values that represent the current graft state of the gadget and what its next state will become." } }
+        { "orientation" "an orientation specifier. This slot is used by layout gadgets." }
+        { "layout-state" { "stores the layout state of the gadget. Do not read or write this slot directly, instead call " { $link relayout } " and " { $link relayout-1 } " if the gadget needs to be re-laid out." } }
+        { "visible?" "a boolean indicating if the gadget should display and receive user input." }
+        { "root?" { "if set to " { $link t } ", layout changes in this gadget will not propagate to the gadget's parent." } }
+        { "clipped?" "a boolean indicating if clipping will be enabled when drawing this gadget's children." }
+        { "interior" { "an implementation of the " { $link "ui-pen-protocol" } } }
+        { "boundary" { "an implementation of the " { $link "ui-pen-protocol" } } }
+        {  "model" { "a " { $link model } " or " { $link f } "; see " { $link "ui-control-impl" } } }
     }
 "Gadgets subclass the " { $link rect } " class, and thus all instances have " { $slot "loc" } " and " { $slot "dim" } " instances holding their location and dimensions." }
 { $notes