Removing an old, cherished, yet pointless caveat "This documentation is
[supercollider.git] / Help / GUI / Cocoa-GUI / SCContainerView.html
blob2bf934b4833910b3342fb09f436e916738314a5c
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.54">
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: #001bec}
14 p.p5 {margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; color: #0000bf; min-height: 14.0px}
15 p.p6 {margin: 0.0px 0.0px 0.0px 0.0px; font: 14.0px Helvetica}
16 p.p7 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 9.0px Monaco; min-height: 12.0px}
17 p.p8 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 14.0px Helvetica}
18 p.p9 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 12.0px Helvetica; min-height: 14.0px}
19 p.p10 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 12.0px Helvetica}
20 p.p11 {margin: 0.0px 0.0px 0.0px 57.0px; text-indent: -57.0px; font: 12.0px Helvetica; color: #0000bf; min-height: 14.0px}
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 span.s1 {font: 18.0px Helvetica}
23 span.s2 {color: #0000bf}
24 span.s3 {color: #000000}
25 span.s4 {text-decoration: underline}
26 span.s5 {text-decoration: underline ; color: #001bec}
27 span.s6 {font: 14.0px Helvetica}
28 span.Apple-tab-span {white-space:pre}
29 </style>
30 </head>
31 <body>
32 <p class="p1"><span class="s1"><b>SCContainerView<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 container views</b><span class="s1"><b><span class="Apple-tab-span"> </span></b></span></p>
33 <p class="p2"><br></p>
34 <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></p>
35 <p class="p3"><br></p>
36 <p class="p1">Users will not normally directly create instances of SCContainerView, but only use it through its subclasses. It provides the basic mechanisms for container views of various kinds, which are used for placing and grouping widgets in a window.</p>
37 <p class="p2"><br></p>
38 <p class="p4"><span class="s3"><b>See also: </b><a href="SCTopView.html"><span class="s2">SCTopView</span></a><b>,</b> <a href="SCCompositeView.html"><span class="s4">SCCompositeView</span></a>, <a href="SCHLayoutView.html"><span class="s4">SCHLayoutView</span></a>, <a href="SCVLayoutView.html"><span class="s4">SCVLayoutView</span></a>, <a href="SCScrollView.html"><span class="s4">SCScrollView</span></a></span><span class="s2"> <a href="SCScrollTopView.html"><span class="s5">SCScrollTopView</span></a></span></p>
39 <p class="p5"><br></p>
40 <p class="p6"><b>Some Important Issues Regarding SCContainerView</b></p>
41 <p class="p2"><br></p>
42 <p class="p1">Container views are meant for placing and grouping child views and widgets. While they accept key actions, many do not accept mouse cklicks or drags. The exception is <a href="SCTopView.html"><span class="s2">SCTopView</span></a> and its subclasses.</p>
43 <p class="p7"><br></p>
44 <p class="p8"><b>Accessing Instance and Class Variables</b></p>
45 <p class="p9"><span class="Apple-tab-span"> </span></p>
46 <p class="p10"><b><span class="Apple-tab-span"> </span>decorator_(arg1)</b></p>
47 <p class="p10"><b><span class="Apple-tab-span"> </span>decorator</b></p>
48 <p class="p9"><b><span class="Apple-tab-span"> </span></b><span class="Apple-tab-span"> </span></p>
49 <p class="p10"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>An automatic layout management for a container. Currently the only one existing is <a href="../GUI-Tools/FlowLayout.html"><span class="s2">FlowLayout</span></a>.</p>
50 <p class="p10"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>(note: Crucial Library also has a useful layout tool called <a href="../../Libraries/crucial/Gui/GridLayout.html"><span class="s2">GridLayout</span></a><span class="s2">.)</span></p>
51 <p class="p9"><br></p>
52 <p class="p10"><b><span class="Apple-tab-span"> </span>addFlowLayout(margin, gap)</b></p>
53 <p class="p9"><b><span class="Apple-tab-span"> </span></b><span class="Apple-tab-span"> </span></p>
54 <p class="p10"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>A convenience utility which sets <b>decorator</b> to FlowLayout and returns the decorator. See FlowLayout for examples.</p>
55 <p class="p10"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><b>margin</b> - An instance of <a href="../../Geometry/Point.html"><span class="s2">Point</span></a></p>
56 <p class="p10"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><b>gap</b> - An instance of <a href="../../Geometry/Point.html"><span class="s2">Point</span></a></p>
57 <p class="p11"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></p>
58 <p class="p10"><b><span class="Apple-tab-span"> </span>children</b></p>
59 <p class="p9"><b><span class="Apple-tab-span"> </span></b><span class="Apple-tab-span"> </span></p>
60 <p class="p10"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span>An array containing all the views (children) contained in the the container.</p>
61 <p class="p12"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></p>
62 <p class="p12"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></p>
63 <p class="p8"><b>Adding and Removing Subviews</b></p>
64 <p class="p9"><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></p>
65 <p class="p10"><b><span class="Apple-tab-span"> </span>add (child)</b></p>
66 <p class="p9"><b><span class="Apple-tab-span"> </span></b></p>
67 <p class="p10"><b><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></b>Adds a view to <b>children</b>. The placement of the child view will depend on the the <b>decorator</b>, and the child's <b>bounds</b>. Nomally you don't need to call this directly, since subviews call it automatically when you create them.</p>
68 <p class="p7"><br></p>
69 <p class="p10"><b><span class="Apple-tab-span"> </span>removeAll</b></p>
70 <p class="p9"><b><span class="Apple-tab-span"> </span></b></p>
71 <p class="p10"><b><span class="Apple-tab-span"> </span><span class="Apple-tab-span"> </span></b>Removes all children from the view</p>
72 <p class="p7"><br></p>
73 <p class="p8"><b>Subclassing and Internal Methods</b></p>
74 <p class="p10"><span class="s6"><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>
75 <p class="p7"><br></p>
76 <p class="p10"><b><span class="Apple-tab-span"> </span>init (argParent, argBounds)</b></p>
77 <p class="p9"><b><span class="Apple-tab-span"> </span></b></p>
78 <p class="p10"><b><span class="Apple-tab-span"> </span>prRemoveChild (child) </b>private method</p>
79 <p class="p10"><b><span class="Apple-tab-span"> </span>prClose </b>private method</p>
80 <p class="p9"><b><span class="Apple-tab-span"> </span></b></p>
81 <p class="p7"><br></p>
82 </body>
83 </html>