supernova: c++11 compile fix
[supercollider.git] / Help / GUI / Cocoa-GUI / SCSliderBase.html
blobdfb86bf4c74567c2136c4d9637ed07006160d483
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <meta http-equiv="Content-Style-Type" content="text/css">
6 <title></title>
7 <meta name="Generator" content="Cocoa HTML Writer">
8 <meta name="CocoaVersion" content="949.43">
9 <style type="text/css">
10 p.p1 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica}
11 p.p2 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; min-height: 14.0px}
12 p.p3 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; min-height: 12.0px}
13 p.p4 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; color: #0000bf}
14 p.p5 {margin: 0.0px 0.0px 0.0px 0.0px; font: 14.0px Helvetica}
15 p.p6 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 9.0px Monaco; min-height: 12.0px}
16 p.p7 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 14.0px Helvetica}
17 p.p8 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 14.0px Helvetica; min-height: 17.0px}
18 p.p9 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 12.0px Helvetica}
19 p.p10 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 12.0px Helvetica; min-height: 14.0px}
20 p.p11 {margin: 0.0px 0.0px 0.0px 85.0px; text-indent: -85.0px; font: 12.0px Helvetica}
21 p.p12 {margin: 0.0px 0.0px 0.0px 85.0px; text-indent: -85.0px; font: 12.0px Helvetica; min-height: 14.0px}
22 p.p13 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 9.0px Monaco; color: #007300}
23 span.s1 {font: 18.0px Helvetica}
24 span.s2 {color: #0000bf}
25 span.s3 {color: #0000bf}
26 span.s4 {color: #000000}
27 span.s5 {text-decoration: underline}
28 span.s6 {color: #0000bf}
29 span.s7 {color: #0000bf}
30 span.s8 {font: 14.0px Helvetica}
31 span.s9 {color: #0000bf}
32 span.Apple-tab-span {white-space:pre}
33 </style>
34 </head>
35 <body>
36 <p class="p1"><span class="s1"><b>SCSliderBase<span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></b></span><b>an abstract superclass for various sliders</b><span class="s1"><b><span class="Apple-tab-span"> </span></b></span></p>
37 <p class="p2"><br></p>
38 <p class="p1"><b>Inherits from: </b><a href="../../Core/Object.html"><span class="s2"><b>Object</b></span></a><b> : </b><a href="SCView.html"><span class="s2"><b>SCView</b></span></a><b> : </b><a href="SCControlView.html"><span class="s3"><b>SCControlView</b></span></a></p>
39 <p class="p3"><br></p>
40 <p class="p1">Users will not normally directly create instances of SCSliderBase, but only use it through its subclasses. It provides a few methods common to various slider views. To set the increment or decrement value of a slider, set the <b>step</b> .<span class="Apple-converted-space">  </span>By default, the shift, ctrl, and alt keys will modify the stepping by 100x, 10x, or 0.1x repectively, though you can customize this by setting <b>shift_scale, ctrl_scale, </b>or<b> alt_scale.</b></p>
41 <p class="p2"><br></p>
42 <p class="p4"><span class="s4"><b>See also:</b> <a href="SCSlider.html"><span class="s5">SCSlider</span></a>, <a href="SCRangeSlider.html"><span class="s5">SCRangeSlider</span></a>, <a href="SC2DSlider.html"><span class="s5">SC2DSlider</span></a></span></p>
43 <p class="p2"><br></p>
44 <p class="p5"><b>Creation / Class Methods</b></p>
45 <p class="p6"><br></p>
46 <p class="p7"><b>Accessing Instance and Class Variables</b></p>
47 <p class="p8"><br></p>
48 <p class="p9"><b><span class="Apple-tab-span"> </span>step</b></p>
49 <p class="p9"><b><span class="Apple-tab-span"> </span>step_ (stepSize)</b></p>
50 <p class="p10"><b><span class="Apple-tab-span"> </span></b></p>
51 <p class="p9"><b><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></b>The step size for changing a slider value. The subclasses tend to use this in their <b>increment</b> an <b>decrement</b> methods, among other things.</p>
52 <p class="p11"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><b>stepSize </b>- A Number;</p>
53 <p class="p12"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></p>
54 <p class="p10"><br></p>
55 <p class="p9"><b><span class="Apple-tab-span"> </span>shift_scale_(aFloat)</b></p>
56 <p class="p9"><b><span class="Apple-tab-span"> </span>shift_scale</b></p>
57 <p class="p10"><b><span class="Apple-tab-span"> </span></b><span class="Apple-tab-span"> </span></p>
58 <p class="p9"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>A value for <b>increment</b>'s or <b>decrement</b>'s zoom argument while mouse scrolling<span class="Apple-converted-space">  </span>or arrow keys, and while the <b>shift</b> key is pressed.<span class="Apple-converted-space"> </span></p>
59 <p class="p9"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><b>shift_scale</b> defaults to 100.</p>
60 <p class="p11"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><b>aFloat </b>- An instance of <a href="../../Math/Float.html"><span class="s6">Float</span></a>.</p>
61 <p class="p6"><br></p>
62 <p class="p9"><b><span class="Apple-tab-span"> </span>ctrl_scale_(aFloat)</b></p>
63 <p class="p9"><b><span class="Apple-tab-span"> </span>ctrl_scale</b></p>
64 <p class="p10"><b><span class="Apple-tab-span"> </span></b><span class="Apple-tab-span"> </span></p>
65 <p class="p9"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>A value for <b>increment</b>'s or <b>decrement</b>'s zoom argument while mouse scrolling or arrow keys, and while the <b>ctrl</b> key is pressed.<span class="Apple-converted-space"> </span></p>
66 <p class="p9"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><b>ctrl_scale</b> defaults to 10.</p>
67 <p class="p11"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><b>aFloat </b>- An instance of <a href="../../Math/Float.html"><span class="s6">Float</span></a>.</p>
68 <p class="p12"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></p>
69 <p class="p9"><b><span class="Apple-tab-span"> </span>alt_scale_(aFloat)</b></p>
70 <p class="p9"><b><span class="Apple-tab-span"> </span>alt_scale</b></p>
71 <p class="p10"><b><span class="Apple-tab-span"> </span></b><span class="Apple-tab-span"> </span></p>
72 <p class="p9"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>A value for <b>increment</b>'s or <b>decrement</b>'s zoom argument while mouse scrolling or arrow keys, and while the <b>alt</b> key is pressed.<span class="Apple-converted-space"> </span></p>
73 <p class="p9"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><b>ctrl_scale</b> defaults to 0.1.</p>
74 <p class="p11"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><b>aFloat </b>- An instance of <a href="../../Math/Float.html"><span class="s6">Float</span></a>.</p>
75 <p class="p12"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></p>
76 <p class="p7"><b>Customizing Appearance</b></p>
77 <p class="p8"><br></p>
78 <p class="p9"><b><span class="Apple-tab-span"> </span>knobColor</b></p>
79 <p class="p9"><b><span class="Apple-tab-span"> </span>knobColor_ (color)</b></p>
80 <p class="p10"><b><span class="Apple-tab-span"> </span></b></p>
81 <p class="p9"><b><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></b>Set the knob <a href="../GUI-Tools/Color.html"><span class="s7">Color</span></a> for a slider-</p>
82 <p class="p9"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><b>color </b>- An instance of <a href="../GUI-Tools/Color.html"><span class="s7">Color</span></a>.</p>
83 <p class="p6"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></p>
84 <p class="p10"><br></p>
85 <p class="p7"><b>Subclassing and Internal Methods</b></p>
86 <p class="p9"><span class="s8"><span class="Apple-tab-span"> </span></span>The following methods are usually not used directly or are called by a primitive. Programmers can still call or override these as needed.</p>
87 <p class="p10"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></p>
88 <p class="p9"><b><span class="Apple-tab-span"> </span>properties</b></p>
89 <p class="p10"><b><span class="Apple-tab-span"> </span></b></p>
90 <p class="p9"><b><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></b>A list of properties to which this view responds. See <a href="SCView.html"><span class="s9">SCView</span></a>.</p>
91 <p class="p9"><b><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></b>Returns:</p>
92 <p class="p13"><span class="s4"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>[ </span>\bounds<span class="s4">, </span>\visible<span class="s4">, </span>\enabled<span class="s4">, </span>\canFocus<span class="s4">, </span>\resize<span class="s4">, </span>\background<span class="s4">, </span>\minWidth<span class="s4">, </span>\maxWidth<span class="s4">, </span>\minHeight<span class="s4">, </span>\maxHeight<span class="s4">, </span>\knobColor<span class="s4">, </span>\step<span class="s4">, </span>\thumbSize<span class="s4"> ]<span class="Apple-tab-span"> </span></span></p>
93 <p class="p6"><br></p>
94 <p class="p7"><b>Examples</b></p>
95 <p class="p8"><br></p>
96 <p class="p4"><span class="s4">See <a href="SCSlider.html"><span class="s5">SCSlider</span></a>, <a href="SCRangeSlider.html"><span class="s5">SCRangeSlider</span></a>, <a href="SC2DSlider.html"><span class="s5">SC2DSlider</span></a></span></p>
97 <p class="p3"><br></p>
98 </body>
99 </html>