HelpSource/Classes/Slider.schelp

   1 CLASS:: Slider
   2 redirect:: implClass
   3 summary:: A view consisting of a sliding handle.
   4 categories:: GUI>Views
   5
   6 DESCRIPTION::
   7
   8 A view that allows setting a numerical value by means of moving a sliding handle. It can have horizontal or vertical orientation, meaning the direction in which the handle moves.
   9
  10
  11
  12
  13 CLASSMETHODS::
  14
  15 PRIVATE:: key
  16
  17 METHOD:: new
  18
  19         When a new Slider is created, its link::#-orientation:: is determined by the initial size: if it is wider than high, the orientation will be horizontal, otherwise it will be vertical.
  20
  21
  22
  23
  24
  25 INSTANCEMETHODS::
  26
  27
  28
  29 SUBSECTION:: Data
  30
  31 METHOD:: value
  32         Numerical value between 0 and 1, represented by the handle position within the groove.
  33
  34         argument::
  35                 A Float.
  36
  37 METHOD:: valueAction
  38         Sets link::#-value:: and triggeres link::#-action::.
  39
  40 METHOD:: increment
  41         Increments the value by link::#-step:: multiplied by 'factor'.
  42
  43         argument:: factor
  44                 Any number.
  45
  46 METHOD:: decrement
  47         Decrements the value by link::#-step:: multiplied by 'factor'.
  48
  49         argument:: factor
  50                 Any number.
  51
  52
  53
  54
  55 SUBSECTION:: Appearance
  56
  57 METHOD:: orientation
  58         The orientation of the Slider - the direction in which the handle moves. The default value depends on the size of the view when created.
  59
  60         argument::
  61                 One of the two Symbols: \horizontal or \vertical.
  62
  63 METHOD:: thumbSize
  64         The size of the handle - its width or height, depending on link::#-orientation::.
  65
  66         argument::
  67                 An Integer amount of pixels.
  68
  69 METHOD:: knobColor
  70         The color of the handle.
  71
  72         argument::
  73                 A Color.
  74
  75
  76
  77 SUBSECTION:: Interaction
  78
  79 METHOD:: step
  80         The amount by which the value will changed when link::#-increment:: or link::#-decrement:: is called, or when related keys are pressed.
  81
  82         argument::
  83                 A Float.
  84
  85 METHOD:: pixelStep
  86         The absolute amount by which the value would change if the handle moved by one pixel.
  87
  88         returns::
  89                 A Float.
  90
  91 METHOD:: shift_scale
  92         The factor by which link::#-step:: is multiplied when incrementing or decrementing the value by keyboard while the Shift key is pressed.
  93
  94         argument::
  95                 A Float.
  96
  97 METHOD:: ctrl_scale
  98         The factor by which link::#-step:: is multiplied when incrementing or decrementing the value by keyboard while the Ctrl key is pressed.
  99
 100         argument::
 101                 A Float.
 102
 103 METHOD:: alt_scale
 104         The factor by which link::#-step:: is multiplied when incrementing or decrementing the value by keyboard while the Alt key is pressed.
 105
 106         argument::
 107                 A Float.
 108
 109
 110 SUBSECTION:: Actions
 111
 112 METHOD:: action
 113         The action object evaluated whenever the user moves the handle.
 114
 115 METHOD:: defaultKeyDownAction
 116
 117         Implements the default effects of key presses as follows:
 118
 119         table::
 120         ## strong::Key::   || strong::Effect::
 121         ## r               || valueAction_(1.0.rand)
 122         ## n               || valueAction_(0)
 123         ## x               || valueAction_(1)
 124         ## c               || valueAction_(0.5)
 125         ## ]               || increment
 126         ## [               || decrement
 127         ## up arrow        || increment
 128         ## down arrow      || decrement
 129         ## right arrow     || increment
 130         ## left arrow      || decrement
 131         ::
 132
 133
 134
 135 SUBSECTION:: Drag and drop
 136
 137 METHOD:: defaultGetDrag
 138         returns::
 139                 The link::#-value::.
 140
 141 METHOD:: defaultCanReceiveDrag
 142         returns::
 143                 True if the current drag data is a number.
 144
 145 METHOD:: defaultReceiveDrag
 146         Sets link::#-valueAction:: to the current drag data.
 147
 148
 149
 150
 151