extra/ui/gadgets/sliders/sliders-docs.factor

   1 USING: ui.gadgets.controls help.markup help.syntax ui.gadgets
   2 models ;
   3 IN: ui.gadgets.sliders
   4
   5 HELP: elevator
   6 { $class-description "An elevator is the part of a " { $link slider } " between the up/down arrow buttons, where a " { $link thumb } " may be moved up and down." } ;
   7
   8 HELP: find-elevator
   9 { $values { "gadget" gadget } { "elevator/f" "an " { $link elevator } " or " { $link f } } }
  10 { $description "Finds the first parent of " { $snippet "gadget" } " which is an " { $link elevator } ". Outputs " { $link f } " if the gadget is not contained in an " { $link elevator } "." } ;
  11
  12 HELP: slider
  13 { $class-description "A slider is a " { $link control } " for graphically manipulating a " { $link "models-range" } "."
  14 $nl
  15 "Sliders are created by calling " { $link <x-slider> } " or " { $link <y-slider> } "." } ;
  16
  17 HELP: find-slider
  18 { $values { "gadget" gadget } { "slider/f" "a " { $link slider } " or " { $link f } } }
  19 { $description "Finds the first parent of " { $snippet "gadget" } " which is a " { $link slider } ". Outputs " { $link f } " if the gadget is not contained in a " { $link slider } "." } ;
  20
  21 HELP: thumb
  22 { $class-description "A thumb is the gadget contained in a " { $link slider } "'s " { $link elevator } " which indicates the current scroll position and can be dragged up and down with the mouse." } ;
  23
  24 HELP: slide-by
  25 { $values { "amount" "an integer" } { "slider" slider } }
  26 { $description "Adds the amount (which may be positive or negative) to the slider's current position." } ;
  27
  28 HELP: slide-by-page
  29 { $values { "amount" "an integer" } { "slider" slider } }
  30 { $description "Adds the amount multiplied by " { $link slider-page } " to the slider's current position." } ;
  31
  32 HELP: slide-by-line
  33 { $values { "amount" "an integer" } { "slider" slider } }
  34 { $description "Adds the amount multiplied by " { $link slider-line } " to the slider's current position." } ;
  35
  36 HELP: <slider>
  37 { $values { "range" range } { "orientation" "an orientation specifier" } { "slider" "a new " { $link slider } } }
  38 { $description "Internal word for constructing sliders." }
  39 { $notes "This does not build a complete slider, and user code should call " { $link <x-slider> } " or " { $link <y-slider> } " instead." } ;
  40
  41 HELP: <x-slider>
  42 { $values { "range" range } { "slider" slider } }
  43 { $description "Creates a new horizontal " { $link slider } "." } ;
  44
  45 HELP: <y-slider>
  46 { $values { "range" range } { "slider" slider } }
  47 { $description "Creates a new vertical " { $link slider } "." } ;
  48
  49 { <x-slider> <y-slider> } related-words
  50
  51 ARTICLE: "ui.gadgets.sliders" "Slider gadgets"
  52 "A slider allows the user to graphically manipulate a value by moving a thumb back and forth."
  53 { $subsection slider }
  54 { $subsection <x-slider> }
  55 { $subsection <y-slider> }
  56 "Changing slider values:"
  57 { $subsection slide-by }
  58 { $subsection slide-by-line }
  59 { $subsection slide-by-page }
  60 "Since sliders are controls the value can be get and set by calling " { $link control-model } "." ;
  61
  62 ABOUT: "ui.gadgets.sliders"