FlowView | SuperCollider 3.12.2 Help

Description

In the simplest respect this is a lazy contraction of this:w = GUI.window.new; w.view.decorator = FlowLayout.new(w.bounds); w.front;

FlowView add some features to this setup.( f = FlowView.new; GUI.slider.new(f, Rect(0,0,100,100)); GUI.slider.new(f, Rect(0,0,100,100)); // the StartRow will be fixed at this point in the children array f.startRow; GUI.slider.new(f, Rect(0,0,100,100)); f.startRow; GUI.slider.new(f, Rect(0,0,100,100)); )

Class Methods

FlowView.new(parent, bounds, margin, gap, windowTitle: "")

Arguments:

parent	Parent widget.
bounds	An instance of Rect, or a Point indicating width@height.
margin	...
gap	...
windowTitle	Title of the window.

Inherited class methods

Undocumented class methods

FlowView.layout(f, bounds)

FlowView.viewClass

Instance Methods

.startRow

Start a new row.

.indentedRemaining

The maximum space that is left, starting at the current cursor position.( f = FlowView.new; GUI.slider.new(f, Rect(0,0,100,100)); GUI.slider.new(f, Rect(0,0,100,100)); GUI.slider.new(f, f.indentedRemaining) .background = Color.blue(alpha:0.2) ) ( f = FlowView.new; GUI.slider.new(f, Rect(0,0,100,100)); GUI.slider.new(f, Rect(0,0,100,100)); f.startRow; // new row GUI.slider.new(f, f.indentedRemaining) .background = Color.blue(alpha:0.2) ) ( f = FlowView.new; GUI.slider.new(f, Rect(0,0,100,100)); GUI.slider.new(f, Rect(0,0,100,100)); GUI.slider.new(f, Rect(0,0,100,100)); GUI.slider.new(f, Rect(0,0,100,100)); GUI.slider.new(f, f.indentedRemaining) .background = Color.blue(alpha:0.2) )

.used

The area used so far, rounded up to the nearest rectangle plus margin.( w = GUI.window.new; w.front; f = FlowView.new(w); f.background = Color.blue(alpha:0.1); GUI.slider.new(f, Rect(0,0,100,100)); GUI.slider.new(f, Rect(0,0,100,100)); f.used.postln; // overlaid GUI.compositeView.new(w,f.used) .background = Color.red(alpha: 0.1); ) ( w = GUI.window.new; w.front; f = FlowView.new(w); f.background = Color.blue(alpha:0.1); GUI.slider.new(f, Rect(0,0,100,100)); GUI.slider.new(f, Rect(0,0,100,100)); f.startRow; // new row GUI.slider.new(f, Rect(0,0,100,100)); f.used.postln; // overlaid GUI.compositeView.new(w,f.used) .background = Color.red(alpha: 0.1); )

.flow(func, bounds)

From extension in /usr/local/share/SuperCollider/SCClassLibrary/Common/GUI/backwardsCompatibility/viewExtensions.sc

Insert a sub flow view into the current view.( f = FlowView.new; GUI.slider.new(f, Rect(0,0,100,100)); // flow within a flow g = f.flow({ arg g; ActionButton(g,"a"); GUI.slider.new(g,Rect(0,0,100,100)).background_(Color.rand); }).background_(Color.black); // shrinks to fit the contents afterwards )

Arguments:

func	(describe argument here)
bounds	(describe argument here)

.comp(func, bounds)

From extension in /usr/local/share/SuperCollider/SCClassLibrary/Common/GUI/backwardsCompatibility/viewExtensions.sc

Insert a sub composite view into the current view.( f = FlowView.new; GUI.slider.new(f, Rect(0,0,100,100)); // SuperCollider composite view g = f.comp({ arg g; GUI.slider.new(g, Rect(50,30,50,100)).background_(Color.rand); GUI.slider.new(g, Rect(120,30,50,100)).background_(Color.rand); },Rect(0, 0, 200, 200)).background_(Color.black); f.startRow; "Back to flowing".gui(f); )

Arguments:

func	(describe argument here)
bounds	(describe argument here)

Inherited instance methods

Undocumented instance methods

.add(child)

.allocateRemaining

.anyChildExceeds

.asFlowView

.asPageLayout

.bounds

.bounds_(b, reflow: true)

From superclass: SCViewHolder

.children

.decorator

.decorator = dec

.didUseAllocated(vbounds)

.front

.horz(func, bounds, spacing)

From extension in /usr/local/share/SuperCollider/SCClassLibrary/Common/GUI/backwardsCompatibility/viewExtensions.sc

.hr(color, height: 3)

.innerBounds

.parent

.prClose

.prRemoveChild(child)

.reflowAll

.reflowDeep

.remove

.removeAll

.removeOnClose(updater)

.resizeToFit(reflow: false, tryParent: false)

.scroll(func, bounds, autohidesScrollers: true, autoScrolls: true, hasHorizontalScroller: true, hasVerticalScroller: true)

From extension in /usr/local/share/SuperCollider/SCClassLibrary/Common/GUI/backwardsCompatibility/viewExtensions.sc

.vert(func, bounds, spacing)

From extension in /usr/local/share/SuperCollider/SCClassLibrary/Common/GUI/backwardsCompatibility/viewExtensions.sc

.viewDidClose

.wouldExceedBottom(aBounds)

Examples

// note: some of the following examples use ActionButton from the crucialib

// tests
(
FlowView.new.flow({ arg f;
//    b = ActionButton(f,"hi",minWidth:140)
}).background_(Color.grey)
)

(
FlowView.new.flow({ arg f;
    b = ActionButton(f,"hi",minWidth:140);
}).background_(Color.grey)
)

(
FlowView.new.flow({ arg f;
    b = GUI.slider.new(f,Rect(0,0,100,100));
}).background_(Color.grey)
)

(
FlowView.new.flow({ arg f;
    g = f;
    f.flow({ arg f;
        //b = ActionButton(f,"hi",minWidth:140)
    }).background_(Color.white)
}).background_(Color.grey)
)

(
FlowView.new.flow({ arg f;
    g = f;
    f.flow({ arg f;
        b = ActionButton(f,"hi",minWidth:140)
    }).background_(Color.white)
}).background_(Color.grey)
)

(
FlowView.new.flow({ arg f;
    g = f;
    f.flow({ arg f;
        f.flow({ arg f;
            ActionButton(f,"hello",minWidth:100);
        }).background_(Color.blue);
        b = ActionButton(f,"hi",minWidth:140);
    }).background_(Color.white)
}).background_(Color.grey)
)

(
FlowView.new.flow({ arg f;
    g = f;
    f.flow({ arg f;
        b = ActionButton(f,"hi",minWidth:140);
        f.flow({ arg f;
            ActionButton(f,"hello",minWidth:100);
        }).background_(Color.blue);
    }).background_(Color.white)
}).background_(Color.grey)
)

(
FlowView.new.flow({ arg f;
    g = f;
    f.flow({ arg f;
        b = GUI.slider.new(f,Rect(0,0,140,20));
        f.flow({ arg f;
            ActionButton(f,"hello",minWidth:100);
        }).background_(Color.blue);
    }).background_(Color.white)
}).background_(Color.grey)
)

(
FlowView.new.flow({ arg f;
        b = GUI.slider.new(f,Rect(0,0,140,20));
        f.flow({ arg f;
            ActionButton(f,"hello",minWidth:100);
        }).background_(Color.blue);
}).background_(Color.grey)
)

(
a = FlowView.new.flow({ arg f;
    g = f;
    w = f.flow({ arg f;
        b = f.flow({ arg f;
            ActionButton(f,"hello",minWidth:100);
        }).background_(Color.blue);
        ActionButton(f,"hi",minWidth:140);
    }).background_(Color.white)
}).background_(Color.grey)

)

b.remove(true);
w.resizeToFit(true,true);

// add something big back in
ActionButton(w,"i'm back",minWidth: 200);
w.resizeToFit(true,true);
// slightly wrong size at the bottom

helpfile source: /usr/local/share/SuperCollider/HelpSource/Classes/FlowView.schelp
link::Classes/FlowView::

FlowView : SCViewHolder : Object

FlowView.new(parent, bounds, margin, gap, windowTitle: "")

Arguments:

FlowView.layout(f, bounds)

FlowView.viewClass

.startRow

.indentedRemaining

.used

.flow(func, bounds)

Arguments:

.comp(func, bounds)

Arguments:

.add(child)

.allocateRemaining

.anyChildExceeds

.asFlowView

.asPageLayout

.bounds

.bounds_(b, reflow: true)

.children

.decorator

.decorator = dec

.didUseAllocated(vbounds)

.front

.horz(func, bounds, spacing)

.hr(color, height: 3)

.innerBounds

.parent

.prClose

.prRemoveChild(child)

.reflowAll

.reflowDeep

.remove

.removeAll

.removeOnClose(updater)

.resizeToFit(reflow: false, tryParent: false)

.scroll(func, bounds, autohidesScrollers: true, autoScrolls: true, hasHorizontalScroller: true, hasVerticalScroller: true)

.vert(func, bounds, spacing)

.viewDidClose

.wouldExceedBottom(aBounds)