Unity 8
CardTool.qml
1 /*
2  * Copyright (C) 2014 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.4
18 import Ubuntu.Components 1.3
19 import Dash 0.1
20 
21 /*!
22  \brief Tool for introspecting Card properties.
23 
24  Some properties of Cards we need to determine category-wide (like card sizes in grid),
25  so we should not do them per-Card but in the category renderer.
26 
27  This component creates an invisible card filled with maximum mapped data and calculates
28  or measures card properties for this configuration.
29  */
30 
31 Item {
32  id: cardTool
33 
34  /*!
35  \brief Number of cards.
36  */
37  property int count
38 
39  /*!
40  \brief Width of the category view.
41  */
42  property real viewWidth
43 
44  /*!
45  \brief Template supplied for the category.
46  */
47  property var template
48 
49  /*!
50  \brief Component mapping supplied for the category.
51  */
52  property var components
53 
54  /*!
55  \brief The Scope this cardTool is representing
56  */
57  property string scopeId
58 
59  /*!
60  \brief The Scope category this cardTool is representing
61  */
62  property string categoryId
63 
64  /*!
65  \brief Scaling factor of selected Carousel item.
66  */
67  readonly property real carouselSelectedItemScaleFactor: 1.38 // XXX assuming 1.38 carousel scaling factor for cards
68 
69  /*!
70  \brief The category layout for this card tool.
71  */
72  readonly property string categoryLayout: {
73  var layout = template["category-layout"];
74 
75  // carousel fallback mode to grid
76  if (layout === "carousel" && count <= Math.ceil(carouselTool.realPathItemCount)) layout = "grid";
77  return layout;
78  }
79 
80  readonly property string artShapeStyle: {
81  return categoryLayout === "carousel" ? "shadow" : "flat"
82  }
83 
84  // FIXME ? This seems like it should not be needed, but on Qt 5.4 + phone
85  // we are doing unneeded calls to getCardComponent with artShapeStyle and categoryLayout being empty
86  // Check when we move to newer Qts on the phone if we still need this
87  readonly property bool askForCardComponent: cardTool.template !== undefined &&
88  cardTool.components !== undefined &&
89  cardTool.artShapeStyle !== "" &&
90  cardTool.categoryLayout !== ""
91 
92  property var cardComponent: askForCardComponent
93  ? CardCreatorCache.getCardComponent(cardTool.template, cardTool.components, false, cardTool.artShapeStyle, cardTool.categoryLayout)
94  : undefined
95 
96  // FIXME: Saviq
97  // Only way for the card below to actually be laid out completely.
98  // If invisible or in "data" array, some components are not taken into account.
99  width: 0
100  height: 0
101  clip: true
102 
103  // We have 3 view "widths"
104  // narrow <= 45gu
105  // normal
106  // wide >= 70gu
107  readonly property bool isWideView: viewWidth >= units.gu(70)
108  readonly property bool isNarrowView: viewWidth <= units.gu(45)
109 
110  /*!
111  type:real \brief Width to be enforced on the card in this configuration.
112 
113  If -1, should use implicit width of the actual card.
114  */
115  readonly property real cardWidth: {
116  switch (categoryLayout) {
117  case "grid":
118  case "vertical-journal":
119  var size = template["card-size"];
120  if (template["card-layout"] === "horizontal") size = "large";
121  switch (size) {
122  case "small": {
123  if (isNarrowView) return units.gu(12);
124  else return units.gu(14);
125  }
126  case "large": {
127  if (isWideView) return units.gu(42);
128  else return viewWidth - units.gu(2);
129  }
130  }
131  if (isNarrowView) return units.gu(18);
132  else if (isWideView) return units.gu(20);
133  else return units.gu(23);
134  case "carousel":
135  case "horizontal-list":
136  return carouselTool.minimumTileWidth;
137  case undefined:
138  case "organic-grid":
139  case "journal":
140  default:
141  return -1;
142  }
143  }
144 
145  /*!
146  type:real \brief Height to be enforced on the card in this configuration.
147 
148  If -1, should use implicit height of the actual card.
149  */
150  readonly property real cardHeight: {
151  switch (categoryLayout) {
152  case "journal":
153  if (template["card-size"] >= 12 && template["card-size"] <= 38) return units.gu(template["card-size"]);
154  return units.gu(18.5);
155  case "grid":
156  case "horizontal-list":
157  return cardLoader.item ? cardLoader.item.implicitHeight : 0
158  case "carousel":
159  return cardWidth / (components ? components["art"]["aspect-ratio"] : 1)
160  case undefined:
161  case "organic-grid":
162  case "vertical-journal":
163  default:
164  return -1;
165  }
166  }
167 
168  /*!
169  type:real \brief Height of the card's header.
170  */
171  readonly property int headerHeight: cardLoader.item ? cardLoader.item.headerHeight : 0
172 
173  readonly property size artShapeSize: {
174  return cardLoader.item ? cardLoader.item.artShapeSize : Qt.size(0, 0)
175  }
176 
177  QtObject {
178  id: carouselTool
179 
180  readonly property real minimumTileWidth: {
181  if (cardTool.viewWidth === undefined) return undefined;
182  if (cardTool.viewWidth <= units.gu(40)) return units.gu(18);
183  if (cardTool.viewWidth >= units.gu(128)) return units.gu(26);
184  return units.gu(18 + Math.round((cardTool.viewWidth - units.gu(40)) / units.gu(11)));
185  }
186 
187  readonly property real pathItemCount: 4.8457 /// (848 / 175) reference values
188 
189  readonly property real realPathItemCount: {
190  var scaledMinimumTileWidth = minimumTileWidth / cardTool.carouselSelectedItemScaleFactor;
191  var tileWidth = Math.max(cardTool.viewWidth / pathItemCount, scaledMinimumTileWidth);
192  return Math.min(cardTool.viewWidth / tileWidth, pathItemCount);
193  }
194  }
195 
196  Item {
197  id: attributesModel
198  property int numOfAttributes: 0
199  property var model: []
200  readonly property bool hasAttributes: {
201  var attributes = components["attributes"];
202  var hasAttributesFlag = (attributes != undefined) && (attributes["field"] != undefined);
203 
204  if (hasAttributesFlag) {
205  if (attributes["max-count"]) {
206  numOfAttributes = attributes["max-count"];
207  }
208  }
209  return hasAttributesFlag
210  }
211 
212  onNumOfAttributesChanged: {
213  model = []
214  for (var i = 0; i < numOfAttributes; i++) {
215  model.push( {"value":"text"+(i+1), "icon":"image://theme/ok" } );
216  }
217  }
218  }
219 
220  Item {
221  id: socialActionsModel
222  property var model: []
223  readonly property bool hasActions: components["social-actions"] != undefined
224 
225  onHasActionsChanged: {
226  model = []
227  if (hasActions) {
228  model.push( {"id":"text", "icon":"image://theme/ok" } );
229  }
230  }
231  }
232 
233  Loader {
234  id: cardLoader
235  readonly property var cfields: ["art", "mascot", "title", "subtitle", "summary", "attributes", "social-actions"]
236  readonly property var dfields: ["art", "mascot", "title", "subtitle", "summary", "attributes", "socialActions"]
237  readonly property var maxData: {
238  "art": Qt.resolvedUrl("graphics/pixel.png"),
239  "mascot": Qt.resolvedUrl("graphics/pixel.png"),
240  "title": "—\n—",
241  "subtitle": "—",
242  "summary": "—\n—\n—\n—\n—",
243  "attributes": attributesModel.model,
244  "socialActions": socialActionsModel.model
245  }
246  sourceComponent: askForCardComponent
247  ? CardCreatorCache.getCardComponent(cardTool.template, cardTool.components, true, cardTool.artShapeStyle, cardTool.categoryLayout)
248  : undefined
249  onLoaded: {
250  item.objectName = "cardToolCard";
251  item.width = Qt.binding(function() { return cardTool.cardWidth !== -1 ? cardTool.cardWidth : item.implicitWidth; });
252  item.height = Qt.binding(function() { return cardTool.cardHeight !== -1 ? cardTool.cardHeight : item.implicitHeight; });
253  }
254  Connections {
255  target: cardTool
256  onTemplateChanged: cardLoader.updateCardData();
257  onComponentsChanged: cardLoader.updateCardData();
258  }
259  function updateCardData() {
260  var data = {};
261  for (var k in cfields) {
262  var ckey = cfields[k];
263  var component = cardTool.components[ckey];
264  if ((typeof component === "string" && component.length > 0) ||
265  (typeof component === "object" && component !== null
266  && typeof component["field"] === "string" && component["field"].length > 0)) {
267  var dkey = dfields[k];
268  data[dkey] = maxData[dkey];
269  }
270  }
271  item.cardData = data;
272  }
273  }
274 }