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

models-docs: update documentation

modern-harvey2
Alexander Iljin 2017-06-20 21:50:23 +03:00
parent 5cc07a1c5f
commit df576aa6c3
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
basis/models/models-docs.factor
View File

@ -60,15 +60,19 @@ HELP: remove-connection
{ $values { "observer" object } { "model" model } } { $values { "observer" object } { "model" model } }
{ $contract "Unregisters an object no longer interested in being notified of changes to the model's value." } ; { $contract "Unregisters an object no longer interested in being notified of changes to the model's value." } ;
HELP: update-model
{ $values { "model" model } }
{ $description "Notifies the model that its " { $slot "value" } " slot has been updated by " { $link set-model } "." } ;
HELP: set-model HELP: set-model
{ $values { "value" object } { "model" model } } { $values { "value" object } { "model" model } }
{ $description "Changes the value of a model and calls " { $link model-changed } " on all observers registered with " { $link add-connection } "." } ; { $description "Changes the value of a model, calls " { $link update-model } " to notify it, then calls " { $link model-changed } " on all observers registered with " { $link add-connection } "." } ;
HELP: ?set-model HELP: ?set-model
{ $values { "value" object } { "model" model } } { $values { "value" object } { "model" model } }
{ $description "Similar to " { $link set-model } ", but only sets the value if the new value is different." } ; { $description "Similar to " { $link set-model } ", but only sets the value if the new value is different." } ;
{ set-model change-model change-model* (change-model) push-model pop-model } related-words { set-model ?set-model change-model change-model* (change-model) push-model pop-model } related-words
HELP: change-model HELP: change-model
{ $values { "model" model } { "quot" { $quotation ( ..a obj -- ..b newobj ) } } } { $values { "model" model } { "quot" { $quotation ( ..a obj -- ..b newobj ) } } }
@ -161,7 +165,9 @@ ARTICLE: "models-impl" "Implementing models"
$nl $nl
"Models can execute hooks when activated:" "Models can execute hooks when activated:"
{ $subsections model-activated } { $subsections model-activated }
"Models can override requests to change their value, for example to perform validation:" "To avoid recursive updating and do proper notifications, you should set the model values via:"
{ $subsections set-model } ; { $subsections set-model }
"Models are notified when their values are changed:"
{ $subsections update-model } ;
ABOUT: "models" ABOUT: "models"