basis/models/range/range-docs.factor

   1 USING: help.syntax help.markup kernel math classes classes.tuple\r
   2 calendar models ;\r
   3 IN: models.range\r
   4 \r
   5 HELP: range\r
   6 { $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> } "." }\r
   7 { $notes { $link "ui.gadgets.sliders" } " use range models." } ;\r
   8 \r
   9 HELP: range-model\r
  10 { $values { "range" range } { "model" model } }\r
  11 { $description "Outputs a model holding a range model's current value." }\r
  12 { $notes "This word is not part of the " { $link "range-model-protocol" } ", and can only be used on direct instances of " { $link range } "." } ;\r
  13 \r
  14 HELP: range-min\r
  15 { $values { "range" range } { "model" model } }\r
  16 { $description "Outputs a model holding a range model's minimum value." }\r
  17 { $notes "This word is not part of the " { $link "range-model-protocol" } ", and can only be used on direct instances of " { $link range } "." } ;\r
  18 \r
  19 HELP: range-max\r
  20 { $values { "range" range } { "model" model } }\r
  21 { $description "Outputs a model holding a range model's maximum value." }\r
  22 { $notes "This word is not part of the " { $link "range-model-protocol" } ", and can only be used on direct instances of " { $link range } "." } ;\r
  23 \r
  24 HELP: range-page\r
  25 { $values { "range" range } { "model" model } }\r
  26 { $description "Outputs a model holding a range model's page size." }\r
  27 { $notes "This word is not part of the " { $link "range-model-protocol" } ", and can only be used on direct instances of " { $link range } "." } ;\r
  28 \r
  29 HELP: move-by\r
  30 { $values { "amount" real } { "range" range } }\r
  31 { $description "Adds a number to a range model's current value." }\r
  32 { $side-effects "range" } ;\r
  33 \r
  34 HELP: move-by-page\r
  35 { $values { "amount" real } { "range" range } }\r
  36 { $description "Adds a multiple of the page size to a range model's current value." }\r
  37 { $side-effects "range" } ;\r
  38 \r
  39 ARTICLE: "models-range" "Range models"\r
  40 "Range models ensure their value is a real number within a fixed range."\r
  41 { $subsection range }\r
  42 { $subsection <range> }\r
  43 "Range models conform to a protocol for getting and setting the current value, as well as the endpoints of the range."\r
  44 { $subsection "range-model-protocol" } ;\r
  45 \r
  46 ARTICLE: "range-model-protocol" "Range model protocol"\r
  47 "The range model protocol is implemented by the " { $link range } " and " { $link compose } " classes. User-defined models may implement it too."\r
  48 { $subsection range-value          }\r
  49 { $subsection range-page-value     } \r
  50 { $subsection range-min-value      } \r
  51 { $subsection range-max-value      } \r
  52 { $subsection range-max-value*     } \r
  53 { $subsection set-range-value      } \r
  54 { $subsection set-range-page-value } \r
  55 { $subsection set-range-min-value  } \r
  56 { $subsection set-range-max-value  } ;\r
  57 \r
  58 ABOUT: "models-range"\r