Unity 8
 All Classes Functions
ResponsiveGridView.qml
1 /*
2  * Copyright (C) 2013 Canonical, Ltd.
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; version 3.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  */
16 
17 import QtQuick 2.3
18 import Ubuntu.Components 0.1
19 import "Flickables" as Flickables
20 
21 /*
22  Essentially a GridView where you can specify the maximum number of columns it can have.
23  */
24 Item {
25  property int minimumHorizontalSpacing: units.gu(0.5)
26  // property int minimumNumberOfColumns: 2 // FIXME: not implemented
27  property int maximumNumberOfColumns: 6
28  readonly property int columns: gridView.columns
29  property alias verticalSpacing: gridView.verticalSpacing
30  readonly property alias margins: gridView.margin
31  property int delegateWidth
32  property int delegateHeight
33  property alias model: gridView.model
34  property alias delegate: gridView.delegate
35  readonly property int cellWidth: gridView.cellWidth
36  readonly property int cellHeight: gridView.cellHeight
37  readonly property int totalContentHeight: {
38  if (gridView.model) {
39  return contentHeightForRows(Math.ceil(gridView.model.count / columns), cellHeight)
40  } else {
41  return 0;
42  }
43  }
44  property alias interactive: gridView.interactive
45  readonly property alias flicking: gridView.flicking
46  readonly property alias moving: gridView.moving
47  readonly property alias pressDelay: gridView.pressDelay
48  readonly property alias originY: gridView.originY
49  property alias displayMarginBeginning: gridView.displayMarginBeginning
50  property alias displayMarginEnd: gridView.displayMarginEnd
51  property alias highlightIndex: gridView.highlightIndex
52  property alias cacheBuffer: gridView.cacheBuffer
53  readonly property alias currentItem: gridView.currentItem
54 
55  function contentHeightForRows(rows, height) {
56  return rows * height
57  }
58 
59  Flickables.GridView {
60  id: gridView
61  objectName: "responsiveGridViewGrid"
62  anchors {
63  fill: parent
64  leftMargin: margin/2
65  rightMargin: margin/2
66  }
67  clip: parent.height != totalContentHeight
68 
69  function pixelToGU(value) {
70  return Math.floor(value / units.gu(1));
71  }
72 
73  function spacingForColumns(columns) {
74  // spacing between columns as an integer number of GU, the remainder goes in the margins
75  var spacingGU = pixelToGU(allocatableHorizontalSpace / columns);
76  return units.gu(spacingGU);
77  }
78 
79  function columnsForSpacing(spacing) {
80  // minimum margin is half of the spacing
81  return Math.max(1, Math.floor(parent.width / (delegateWidth + spacing)));
82  }
83 
84  property real allocatableHorizontalSpace: parent.width - columns * delegateWidth
85  property int columns: Math.min(columnsForSpacing(minimumHorizontalSpacing), maximumNumberOfColumns)
86  property real horizontalSpacing: spacingForColumns(columns)
87  property real verticalSpacing: horizontalSpacing
88  property int margin: allocatableHorizontalSpace - columns * horizontalSpacing
89  property int highlightIndex: -1
90 
91  cellWidth: delegateWidth + horizontalSpacing
92  cellHeight: delegateHeight + verticalSpacing
93 
94  onHighlightIndexChanged: {
95  if (highlightIndex != -1) {
96  currentIndex = highlightIndex
97  }
98  }
99  }
100 }