1
=== modified file 'components.api'
2
--- components.api	2015-09-14 11:32:40 +0000
3
+++ components.api	2015-09-23 11:35:46 +0000
4
@@ -389,6 +389,10 @@
5
389
    property bool useDeprecatedToolbar
389
    property bool useDeprecatedToolbar
6
390
Ubuntu.Components.ListItems.Header 1.3: Item
390
Ubuntu.Components.ListItems.Header 1.3: Item
7
391
    property string text
391
    property string text
8
392
Ubuntu.Components.Header 1.3: StyledItem
9
393
    property bool exposed
10
394
    property Flickable flickable
11
395
    readonly property bool moving
12
392
Ubuntu.Components.Icon 1.0 0.1: Item
396
Ubuntu.Components.Icon 1.0 0.1: Item
13
393
    property color color
397
    property color color
14
394
    property color keyColor
398
    property color keyColor
15
395
399
16
=== renamed file 'src/Ubuntu/Components/ListItems/1.2/Header.qml' => 'src/Ubuntu/Components/ListItems/1.2/ListItemHeader.qml'
17
--- src/Ubuntu/Components/ListItems/1.2/Header.qml	2015-04-30 08:32:44 +0000
18
+++ src/Ubuntu/Components/ListItems/1.2/ListItemHeader.qml	2015-09-23 11:35:46 +0000
19
@@ -18,6 +18,7 @@
20
18
18
21
19
/*!
19
/*!
22
20
    \qmltype Header
20
    \qmltype Header
23
21
    \deprecated
24
21
    \inqmlmodule Ubuntu.Components.ListItems 1.0
22
    \inqmlmodule Ubuntu.Components.ListItems 1.0
25
22
    \ingroup ubuntu-listitems
23
    \ingroup ubuntu-listitems
26
23
    \brief Header for grouping list items together
24
    \brief Header for grouping list items together
27
24
25
28
=== renamed file 'src/Ubuntu/Components/ListItems/1.3/Header.qml' => 'src/Ubuntu/Components/ListItems/1.3/ListItemHeader.qml'
29
--- src/Ubuntu/Components/ListItems/1.3/Header.qml	2015-04-29 07:21:29 +0000
30
+++ src/Ubuntu/Components/ListItems/1.3/ListItemHeader.qml	2015-09-23 11:35:46 +0000
31
@@ -18,6 +18,7 @@
32
18
18
33
19
/*!
19
/*!
34
20
    \qmltype Header
20
    \qmltype Header
35
21
    \deprecated
36
21
    \inqmlmodule Ubuntu.Components.ListItems 1.0
22
    \inqmlmodule Ubuntu.Components.ListItems 1.0
37
22
    \ingroup ubuntu-listitems
23
    \ingroup ubuntu-listitems
38
23
    \brief Header for grouping list items together
24
    \brief Header for grouping list items together
39
24
25
40
=== modified file 'src/Ubuntu/Components/ListItems/ListItems.pro'
41
--- src/Ubuntu/Components/ListItems/ListItems.pro	2015-05-19 09:23:01 +0000
42
+++ src/Ubuntu/Components/ListItems/ListItems.pro	2015-09-23 11:35:46 +0000
43
@@ -6,7 +6,7 @@
44
6
             1.2/Empty.qml \
6
             1.2/Empty.qml \
45
7
             1.2/Expandable.qml \
7
             1.2/Expandable.qml \
46
8
             1.2/ExpandablesColumn.qml \
8
             1.2/ExpandablesColumn.qml \
48
9
             1.2/Header.qml \
9
             1.2/ListItemHeader.qml \
49
10
             1.2/IconVisual.qml \
10
             1.2/IconVisual.qml \
50
11
             1.2/ImageWithFallback.qml \
11
             1.2/ImageWithFallback.qml \
51
12
             1.2/ItemSelector.qml \
12
             1.2/ItemSelector.qml \
52
@@ -25,7 +25,7 @@
53
25
             1.3/Empty.qml \
25
             1.3/Empty.qml \
54
26
             1.3/Expandable.qml \
26
             1.3/Expandable.qml \
55
27
             1.3/ExpandablesColumn.qml \
27
             1.3/ExpandablesColumn.qml \
57
28
             1.3/Header.qml \
28
             1.3/ListItemHeader.qml \
58
29
             1.3/IconVisual.qml \
29
             1.3/IconVisual.qml \
59
30
             1.3/ImageWithFallback.qml \
30
             1.3/ImageWithFallback.qml \
60
31
             1.3/ItemSelector.qml \
31
             1.3/ItemSelector.qml \
61
32
32
62
=== modified file 'src/Ubuntu/Components/ListItems/qmldir'
63
--- src/Ubuntu/Components/ListItems/qmldir	2015-05-02 13:27:39 +0000
64
+++ src/Ubuntu/Components/ListItems/qmldir	2015-09-23 11:35:46 +0000
65
@@ -3,7 +3,7 @@
66
3
Base 0.1 1.2/Base.qml
3
Base 0.1 1.2/Base.qml
67
4
Caption 0.1 1.2/Caption.qml
4
Caption 0.1 1.2/Caption.qml
68
5
Divider 0.1 1.2/Divider.qml
5
Divider 0.1 1.2/Divider.qml
70
6
Header 0.1 1.2/Header.qml
6
Header 0.1 1.2/ListItemHeader.qml
71
7
internal IconVisual IconVisual.qml
7
internal IconVisual IconVisual.qml
72
8
internal LabelVisual LabelVisual.qml
8
internal LabelVisual LabelVisual.qml
73
9
MultiValue 0.1 1.2/MultiValue.qml
9
MultiValue 0.1 1.2/MultiValue.qml
74
@@ -23,7 +23,7 @@
75
23
Base 1.0 1.2/Base.qml
23
Base 1.0 1.2/Base.qml
76
24
Caption 1.0 1.2/Caption.qml
24
Caption 1.0 1.2/Caption.qml
77
25
Divider 1.0 1.2/Divider.qml
25
Divider 1.0 1.2/Divider.qml
79
26
Header 1.0 1.2/Header.qml
26
Header 1.0 1.2/ListItemHeader.qml
80
27
MultiValue 1.0 1.2/MultiValue.qml
27
MultiValue 1.0 1.2/MultiValue.qml
81
28
ItemSelector 1.0 1.2/ItemSelector.qml
28
ItemSelector 1.0 1.2/ItemSelector.qml
82
29
ValueSelector 1.0 1.2/ValueSelector.qml
29
ValueSelector 1.0 1.2/ValueSelector.qml
83
@@ -41,7 +41,7 @@
84
41
Base 1.3 1.3/Base.qml
41
Base 1.3 1.3/Base.qml
85
42
Caption 1.3 1.3/Caption.qml
42
Caption 1.3 1.3/Caption.qml
86
43
Divider 1.3 1.3/Divider.qml
43
Divider 1.3 1.3/Divider.qml
88
44
Header 1.3 1.3/Header.qml
44
Header 1.3 1.3/ListItemHeader.qml
89
45
MultiValue 1.3 1.3/MultiValue.qml
45
MultiValue 1.3 1.3/MultiValue.qml
90
46
ItemSelector 1.3 1.3/ItemSelector.qml
46
ItemSelector 1.3 1.3/ItemSelector.qml
91
47
ValueSelector 1.3 1.3/ValueSelector.qml
47
ValueSelector 1.3 1.3/ValueSelector.qml
92
48
48
93
=== modified file 'src/Ubuntu/Components/plugin/plugin.cpp'
94
--- src/Ubuntu/Components/plugin/plugin.cpp	2015-09-21 11:40:22 +0000
95
+++ src/Ubuntu/Components/plugin/plugin.cpp	2015-09-23 11:35:46 +0000
96
@@ -66,6 +66,7 @@
97
66
#include "ucactionitem.h"
66
#include "ucactionitem.h"
98
67
#include "uchaptics.h"
67
#include "uchaptics.h"
99
68
#include "ucabstractbutton.h"
68
#include "ucabstractbutton.h"
100
69
#include "ucheader.h"
101
69
70
102
70
#include <sys/types.h>
71
#include <sys/types.h>
103
71
#include <unistd.h>
72
#include <unistd.h>
104
@@ -240,6 +241,7 @@
105
240
    qmlRegisterType<UCProportionalShape>(uri, 1, 3, "ProportionalShape");
241
    qmlRegisterType<UCProportionalShape>(uri, 1, 3, "ProportionalShape");
106
241
    qmlRegisterType<LiveTimer>(uri, 1, 3, "LiveTimer");
242
    qmlRegisterType<LiveTimer>(uri, 1, 3, "LiveTimer");
107
242
    qmlRegisterType<UCAbstractButton>(uri, 1, 3, "AbstractButton");
243
    qmlRegisterType<UCAbstractButton>(uri, 1, 3, "AbstractButton");
108
244
    qmlRegisterType<UCHeader>(uri, 1, 3, "Header");
109
243
}
245
}
110
244
246
111
245
void UbuntuComponentsPlugin::initializeEngine(QQmlEngine *engine, const char *uri)
247
void UbuntuComponentsPlugin::initializeEngine(QQmlEngine *engine, const char *uri)
112
246
248
113
=== modified file 'src/Ubuntu/Components/plugin/plugin.pri'
114
--- src/Ubuntu/Components/plugin/plugin.pri	2015-09-21 11:40:22 +0000
115
+++ src/Ubuntu/Components/plugin/plugin.pri	2015-09-23 11:35:46 +0000
116
@@ -84,7 +84,8 @@
117
84
    $$PWD/ucactionitem.h \
84
    $$PWD/ucactionitem.h \
118
85
    $$PWD/uchaptics.h \
85
    $$PWD/uchaptics.h \
119
86
    $$PWD/ucabstractbutton.h \
86
    $$PWD/ucabstractbutton.h \
121
87
    $$PWD/ucthemingextension.h
87
    $$PWD/ucthemingextension.h \
122
88
    $$PWD/ucheader.h
123
88
89
124
89
SOURCES += $$PWD/plugin.cpp \
90
SOURCES += $$PWD/plugin.cpp \
125
90
    $$PWD/uctheme.cpp \
91
    $$PWD/uctheme.cpp \
126
@@ -141,7 +142,8 @@
127
141
    $$PWD/ucactionitem.cpp \
142
    $$PWD/ucactionitem.cpp \
128
142
    $$PWD/uchaptics.cpp \
143
    $$PWD/uchaptics.cpp \
129
143
    $$PWD/ucabstractbutton.cpp \
144
    $$PWD/ucabstractbutton.cpp \
131
144
    $$PWD/ucthemingextension.cpp
145
    $$PWD/ucthemingextension.cpp \
132
146
    $$PWD/ucheader.cpp
133
145
147
134
146
# adapters
148
# adapters
135
147
SOURCES += $$PWD/adapters/alarmsadapter_organizer.cpp
149
SOURCES += $$PWD/adapters/alarmsadapter_organizer.cpp
136
148
150
137
=== added file 'src/Ubuntu/Components/plugin/ucheader.cpp'
138
--- src/Ubuntu/Components/plugin/ucheader.cpp	1970-01-01 00:00:00 +0000
139
+++ src/Ubuntu/Components/plugin/ucheader.cpp	2015-09-23 11:35:46 +0000
140
@@ -0,0 +1,328 @@
141
1
/*
142
2
 * Copyright 2015 Canonical Ltd.
143
3
 *
144
4
 * This program is free software; you can redistribute it and/or modify
145
5
 * it under the terms of the GNU Lesser General Public License as published by
146
6
 * the Free Software Foundation; version 3.
147
7
 *
148
8
 * This program is distributed in the hope that it will be useful,
149
9
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
150
10
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
151
11
 * GNU Lesser General Public License for more details.
152
12
 *
153
13
 * You should have received a copy of the GNU Lesser General Public License
154
14
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
155
15
 */
156
16
157
17
#include "ucheader.h"
158
18
#include <QDebug>
159
19
#include <QtQuick/private/qquickflickable_p.h>
160
20
#include <QtQuick/private/qquickanchors_p.h>
161
21
#include <QtQuick/private/qquickanimation_p.h>
162
22
#include "ucubuntuanimation.h"
163
23
#include "ucunits.h"
164
24
#include "propertychange_p.h"
165
25
166
26
167
27
/*!
168
28
    \qmltype Header
169
29
    \instantiates UCHeader
170
30
    \inherits StyledItem
171
31
    \inqmlmodule Ubuntu.Components 1.3
172
32
    \ingroup ubuntu
173
33
    \since Ubuntu.Components 1.3
174
34
    \brief Header bar that can contain the title and controls for the current view.
175
35
176
36
    The Header can be exposed and hidden by setting the
177
37
    \l exposed property, and when a \l flickable is set, the header will
178
38
    scroll together with the flickable and expose or hide when the
179
39
    Flickable movement ends.
180
40
181
41
    \qml
182
42
    import QtQuick 2.4
183
43
    import Ubuntu.Components 1.3
184
44
185
45
    Item {
186
46
        width: units.gu(50)
187
47
        height: units.gu(70)
188
48
189
49
        Header {
190
50
            id: header
191
51
            width: parent.width
192
52
            height: units.gu(6)
193
53
            z: 1 // ensure the header goes on top of the flickable contents
194
54
            flickable: scrollableContent
195
55
196
56
            Rectangle {
197
57
                // to visualize the header
198
58
                anchors.fill: parent
199
59
                color: UbuntuColors.blue
200
60
            }
201
61
        }
202
62
203
63
        Flickable {
204
64
            id: scrollableContent
205
65
            anchors.fill: parent
206
66
            contentHeight: height * 2
207
67
            Label {
208
68
                text: "Flick me"
209
69
            }
210
70
        }
211
71
    }
212
72
    \endqml
213
73
214
74
    The default z-value is 0, so declare the Header after any Items that it should
215
75
    overlay, or set its z-value to be larger than that of the other Items.
216
76
    The initial y-value is 0, but scrolling the flickable or setting \l exposed to
217
77
    false will change the y-value in the range from -height to 0.
218
78
*/
219
79
220
80
UCUbuntuAnimation *UCHeader::s_ubuntuAnimation = new UCUbuntuAnimation();
221
81
222
82
UCHeader::UCHeader(QQuickItem *parent)
223
83
    : UCStyledItemBase(parent)
224
84
    , m_flickable(Q_NULLPTR)
225
85
    , m_showHideAnimation(new QQuickNumberAnimation)
226
86
    , m_flickableTopMarginBackup(Q_NULLPTR)
227
87
    , m_previous_contentY(0)
228
88
    , m_exposed(true)
229
89
    , m_moving(false)
230
90
{
231
91
    m_showHideAnimation->setParent(this);
232
92
    m_showHideAnimation->setTargetObject(this);
233
93
    m_showHideAnimation->setProperty("y");
234
94
    m_showHideAnimation->setEasing(s_ubuntuAnimation->StandardEasing());
235
95
    m_showHideAnimation->setDuration(s_ubuntuAnimation->BriskDuration());
236
96
237
97
    connect(m_showHideAnimation, SIGNAL(runningChanged(bool)),
238
98
            this, SLOT(_q_showHideAnimationRunningChanged()));
239
99
    connect(this, SIGNAL(heightChanged()), this, SLOT(_q_heightChanged()));
240
100
}
241
101
242
102
UCHeader::~UCHeader() {
243
103
    if (m_flickable != Q_NULLPTR) {
244
104
        Q_ASSERT(m_flickableTopMarginBackup != Q_NULLPTR);
245
105
        delete m_flickableTopMarginBackup;
246
106
    }
247
107
}
248
108
249
109
void UCHeader::_q_heightChanged() {
250
110
    updateFlickableMargins();
251
111
    if (m_exposed || (!m_flickable.isNull() && m_flickable->contentY() <= 0.0)) {
252
112
        // Header was exposed before, or the flickable is scrolled up close to
253
113
        //  the top so that the header should be visible.
254
114
        show();
255
115
    } else {
256
116
        hide();
257
117
    }
258
118
}
259
119
260
120
/*!
261
121
 * \qmlproperty Flickable Header::flickable
262
122
 *
263
123
 * When flickable is set, scrolling vertically in the flickable, or setting the
264
124
 * Flickable's y-value will move the header y-position by the same amount as the
265
125
 * flickable content movement. When scrolling the flickable, upon release, the header
266
126
 * will animate to fully exposed or fully hidden state, depending on whether it was
267
127
 * more or less than half exposed when the user stopped moving the flickable.
268
128
 *
269
129
 * When flickable is null, the header can be exposed or
270
130
 * hidden by setting the \l exposed property.
271
131
 *
272
132
 * The topMargin of the flickable will automatically be updated to always match
273
133
 * the height of the header. When changing the flickable, the topMargin of the previous
274
134
 * flickable is set to 0.
275
135
 *
276
136
 * It is permitted to use a ListView as the value of flickable, but this works
277
137
 * well only if the ListView.header property is not set. Alternatively,
278
138
 * a Header component may be used for ListView.header, but in that case the flickable
279
139
 * of the Header must be null.
280
140
 */
281
141
QQuickFlickable* UCHeader::flickable() {
282
142
    return m_flickable.data();
283
143
}
284
144
285
145
void UCHeader::setFlickable(QQuickFlickable *flickable) {
286
146
    if (m_flickable == flickable) {
287
147
        return;
288
148
    }
289
149
    if (!m_flickable.isNull()) {
290
150
        Q_ASSERT(m_flickableTopMarginBackup != Q_NULLPTR);
291
151
292
152
        // Finish the current header movement in case the current
293
153
        //  flickable is disconnected while scrolling.
294
154
        _q_flickableMovementEnded();
295
155
        m_flickable->disconnect(this);
296
156
297
157
        delete m_flickableTopMarginBackup; // Restores previous value/binding for topMargin.
298
158
        m_flickableTopMarginBackup = Q_NULLPTR;
299
159
    }
300
160
301
161
    m_flickable = flickable;
302
162
    Q_EMIT flickableChanged();
303
163
304
164
    Q_ASSERT(m_flickableTopMarginBackup == Q_NULLPTR);
305
165
    if (!m_flickable.isNull()) {
306
166
        m_flickableTopMarginBackup = new PropertyChange(m_flickable, "topMargin");
307
167
        connect(m_flickable, SIGNAL(contentYChanged()),
308
168
                this, SLOT(_q_scrolledContents()));
309
169
        connect(m_flickable, SIGNAL(movementEnded()),
310
170
                this, SLOT(_q_flickableMovementEnded()));
311
171
        connect(m_flickable, SIGNAL(contentHeightChanged()),
312
172
                this, SLOT(_q_contentHeightChanged()));
313
173
        connect(m_flickable, SIGNAL(interactiveChanged()),
314
174
                this, SLOT(_q_flickableInteractiveChanged()));
315
175
        m_previous_contentY = m_flickable->contentY();
316
176
        updateFlickableMargins();
317
177
        show();
318
178
    }
319
179
}
320
180
321
181
void UCHeader::updateFlickableMargins() {
322
182
    if (m_flickable.isNull()) {
323
183
        return;
324
184
    }
325
185
    qreal headerHeight = height();
326
186
    qreal previousHeaderHeight = m_flickable->topMargin();
327
187
    if (headerHeight != previousHeaderHeight) {
328
188
        qreal previousContentY = m_flickable->contentY();
329
189
        PropertyChange::setValue(m_flickableTopMarginBackup, headerHeight);
330
190
        // Push down contents when header grows,
331
191
        //  pull up contents when header shrinks.
332
192
        m_flickable->setContentY(previousContentY - headerHeight + previousHeaderHeight);
333
193
    }
334
194
}
335
195
336
196
void UCHeader::show() {
337
197
    if (!m_exposed) {
338
198
        m_exposed = true;
339
199
        Q_EMIT exposedChanged();
340
200
        if (m_showHideAnimation->isRunning()) {
341
201
            // The header was in the process of hiding.
342
202
            m_showHideAnimation->stop();
343
203
        }
344
204
    }
345
205
    if (isComponentComplete()) {
346
206
        m_showHideAnimation->setFrom(y());
347
207
        m_showHideAnimation->setTo(0.0);
348
208
        m_showHideAnimation->start();
349
209
    } else {
350
210
        this->setY(0.0);
351
211
        if (m_moving) {
352
212
            m_moving = false;
353
213
            Q_EMIT movingChanged();
354
214
        }
355
215
    }
356
216
}
357
217
358
218
void UCHeader::hide() {
359
219
    if (m_exposed) {
360
220
        m_exposed = false;
361
221
        Q_EMIT exposedChanged();
362
222
        if (m_showHideAnimation->isRunning()) {
363
223
            // The header was in the process of showing.
364
224
            m_showHideAnimation->stop();
365
225
        }
366
226
    }
367
227
    if (isComponentComplete()) {
368
228
        m_showHideAnimation->setFrom(y());
369
229
        m_showHideAnimation->setTo(-1.0*height());
370
230
        m_showHideAnimation->start();
371
231
    } else {
372
232
        this->setY(-1.0*height());
373
233
        if (m_moving) {
374
234
            m_moving = false;
375
235
            Q_EMIT movingChanged();
376
236
        }
377
237
    }
378
238
}
379
239
380
240
void UCHeader::_q_showHideAnimationRunningChanged() {
381
241
    if (!m_showHideAnimation->isRunning()) {
382
242
        // Animation finished.
383
243
        Q_ASSERT(m_moving);
384
244
        m_moving = false;
385
245
        Q_EMIT movingChanged();
386
246
    } else if (!m_moving) {
387
247
        // Animation started.
388
248
        m_moving = true;
389
249
        Q_EMIT movingChanged();
390
250
    } // else: Transition from flickable movement to showHideAnimation running.
391
251
}
392
252
393
253
/*!
394
254
 * \qmlproperty bool Header::exposed
395
255
 * Exposes and hides the header by animating its y-value between -height and 0
396
256
 * to move it in or out of its parent Item. The value of exposed can be set directly,
397
257
 * or it will be automatically updated when the user exposes or hides the Header
398
258
 * by scrolling the Header's \l flickable.
399
259
 */
400
260
void UCHeader::setExposed(bool exposed) {
401
261
    if (exposed) {
402
262
        show();
403
263
    } else {
404
264
        hide();
405
265
    }
406
266
}
407
267
408
268
/*!
409
269
 * \qmlproperty bool Header::moving
410
270
 * \readonly
411
271
 * Indicates whether the header is currently moving, either because contentY of
412
272
 * the \l flickable changes (due to user interaction or by setting it directly),
413
273
 * or because the header is animating in or out because the value of \l exposed
414
274
 * was updated.
415
275
 */
416
276
bool UCHeader::moving() {
417
277
    return m_moving;
418
278
}
419
279
420
280
// Called when moving due to user interaction with the flickable, or by
421
281
// setting m_flickable.contentY programatically.
422
282
void UCHeader::_q_scrolledContents() {
423
283
    Q_ASSERT(!m_flickable.isNull());
424
284
    // Avoid moving the header when rebounding or being dragged over the bounds.
425
285
    if (!m_flickable->isAtYBeginning() && !m_flickable->isAtYEnd()) {
426
286
        qreal dy = m_flickable->contentY() - m_previous_contentY;
427
287
        // Restrict the header y between -height and 0.
428
288
        qreal clampedY = qMin(qMax(-height(), y() - dy), 0.0);
429
289
        setY(clampedY);
430
290
    }
431
291
    m_previous_contentY = m_flickable->contentY();
432
292
    if (!m_moving) {
433
293
        m_moving = true;
434
294
        Q_EMIT movingChanged();
435
295
    }
436
296
    if (!m_flickable->isMoving()) {
437
297
        // m_flickable.contentY was set directly, so no user flicking.
438
298
        _q_flickableMovementEnded();
439
299
    }
440
300
}
441
301
442
302
void UCHeader::_q_flickableMovementEnded() {
443
303
    Q_ASSERT(!m_flickable.isNull());
444
304
    if ((m_flickable->contentY() < 0)
445
305
            || (y() > -height()/2.0)) {
446
306
        show();
447
307
    } else {
448
308
        hide();
449
309
    }
450
310
}
451
311
452
312
void UCHeader::_q_contentHeightChanged() {
453
313
    Q_ASSERT(!m_flickable.isNull());
454
314
    if (m_flickable->height() >= m_flickable->contentHeight()) {
455
315
        // The user cannot scroll down to expose the header, so ensure
456
316
        //  that it is visible.
457
317
        show();
458
318
    }
459
319
}
460
320
461
321
void UCHeader::_q_flickableInteractiveChanged() {
462
322
    Q_ASSERT(!m_flickable.isNull());
463
323
    if (!m_flickable->isInteractive()) {
464
324
        // The user cannot scroll down to expose the header, so ensure
465
325
        //  that it is visible.
466
326
        show();
467
327
    }
468
328
}
469
0
329
470
=== added file 'src/Ubuntu/Components/plugin/ucheader.h'
471
--- src/Ubuntu/Components/plugin/ucheader.h	1970-01-01 00:00:00 +0000
472
+++ src/Ubuntu/Components/plugin/ucheader.h	2015-09-23 11:35:46 +0000
473
@@ -0,0 +1,76 @@
474
1
/*
475
2
 * Copyright 2015 Canonical Ltd.
476
3
 *
477
4
 * This program is free software; you can redistribute it and/or modify
478
5
 * it under the terms of the GNU Lesser General Public License as published by
479
6
 * the Free Software Foundation; version 3.
480
7
 *
481
8
 * This program is distributed in the hope that it will be useful,
482
9
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
483
10
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
484
11
 * GNU Lesser General Public License for more details.
485
12
 *
486
13
 * You should have received a copy of the GNU Lesser General Public License
487
14
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
488
15
 */
489
16
490
17
#ifndef UCHEADER_H
491
18
#define UCHEADER_H
492
19
493
20
#include "ucstyleditembase.h"
494
21
#include <QtCore/QPointer>
495
22
496
23
class QQuickFlickable;
497
24
class QQuickNumberAnimation;
498
25
class UCUbuntuAnimation;
499
26
class PropertyChange;
500
27
501
28
class UCHeader : public UCStyledItemBase
502
29
{
503
30
    Q_OBJECT
504
31
    Q_PROPERTY(QQuickFlickable* flickable READ flickable WRITE setFlickable NOTIFY flickableChanged FINAL)
505
32
    Q_PROPERTY(bool exposed MEMBER m_exposed WRITE setExposed NOTIFY exposedChanged FINAL)
506
33
    Q_PROPERTY(bool moving READ moving NOTIFY movingChanged FINAL)
507
34
508
35
public:
509
36
    explicit UCHeader(QQuickItem *parent = 0);
510
37
    ~UCHeader();
511
38
512
39
    QQuickFlickable* flickable();
513
40
    void setFlickable(QQuickFlickable* flickable);
514
41
    void setExposed(bool exposed);
515
42
    bool moving();
516
43
517
44
Q_SIGNALS:
518
45
    void flickableChanged();
519
46
    void exposedChanged();
520
47
    void movingChanged();
521
48
522
49
protected:
523
50
    void show();
524
51
    void hide();
525
52
526
53
private Q_SLOTS:
527
54
    void _q_scrolledContents();
528
55
    void _q_showHideAnimationRunningChanged();
529
56
    void _q_flickableMovementEnded();
530
57
    void _q_contentHeightChanged();
531
58
    void _q_flickableInteractiveChanged();
532
59
    void _q_heightChanged();
533
60
534
61
private:
535
62
    QPointer<QQuickFlickable> m_flickable;
536
63
    QQuickNumberAnimation* m_showHideAnimation;
537
64
    PropertyChange* m_flickableTopMarginBackup;
538
65
539
66
    qreal m_previous_contentY;
540
67
    bool m_exposed:1;
541
68
    bool m_moving:1;
542
69
543
70
    // used to set the easing and duration of m_showHideAnimation
544
71
    static UCUbuntuAnimation *s_ubuntuAnimation;
545
72
546
73
    void updateFlickableMargins();
547
74
};
548
75
549
76
#endif // UCHEADER_H
550
0
77
551
=== added file 'tests/unit_x11/tst_components/tst_header.qml'
552
--- tests/unit_x11/tst_components/tst_header.qml	1970-01-01 00:00:00 +0000
553
+++ tests/unit_x11/tst_components/tst_header.qml	2015-09-23 11:35:46 +0000
554
@@ -0,0 +1,354 @@
555
1
/*
556
2
 * Copyright (C) 2015 Canonical Ltd.
557
3
 *
558
4
 * This program is free software; you can redistribute it and/or modify
559
5
 * it under the terms of the GNU Lesser General Public License as published by
560
6
 * the Free Software Foundation; version 3.
561
7
 *
562
8
 * This program is distributed in the hope that it will be useful,
563
9
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
564
10
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
565
11
 * GNU Lesser General Public License for more details.
566
12
 *
567
13
 * You should have received a copy of the GNU Lesser General Public License
568
14
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
569
15
 */
570
16
571
17
import QtQuick 2.4
572
18
import Ubuntu.Components 1.3
573
19
import Ubuntu.Test 1.0
574
20
575
21
Item {
576
22
    id: root
577
23
    width: units.gu(50)
578
24
    height: units.gu(70)
579
25
580
26
    property real initialHeaderHeight: units.gu(6)
581
27
582
28
    Header {
583
29
        id: header
584
30
        flickable: flickable
585
31
        z:1
586
32
        width: parent.width
587
33
        height: root.initialHeaderHeight
588
34
589
35
        Rectangle {
590
36
            // to visualize the header
591
37
            anchors.fill: parent
592
38
            color: UbuntuColors.red
593
39
            opacity: 0.5
594
40
            border {
595
41
                color: "black"
596
42
                width: 2
597
43
            }
598
44
        }
599
45
    }
600
46
601
47
    Flickable {
602
48
        id: flickable
603
49
        anchors.fill: parent
604
50
        contentHeight: height * 2
605
51
606
52
        Grid {
607
53
            id: switchGrid
608
54
            columns: 2
609
55
            spacing: units.gu(1)
610
56
            anchors {
611
57
                top: parent.top
612
58
                left: parent.left
613
59
                margins: units.gu(5)
614
60
            }
615
61
            Switch {
616
62
                id: lockedSwitch
617
63
                checked: null === header.flickable
618
64
                function trigger() {
619
65
                    if (header.flickable) {
620
66
                        header.flickable = null;
621
67
                    } else {
622
68
                        header.flickable = flickable;
623
69
                    }
624
70
                }
625
71
            }
626
72
            Label {
627
73
                text: "header locked"
628
74
            }
629
75
            Switch {
630
76
                id: hiddenSwitch
631
77
                checked: header.exposed
632
78
                function trigger() {
633
79
                    header.exposed = !header.exposed;
634
80
                }
635
81
            }
636
82
            Label {
637
83
                text: "header exposed"
638
84
            }
639
85
            Item {
640
86
                width: 1
641
87
                height: 1
642
88
            }
643
89
        }
644
90
        Button {
645
91
            id: contentYButton
646
92
            anchors {
647
93
                top: switchGrid.bottom
648
94
                topMargin: units.gu(4)
649
95
                horizontalCenter: parent.horizontalCenter
650
96
            }
651
97
            property real newY: flickable.contentY == 0 ? -header.height : 0
652
98
            onClicked: flickable.contentY = newY;
653
99
            text: "Set contentY to " + newY
654
100
        }
655
101
        Label {
656
102
            anchors {
657
103
                top : contentYButton.bottom
658
104
                horizontalCenter: parent.horizontalCenter
659
105
                topMargin: units.gu(8)
660
106
            }
661
107
            text: "Flick me"
662
108
        }
663
109
    }
664
110
665
111
    Rectangle {
666
112
        id: reparentTestItem
667
113
        anchors {
668
114
            right: parent.right
669
115
            bottom: parent.bottom
670
116
        }
671
117
        height: units.gu(15)
672
118
        width: parent.width / 2
673
119
        color: "blue"
674
120
675
121
        Label {
676
122
            anchors {
677
123
                horizontalCenter: parent.horizontalCenter
678
124
                bottom: parent.bottom
679
125
            }
680
126
            text: "Click to reparent"
681
127
            color: "white"
682
128
        }
683
129
684
130
        MouseArea {
685
131
            anchors.fill: parent
686
132
            onClicked: {
687
133
                if (header.parent === root) {
688
134
                    header.parent = reparentTestItem;
689
135
                } else {
690
136
                    header.parent = root;
691
137
                }
692
138
            }
693
139
        }
694
140
    }
695
141
696
142
    Flickable {
697
143
        id: otherFlickable
698
144
        property real initialTopMargin: 123
699
145
        topMargin: initialTopMargin
700
146
        height: units.gu(10)
701
147
        contentHeight: units.gu(20);
702
148
    }
703
149
704
150
    Header {
705
151
        id: otherHeader
706
152
    }
707
153
708
154
    UbuntuTestCase {
709
155
        name: "Header"
710
156
        when: windowShown
711
157
        id: testCase
712
158
713
159
        function initTestCase() {
714
160
            wait_for_exposed(true, "Header is not exposed initially.");
715
161
            compare(otherHeader.flickable, null, "Flickable not null by default.");
716
162
            compare(header.flickable, flickable, "Flickable not properly intialized.");
717
163
            // note: moving may be true briefly due to header height changes, but
718
164
            //  it does not change in the initialization after wait_for_exposed() above.
719
165
            compare(header.moving, false, "Header moving initially.");
720
166
        }
721
167
722
168
        function init() {
723
169
            flickable.contentHeight = 2*flickable.height;
724
170
            flickable.interactive = true;
725
171
            flickable.contentY = -header.height;
726
172
            header.exposed = true;
727
173
            wait_for_exposed(true);
728
174
        }
729
175
730
176
        function scroll(dy) {
731
177
            var p = centerOf(flickable);
732
178
            // Use mouseWheel to scroll because mouseDrag is very unreliable
733
179
            // and does not properly handle negative values for dy.
734
180
            mouseWheel(flickable, p.x, p.y, 0,dy);
735
181
        }
736
182
737
183
        function scroll_down() {
738
184
            scroll(-2.0*header.height);
739
185
        }
740
186
741
187
        function scroll_up() {
742
188
            scroll(header.height);
743
189
        }
744
190
745
191
        function wait_for_exposed(exposed, errorMessage) {
746
192
            tryCompare(header, "exposed", exposed, 5000, errorMessage);
747
193
            // wait for the animation to finish:
748
194
            tryCompare(header, "moving", false, 5000, "Header still moving?");
749
195
            if (exposed) {
750
196
                compare(header.y, 0, errorMessage +
751
197
                        " y-value/exposed mismatch for exposed header!");
752
198
            } else {
753
199
                compare(header.y, -header.height, errorMessage +
754
200
                        " y-value/exposed mismatch for hidden header!");
755
201
            }
756
202
        }
757
203
758
204
        function test_reparent_width() {
759
205
            // test initial header width:
760
206
            compare(header.parent, root);
761
207
            compare(header.width, root.width);
762
208
            compare(header.y, 0);
763
209
764
210
            // test width update when changing parent:
765
211
            header.parent = reparentTestItem;
766
212
            compare(header.parent, reparentTestItem);
767
213
            compare(header.width, reparentTestItem.width);
768
214
            compare(header.y, 0);
769
215
770
216
            // test width update when changing width of parent:
771
217
            var old_width = reparentTestItem.width;
772
218
            reparentTestItem.width = units.gu(5);
773
219
            compare(header.width, reparentTestItem.width);
774
220
            compare(header.y, 0);
775
221
776
222
            // revert to original parent:
777
223
            header.parent = root;
778
224
            compare(header.parent, root);
779
225
            compare(header.width, root.width);
780
226
            compare(header.y, 0);
781
227
            reparentTestItem.width = old_width;
782
228
        }
783
229
784
230
        function test_height_change() {
785
231
            // first scroll down for this test, the following test repeats
786
232
            //  the cases at the top of the flickable.
787
233
            scroll_down();
788
234
            header.height = units.gu(15);
789
235
            wait_for_exposed(true, "Increasing header height hides header.");
790
236
            scroll_down();
791
237
            header.exposed = false;
792
238
            wait_for_exposed(false, "Header with height set does not hide.");
793
239
            header.height = units.gu(2);
794
240
            wait_for_exposed(false, "Decreasing header height exposes it.");
795
241
            header.exposed = true;
796
242
            wait_for_exposed(true, "Header with decreased height does not expose.");
797
243
798
244
            // revert to initial state
799
245
            header.height = root.initialHeaderHeight;
800
246
            flickable.contentY = -header.height;
801
247
            wait_for_exposed(true, "Setting flickable.contentY hides the header.");
802
248
        }
803
249
804
250
        function test_height_change_at_top() {
805
251
            // Near the top, changing the header height exposes the header
806
252
            //  to avoid the header becoming inaccessible because it cannot
807
253
            //  be pulled down.
808
254
            header.exposed = false;
809
255
            wait_for_exposed(false);
810
256
            header.height = units.gu(15);
811
257
            wait_for_exposed(true, "Increasing header height at top hides header.");
812
258
813
259
            // making the header smaller does not need to expose it, because there is
814
260
            //  enough space to pull it down.
815
261
816
262
            // revert to original state.
817
263
            header.height = root.initialHeaderHeight;
818
264
            flickable.contentY = -header.height;
819
265
            header.exposed = true;
820
266
            wait_for_exposed(true);
821
267
        }
822
268
823
269
        function test_set_exposed_to_hide_and_show() {
824
270
            header.exposed = false;
825
271
            wait_for_exposed(false, "Cannot hide header by setting visible to false.");
826
272
            header.exposed = true;
827
273
            wait_for_exposed(true, "Cannot show header by setting visible to true.");
828
274
829
275
            // change the value of exposed twice quickly:
830
276
            header.exposed = false;
831
277
            header.exposed = true;
832
278
            wait_for_exposed(true, "Quickly hiding and showing header does not result in exposed header.");
833
279
834
280
            // and the other way around:
835
281
            header.exposed = false;
836
282
            wait_for_exposed(false);
837
283
            header.exposed = true;
838
284
            header.exposed = false;
839
285
            wait_for_exposed(false, "Quickly showing and hiding header does not result in hidden header.");
840
286
841
287
            header.exposed = true;
842
288
            wait_for_exposed(true);
843
289
        }
844
290
845
291
        function test_scroll_updates_visible() {
846
292
            scroll_down();
847
293
            wait_for_exposed(false, "Scrolling down does not hide header.");
848
294
            scroll_up();
849
295
            wait_for_exposed(true, "Scrolling up does not show header.");
850
296
        }
851
297
852
298
        function test_flickable_margins() {
853
299
            compare(flickable.topMargin, header.height, "Flickable top margin does not match header height.");
854
300
            header.height = units.gu(15);
855
301
            wait_for_exposed(true, "Increasing header height at top hides header.");
856
302
            compare(flickable.topMargin, header.height, "Updating header height does not update flickable top margin.");
857
303
858
304
            header.height = root.initialHeaderHeight; // revert
859
305
            wait_for_exposed(true, "Reverting header height at top hides header.");
860
306
            compare(flickable.topMargin, header.height, "Reverting header height does not revert flickable top margin.");
861
307
862
308
            compare(otherFlickable.topMargin, otherFlickable.initialTopMargin, "Flickable top margin is not initialized properly.");
863
309
            header.flickable = otherFlickable;
864
310
            compare(otherFlickable.topMargin, header.height, "Setting flickable does not update flickable top margin.");
865
311
            compare(flickable.topMargin, 0, "Changing the flickable does not reset the previous flickable top margin to 0.");
866
312
867
313
            header.flickable = flickable;
868
314
            compare(otherFlickable.topMargin, otherFlickable.initialTopMargin, "Reverting flickable does not restore the other flickable top margin.");
869
315
            compare(flickable.topMargin, header.height, "Reverting flickable breaks flickable top margin.");
870
316
        }
871
317
872
318
        function test_flickable_contentHeight_bug1156573() {
873
319
            var old_height = flickable.contentHeight;
874
320
            header.exposed = false;
875
321
            wait_for_exposed(false);
876
322
            flickable.contentHeight = flickable.height / 2;
877
323
            wait_for_exposed(true, "Small content height does not expose the header.");
878
324
879
325
            // revert:
880
326
            flickable.contentHeight = old_height;
881
327
            compare(header.exposed, true, "Reverting flickable content height hides the header.");
882
328
        }
883
329
884
330
        function test_flickable_interactive() {
885
331
            header.exposed = false;
886
332
            wait_for_exposed(false);
887
333
            flickable.interactive = false;
888
334
            wait_for_exposed(true, "Making flickable not interactive does not expose the header.");
889
335
890
336
            // revert:
891
337
            flickable.interactive = true;
892
338
            compare(header.exposed, true, "Reverting flickable exposed hides the header.");
893
339
        }
894
340
895
341
        function test_scroll_disconnected_flickable() {
896
342
            var hy = header.y;
897
343
            header.flickable = null;
898
344
            scroll_down();
899
345
            compare(header.y, hy, "Header scrolls when disconnected flickable scrolls down.");
900
346
            wait_for_exposed(true, "Scrolling down disconnected flickable hides header.");
901
347
            scroll_up();
902
348
            compare(header.y, hy, "Header scrolls when disconnected flickable scrolls up.");
903
349
            wait_for_exposed(true, "Scrolling up disconnected flickable hides header.");
904
350
905
351
            header.flickable = flickable;
906
352
        }
907
353
    }
908
354
}
Status:	Merged
Approved by:	Tim Peeters on 2015-09-23
Approved revision:	1681
Merged at revision:	1648
Proposed branch:	lp:~tpeeters/ubuntu-ui-toolkit/cppHeader
Merge into:	lp:ubuntu-ui-toolkit/staging
Diff against target:	908 lines (+775/-7) 10 files modified components.api (+4/-0) src/Ubuntu/Components/ListItems/1.2/ListItemHeader.qml (+1/-0) src/Ubuntu/Components/ListItems/1.3/ListItemHeader.qml (+1/-0) src/Ubuntu/Components/ListItems/ListItems.pro (+2/-2) src/Ubuntu/Components/ListItems/qmldir (+3/-3) src/Ubuntu/Components/plugin/plugin.cpp (+2/-0) src/Ubuntu/Components/plugin/plugin.pri (+4/-2) src/Ubuntu/Components/plugin/ucheader.cpp (+328/-0) src/Ubuntu/Components/plugin/ucheader.h (+76/-0) tests/unit_x11/tst_components/tst_header.qml (+354/-0)
To merge this branch:	bzr merge lp:~tpeeters/ubuntu-ui-toolkit/cppHeader
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
PS Jenkins bot	continuous-integration		Approve on 2015-09-23
Zsombor Egri		2015-09-16	Approve on 2015-09-23
Review via email: mp+271347@code.launchpad.net