steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

models: Update documentation

db4
Slava Pestov 2009-02-12 01:36:23 -06:00
parent 21d823757f
commit 2e454cb43b
3 changed files with 23 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
basis/models/compose/compose-docs.factor
View File

@ -9,12 +9,17 @@ $nl
{ $examples
"The following code displays a pair of sliders, and an updating label showing their current values:"
{ $code
"USING: models ui.gadgets.labels ui.gadgets.sliders ui.gadgets.panes ;"
": <funny-slider> <x-slider> 100 over set-slider-max ;"
"<funny-slider> <funny-slider> 2array"
"dup make-pile gadget."
"dup [ gadget-model ] map <compose> [ unparse ] <filter>"
"<label-control> gadget."
"USING: models models.compose models.range ui.gadgets"
"ui.gadgets.labels ui.gadgets.packs ui.gadgets.panes"
"ui.gadgets.sliders ;"
""
": <funny-model> ( -- model ) 0 10 0 100 <range> ;"
": <funny-slider> ( model -- slider ) horizontal <slider> ;"
""
"<funny-model> <funny-model> 2array"
"[ <pile> [ horizontal <slider> add-gadget ] reduce gadget. ]"
"[ <compose> [ unparse ] <filter> <label-control> gadget. ]"
"bi"
}
} ;

12
basis/models/delay/delay-docs.factor
View File

@ -7,11 +7,15 @@ HELP: delay
{ $examples
"The following code displays a sliders and a label which is updated half a second after the slider stops changing:"
{ $code
"USING: models ui.gadgets.labels ui.gadgets.sliders ui.gadgets.panes calendar ;"
": <funny-slider>"
" 0 0 0 100 <range> <x-slider> 500 over set-slider-max ;"
"USING: models models.delay models.filter models.range"
"ui.gadgets ui.gadgets.labels ui.gadgets.sliders ui.gadgets.panes"
"math.parser calendar ;"
""
": <funny-slider> ( -- slider )"
" 0 10 0 100 <range> horizontal <slider> ;"
""
"<funny-slider> dup gadget."
"gadget-model 1/2 seconds <delay> [ number>string ] <filter>"
"model>> 1/2 seconds <delay> [ unparse ] <filter>"
"<label-control> gadget."
}
} ;

4
basis/models/range/range-docs.factor
View File

@ -6,6 +6,10 @@ HELP: range
{ $class-description "Range models implement the " { $link "range-model-protocol" } " with real numbers as the minimum, current, maximum, and page size. Range models are created with " { $link <range> } "." }
{ $notes { $link "ui.gadgets.sliders" } " use range models." } ;
HELP: <range>
{ $values { "value" real } { "page" real } { "min" real } { "max" real } { "range" range } }
{ $description "Creates a new " { $link range } " model." } ;
HELP: range-model
{ $values { "range" range } { "model" model } }
{ $description "Outputs a model holding a range model's current value." }