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 
20 /*
21  Essentially a GridView where you can specify the maximum number of columns it can have.
22  */
23 Item {
24  property int minimumHorizontalSpacing: units.gu(0.5)
25  // property int minimumNumberOfColumns: 2 // FIXME: not implemented
26  property int maximumNumberOfColumns: 6
27  readonly property int columns: gridView.columns
28  property alias verticalSpacing: gridView.verticalSpacing
29  readonly property alias margins: gridView.margin
30  property int delegateWidth
31  property int delegateHeight
32  property alias model: gridView.model
33  property alias delegate: gridView.delegate
34  readonly property int cellWidth: gridView.cellWidth
35  readonly property int cellHeight: gridView.cellHeight
36  readonly property int totalContentHeight: {
37  return contentHeightForRows(Math.ceil(gridView.model.count / columns), cellHeight)
38  }
39  property alias interactive: gridView.interactive
40  readonly property alias flicking: gridView.flicking
41  readonly property alias moving: gridView.moving
42  readonly property alias pressDelay: gridView.pressDelay
43  readonly property alias originY: gridView.originY
44  property alias displayMarginBeginning: gridView.displayMarginBeginning
45  property alias displayMarginEnd: gridView.displayMarginEnd
46  property alias highlightIndex: gridView.highlightIndex
47  property alias cacheBuffer: gridView.cacheBuffer
48  readonly property alias currentItem: gridView.currentItem
49 
50  function contentHeightForRows(rows, height) {
51  return rows * height
52  }
53 
54  GridView {
55  id: gridView
56  objectName: "responsiveGridViewGrid"
57  anchors {
58  fill: parent
59  leftMargin: margin/2
60  rightMargin: margin/2
61  }
62  clip: parent.height != totalContentHeight
63 
64  function pixelToGU(value) {
65  return Math.floor(value / units.gu(1));
66  }
67 
68  function spacingForColumns(columns) {
69  // spacing between columns as an integer number of GU, the remainder goes in the margins
70  var spacingGU = pixelToGU(allocatableHorizontalSpace / columns);
71  return units.gu(spacingGU);
72  }
73 
74  function columnsForSpacing(spacing) {
75  // minimum margin is half of the spacing
76  return Math.max(1, Math.floor(parent.width / (delegateWidth + spacing)));
77  }
78 
79  property real allocatableHorizontalSpace: parent.width - columns * delegateWidth
80  property int columns: Math.min(columnsForSpacing(minimumHorizontalSpacing), maximumNumberOfColumns)
81  property real horizontalSpacing: spacingForColumns(columns)
82  property real verticalSpacing: horizontalSpacing
83  property int margin: allocatableHorizontalSpace - columns * horizontalSpacing
84  property int highlightIndex: -1
85 
86  cellWidth: delegateWidth + horizontalSpacing
87  cellHeight: delegateHeight + verticalSpacing
88 
89  onHighlightIndexChanged: {
90  if (highlightIndex != -1) {
91  currentIndex = highlightIndex
92  }
93  }
94  }
95 }