basis/models/history/history-docs.factor

   1 USING: help.syntax help.markup kernel math classes classes.tuple\r
   2 calendar models ;\r
   3 IN: models.history\r
   4 \r
   5 HELP: history\r
   6 { $class-description "History models record a timeline of previous values on calls to " { $link add-history } ", and can travel back and forth on the timeline with " { $link go-back } " and " { $link go-forward } ". History models are constructed by " { $link <history> } "." } ;\r
   7 \r
   8 HELP: <history>\r
   9 { $values { "value" object } { "history" "a new " { $link history } } }\r
  10 { $description "Creates a new history model with an initial value." } ;\r
  11 \r
  12 { <history> add-history go-back go-forward } related-words\r
  13 \r
  14 HELP: go-back\r
  15 { $values { "history" history } }\r
  16 { $description "Restores the previous value and calls " { $link model-changed } " on all observers registered with " { $link add-connection } "." } ;\r
  17 \r
  18 HELP: go-forward\r
  19 { $values { "history" history } }\r
  20 { $description "Restores the value set prior to the last call to " { $link go-back } " and calls " { $link model-changed } " on all observers registered with " { $link add-connection } "." } ;\r
  21 \r
  22 HELP: add-history\r
  23 { $values { "history" history } }\r
  24 { $description "Adds the current value to the history." } ;\r
  25 \r
  26 ARTICLE: "models-history" "History models"\r
  27 "History models record previous values."\r
  28 { $subsection history }\r
  29 { $subsection <history> }\r
  30 "Recording history:"\r
  31 { $subsection add-history }\r
  32 "Navigating the history:"\r
  33 { $subsection go-back }\r
  34 { $subsection go-forward } ;\r
  35 \r
  36 ABOUT: "models-history"\r