2 * Copyright (C) 2013,2015 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.3
19 import Ubuntu.Components.Themes.Ambiance 1.3
20 import Ubuntu.Components.Popups 1.3
21 import Ubuntu.Components.ListItems 1.3
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)
105 searchTextField.forceActiveFocus();
109 function refreshLogo() {
110 if (root.scopeStyle ? root.scopeStyle.headerLogo != "" : false) {
111 header.contents = imageComponent.createObject();
112 } else if (header.contents) {
113 header.contents.destroy();
114 header.contents = null;
119 target: root.scopeStyle
120 onHeaderLogoChanged: root.refreshLogo()
124 anchors { fill: parent; margins: units.gu(1); bottomMargin: units.gu(3) + bottomContainer.height }
125 visible: headerContainer.showSearch
127 closePopup(/* keepFocus */false);
128 if (!searchTextField.text) {
129 headerContainer.showSearch = false;
131 mouse.accepted = false;
137 objectName: "headerContainer"
138 clip: contentY < height
139 anchors { left: parent.left; top: parent.top; right: parent.right }
140 height: header.contentHeight
141 contentHeight: headersColumn.height
143 contentY: showSearch ? 0 : height
145 property bool showSearch: false
146 property var popover: null
150 objectName: "headerBackground"
151 style: scopeStyle.headerBackground
154 Behavior on contentY {
155 UbuntuNumberAnimation {
156 id: openSearchAnimation
157 property bool openSearchHistory: false
160 if (!running && openSearchAnimation.openSearchHistory) {
161 openSearchAnimation.openSearchHistory = false;
162 root.openSearchHistory();
170 anchors { left: parent.left; right: parent.right }
174 anchors { left: parent.left; right: parent.right }
175 opacity: headerContainer.clip || headerContainer.showSearch ? 1 : 0 // setting visible false cause column to relayout
176 __separator_visible: false
177 // Required to keep PageHeadStyle noise down as it expects the Page's properties around.
178 property var styledItem: searchHeader
179 property color dividerColor: "transparent" // Doesn't matter as we don't have PageHeadSections
180 property color panelColor: background.topColor
181 panelForegroundColor: config.foregroundColor
182 config: PageHeadConfiguration {
183 foregroundColor: root.scopeStyle ? root.scopeStyle.headerForeground : theme.palette.normal.baseText
188 headerContainer.showSearch = false;
192 property var contents: TextField {
194 objectName: "searchTextField"
195 inputMethodHints: Qt.ImhNoPredictiveText
196 hasClearButton: false
199 leftMargin: units.gu(1)
200 topMargin: units.gu(1)
201 bottomMargin: units.gu(1)
202 rightMargin: root.width > units.gu(60) ? root.width - units.gu(40) : units.gu(1)
205 secondaryItem: AbstractButton {
206 height: searchTextField.height
208 enabled: searchTextField.text.length > 0
211 objectName: "clearIcon"
213 anchors.margins: units.gu(.75)
214 source: "image://theme/clear"
215 opacity: searchTextField.text.length > 0
217 Behavior on opacity {
218 UbuntuNumberAnimation { duration: UbuntuAnimation.FastDuration }
223 root.resetSearch(true);
224 root.openSearchHistory();
228 onActiveFocusChanged: {
230 root.searchTextFieldFocused();
231 root.openSearchHistory();
237 closePopup(/* keepFocus */true);
245 objectName: "innerPageHeader"
246 anchors { left: parent.left; right: parent.right }
247 height: headerContainer.height
248 opacity: headerContainer.clip || !headerContainer.showSearch ? 1 : 0 // setting visible false cause column to relayout
249 __separator_visible: false
250 property var styledItem: header
251 property color dividerColor: "transparent" // Doesn't matter as we don't have PageHeadSections
252 property color panelColor: background.topColor
253 panelForegroundColor: config.foregroundColor
254 config: PageHeadConfiguration {
256 foregroundColor: root.scopeStyle ? root.scopeStyle.headerForeground : theme.palette.normal.baseText
258 iconName: backIsClose ? "close" : "back"
259 visible: root.showBackButton
260 onTriggered: root.backClicked()
266 text: i18n.ctr("Button: Open the Ubuntu Store", "Store")
267 iconName: "ubuntu-store-symbolic"
268 visible: root.storeEntryEnabled
269 onTriggered: root.storeClicked();
273 text: i18n.ctr("Button: Start a search in the current dash scope", "Search")
275 visible: root.searchEntryEnabled
277 headerContainer.showSearch = true;
278 searchTextField.forceActiveFocus();
282 objectName: "settings"
283 text: i18n.ctr("Button: Show the current dash scope settings", "Settings")
285 visible: root.settingsEnabled
286 onTriggered: root.settingsClicked()
289 objectName: "favorite"
290 text: root.favorite ? i18n.tr("Remove from Favorites") : i18n.tr("Add to Favorites")
291 iconName: root.favorite ? "starred" : "non-starred"
292 visible: root.favoriteEnabled
293 onTriggered: root.favoriteClicked()
298 property var contents: null
299 Component.onCompleted: root.refreshLogo()
305 anchors { fill: parent; topMargin: units.gu(1.5); bottomMargin: units.gu(1.5) }
308 objectName: "titleImage"
310 source: root.scopeStyle ? root.scopeStyle.headerLogo : ""
311 fillMode: Image.PreserveAspectFit
312 horizontalAlignment: Image.AlignLeft
313 sourceSize.height: height
327 property bool unfocusOnDestruction: false
329 Component.onDestruction: {
330 headerContainer.popover = null;
331 if (unfocusOnDestruction) {
345 objectName: "recentSearches"
349 showDivider: index < recentSearches.count - 1
352 searchHistory.addQuery(text);
353 searchTextField.text = text;
354 closePopup(/* keepFocus */false);
364 visible: showSignatureLine
366 top: headerContainer.bottom
369 bottom: bottomContainer.top
372 color: root.scopeStyle ? root.scopeStyle.headerDividerColor : "#e0e0e0"
381 color: Qt.darker(parent.color, 1.1)
386 visible: bottomBorder.visible
387 spacing: units.gu(.5)
389 objectName: "paginationRepeater"
390 model: root.paginationCount
392 objectName: "paginationDots_" + index
395 source: (index == root.paginationIndex) ? "graphics/pagination_dot_on.png" : "graphics/pagination_dot_off.png"
399 top: headerContainer.bottom
400 horizontalCenter: headerContainer.horizontalCenter
401 topMargin: units.gu(.5)
405 // FIXME this doesn't work with solid scope backgrounds due to z-ordering
408 visible: bottomBorder.visible
410 top: bottomContainer.top
418 // FIXME this should be a shader when bottomItem exists
419 // to support image backgrounds
422 color: if (bottomItem && bottomItem.background) {
423 Qt.lighter(Qt.rgba(bottomItem.background.topColor.r,
424 bottomItem.background.topColor.g,
425 bottomItem.background.topColor.b, 1.0), 1.2);
426 } else if (!bottomItem && root.scopeStyle) {
427 Qt.lighter(Qt.rgba(root.scopeStyle.background.r,
428 root.scopeStyle.background.g,
429 root.scopeStyle.background.b, 1.0), 1.2);
440 bottom: parent.bottom
442 height: childrenRect.height