From 3503bf86e24ff2815f4dd5df67bd7c8a17508356 Mon Sep 17 00:00:00 2001 From: Alexander Iljin Date: Sat, 21 Jan 2017 22:58:25 +0300 Subject: [PATCH] ui.render-docs: replace $snippet with $slot --- basis/ui/render/render-docs.factor | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/basis/ui/render/render-docs.factor b/basis/ui/render/render-docs.factor index 8840199313..737a1a6355 100644 --- a/basis/ui/render/render-docs.factor +++ b/basis/ui/render/render-docs.factor @@ -13,20 +13,20 @@ 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 - { { $snippet "pref-dim" } " - a cached value for " { $link pref-dim } "; do not read or write this slot directly." } - { { $snippet "parent" } " - the gadget containing this one, or " { $link f } " if this gadget is not part of the visible gadget hierarchy." } - { { $snippet "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 } "." } - { { $snippet "graft-state" } { " - a pair of " { $link boolean } " values that represent the current graft state of the gadget and what its next state will become." } } - { { $snippet "orientation" } " - an orientation specifier. This slot is used by layout gadgets." } - { { $snippet "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." } - { { $snippet "visible?" } " - a boolean indicating if the gadget should display and receive user input." } - { { $snippet "root?" } " - if set to " { $link t } ", layout changes in this gadget will not propagate to the gadget's parent." } - { { $snippet "clipped?" } " - a boolean indicating if clipping will be enabled when drawing this gadget's children." } - { { $snippet "interior" } " - an implementation of the " { $link "ui-pen-protocol" } } - { { $snippet "boundary" } " - an implementation of the " { $link "ui-pen-protocol" } } - { { $snippet "model" } " - a " { $link model } " or " { $link f } "; see " { $link "ui-control-impl" } } + { { $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" } } } -"Gadgets subclass the " { $link rect } " class, and thus all instances have " { $snippet "loc" } " and " { $snippet "dim" } " instances holding their location and dimensions." } +"Gadgets subclass the " { $link rect } " class, and thus all instances have " { $slot "loc" } " and " { $slot "dim" } " instances holding their location and dimensions." } { $notes "Other classes may inherit from " { $link gadget } " in order to re-implement generic words such as " { $link draw-gadget* } " and " { $link user-input* } ", or to define gestures with " { $link set-gestures } "." } ; @@ -37,10 +37,10 @@ HELP: gl-draw-init ARTICLE: "ui-paint" "Customizing gadget appearance" "The UI carries out the following steps when drawing a gadget:" { $list - { "The " { $link draw-interior } " generic word is called on the value of the " { $snippet "interior" } " slot." } + { "The " { $link draw-interior } " generic word is called on the value of the " { $slot "interior" } " slot." } { "The " { $link draw-gadget* } " generic word is called on the gadget." } { "The gadget's visible children are drawn, determined by calling " { $link visible-children } " on the gadget." } - { "The " { $link draw-boundary } " generic word is called on the value of the " { $snippet "boundary" } " slot." } + { "The " { $link draw-boundary } " generic word is called on the value of the " { $slot "boundary" } " slot." } } "Now, each one of these steps will be covered in detail." { $subsections