factor/core/ui/gadgets/incremental.facts

29 lines
1.4 KiB
Plaintext

IN: gadgets
USING: help ;
HELP: incremental
{ $class-description "An incremental layout gadget delegates to a " { $link pack } " and implements an optimization which the relayout operation after adding a child to be done in constant time."
$terpri
"Incremental layout gadgets are created by calling " { $link <incremental> } "."
$terpri
"Children are managed with the " { $link add-incremental } " and " { $link clear-incremental } " words."
$terpri
"Not every " { $link pack } " can use incremental layout, since incremental layout does not support non-default values for " { $link pack-align } ", " { $link pack-fill } ", and " { $link pack-gap } "." } ;
HELP: <incremental>
{ $values { "pack" pack } { "incremental" "a new instance of " { $link incremental } } }
{ $description "Creates a new incremental layout gadget delegating to " { $snippet "pack" } "." }
{ $see-also add-incremental clear-incremental } ;
HELP: add-incremental
{ $values { "gadget" gadget } { "incremental" incremental } }
{ $description "Adds the gadget to the incremental layout and performs relayout immediately in constant time." }
{ $side-effects "incremental" }
{ $see-also add-gadget clear-incremental } ;
HELP: clear-incremental
{ $values { "incremental" incremental } }
{ $description "Removes all gadgets from the incremental layout and performs relayout immediately in constant time." }
{ $side-effects "incremental" }
{ $see-also add-gadget clear-incremental } ;