Revert "Class browser's help button in 3.5 should open the scdoc browser, not old...
[supercollider.git] / Help / Core / Kernel / Class.html
blob314ec88eab7d3d7200700e2d41f72b5c65f100f6
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="824.42">
9 <style type="text/css">
10 p.p1 {margin: 0.0px 0.0px 0.0px 0.0px; font: 18.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: 12.0px Helvetica}
13 p.p4 {margin: 0.0px 0.0px 0.0px 0.0px; font: 14.0px Helvetica}
14 p.p5 {margin: 0.0px 0.0px 0.0px 0.0px; font: 9.0px Monaco; color: #a71e12}
15 span.s1 {text-decoration: underline}
16 span.s2 {color: #0019b7}
17 span.s3 {color: #000000}
18 span.s4 {color: #326f17}
19 </style>
20 </head>
21 <body>
22 <p class="p1"><b>Class</b></p>
23 <p class="p2"><br></p>
24 <p class="p3"><b>superclass: Object</b></p>
25 <p class="p2"><br></p>
26 <p class="p3">A Class describes the structure and implementation of a set objects which are its instances.</p>
27 <p class="p2"><br></p>
28 <p class="p2"><br></p>
29 <p class="p4"><b><span class="s1">Utilities</span></b></p>
30 <p class="p2"><br></p>
31 <p class="p3"><b>browse</b></p>
32 <p class="p2"><br></p>
33 <p class="p3">Open a graphical browser for this Class. (OSX only). Shows methods, arguments, variables, subclasses, and has buttons for navigating to the superclass, source, helpfile, cvs, etc.</p>
34 <p class="p2"><br></p>
35 <p class="p3"><b>findMethod(methodName)</b></p>
36 <p class="p2"><br></p>
37 <p class="p3">Find the Method referred to by name. If not found, return nil.</p>
38 <p class="p2"><br></p>
39 <p class="p3"><b>findRespondingMethodFor(methodName)</b></p>
40 <p class="p2"><br></p>
41 <p class="p3">As above, but climb the class tree to see if the method is inherited from a superclass. If not found, return nil.</p>
42 <p class="p2"><br></p>
43 <p class="p3"><b>dumpAllMethods</b></p>
44 <p class="p2"><br></p>
45 <p class="p3">Post all instance methods which instances of this class responde too, including inherited ones. this.class.dumpAllMethods will post all class methods which this class responds to.</p>
46 <p class="p2"><br></p>
47 <p class="p3"><b>dumpByteCodes(methodName)</b></p>
48 <p class="p2"><br></p>
49 <p class="p3">Dump the byte codes of the named method.</p>
50 <p class="p2"><br></p>
51 <p class="p3"><b>dumpClassSubtree</b></p>
52 <p class="p2"><br></p>
53 <p class="p3">Post the tree of all Classes that inherit from this class.</p>
54 <p class="p2"><br></p>
55 <p class="p3"><b>dumpInterface</b></p>
56 <p class="p2"><br></p>
57 <p class="p3">Post all the methods defined by this Class and their arguments.</p>
58 <p class="p2"><br></p>
59 <p class="p3"><b>dumpFullInterface</b></p>
60 <p class="p2"><br></p>
61 <p class="p3">Post all the class and instance methods that this class responds to (i.e. those defined in this class and those inherited by it).</p>
62 <p class="p2"><br></p>
63 <p class="p3"><b>openHelpFile</b></p>
64 <p class="p2"><br></p>
65 <p class="p3">Opens the help file for this Class if it exists.</p>
66 <p class="p2"><br></p>
67 <p class="p3"><b>helpFilePath</b></p>
68 <p class="p2"><br></p>
69 <p class="p3">Returns the path of this Class's helpfile as a String.</p>
70 <p class="p2"><br></p>
71 <p class="p3"><b>helpFileForMethod(methodSymbol)</b></p>
72 <p class="p2"><br></p>
73 <p class="p3">Opens the helpfile for the class in which the responding method is implemented.</p>
74 <p class="p2"><br></p>
75 <p class="p5"><span class="s2">Array</span><span class="s3">.helpFileForMethod(</span><span class="s4">'select'</span><span class="s3">); </span>// This will open the Collection helpfile</p>
76 <p class="p2"><br></p>
77 <p class="p4"><b><span class="s1">Conversion</span></b></p>
78 <p class="p2"><br></p>
79 <p class="p3"><b>asClass</b></p>
80 <p class="p2"><br></p>
81 <p class="p3">Return this.</p>
82 <p class="p2"><br></p>
83 <p class="p3"><b>asString</b></p>
84 <p class="p2"><br></p>
85 <p class="p3">Return the name of the class as a String.</p>
86 <p class="p2"><br></p>
87 <p class="p2"><br></p>
88 <p class="p4"><b><span class="s1">Accessing</span></b></p>
89 <p class="p2"><br></p>
90 <p class="p3"><b>name</b></p>
91 <p class="p2"><br></p>
92 <p class="p3">A Symbol that is the name of the class.</p>
93 <p class="p2"><br></p>
94 <p class="p3"><b>nextclass</b></p>
95 <p class="p2"><br></p>
96 <p class="p3">The next class in a linked list of all classes.</p>
97 <p class="p2"><br></p>
98 <p class="p3"><b>superclass</b></p>
99 <p class="p2"><br></p>
100 <p class="p3">The Class from which this class directly inherits.</p>
101 <p class="p2"><br></p>
102 <p class="p3"><b>superclasses</b></p>
103 <p class="p2"><br></p>
104 <p class="p3">An Array of this class's superclasses, going back to Object.</p>
105 <p class="p2"><br></p>
106 <p class="p3"><b>subclasses</b></p>
107 <p class="p2"><br></p>
108 <p class="p3">An Array of the direct subclasses of this.</p>
109 <p class="p2"><br></p>
110 <p class="p3"><b>allSubclasses</b></p>
111 <p class="p2"><br></p>
112 <p class="p3">An Array of all subclasses of this.</p>
113 <p class="p2"><br></p>
114 <p class="p3"><b>methods</b></p>
115 <p class="p2"><br></p>
116 <p class="p3">An Array of the methods of this class.</p>
117 <p class="p2"><br></p>
118 <p class="p3"><b>instVarNames</b></p>
119 <p class="p2"><br></p>
120 <p class="p3">An Array of the names of the instance variables for this class.</p>
121 <p class="p2"><br></p>
122 <p class="p3"><b>classVarNames</b></p>
123 <p class="p2"><br></p>
124 <p class="p3">An Array of the names of the class variables for this class.</p>
125 <p class="p2"><br></p>
126 <p class="p3"><b>iprototype</b></p>
127 <p class="p2"><br></p>
128 <p class="p3">An Array of the initial values of instance variables.</p>
129 <p class="p2"><br></p>
130 <p class="p3"><b>cprototype</b></p>
131 <p class="p2"><br></p>
132 <p class="p3">An Array of the initial values of class variables.</p>
133 <p class="p2"><br></p>
134 <p class="p3"><b>filenameSymbol</b></p>
135 <p class="p2"><br></p>
136 <p class="p3">A Symbol which is a path to the file which defines the Class.</p>
137 <p class="p2"><br></p>
138 </body>
139 </html>