HelpSource/Classes/RangeSlider.schelp

   1 CLASS:: RangeSlider
   2 redirect:: implClass
   3 summary:: A view consisting of a sliding extendable handle
   4 categories:: GUI>Views
   5
   6 DESCRIPTION::
   7
   8 A view that allows setting two numerical values between 0 and 1, represented by the two ends of a movable and extendable handle. It can have horizontal or vertical orientation, meaning the direction in which the handle moves and extends.
   9
  10 Clicking and moving the mouse pointer within the view will define the two ends of the range. Doing the same while holding down the Ctrl key will move the whole range without changing its size.
  11
  12
  13
  14 CLASSMETHODS::
  15
  16 PRIVATE:: key
  17
  18 METHOD:: new
  19
  20     When a new RangeSlider 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.
  21
  22
  23
  24
  25 INSTANCEMETHODS::
  26
  27 SUBSECTION:: Data
  28
  29 METHOD:: lo
  30
  31         The low end of the range.
  32
  33         If you attempt to set it higher then the current link::#-hi::, -hi will be set instead, and -lo will become the old -hi.
  34
  35         When setting -lo the value will always be clipped to the range between 0 and 1.
  36
  37         argument::
  38                 A Float between 0 and 1.
  39
  40 METHOD:: hi
  41
  42         The high end of the range. If you attempt to set it lower then the current link::#-lo::, -lo will be set instead, and -hi will become the old -lo.
  43
  44         When setting -hi the value will always be clipped to the range between 0 and 1.
  45
  46         argument::
  47                 A Float between 0 and 1.
  48
  49 METHOD:: activeLo
  50
  51         Sets link::#-lo:: to the argument and triggers link::#-action::.
  52
  53 METHOD:: activeHi
  54
  55         Sets link::#-hi:: to the argument and triggers link::#-action::.
  56
  57 METHOD:: range
  58
  59         The difference between link::#-hi:: and link::#-lo::. Setting -range will set -hi to -lo + -range.
  60
  61 METHOD:: activeRange
  62
  63         Sets link::#-range:: to the argument and triggers link::#-action::.
  64
  65 METHOD:: setSpan
  66
  67         Sets link::#-lo:: and link::#-hi:: to each of the arguments, respectively.
  68
  69 METHOD:: setSpanActive
  70
  71         Calls link::#-setSpan::, forwarding the arguments, and triggers link::#-action::.
  72
  73 METHOD:: setDeviation
  74
  75         Sets link::#-lo:: and link::#-hi:: according to their deviation and their average instead of their absolute values.
  76
  77         argument:: deviation
  78                 A Float determining the absolute deviation of -lo and -hi from their average.
  79         argument:: average
  80                 A Float determining the average of -lo and -hi.
  81
  82 METHOD:: increment
  83         Increments both link::#-lo:: and link::#-hi:: by link::#-step:: multiplied by 'factor'.
  84
  85         argument:: factor
  86                 A Float.
  87
  88 METHOD:: decrement
  89         Decrements both link::#-lo:: and link::#-hi:: by link::#-step:: multiplied by 'factor'.
  90
  91         argument:: factor
  92                 A Float.
  93
  94
  95
  96
  97
  98 SUBSECTION:: Appearance
  99
 100 METHOD:: orientation
 101         The orientation of the RangeSlider - the direction in which the handle moves and is extendable. The default value depends on the size of the view when created.
 102
 103         argument::
 104                 One of the two Symbols: \horizontal or \vertical.
 105
 106 METHOD:: knobColor
 107         The color of the handle.
 108
 109         argument::
 110                 A Color.
 111
 112
 113
 114
 115 SUBSECTION:: Interaction
 116
 117 METHOD:: step
 118         The amount by which the range will change when link::#-increment:: or link::#-decrement:: is called, or when related keys are pressed.
 119
 120         argument::
 121                 A Float.
 122
 123 METHOD:: pixelStep
 124         The absolute amount by which the range would change if the handle moved by one pixel.
 125
 126         returns::
 127                 A Float.
 128
 129 METHOD:: shift_scale
 130         The factor by which link::#-step:: is multiplied when incrementing or decrementing the range by keyboard while the Shift key is pressed.
 131
 132         argument::
 133                 A Float.
 134
 135 METHOD:: ctrl_scale
 136         The factor by which link::#-step:: is multiplied when incrementing or decrementing the range by keyboard while the Ctrl key is pressed.
 137
 138         argument::
 139                 A Float.
 140
 141 METHOD:: alt_scale
 142         The factor by which link::#-step:: is multiplied when incrementing or decrementing the range by keyboard while the Alt key is pressed.
 143
 144         argument::
 145                 A Float.
 146
 147
 148
 149 SUBSECTION:: Actions
 150
 151 METHOD:: action
 152         The action object evaluated whenever the user changes the position or size of the handle.
 153
 154 METHOD:: defaultKeyDownAction
 155
 156         Implements the default effects of key presses as follows:
 157
 158         table::
 159         ## strong::Key::   || strong::Effect::
 160         ## a               || lo_(0), hi_(1), and triggers action
 161         ## n               || lo_(0), hi_(0), and triggers action
 162         ## x               || lo_(1), hi_(1), and triggers action
 163         ## c               || lo_(0.5), hi_(0.5), and triggers action
 164         ## up arrow        || increment
 165         ## down arrow      || decrement
 166         ## right arrow     || increment
 167         ## left arrow      || decrement
 168         ::
 169
 170
 171
 172 SUBSECTION:: Drag and drop
 173
 174 METHOD:: defaultGetDrag
 175         returns::
 176                 A Point of which the x and y coordinates are set to link::#-lo:: and link::#-hi::, respectively.
 177
 178 METHOD:: defaultCanReceiveDrag
 179         returns::
 180                 True if the current drag data is a Point.
 181
 182 METHOD:: defaultReceiveDrag
 183         Sets  link::#-lo:: and link::#-hi:: to the two coordinates of the Point stored as the current drag data, respectively, and triggers the link::#-action::.