Ubuntu UI Toolkit

Merge lp:~kalikiana/ubuntu-ui-toolkit/sortFilterModel into lp:ubuntu-ui-toolkit/staging

sortFilterModel
Merge into staging

Proposed by Cris Dywan on 2014-04-30

Status:

Merged

Approved by:

Tim Peeters on 2014-05-15

Approved revision:

996

Merged at revision:

1056

Proposed branch:

lp:~kalikiana/ubuntu-ui-toolkit/sortFilterModel

Merge into:

lp:ubuntu-ui-toolkit/staging

Diff against target:

811 lines (+686/-3)

11 files modified

components.api (+49/-0)
examples/ubuntu-ui-toolkit-gallery/ListItems.qml (+11/-2)
modules/Ubuntu/Components/plugin/filterbehavior.cpp (+47/-0)
modules/Ubuntu/Components/plugin/filterbehavior.h (+46/-0)
modules/Ubuntu/Components/plugin/plugin.cpp (+10/-1)
modules/Ubuntu/Components/plugin/plugin.pro (+6/-0)
modules/Ubuntu/Components/plugin/sortbehavior.cpp (+47/-0)
modules/Ubuntu/Components/plugin/sortbehavior.h (+46/-0)
modules/Ubuntu/Components/plugin/sortfiltermodel.cpp (+250/-0)
modules/Ubuntu/Components/plugin/sortfiltermodel.h (+66/-0)
tests/unit/tst_components/tst_sortfiltermodel.qml (+108/-0)

To merge this branch:

bzr merge lp:~kalikiana/ubuntu-ui-toolkit/sortFilterModel

Medium

Triaged

Link a bug report

Reviewer	Review Type	Date Requested	Status
PS Jenkins bot	continuous-integration	2014-04-30	Approve on 2014-05-15
Tim Peeters		2014-04-30	Approve on 2014-05-15
Review via email: mp+217736@code.launchpad.net

This proposal supersedes a proposal from 2014-03-20.

Commit message

Introduce QML bindings for SortFilterModel

Revision history for this message

Tim Peeters (tpeeters) wrote on 2014-04-14: Posted in a previous version of this proposal

118 + * model: movies

you need to give the model the id movies

review: Needs Fixing

Revision history for this message

Tim Peeters (tpeeters) wrote on 2014-04-14: Posted in a previous version of this proposal

fix quotes

122 + * filter.property: "producer
123 + * filter.pattern: /blender/

Revision history for this message

Tim Peeters (tpeeters) wrote on 2014-04-14: Posted in a previous version of this proposal

141 + * Label {
142 + * text: {
143 + * var firstRow = sortedMovies.findFirst("title", /Elephant/))

isn't /Elephant/ supposed to be a string?

144 + * var sourceRow = sortedMovies.mapToSource(firstRow)
145 + * var foundTitle = movies.get(sourceRow).title
146 + * i18n.tr("First matching movie: %1").arg(foundTitle)

I would guess you want to keep foundTitle outside of the translateion.
i18n.tr() needs to be return i18n.tr();

add semicolons at the end of the lines

Revision history for this message

Tim Peeters (tpeeters) wrote on 2014-04-14: Posted in a previous version of this proposal

TODO: documentation of properties

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-04-23: Posted in a previous version of this proposal

FAILED: Continuous integration, rev:984
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/2038/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-trusty-touch/379/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/5003/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-amd64-ci/986/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-armhf-ci/986/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/4613/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/5183/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-ui-toolkit-ci/2038/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

Cris Dywan (kalikiana) wrote on 2014-04-24: Posted in a previous version of this proposal

modules/Ubuntu/Components/plugin/sortfiltermodel.cpp:72: warning: Unable to parse QML snippet: "Expected a qualified name id" at line 7, column 19

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-04-24: Posted in a previous version of this proposal

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-ui-toolkit-ci/2039/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-04-24: Posted in a previous version of this proposal

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-ui-toolkit-ci/2040/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

Cris Dywan (kalikiana) wrote on 2014-04-25: Posted in a previous version of this proposal

FTR failures in ubuntuuitoolkit.tests.gallery.test_textinput/optionselector/buttons

lp:~kalikiana/ubuntu-ui-toolkit/sortFilterModel updated on 2014-04-30

989. By Cris Dywan on 2014-04-30: Revert uncommenting of gallery sections
990. By Cris Dywan on 2014-04-30: SortFilterModel should be Ubuntu.Components 1.1

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-04-30:

FAILED: Continuous integration, rev:990
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/138/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-trusty-touch/521/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/5147/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-trusty-amd64-ci/138/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-trusty-armhf-ci/138/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-trusty-i386-ci/138/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/4791/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/5352/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/138/rebuild

review: Needs Fixing (continuous-integration)

lp:~kalikiana/ubuntu-ui-toolkit/sortFilterModel updated on 2014-04-30

991. By Cris Dywan on 2014-04-30: Also register *Behavior and AbstractItemModel with version 1.1

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-04-30:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/143/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

Cris Dywan (kalikiana) wrote on 2014-05-07:

Looks like J has unrelated problems:
The following packages have unmet dependencies:
libmirserver18 : Depends: libmirplatform (= 0.1.8+14.04.20140411-0ubuntu1) but 0.1.9bzr1570pkg0utopic1343+autopilot0 is to be installed
                  Depends: libmirplatformgraphics-mesa (= 0.1.8+14.04.20140411-0ubuntu1) but 0.1.9bzr1570pkg0utopic1343+autopilot0 is to be installed or
                           libmirplatformgraphics-android (= 0.1.8+14.04.20140411-0ubuntu1) but 0.1.9bzr1570pkg0utopic1343+autopilot0 is to be installed
ubuntu-ui-toolkit-doc : Depends: qtdeclarative5-doc-html but it is not going to be installed
                         Depends: qtwebkit5-doc-html but it is not going to be installed
                         Depends: qtsvg5-doc-html but it is not going to be installed
                         Depends: qtscript5-doc-html but it is not going to be installed
                         Depends: qtmultimedia5-doc-html but it is not going to be installed
                         Depends: unity-action-doc but it is not going to be installed
E: Unmet dependencies. Try 'apt-get -f install' with no packages (or specify a solution).

lp:~kalikiana/ubuntu-ui-toolkit/sortFilterModel updated on 2014-05-07

992. By Cris Dywan on 2014-05-07: Merge lp:~ubuntu-sdk-team/ubuntu-ui-toolkit/staging

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-05-07:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/179/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

Cris Dywan (kalikiana) wrote on 2014-05-07:

FTR random failure in test_optionselector_expanded

Revision history for this message

Tim Peeters (tpeeters) wrote on 2014-05-08:

Revision history for this message

Tim Peeters (tpeeters) wrote on 2014-05-08:

Why do you need to register the QAbstractItemModel?

Revision history for this message

Tim Peeters (tpeeters) wrote on 2014-05-08:

I prefer to define each public class in its own .h and .cpp files. Is there a reason not to do this for FilterBehavior and SortBehavior?

Revision history for this message

Tim Peeters (tpeeters) wrote on 2014-05-08:

Q_INVOKABLE QVariantMap get(int row); // Use with caution, it can be slow to query all the roles

perhaps you should document that function in the cpp file and add the warning there?

Revision history for this message

Tim Peeters (tpeeters) wrote on 2014-05-08:

181 + * \qmltype SortFilterModel
182 + * \instantiates QSortFilterProxyModelQML
183 + * \inqmlmodule Ubuntu.Components 0.1
184 + * \ingroup ubuntu

192 + *
193 + * Example usage:
194 + * \qml
195 + * import QtQuick 2.0
196 + * import Ubuntu.Components 0.1
197 + * import Ubuntu.Components.ListItems 0.1

Ubuntu.Components 1.1

Revision history for this message

Tim Peeters (tpeeters) wrote on 2014-05-08:

228 + * ListView {
229 + * model: sortedMovies
230 + *
231 + * delegate: Subtitled {
232 + * text: title
233 + * subText: producer
234 + * }
235 + *
236 + * section.delegate: sectionDelegate
237 + * section.property: "title"
238 + * section.criteria: ViewSection.FirstCharacter
239 + * }

file:///home/tim/dev/ubuntu-ui-toolkit/r/sortFilterModel/test.qml:35: ReferenceError: sortedMovies is not defined
file:///home/tim/dev/ubuntu-ui-toolkit/r/sortFilterModel/test.qml:42: ReferenceError: sectionDelegate is not defined

Revision history for this message

Tim Peeters (tpeeters) wrote on 2014-05-08:

the ListView in your example needs anchors.fill: parent to show anything

review: Needs Fixing

Revision history for this message

Tim Peeters (tpeeters) wrote on 2014-05-08:

your example is not working, output of the SortFilterModel is empty.

review: Needs Fixing

Revision history for this message

Tim Peeters (tpeeters) wrote on 2014-05-08:

> your example is not working, output of the SortFilterModel is empty.

Ignore that comment, I had a typo in the id of the SortFilterModel.

Revision history for this message

Tim Peeters (tpeeters) wrote on 2014-05-08:

> your example is not working, output of the SortFilterModel is empty.

Ignore that comment, I had a typo in the id of the SortFilterModel.

Revision history for this message

Tim Peeters (tpeeters) wrote on 2014-05-08:

qmlRegisterType<FilterBehavior>(uri, 1, 1, "FilterBehavior");
qmlRegisterType<SortBehavior>(uri, 1, 1, "SortBehavior");

Those should also not be creatable from QML right? They come with the SoftFilterModel

lp:~kalikiana/ubuntu-ui-toolkit/sortFilterModel updated on 2014-05-15

993. By Cris Dywan on 2014-05-15: Take comments on inline example into account
994. By Cris Dywan on 2014-05-15: Make *Behavior uncreatable and document QAbstractItemModel type
995. By Cris Dywan on 2014-05-15: Split *Behavior into separate files
996. By Cris Dywan on 2014-05-15: Merge lp:~ubuntu-sdk-team/ubuntu-ui-toolkit/staging

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-05-15:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/231/rebuild

review: Approve (continuous-integration)

Revision history for this message

Tim Peeters (tpeeters) wrote on 2014-05-15:

good stuff, I like the changes!

review: Approve

Revision history for this message

PS Jenkins bot (ps-jenkins) on 2014-05-15:

review: Approve (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) on 2014-05-15:

review: Approve (continuous-integration)

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk

Subscribers

People subscribed via source and target branches

to all changes:

Cris Dywan

Dan Chapman 

Tom Mirmar

Ubuntu SDK team

 === modified file 'components.api'
 --- components.api	2014-05-13 09:13:32 +0000
 +++ components.api	2014-05-15 09:54:24 +0000
@@ -613,6 +613,11 @@
      function mouseLongPress(item, x, y, button, modifiers, delay)
      function tryCompareFunction(func, expectedResult, timeout)
  plugins.qmltypes
++    name: "FilterBehavior"
++    prototype: "QObject"
++    exports: ["FilterBehavior 1.1"]
++    Property { name: "property"; type: "string" }
++    Property { name: "pattern"; type: "QRegExp" }
      name: "InverseMouseAreaType"
      prototype: "QQuickMouseArea"
      exports: ["InverseMouseArea 0.1", "InverseMouseArea 1.0"]
@@ -621,6 +626,45 @@
      Method {
      name: "contains"
      Parameter { name: "point"; type: "QPointF" }
++    name: "QAbstractProxyModel"
++    prototype: "QAbstractItemModel"
++    Property { name: "sourceModel"; type: "QAbstractItemModel"; isPointer: true }
++    name: "QSortFilterProxyModel"
++    prototype: "QAbstractProxyModel"
++    Property { name: "filterRegExp"; type: "QRegExp" }
++    Property { name: "filterKeyColumn"; type: "int" }
++    Property { name: "dynamicSortFilter"; type: "bool" }
++    Property { name: "filterCaseSensitivity"; type: "Qt::CaseSensitivity" }
++    Property { name: "sortCaseSensitivity"; type: "Qt::CaseSensitivity" }
++    Property { name: "isSortLocaleAware"; type: "bool" }
++    Property { name: "sortRole"; type: "int" }
++    Property { name: "filterRole"; type: "int" }
++    Method {
++    name: "setFilterRegExp"
++    Parameter { name: "pattern"; type: "string" }
++    Method {
++    name: "setFilterWildcard"
++    Parameter { name: "pattern"; type: "string" }
++    Method {
++    name: "setFilterFixedString"
++    Parameter { name: "pattern"; type: "string" }
++    Method { name: "clear" }
++    Method { name: "invalidate" }
++    name: "QSortFilterProxyModelQML"
++    prototype: "QSortFilterProxyModel"
++    exports: ["SortFilterModel 1.1"]
++    Property { name: "model"; type: "QAbstractItemModel"; isPointer: true }
++    Property { name: "count"; type: "int"; isReadonly: true }
++    Property { name: "sort"; type: "SortBehavior"; isReadonly: true; isPointer: true }
++    Property { name: "filter"; type: "FilterBehavior"; isReadonly: true; isPointer: true }
++    Method {
++    name: "get"
++    Parameter { name: "row"; type: "int" }
++    Method {
++    name: "data"
++    Parameter { name: "row"; type: "int" }
++    Parameter { name: "role"; type: "int" }
++    Method { name: "count"; type: "int" }
      name: "ShapeItem"
      prototype: "QQuickItem"
      exports: ["Shape 0.1", "Shape 1.0"]
@@ -636,6 +680,11 @@
      Property { name: "borderSource"; type: "string" }
      Signal { name: "borderChanged" }
      Method { name: "gridUnitChanged" }
++    name: "SortBehavior"
++    prototype: "QObject"
++    exports: ["SortBehavior 1.1"]
++    Property { name: "property"; type: "string" }
++    Property { name: "order"; type: "Qt::SortOrder" }
      name: "UCAlarm"
      prototype: "QObject"
      exports: ["Alarm 0.1", "Alarm 1.0"]
 === modified file 'examples/ubuntu-ui-toolkit-gallery/ListItems.qml'
 --- examples/ubuntu-ui-toolkit-gallery/ListItems.qml	2014-04-28 10:30:06 +0000
 +++ examples/ubuntu-ui-toolkit-gallery/ListItems.qml	2014-05-15 09:54:24 +0000
@@ -15,7 +15,7 @@
   */
  import QtQuick 2.0
--import Ubuntu.Components 0.1 as Toolkit
++import Ubuntu.Components 1.1 as Toolkit
  import Ubuntu.Components.ListItems 0.1 as ListItem
  Template {
@@ -259,11 +259,20 @@
              ListElement { name: "Potato"; details: "Vegetable" }
+         }
++        Toolkit.SortFilterModel {
++            id: processedFruits
++            model: fruitModel
++            sort.property: "title"
++            sort.order: Qt.DescendingOrder
++            filter.property: "details"
++            filter.pattern: /Vegetable/
++        }
++
          Toolkit.UbuntuListView {
              id: ubuntuListView
              anchors { left: parent.left; right: parent.right }
              height: units.gu(24)
--            model: fruitModel
++            model: processedFruits
              clip: true
              delegate: ListItem.Expandable {
 === added file 'modules/Ubuntu/Components/plugin/filterbehavior.cpp'
 --- modules/Ubuntu/Components/plugin/filterbehavior.cpp	1970-01-01 00:00:00 +0000
 +++ modules/Ubuntu/Components/plugin/filterbehavior.cpp	2014-05-15 09:54:24 +0000
@@ -0,0 +1,47 @@
++/*
++ * Copyright (C) 2014 Canonical, Ltd.
++ *
++ * Authors:
++ *   Christian Dywan <christian.dywan@canonical.com>
++ *
++ * This program is free software; you can redistribute it and/or modify
++ * it under the terms of the GNU Lesser General Public License as published by
++ * the Free Software Foundation; version 3.
++ *
++ * This program is distributed in the hope that it will be useful,
++ * but WITHOUT ANY WARRANTY; without even the implied warranty of
++ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
++ * GNU Lesser General Public License for more details.
++ *
++ * You should have received a copy of the GNU Lesser General Public License
++ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
++ */
++
++#include "filterbehavior.h"
++
++QString
++FilterBehavior::property() const
++{
++    return m_property;
++}
++
++void
++FilterBehavior::setProperty(const QString& property)
++{
++    m_property = property;
++    Q_EMIT propertyChanged();
++}
++
++QRegExp
++FilterBehavior::pattern() const
++{
++    return m_pattern;
++}
++
++void
++FilterBehavior::setPattern(QRegExp pattern)
++{
++    m_pattern = pattern;
++    Q_EMIT patternChanged();
++}
++
 === added file 'modules/Ubuntu/Components/plugin/filterbehavior.h'
 --- modules/Ubuntu/Components/plugin/filterbehavior.h	1970-01-01 00:00:00 +0000
 +++ modules/Ubuntu/Components/plugin/filterbehavior.h	2014-05-15 09:54:24 +0000
@@ -0,0 +1,46 @@
++/*
++ * Copyright (C) 2014 Canonical, Ltd.
++ *
++ * Authors:
++ *   Christian Dywan <christian.dywan@canonical.com>
++ *
++ * This program is free software; you can redistribute it and/or modify
++ * it under the terms of the GNU Lesser General Public License as published by
++ * the Free Software Foundation; version 3.
++ *
++ * This program is distributed in the hope that it will be useful,
++ * but WITHOUT ANY WARRANTY; without even the implied warranty of
++ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
++ * GNU Lesser General Public License for more details.
++ *
++ * You should have received a copy of the GNU Lesser General Public License
++ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
++ */
++
++#ifndef FILTERBEHAVIOR_H
++#define FILTERBEHAVIOR_H
++
++#include <QSortFilterProxyModel>
++
++class FilterBehavior : public QObject {
++    Q_OBJECT
++
++    Q_PROPERTY(QString property READ property WRITE setProperty NOTIFY propertyChanged)
++    Q_PROPERTY(QRegExp pattern READ pattern WRITE setPattern NOTIFY patternChanged)
++
++public:
++    QString property() const;
++    void setProperty(const QString& property);
++    QRegExp pattern() const;
++    void setPattern(QRegExp pattern);
++
++Q_SIGNALS:
++    void propertyChanged();
++    void patternChanged();
++
++private:
++    QString m_property;
++    QRegExp m_pattern;
++};
++
++#endif // FILTERBEHAVIOR_H
 === modified file 'modules/Ubuntu/Components/plugin/plugin.cpp'
 --- modules/Ubuntu/Components/plugin/plugin.cpp	2014-04-20 19:25:12 +0000
 +++ modules/Ubuntu/Components/plugin/plugin.cpp	2014-05-15 09:54:24 +0000
@@ -1,5 +1,5 @@
  /*
-- * Copyright 2012 Canonical Ltd.
++ * Copyright 2012-2014 Canonical Ltd.
+  *
   * This program is free software; you can redistribute it and/or modify
   * it under the terms of the GNU Lesser General Public License as published by
@@ -48,6 +48,7 @@
  #include "ucurihandler.h"
  #include "ucmouse.h"
  #include "ucinversemouse.h"
++#include "sortfiltermodel.h"
  #include <sys/types.h>
  #include <unistd.h>
@@ -186,6 +187,14 @@
      // register custom event
      ForwardedEvent::registerForwardedEvent();
++
++    // register parent type so that properties can get/ set it
++    qmlRegisterUncreatableType<QAbstractItemModel>(uri, 1, 1, "QAbstractItemModel", "Not instantiable");
++
++    // register 1.1 only API
++    qmlRegisterType<QSortFilterProxyModelQML>(uri, 1, 1, "SortFilterModel");
++    qmlRegisterUncreatableType<FilterBehavior>(uri, 1, 1, "FilterBehavior", "Not instantiable");
++    qmlRegisterUncreatableType<SortBehavior>(uri, 1, 1, "SortBehavior", "Not instantiable");
+ }
  void UbuntuComponentsPlugin::initializeEngine(QQmlEngine *engine, const char *uri)
 === modified file 'modules/Ubuntu/Components/plugin/plugin.pro'
 --- modules/Ubuntu/Components/plugin/plugin.pro	2014-03-25 06:46:36 +0000
 +++ modules/Ubuntu/Components/plugin/plugin.pro	2014-05-15 09:54:24 +0000
@@ -55,6 +55,9 @@
      alarmrequest_p_p.h \
      adapters/alarmsadapter_p.h \
      ucstatesaver.h \
++    sortbehavior.h \
++    filterbehavior.h \
++    sortfiltermodel.h \
      statesaverbackend_p.h \
      ucstatesaver_p.h \
      ucurihandler.h \
@@ -87,6 +90,9 @@
      thumbnailgenerator.cpp \
      alarmrequest_p.cpp \
      ucstatesaver.cpp \
++    sortbehavior.cpp \
++    filterbehavior.cpp \
++    sortfiltermodel.cpp \
      statesaverbackend_p.cpp \
      ucurihandler.cpp \
      ucmousefilters.cpp \
 === added file 'modules/Ubuntu/Components/plugin/sortbehavior.cpp'
 --- modules/Ubuntu/Components/plugin/sortbehavior.cpp	1970-01-01 00:00:00 +0000
 +++ modules/Ubuntu/Components/plugin/sortbehavior.cpp	2014-05-15 09:54:24 +0000
@@ -0,0 +1,47 @@
++/*
++ * Copyright (C) 2014 Canonical, Ltd.
++ *
++ * Authors:
++ *   Christian Dywan <christian.dywan@canonical.com>
++ *
++ * This program is free software; you can redistribute it and/or modify
++ * it under the terms of the GNU Lesser General Public License as published by
++ * the Free Software Foundation; version 3.
++ *
++ * This program is distributed in the hope that it will be useful,
++ * but WITHOUT ANY WARRANTY; without even the implied warranty of
++ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
++ * GNU Lesser General Public License for more details.
++ *
++ * You should have received a copy of the GNU Lesser General Public License
++ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
++ */
++
++#include "sortbehavior.h"
++
++QString
++SortBehavior::property() const
++{
++    return m_property;
++}
++
++Qt::SortOrder
++SortBehavior::order() const
++{
++    return m_order;
++}
++
++void
++SortBehavior::setProperty(const QString& property)
++{
++    m_property = property;
++    Q_EMIT propertyChanged();
++}
++
++void
++SortBehavior::setOrder(Qt::SortOrder order)
++{
++    m_order = order;
++    Q_EMIT orderChanged();
++}
++
 === added file 'modules/Ubuntu/Components/plugin/sortbehavior.h'
 --- modules/Ubuntu/Components/plugin/sortbehavior.h	1970-01-01 00:00:00 +0000
 +++ modules/Ubuntu/Components/plugin/sortbehavior.h	2014-05-15 09:54:24 +0000
@@ -0,0 +1,46 @@
++/*
++ * Copyright (C) 2014 Canonical, Ltd.
++ *
++ * Authors:
++ *   Christian Dywan <christian.dywan@canonical.com>
++ *
++ * This program is free software; you can redistribute it and/or modify
++ * it under the terms of the GNU Lesser General Public License as published by
++ * the Free Software Foundation; version 3.
++ *
++ * This program is distributed in the hope that it will be useful,
++ * but WITHOUT ANY WARRANTY; without even the implied warranty of
++ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
++ * GNU Lesser General Public License for more details.
++ *
++ * You should have received a copy of the GNU Lesser General Public License
++ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
++ */
++
++#ifndef SORTBEHAVIOR_H
++#define SORTBEHAVIOR_H
++
++#include <QSortFilterProxyModel>
++
++class SortBehavior : public QObject {
++    Q_OBJECT
++
++    Q_PROPERTY(QString property READ property WRITE setProperty NOTIFY propertyChanged)
++    Q_PROPERTY(Qt::SortOrder order READ order WRITE setOrder NOTIFY orderChanged)
++
++public:
++    QString property() const;
++    void setProperty(const QString& property);
++    Qt::SortOrder order() const;
++    void setOrder(Qt::SortOrder order);
++
++Q_SIGNALS:
++    void propertyChanged();
++    void orderChanged();
++
++private:
++    QString m_property;
++    Qt::SortOrder m_order;
++};
++
++#endif // SORTBEHAVIOR_H
 === added file 'modules/Ubuntu/Components/plugin/sortfiltermodel.cpp'
 --- modules/Ubuntu/Components/plugin/sortfiltermodel.cpp	1970-01-01 00:00:00 +0000
 +++ modules/Ubuntu/Components/plugin/sortfiltermodel.cpp	2014-05-15 09:54:24 +0000
@@ -0,0 +1,250 @@
++/*
++ * Copyright (C) 2012-2014 Canonical, Ltd.
++ *
++ * Authors:
++ *   Michal Hruby <michal.hruby@canonical.com>
++ *   Christian Dywan <christian.dywan@canonical.com>
++ *
++ * This program is free software; you can redistribute it and/or modify
++ * it under the terms of the GNU Lesser General Public License as published by
++ * the Free Software Foundation; version 3.
++ *
++ * This program is distributed in the hope that it will be useful,
++ * but WITHOUT ANY WARRANTY; without even the implied warranty of
++ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
++ * GNU Lesser General Public License for more details.
++ *
++ * You should have received a copy of the GNU Lesser General Public License
++ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
++ */
++
++#include "sortfiltermodel.h"
++
++/*!
++ * \qmltype SortFilterModel
++ * \instantiates QSortFilterProxyModelQML
++ * \inqmlmodule Ubuntu.Components 0.1
++ * \ingroup ubuntu
++ * \brief SortFilterModel sorts and filters rows from an existing model.
++ *
++ * The SortFilterModel takes an existing model such as a ListModel or
++ * any QAbstractItemModel implementation. The original rows and role names
++ * show up in the SortFilterModel with two basic differences. For one if
++ * \l sort.property is set all rows will be sorted. Further more if
++ * \l filter.property is set only rows matching the filter will be in the model.
++ *
++ * Example usage:
++ * \qml
++ * import QtQuick 2.0
++ * import Ubuntu.Components 1.1
++ * import Ubuntu.Components.ListItems 1.1
++ *
++ * MainView {
++ *     width: units.gu(80)
++ *     height: units.gu(40)
++ *
++ *     ListModel {
++ *         id: movies
++ *         ListElement {
++ *             title: "Esign"
++ *             producer: "Chris Larkee"
++ *         }
++ *         ListElement {
++ *             title: "Elephants Dream"
++ *             producer: "Blender"
++ *         }
++ *         ListElement {
++ *             title: "Big Buck Bunny"
++ *             producer: "Blender"
++ *         }
++ *     }
++ *
++ *     SortFilterModel {
++ *         id: sortedMovies
++ *         model: movies
++ *         sort.property: "title"
++ *         sort.order: Qt.DescendingOrder
++ *
++ *         filter.property: "producer"
++ *         filter.pattern: /blender/
++ *     }
++ *
++ *     ListView {
++ *         model: sortedMovies
++ *         anchors.fill: parent
++ *
++ *         delegate: Subtitled {
++ *             text: title
++ *             subText: producer
++ *         }
++ *
++ *         section.delegate: ListItem.Header { text: i18n.tr(section) }
++ *         section.property: "title"
++ *         section.criteria: ViewSection.FirstCharacter
++ *     }
++ * }
++ * \endqml
++ *
++ * Pay attention to the differences between the original model and the result:
++ * \list
++ *     \li Big Buck Bunny will be the first row, because it's sorted by title
++ *     \li Esign won't be visible, because it's from the wrong producer
++ * \endlist
++ */
++
++
++QSortFilterProxyModelQML::QSortFilterProxyModelQML(QObject *parent)
++    : QSortFilterProxyModel(parent)
++{
++    // This is virtually always what you want in QML
++    setDynamicSortFilter(true);
++    connect(this, SIGNAL(modelReset()), SIGNAL(countChanged()));
++    connect(this, SIGNAL(rowsInserted(QModelIndex,int,int)), SIGNAL(countChanged()));
++    connect(this, SIGNAL(rowsRemoved(QModelIndex,int,int)), SIGNAL(countChanged()));
++    connect(&m_sortBehavior, &SortBehavior::propertyChanged, this, &QSortFilterProxyModelQML::sortChanged);
++    connect(&m_sortBehavior, &SortBehavior::orderChanged, this, &QSortFilterProxyModelQML::sortChanged);
++    connect(&m_filterBehavior, &FilterBehavior::propertyChanged, this, &QSortFilterProxyModelQML::filterChanged);
++    connect(&m_filterBehavior, &FilterBehavior::patternChanged, this, &QSortFilterProxyModelQML::filterChanged);
++}
++
++int
++QSortFilterProxyModelQML::roleByName(const QString& roleName) const
++{
++    const QHash<int, QByteArray> roles = roleNames();
++    for(int role = 0; role < roles.count(); role++)
++        if (roles[role] == roleName)
++            return role;
++    return 0;
++}
++
++/*!
++ * \qmlproperty string SortFilterModel::sort.property
++ *
++ * If set to a valid role name, all rows will be sorted according to \l sort.order.
++ */
++
++/*!
++ * \qmlproperty string SortFilterModel::sort.order
++ *
++ * The order, if \l sort.property is set.
++ * Qt::AscendingOrder sorts results from A to Z or 0 to 9.
++ * Qt::DescendingOrder sorts results from Z to A or 9 to 0.
++ */
++
++SortBehavior*
++QSortFilterProxyModelQML::sortBehavior()
++{
++    return &m_sortBehavior;
++}
++
++/*!
++ * \qmlproperty string SortFilterModel::filter.pattern
++ *
++ * The pattern all rows must match, if \l filter.property is set.
++ *
++ * Some examples:
++ * \list
++ *     \li /possible/ matches anywhere in a word, so both "impossible" and "possible".
++ *     \li /^sign/ matches "sign". But not "assignment" because ^ means start.
++ *     \li /vest$/ matches "safety vest" and "vest" but not "vested".
++ * \endlist
++ *
++ * For more advanced uses it's recommended to read up on Javascript regular expressions.
++ */
++
++/*!
++ * \qmlproperty string SortFilterModel::filter.property
++ *
++ * If set to a valid role name, only rows matching \l filter.pattern will be in the model.
++ */
++
++FilterBehavior*
++QSortFilterProxyModelQML::filterBehavior()
++{
++    return &m_filterBehavior;
++}
++
++void
++QSortFilterProxyModelQML::sortChanged()
++{
++    setSortRole(roleByName(m_sortBehavior.property()));
++    sort(sortColumn() != -1 ? sortColumn() : 0, m_sortBehavior.order());
++}
++
++void
++QSortFilterProxyModelQML::filterChanged()
++{
++    setFilterRole(roleByName(m_filterBehavior.property()));
++    setFilterRegExp(m_filterBehavior.pattern());
++}
++
++QHash<int, QByteArray> QSortFilterProxyModelQML::roleNames() const
++{
++    return sourceModel() ? sourceModel()->roleNames() : QHash<int, QByteArray>();
++}
++
++/*!
++ * \qmlproperty QAbstractItemModel SortFilterModel::model
++ *
++ * The source model to sort and/ or filter.
++ */
++void
++QSortFilterProxyModelQML::setModel(QAbstractItemModel *itemModel)
++{
++    if (itemModel == NULL) {
++        return;
++    }
++
++    if (itemModel != sourceModel()) {
++        if (sourceModel() != NULL) {
++            sourceModel()->disconnect(this);
++        }
++
++        setSourceModel(itemModel);
++        // Roles mapping to role names may change
++        setSortRole(roleByName(m_sortBehavior.property()));
++        setFilterRole(roleByName(m_filterBehavior.property()));
++        Q_EMIT modelChanged();
++    }
++}
++
++QVariantMap
++QSortFilterProxyModelQML::get(int row)
++{
++    QVariantMap res;
++    const QHash<int, QByteArray> roles = roleNames();
++    for(int role = 0; role < roles.count(); role++)
++        res.insert (roles[role], data(row, role));
++    return res;
++}
++
++QVariant
++QSortFilterProxyModelQML::data(int row, int role)
++{
++    if (sourceModel() == NULL) {
++        return QVariant();
++    }
++
++    return index(row, 0).data(role);
++}
++
++int
++QSortFilterProxyModelQML::count()
++{
++    return rowCount();
++}
++
++bool
++QSortFilterProxyModelQML::filterAcceptsRow(int sourceRow,
++                                           const QModelIndex &sourceParent) const
++{
++    if (filterRegExp().isEmpty()) {
++        return true;
++    }
++
++    bool result = QSortFilterProxyModel::filterAcceptsRow(sourceRow, sourceParent);
++    return result;
++}
++
++#include "moc_sortfiltermodel.cpp"
++
 === added file 'modules/Ubuntu/Components/plugin/sortfiltermodel.h'
 --- modules/Ubuntu/Components/plugin/sortfiltermodel.h	1970-01-01 00:00:00 +0000
 +++ modules/Ubuntu/Components/plugin/sortfiltermodel.h	2014-05-15 09:54:24 +0000
@@ -0,0 +1,66 @@
++/*
++ * Copyright (C) 2012-2014 Canonical, Ltd.
++ *
++ * Authors:
++ *   Michal Hruby <michal.hruby@canonical.com>
++ *   Christian Dywan <christian.dywan@canonical.com>
++ *
++ * This program is free software; you can redistribute it and/or modify
++ * it under the terms of the GNU Lesser General Public License as published by
++ * the Free Software Foundation; version 3.
++ *
++ * This program is distributed in the hope that it will be useful,
++ * but WITHOUT ANY WARRANTY; without even the implied warranty of
++ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
++ * GNU Lesser General Public License for more details.
++ *
++ * You should have received a copy of the GNU Lesser General Public License
++ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
++ */
++
++#ifndef QSORTFILTERPROXYMODELQML_H
++#define QSORTFILTERPROXYMODELQML_H
++
++#include <QSortFilterProxyModel>
++#include "sortbehavior.h"
++#include "filterbehavior.h"
++
++class Q_DECL_EXPORT QSortFilterProxyModelQML : public QSortFilterProxyModel
++{
++    Q_OBJECT
++
++    Q_PROPERTY(QAbstractItemModel* model READ sourceModel WRITE setModel NOTIFY modelChanged)
++    Q_PROPERTY(int count READ count NOTIFY countChanged)
++    Q_PROPERTY(SortBehavior* sort READ sortBehavior)
++    Q_PROPERTY(FilterBehavior* filter READ filterBehavior)
++
++public:
++    explicit QSortFilterProxyModelQML(QObject *parent = 0);
++
++    Q_INVOKABLE QVariantMap get(int row);
++    Q_INVOKABLE QVariant data(int row, int role);
++    Q_INVOKABLE int count();
++    virtual bool filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent) const;
++
++    /* getters */
++    QHash<int, QByteArray> roleNames() const;
++
++    /* setters */
++    void setFilterProperty(const QString& property);
++    void setModel(QAbstractItemModel *model);
++
++Q_SIGNALS:
++    void countChanged();
++    void modelChanged();
++
++private:
++    SortBehavior m_sortBehavior;
++    SortBehavior* sortBehavior();
++    void sortChanged();
++    FilterBehavior m_filterBehavior;
++    FilterBehavior* filterBehavior();
++    void filterChanged();
++    int roleByName(const QString& roleName) const;
++};
++
++#endif // QSORTFILTERPROXYMODELQML_H
 === added file 'tests/unit/tst_components/tst_sortfiltermodel.qml'
 --- tests/unit/tst_components/tst_sortfiltermodel.qml	1970-01-01 00:00:00 +0000
 +++ tests/unit/tst_components/tst_sortfiltermodel.qml	2014-05-15 09:54:24 +0000
@@ -0,0 +1,108 @@
++/*
++ * Copyright 2014 Canonical Ltd.
++ *
++ * This program is free software; you can redistribute it and/or modify
++ * it under the terms of the GNU Lesser General Public License as published by
++ * the Free Software Foundation; version 3.
++ *
++ * This program is distributed in the hope that it will be useful,
++ * but WITHOUT ANY WARRANTY; without even the implied warranty of
++ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
++ * GNU Lesser General Public License for more details.
++ *
++ * You should have received a copy of the GNU Lesser General Public License
++ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
++ */
++
++import QtQuick 2.0
++import QtTest 1.0
++import Ubuntu.Components 1.1
++
++TestCase {
++     name: "SortFilterModel"
++
++    ListModel {
++        id: things
++        ListElement { foo: "den"; alpha: "bee"; num: 200 }
++        ListElement { foo: "pub"; alpha: "cow"; num: 300 }
++        ListElement { foo: "bar"; alpha: "ant"; num: 100 }
++    }
++
++    SortFilterModel {
++        id: unmodified
++        model: things
++    }
++
++    SortFilterModel {
++        id: alphabetic
++        model: things
++        sort.property: "alpha"
++    }
++
++    SortFilterModel {
++        id: alphaSecond
++        model: things
++        sort.property: "foo"
++    }
++
++    SortFilterModel {
++        id: alphabeticRe
++        model: things
++        sort.property: "alpha"
++        sort.order: Qt.DescendingOrder
++    }
++
++    SortFilterModel {
++        id: numeric
++        model: things
++        sort.property: "num"
++    }
++
++    SortFilterModel {
++        id: numericRe
++        model: things
++        sort.property: "num"
++        sort.order: Qt.DescendingOrder
++    }
++
++    SortFilterModel {
++        id: bee
++        model: things
++        filter.property: "alpha"
++        filter.pattern: /e/
++    }
++
++    function test_passthrough() {
++        compare(unmodified.count, things.count)
++    }
++
++    function test_sort() {
++        // Default is Ascending
++        compare(alphabetic.sort.order, Qt.AscendingOrder)
++        compare(alphabetic.get(0).alpha, "ant")
++        compare(alphabetic.get(1).alpha, "bee")
++        compare(alphabetic.get(2).alpha, "cow")
++
++        // Ensure different columns work also
++        compare(alphaSecond.get(0).foo, "bar")
++
++        // Descending
++        compare(alphabeticRe.sort.order, Qt.DescendingOrder)
++        compare(alphabeticRe.get(0).alpha, "cow")
++        compare(alphabeticRe.get(1).alpha, "bee")
++        compare(alphabeticRe.get(2).alpha, "ant")
++
++        // Numbers
++        compare(numeric.get(0).num, 100)
++        compare(numericRe.get(0).num, 300)
++    }
++
++    function test_filter() {
++        // Default is an empty pattern
++        compare(unmodified.filter.pattern, RegExp())
++
++        // Filter
++        compare(bee.count, 1)
++        compare(bee.get(0).alpha, "bee")
++    }
++}

Ubuntu UI Toolkit

Merge lp:~kalikiana/ubuntu-ui-toolkit/sortFilterModel into lp:ubuntu-ui-toolkit/staging

Commit message

Description of the change

Preview Diff

Subscribers