HelpSource/Classes/FlowView.schelp

   1 CLASS:: FlowView
   2 summary:: CompositeView with a FlowLayout as decorator
   3 categories:: GUI
   4 related:: Classes/FlowLayout, Classes/CompositeView
   5
   6 DESCRIPTION::
   7 In the simplest respect this is a lazy contraction of this:
   8 code::
   9 w = GUI.window.new;
  10 w.view.decorator = FlowLayout.new(w.bounds);
  11 w.front;
  12 ::
  13
  14 link::Classes/FlowView:: add some features to this setup.
  15 code::
  16 (
  17 f = FlowView.new;
  18
  19 GUI.slider.new(f, Rect(0,0,100,100));
  20 GUI.slider.new(f, Rect(0,0,100,100));
  21
  22 // the StartRow will be fixed at this point in the children array
  23 f.startRow;
  24
  25 GUI.slider.new(f, Rect(0,0,100,100));
  26 f.startRow;
  27
  28 GUI.slider.new(f, Rect(0,0,100,100));
  29 )
  30 ::
  31
  32
  33 CLASSMETHODS::
  34
  35 METHOD:: new
  36
  37 argument:: parent
  38 Parent widget.
  39
  40 argument:: bounds
  41 An instance of link::Classes/Rect::, or a link::Classes/Point:: indicating width@height.
  42
  43 argument:: margin
  44
  45 argument:: gap
  46
  47 argument:: windowTitle
  48 Title of the window.
  49
  50
  51 INSTANCEMETHODS::
  52
  53 METHOD:: startRow
  54 Start a new row.
  55
  56 METHOD:: indentedRemaining
  57 The maximum space that is left, starting at the current cursor position.
  58 code::
  59 (
  60 f = FlowView.new;
  61
  62 GUI.slider.new(f, Rect(0,0,100,100));
  63 GUI.slider.new(f, Rect(0,0,100,100));
  64
  65 GUI.slider.new(f, f.indentedRemaining)
  66         .background = Color.blue(alpha:0.2)
  67 )
  68
  69 (
  70 f = FlowView.new;
  71
  72 GUI.slider.new(f, Rect(0,0,100,100));
  73 GUI.slider.new(f, Rect(0,0,100,100));
  74
  75 f.startRow; // new row
  76
  77 GUI.slider.new(f, f.indentedRemaining)
  78         .background = Color.blue(alpha:0.2)
  79 )
  80
  81 (
  82 f = FlowView.new;
  83
  84 GUI.slider.new(f, Rect(0,0,100,100));
  85 GUI.slider.new(f, Rect(0,0,100,100));
  86 GUI.slider.new(f, Rect(0,0,100,100));
  87 GUI.slider.new(f, Rect(0,0,100,100));
  88
  89 GUI.slider.new(f, f.indentedRemaining)
  90         .background = Color.blue(alpha:0.2)
  91 )
  92 ::
  93
  94 METHOD:: used
  95 The area used so far, rounded up to the nearest rectangle plus margin.
  96 code::
  97 (
  98 w = GUI.window.new;
  99 w.front;
 100 f = FlowView.new(w);
 101 f.background = Color.blue(alpha:0.1);
 102
 103 GUI.slider.new(f, Rect(0,0,100,100));
 104 GUI.slider.new(f, Rect(0,0,100,100));
 105
 106 f.used.postln;
 107
 108 // overlaid
 109 GUI.compositeView.new(w,f.used)
 110         .background = Color.red(alpha: 0.1);
 111 )
 112
 113 (
 114 w = GUI.window.new;
 115 w.front;
 116 f = FlowView.new(w);
 117 f.background = Color.blue(alpha:0.1);
 118
 119 GUI.slider.new(f, Rect(0,0,100,100));
 120 GUI.slider.new(f, Rect(0,0,100,100));
 121
 122 f.startRow; // new row
 123
 124 GUI.slider.new(f, Rect(0,0,100,100));
 125
 126 f.used.postln;
 127
 128 // overlaid
 129 GUI.compositeView.new(w,f.used)
 130         .background = Color.red(alpha: 0.1);
 131 )
 132 ::
 133
 134 METHOD:: flow
 135 Insert a sub flow view into the current view.
 136 code::
 137 (
 138 f = FlowView.new;
 139
 140 GUI.slider.new(f, Rect(0,0,100,100));
 141
 142 // flow within a flow
 143 g = f.flow({ arg g;
 144         ActionButton(g,"a");
 145         GUI.slider.new(g,Rect(0,0,100,100)).background_(Color.rand);
 146 }).background_(Color.black); // shrinks to fit the contents afterwards
 147 )
 148 ::
 149
 150 argument:: func
 151 (describe argument here)
 152
 153 argument:: bounds
 154 (describe argument here)
 155
 156 METHOD:: comp
 157 Insert a sub composite view into the current view.
 158 code::
 159 (
 160 f = FlowView.new;
 161
 162 GUI.slider.new(f, Rect(0,0,100,100));
 163
 164 // sc composite view
 165 g = f.comp({ arg g;
 166         GUI.slider.new(g, Rect(50,30,50,100)).background_(Color.rand);
 167         GUI.slider.new(g, Rect(120,30,50,100)).background_(Color.rand);
 168 },Rect(0, 0, 200, 200)).background_(Color.black);
 169
 170 f.startRow;
 171 "Back to flowing".gui(f);
 172 )
 173 ::
 174
 175 argument:: func
 176 (describe argument here)
 177
 178 argument:: bounds
 179 (describe argument here)
 180
 181
 182 EXAMPLES::
 183
 184 code::
 185 // note: some of the following examples use ActionButton from the crucialib
 186
 187 // tests
 188 (
 189 FlowView.new.flow({ arg f;
 190 //      b = ActionButton(f,"hi",minWidth:140)
 191 }).background_(Color.grey)
 192 )
 193
 194
 195 (
 196 FlowView.new.flow({ arg f;
 197         b = ActionButton(f,"hi",minWidth:140);
 198 }).background_(Color.grey)
 199 )
 200
 201
 202 (
 203 FlowView.new.flow({ arg f;
 204         b = GUI.slider.new(f,Rect(0,0,100,100));
 205 }).background_(Color.grey)
 206 )
 207
 208
 209 (
 210 FlowView.new.flow({ arg f;
 211         g = f;
 212         f.flow({ arg f;
 213                 //b = ActionButton(f,"hi",minWidth:140)
 214         }).background_(Color.white)
 215 }).background_(Color.grey)
 216 )
 217
 218
 219 (
 220 FlowView.new.flow({ arg f;
 221         g = f;
 222         f.flow({ arg f;
 223                 b = ActionButton(f,"hi",minWidth:140)
 224         }).background_(Color.white)
 225 }).background_(Color.grey)
 226 )
 227
 228
 229 (
 230 FlowView.new.flow({ arg f;
 231         g = f;
 232         f.flow({ arg f;
 233                 f.flow({ arg f;
 234                         ActionButton(f,"hello",minWidth:100);
 235                 }).background_(Color.blue);
 236                 b = ActionButton(f,"hi",minWidth:140);
 237         }).background_(Color.white)
 238 }).background_(Color.grey)
 239 )
 240
 241
 242 (
 243 FlowView.new.flow({ arg f;
 244         g = f;
 245         f.flow({ arg f;
 246                 f.flow({ arg f;
 247                         ActionButton(f,"hello",minWidth:100);
 248                 }).background_(Color.blue);
 249                 b = ActionButton(f,"hi",minWidth:140);
 250         }).background_(Color.white)
 251 }).background_(Color.grey)
 252 )
 253
 254
 255 (
 256 FlowView.new.flow({ arg f;
 257         g = f;
 258         f.flow({ arg f;
 259                 b = ActionButton(f,"hi",minWidth:140);
 260                 f.flow({ arg f;
 261                         ActionButton(f,"hello",minWidth:100);
 262                 }).background_(Color.blue);
 263         }).background_(Color.white)
 264 }).background_(Color.grey)
 265 )
 266
 267 (
 268 FlowView.new.flow({ arg f;
 269         g = f;
 270         f.flow({ arg f;
 271                 b = GUI.slider.new(f,Rect(0,0,140,20));
 272                 f.flow({ arg f;
 273                         ActionButton(f,"hello",minWidth:100);
 274                 }).background_(Color.blue);
 275         }).background_(Color.white)
 276 }).background_(Color.grey)
 277 )
 278
 279
 280 (
 281 FlowView.new.flow({ arg f;
 282                 b = GUI.slider.new(f,Rect(0,0,140,20));
 283                 f.flow({ arg f;
 284                         ActionButton(f,"hello",minWidth:100);
 285                 }).background_(Color.blue);
 286 }).background_(Color.grey)
 287 )
 288
 289
 290 (
 291 a = FlowView.new.flow({ arg f;
 292         g = f;
 293         w = f.flow({ arg f;
 294                 b = f.flow({ arg f;
 295                         ActionButton(f,"hello",minWidth:100);
 296                 }).background_(Color.blue);
 297                 ActionButton(f,"hi",minWidth:140);
 298         }).background_(Color.white)
 299 }).background_(Color.grey)
 300
 301 )
 302
 303 b.remove(true);
 304 w.resizeToFit(true,true);
 305
 306
 307 // add something big back in
 308 ActionButton(w,"i'm back",minWidth: 200);
 309 w.resizeToFit(true,true);
 310 // slightly wrong size at the bottom
 311 ::