2 * Copyright (C) 2013 Canonical, Ltd.
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.
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.
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/>.
18 import Ubuntu.Components 1.1
19 import Ubuntu.Components.Themes.Ambiance 1.1
20 import Ubuntu.Components.Popups 1.0
21 import Ubuntu.Components.ListItems 1.0
22 import "../Components"
23 import "../Components/SearchHistoryModel"
27 objectName: "pageHeader"
28 implicitHeight: headerContainer.height + bottomContainer.height + (showSignatureLine ? units.gu(2) : 0)
30 property bool showBackButton: false
31 property bool backIsClose: false
34 property bool storeEntryEnabled: false
35 property bool searchEntryEnabled: false
36 property bool settingsEnabled: false
37 property bool favoriteEnabled: false
38 property bool favorite: false
39 property ListModel searchHistory: SearchHistoryModel
40 property alias searchQuery: searchTextField.text
41 property alias searchHint: searchTextField.placeholderText
42 property bool showSignatureLine: true
44 property alias bottomItem: bottomContainer.children
45 property int paginationCount: 0
46 property int paginationIndex: -1
48 property var scopeStyle: null
52 signal settingsClicked()
53 signal favoriteClicked()
54 signal searchTextFieldFocused()
56 onScopeStyleChanged: refreshLogo()
57 onSearchQueryChanged: {
58 // Make sure we are at the search page if the search query changes behind our feet
60 headerContainer.showSearch = true;
64 function triggerSearch() {
65 if (searchEntryEnabled) {
66 headerContainer.showSearch = true;
67 searchTextField.forceActiveFocus();
71 function closePopup(keepFocus) {
72 if (headerContainer.popover != null) {
73 headerContainer.popover.unfocusOnDestruction = !keepFocus;
74 PopupUtils.close(headerContainer.popover);
75 } else if (!keepFocus) {
80 function resetSearch(keepFocus) {
82 searchHistory.addQuery(searchTextField.text);
84 searchTextField.text = "";
85 closePopup(keepFocus);
89 searchTextField.focus = false;
90 if (!searchTextField.text) {
91 headerContainer.showSearch = false;
95 function openSearchHistory() {
96 if (openSearchAnimation.running) {
97 openSearchAnimation.openSearchHistory = true;
98 } else if (root.searchHistory.count > 0 && headerContainer.popover == null) {
99 headerContainer.popover = PopupUtils.open(popoverComponent, searchTextField,
101 "contentWidth": searchTextField.width,
102 "edgeMargins": units.gu(1)
108 function refreshLogo() {
109 if (root.scopeStyle ? root.scopeStyle.headerLogo != "" : false) {
110 header.contents = imageComponent.createObject();
111 } else if (header.contents) {
112 header.contents.destroy();
113 header.contents = null;
118 target: root.scopeStyle
119 onHeaderLogoChanged: root.refreshLogo()
123 anchors { fill: parent; margins: units.gu(1); bottomMargin: units.gu(3) + bottomContainer.height }
124 visible: headerContainer.showSearch
126 closePopup(/* keepFocus */false);
127 if (!searchTextField.text) {
128 headerContainer.showSearch = false;
130 mouse.accepted = false;
136 objectName: "headerContainer"
137 clip: contentY < height
138 anchors { left: parent.left; top: parent.top; right: parent.right }
140 contentHeight: headersColumn.height
142 contentY: showSearch ? 0 : height
144 property bool showSearch: false
145 property var popover: null
149 objectName: "headerBackground"
150 style: scopeStyle.headerBackground
153 Behavior on contentY {
154 UbuntuNumberAnimation {
155 id: openSearchAnimation
156 property bool openSearchHistory: false
159 if (!running && openSearchAnimation.openSearchHistory) {
160 openSearchAnimation.openSearchHistory = false;
161 root.openSearchHistory();
169 anchors { left: parent.left; right: parent.right }
173 anchors { left: parent.left; right: parent.right }
174 height: headerContainer.height
175 contentHeight: height
176 opacity: headerContainer.clip || headerContainer.showSearch ? 1 : 0 // setting visible false cause column to relayout
177 __separator_visible: false
178 // Required to keep PageHeadStyle noise down as it expects the Page's properties around.
179 property var styledItem: searchHeader
180 property string title
181 property color dividerColor: "transparent" // Doesn't matter as we don't have PageHeadSections
182 property color panelColor: background.topColor
183 panelForegroundColor: config.foregroundColor
184 property var config: PageHeadConfiguration {
185 foregroundColor: root.scopeStyle ? root.scopeStyle.headerForeground : Theme.palette.normal.baseText
190 headerContainer.showSearch = false;
194 property var contents: TextField {
196 objectName: "searchTextField"
197 inputMethodHints: Qt.ImhNoPredictiveText
198 hasClearButton: false
201 leftMargin: units.gu(1)
202 topMargin: units.gu(1)
203 bottomMargin: units.gu(1)
204 rightMargin: root.width > units.gu(60) ? root.width - units.gu(40) : units.gu(1)
207 secondaryItem: AbstractButton {
208 height: searchTextField.height
210 enabled: searchTextField.text.length > 0
213 objectName: "clearIcon"
215 anchors.margins: units.gu(.75)
216 source: "image://theme/clear"
217 opacity: searchTextField.text.length > 0
219 Behavior on opacity {
220 UbuntuNumberAnimation { duration: UbuntuAnimation.FastDuration }
225 root.resetSearch(true);
226 root.openSearchHistory();
230 onActiveFocusChanged: {
232 root.searchTextFieldFocused();
233 root.openSearchHistory();
239 closePopup(/* keepFocus */true);
247 objectName: "innerPageHeader"
248 anchors { left: parent.left; right: parent.right }
249 height: headerContainer.height
250 contentHeight: height
251 opacity: headerContainer.clip || !headerContainer.showSearch ? 1 : 0 // setting visible false cause column to relayout
252 __separator_visible: false
253 property var styledItem: header
254 property string title: root.title
255 property color dividerColor: "transparent" // Doesn't matter as we don't have PageHeadSections
256 property color panelColor: background.topColor
257 panelForegroundColor: config.foregroundColor
258 property var config: PageHeadConfiguration {
259 foregroundColor: root.scopeStyle ? root.scopeStyle.headerForeground : Theme.palette.normal.baseText
261 iconName: backIsClose ? "close" : "back"
262 visible: root.showBackButton
263 onTriggered: root.backClicked()
269 text: i18n.ctr("Button: Open the Ubuntu Store", "Store")
270 iconName: "ubuntu-store-symbolic"
271 visible: root.storeEntryEnabled
272 onTriggered: root.storeClicked();
276 text: i18n.ctr("Button: Start a search in the current dash scope", "Search")
278 visible: root.searchEntryEnabled
280 headerContainer.showSearch = true;
281 searchTextField.forceActiveFocus();
285 objectName: "settings"
286 text: i18n.ctr("Button: Show the current dash scope settings", "Settings")
288 visible: root.settingsEnabled
289 onTriggered: root.settingsClicked()
292 objectName: "favorite"
293 text: root.favorite ? i18n.tr("Remove from Favorites") : i18n.tr("Add to Favorites")
294 iconName: root.favorite ? "starred" : "non-starred"
295 visible: root.favoriteEnabled
296 onTriggered: root.favoriteClicked()
301 property var contents: null
302 Component.onCompleted: root.refreshLogo()
308 anchors { fill: parent; topMargin: units.gu(1.5); bottomMargin: units.gu(1.5) }
311 objectName: "titleImage"
313 source: root.scopeStyle ? root.scopeStyle.headerLogo : ""
314 fillMode: Image.PreserveAspectFit
315 horizontalAlignment: Image.AlignLeft
316 sourceSize.height: height
330 property bool unfocusOnDestruction: false
332 Component.onDestruction: {
333 headerContainer.popover = null;
334 if (unfocusOnDestruction) {
348 objectName: "recentSearches"
352 showDivider: index < recentSearches.count - 1
355 searchHistory.addQuery(text);
356 searchTextField.text = text;
357 closePopup(/* keepFocus */false);
367 visible: showSignatureLine
369 top: headerContainer.bottom
372 bottom: bottomContainer.top
375 color: root.scopeStyle ? root.scopeStyle.headerDividerColor : "#e0e0e0"
384 color: Qt.darker(parent.color, 1.1)
389 visible: bottomBorder.visible
390 spacing: units.gu(.5)
392 objectName: "paginationRepeater"
393 model: root.paginationCount
395 objectName: "paginationDots_" + index
398 source: (index == root.paginationIndex) ? "graphics/pagination_dot_on.png" : "graphics/pagination_dot_off.png"
402 top: headerContainer.bottom
403 horizontalCenter: headerContainer.horizontalCenter
404 topMargin: units.gu(.5)
408 // FIXME this doesn't work with solid scope backgrounds due to z-ordering
411 visible: bottomBorder.visible
413 top: bottomContainer.top
421 // FIXME this should be a shader when bottomItem exists
422 // to support image backgrounds
425 color: if (bottomItem && bottomItem.background) {
426 Qt.lighter(Qt.rgba(bottomItem.background.topColor.r,
427 bottomItem.background.topColor.g,
428 bottomItem.background.topColor.b, 1.0), 1.2);
429 } else if (!bottomItem && root.scopeStyle) {
430 Qt.lighter(Qt.rgba(root.scopeStyle.background.r,
431 root.scopeStyle.background.g,
432 root.scopeStyle.background.b, 1.0), 1.2);
443 bottom: parent.bottom
445 height: childrenRect.height