3 // This file contains the actual layout engine. It has no dependence
4 // on outside libraries; see layout-props.cxx for the glue code.
6 // Note, property names with leading double-underscores (__bx, etc...)
7 // are debugging information, and can be safely removed.
9 const int DEFAULT_PADDING = 2;
11 int LayoutWidget::UNIT = 5;
13 bool LayoutWidget::eq(const char* a, const char* b)
15 while(*a && (*a == *b)) { a++; b++; }
19 // Normal widgets get a padding of 4 pixels. Layout groups shouldn't
20 // have visible padding by default, except for top-level dialog groups
21 // which need to leave two pixels for the puFrame's border. This
22 // value can, of course, be overriden by the parent groups
23 // <default-padding> property, or per widget with <padding>.
24 int LayoutWidget::padding()
26 int pad = (isType("group") || isType("frame")) ? 0 : 4;
27 // As comments above note, this was being set to 2. For some
28 // reason this causes the dialogs to shrink on subsequent pops
29 // so for now we'll make "dialog" padding 0.
30 if(isType("dialog")) pad = 0;
31 if(hasParent() && parent().hasField("default-padding"))
32 pad = parent().getNum("default-padding");
33 if(hasField("padding"))
34 pad = getNum("padding");
38 void LayoutWidget::calcPrefSize(int* w, int* h)
40 *w = *h = 0; // Ask for nothing by default
45 int legw = stringLength(getStr("legend"));
46 int labw = stringLength(getStr("label"));
48 if(isType("dialog") || isType("group") || isType("frame")) {
49 if(!hasField("layout")) {
50 // Legacy support for groups without layout managers.
51 if(hasField("width")) *w = getNum("width");
52 if(hasField("height")) *h = getNum("height");
54 const char* layout = getStr("layout");
55 if (eq(layout, "hbox" )) doHVBox(false, false, w, h);
56 else if(eq(layout, "vbox" )) doHVBox(false, true, w, h);
57 else if(eq(layout, "table")) doTable(false, w, h);
59 } else if (isType("text")) {
61 *h = 3*UNIT; // FIXME: multi line height?
62 } else if (isType("button")) {
63 *w = legw + 6*UNIT + (labw ? labw + UNIT : 0);
65 } else if (isType("checkbox") || isType("radio")) {
66 *w = 3*UNIT + (labw ? (3*UNIT + labw) : 0);
68 } else if (isType("input") || isType("combo") || isType("select")) {
71 } else if (isType("slider")) {
73 if(getBool("vertical")) *w = 4*UNIT;
75 } else if (isType("list") || isType("airport-list") || isType("dial")) {
77 } else if (isType("hrule")) {
79 } else if (isType("vrule")) {
83 // Throw it all out if the user specified a fixed preference
84 if(hasField("pref-width")) *w = getNum("pref-width");
85 if(hasField("pref-height")) *h = getNum("pref-height");
87 // And finally correct for cell padding
88 int pad = 2*padding();
92 // Store what we calculated
97 // Set up geometry such that the widget lives "inside" the specified
98 void LayoutWidget::layout(int x, int y, int w, int h)
108 // Correct for padding.
115 int prefw = 0, prefh = 0;
116 calcPrefSize(&prefw, &prefh);
120 // "Parent Set" values override widget preferences
121 if(hasField("_psw")) prefw = getNum("_psw");
122 if(hasField("_psh")) prefh = getNum("_psh");
124 bool isGroup = isType("dialog") || isType("group") || isType("frame");
126 // Correct our box for alignment. The values above correspond to
127 // a "fill" alignment.
128 const char* halign = (isGroup || isType("hrule")) ? "fill" : "center";
129 if(hasField("halign")) halign = getStr("halign");
130 if(eq(halign, "left")) {
132 } else if(eq(halign, "right")) {
135 } else if(eq(halign, "center")) {
139 const char* valign = (isGroup || isType("vrule")) ? "fill" : "center";
140 if(hasField("valign")) valign = getStr("valign");
141 if(eq(valign, "bottom")) {
143 } else if(eq(valign, "top")) {
146 } else if(eq(valign, "center")) {
151 // PUI widgets interpret their size differently depending on
152 // type, so diddle the values as needed to fit the widget into
153 // the x/y/w/h box we have calculated.
154 if (isType("text")) {
155 // puText labels are layed out to the right of the box, so
158 } else if (isType("input") || isType("combo") || isType("select")) {
159 // Fix the height to a constant
160 y += (h - 6*UNIT) / 2;
162 } else if (isType("checkbox") || isType("radio")) {
163 // The PUI dimensions are of the check area only. Center it
164 // on the left side of our box.
165 y += (h - 3*UNIT) / 2;
167 } else if (isType("slider")) {
168 // Fix the thickness to a constant
169 if(getBool("vertical")) { x += (w-4*UNIT)/2; w = 4*UNIT; }
170 else { y += (h-4*UNIT)/2; h = 4*UNIT; }
173 // Set out output geometry
179 // Finally, if we are ourselves a layout object, do the actual layout.
180 if(isGroup && hasField("layout")) {
181 const char* layout = getStr("layout");
182 if (eq(layout, "hbox" )) doHVBox(true, false);
183 else if(eq(layout, "vbox" )) doHVBox(true, true);
184 else if(eq(layout, "table")) doTable(true);
185 } else if(isType("hrule"))
186 doHVBox(true, false);
187 else if(isType("vrule"))
191 // Convention: the "A" cooridinate refers to the major axis of the
192 // container (width, for an hbox), "B" is minor.
193 void LayoutWidget::doHVBox(bool doLayout, bool vertical, int* w, int* h)
195 int nc = nChildren();
196 int* prefA = doLayout ? new int[nc] : 0;
197 int i, totalA = 0, maxB = 0, nStretch = 0;
198 int nEq = 0, eqA = 0, eqB = 0, eqTotalA = 0;
199 for(i=0; i<nc; i++) {
200 LayoutWidget child = getChild(i);
201 if (child.getBool("hide"))
205 child.calcPrefSize(vertical ? &b : &a, vertical ? &a : &b);
206 if(doLayout) prefA[i] = a;
208 if(b > maxB) maxB = b;
209 if(child.getBool("stretch")) {
211 } else if(child.getBool("equal")) {
212 int pad = child.padding();
214 eqTotalA += a - 2*pad;
215 if(a-2*pad > eqA) eqA = a - 2*pad;
216 if(b-2*pad > eqB) eqB = b - 2*pad;
219 if(nStretch == 0) nStretch = nc;
220 totalA += nEq * eqA - eqTotalA;
223 if(vertical) { *w = maxB; *h = totalA; }
224 else { *w = totalA; *h = maxB; }
229 int availA = getNum(vertical ? "height" : "width");
230 int availB = getNum(vertical ? "width" : "height");
231 bool stretchAll = nStretch == nc ? true : false;
232 int stretch = availA - totalA;
233 if(stretch < 0) stretch = 0;
234 for(i=0; i<nc; i++) {
235 // Swap the child order for vertical boxes, so we lay out
236 // from top to bottom instead of along the cartesian Y axis.
237 int idx = vertical ? (nc-i-1) : i;
238 LayoutWidget child = getChild(idx);
239 if (child.getBool("hide"))
242 if(child.getBool("equal")) {
243 int pad = child.padding();
244 prefA[idx] = eqA + 2*pad;
245 // Use "parent set" values to communicate the setting to
247 child.setNum(vertical ? "_psh" : "_psw", eqA);
248 child.setNum(vertical ? "_psw" : "_psh", eqB);
250 if(stretchAll || child.getBool("stretch")) {
251 int chunk = stretch / nStretch;
255 child.setNum("__stretch", chunk);
257 if(vertical) child.layout( 0, currA, availB, prefA[idx]);
258 else child.layout(currA, 0, prefA[idx], availB);
268 int w, h, row, col, rspan, cspan;
271 void LayoutWidget::doTable(bool doLayout, int* w, int* h)
273 int i, j, nc = nChildren();
274 TabCell* children = new TabCell[nc];
276 // Pass 1: initialize bookeeping structures
277 int rows = 0, cols = 0;
278 for(i=0; i<nc; i++) {
279 TabCell* cell = &children[i];
280 cell->child = getChild(i);
281 cell->child.calcPrefSize(&cell->w, &cell->h);
282 cell->row = cell->child.getNum("row");
283 cell->col = cell->child.getNum("col");
284 cell->rspan = cell->child.hasField("rowspan") ? cell->child.getNum("rowspan") : 1;
285 cell->cspan = cell->child.hasField("colspan") ? cell->child.getNum("colspan") : 1;
286 if(cell->row + cell->rspan > rows) rows = cell->row + cell->rspan;
287 if(cell->col + cell->cspan > cols) cols = cell->col + cell->cspan;
289 int* rowSizes = new int[rows];
290 int* colSizes = new int[cols];
291 for(i=0; i<rows; i++) rowSizes[i] = 0;
292 for(i=0; i<cols; i++) colSizes[i] = 0;
294 // Pass 1a (hack): we want row zero to be the top, not the
295 // (cartesian: y==0) bottom, so reverse the sense of the row
297 for(i=0; i<nc; i++) {
298 TabCell* cell = &children[i];
299 cell->row = rows - cell->row - cell->rspan;
302 // Pass 2: get sizes for single-cell children
303 for(i=0; i<nc; i++) {
304 TabCell* cell = &children[i];
305 if(cell->rspan < 2 && cell->h > rowSizes[cell->row])
306 rowSizes[cell->row] = cell->h;
307 if(cell->cspan < 2 && cell->w > colSizes[cell->col])
308 colSizes[cell->col] = cell->w;
311 // Pass 3: multi-cell children, make space as needed
312 for(i=0; i<nc; i++) {
313 TabCell* cell = &children[i];
314 if(cell->rspan > 1) {
316 for(j=0; j<cell->rspan; j++)
317 total += rowSizes[cell->row + j];
318 int extra = total - cell->h;
320 for(j=0; j<cell->rspan; j++) {
321 int chunk = extra / (cell->rspan - j);
322 rowSizes[cell->row + j] += chunk;
327 if(cell->cspan > 1) {
329 for(j=0; j<cell->cspan; j++)
330 total += colSizes[cell->col + j];
331 int extra = total - cell->w;
333 for(j=0; j<cell->cspan; j++) {
334 int chunk = extra / (cell->cspan - j);
335 colSizes[cell->col + j] += chunk;
342 // Calculate our preferred sizes, and return if we aren't doing layout
343 int prefw=0, prefh=0;
344 for(i=0; i<cols; i++) prefw += colSizes[i];
345 for(i=0; i<rows; i++) prefh += rowSizes[i];
348 *w = prefw; *h = prefh;
349 delete[] children; delete[] rowSizes; delete[] colSizes;
353 // Allocate extra space
354 int pad = 2*padding();
355 int extra = getNum("height") - pad - prefh;
356 for(i=0; i<rows; i++) {
357 int chunk = extra / (rows - i);
358 rowSizes[i] += chunk;
361 extra = getNum("width") - pad - prefw;
362 for(i=0; i<cols; i++) {
363 int chunk = extra / (cols - i);
364 colSizes[i] += chunk;
368 // Finally, lay out the children (with just two more temporary
369 // arrays for calculating coordinates)
370 int* rowY = new int[rows];
372 for(i=0; i<rows; i++) { rowY[i] = total; total += rowSizes[i]; }
374 int* colX = new int[cols];
376 for(i=0; i<cols; i++) { colX[i] = total; total += colSizes[i]; }
378 for(i=0; i<nc; i++) {
379 TabCell* cell = &children[i];
381 for(j=0; j<cell->rspan; j++) h += rowSizes[cell->row + j];
382 for(j=0; j<cell->cspan; j++) w += colSizes[cell->col + j];
383 int x = colX[cell->col];
384 int y = rowY[cell->row];
385 cell->child.layout(x, y, w, h);