Writing QML Application in a Flux way

[clogwog]

@Ben-Lau thank you for the example ! it will help a lot.

[benlau]

v1.0.3 has been released.

Changes:

New Components

1. AppScript

---

AppScript is a helper component to handle asynchronous sequential workflow. The immediate benefit of using AppScript is the centralisation of code in a place. Instead of placing them within onXXXX code block in several components in several places.

2. AppListenerGroup

---

AppListenerGroup collects listener ID from all of its child AppListener and initialize their waitFor property.
It could be used as the base type of a Store component for setup dependence between them.

MyStore1.qml

AppListenerGroup {
    AppListener {
    }
    AppListener {
    }
}

MyStore2.qml

AppListenerGroup {
   waitFor: MyStore1.listenerIds
}

Changes

AppDispatcher

1. Added addListener() function

Registers a callback to be invoked with every dispatched message. Returns a listener ID that can be used with waitFor().

2. Added removeListener() function

Remove a callback by the listenerId returned by addListener

3. Added waitFor() function

Waits for the callbacks specified to be invoked before continuing execution of the current callback. This method should only be used by a callback in response to a dispatched message.

AppListener

1. Added “listenerId” property

The listener ID of this component. It could be used with AppListener.waitFor/AppDispatcher.waitFor to control the order of message delivery.

2. Added “waitFor” property

If it is set, it will block the emission of dispatched signal until all the specified listeners invoked.

Example code:

AppListener {
  id: listener1
}

AppListener {
  id: listener2
  waitFor: [listener1.listenerId]
}

[Vincent007]

Hi Ben,

Thank for your contributions!

Did you discuss about writing QML Application in a Flux way with developers of Qt via Qt development mailing list?

If not, why not?

Merry Christmas!

[benlau]

@Vincent007 no. hmmm... Just I can't think of any reason to send to dev mailing list. Ask them for comment? or ask them to include related class in next version? Ofcoz it will be better if more people can comment / raise suggestion, but I just not sure should I send to dev mailing list.

Merry Christmas!

[Vincent007]

Hi Ben,

I think your work can help Qt developers think how QML should be evolved in feature. Therefore you can discuss with them about the evolution of QML by your work.

[benlau]

@Vincent007 hmm. Let's me think about it. By the way, I am going to publish another article with similar topic but better explanation, code and diagram on a blog in this week.

[clogwog]

Hi Ben,

i'm not sure if this is a bug but i'm trying to figure out how to use quickflux by making a small change to the todo example.

I added a 'mark all items done' button and mark all items as done. however the ui doesn't always update.

example: 1) start application (3 items in list 1 in done)
2) press 'all done' -> all items disappear (expected)
3) show all items by checking 'show completed' (expecteD)
4) unmark one item (for example 'Task A')
5) press 'all done' -> 'Task A' doesn't update to done ?

if i uncheck and re-check 'show completed' the model and view are back in sync.

https://github.com/clogwog/fluxtest1

am i missing something ?

[benlau]

@clogwog I can't reproduce your problem in my example program and in your code. When it is set to "Show Completed". It will show every tasks. So if you set a task done in "Show Completed" mode. It won't disappear. The behaviour should be correct.

[clogwog]

no, i was expecting it to show all tasks as you said, i just expected it to switch back to checked when i pressed the 'all done' button

so when you are in the 'show completed' mode in step 5 with a task you just set to 'uncompleted' and then press 'all done' your tasks goes back to checked ?

[benevo]

@benlau

Hi Ben,

Thank for your sparking idea about this area, It's charming & meaningful to do this.
BTW, could U show the link of Ur another article with better description if possible.

Thanks !

Happy New Year !

[benlau]

@clogwog said:

no, i was expecting it to show all tasks as you said, i just expected it to switch back to checked when i pressed the 'all done' button

so when you are in the 'show completed' mode in step 5 with a task you just set to 'uncompleted' and then press 'all done' your tasks goes back to checked ?

oh, you mean in your program. I didn't realize that you have added a "All Done" button. The problem is about data binding in Qt. Qt use one-way data binding. Although it has binded CheckBox.checked to model.done , the binding will lost whatever it is toggled by user event. It is overridden by system. And that is why step 5 failed.

You may solve this problem in this way:

At TodoVisualDataModel.qml:

    delegate: TodoItem {
        id:item
        uid: model.uid
        title: model.title
        property bool done: model.done

        onDoneChanged: {
            checked = model.done;
        }

        Component.onCompleted: {
            item.VisualDataModel.inNonCompleted = Qt.binding(function() { return !model.done})
        }
    }

@benevo: thx. The article is not ready yet. I will post it within this few days.

[clogwog]

@benlau thank you for taking the time to tell me this !
i have learned something new.

kind regards,
tom

[stackprogramer]

nice,thanks for share,i think MVC is too good for our Qml project.

[benlau]

@benevo @Vincent007 The new article is ready.

Action-Dispatcher Design Pattern for QML — Medium

[Vincent007]

@benlau

Do you think it is beneficial to use Action-Dispatcher Design Pattern in C++ ?
If Yes, would you mind giving us an example in C++ ?

[benlau]

@Vincent007 yes, I think so. However, I am not coding in pure C++ way. I could provide a C++ and QML mixing example code. Before it is ready, you may take a look about the C++ API of QuickFlux:

QFAppDispatcher Class | QuickFlux 1.0

[Vincent007]

@benlau Thank for your new example in advance!

I think it is time to show your work to Qt contributors via Qt development mailing list. I think your work can help Qt contributors think how QML should be evolved in feature.

[Vincent007]

Someone implemented FLUX too!

[benlau]

@Vincent007 Interesting. thx.

I am happy to see more people talking about using Flux in Qt/QML even they are not using my library. That means the approach really works. Moreover, until now, I don't see a standard QML application guide available yet. I would like to draw more attention from Qt users / developers to think about this problem.

p.s I have added a FAQ about why it need a Dispatcher instead of just a QObject:

Why use AppDispatcher instead of listening from AppActions directly?

[benlau]

v1.0.4 has been released.

New Components

KeyTable

KeyTable is an object with properties equal to its key name. Once it's construction is completed, it will search all of its string property. If it is a string type and not assigned to any value, it will set its value by its name. It can be used to create ActionTypes.qml in QuickFlux Application.

Example:

KeyTable {

    // It will be set to "customField1" in Component.onCompleted callback.
    property string customField1;

    // Since it is already assigned a value, KeyTable will not modify this property.
    property string customField2 : "value";

}

Filter

Filter component listens for the parent's dispatched signal, if a dispatched signal match with its type, it will emit its own "dispatched" signal. Otherwise, it will simply ignore the signal.

This component provides an alternative way to filter incoming message which is suitable for making Store component.

Example:

pragma Singleton
import QtQuick 2.0
import QuickFlux 1.0
import "../actions"

AppListener {
    id: store

    property ListModel model: ListModel { }

    Filter {
        type: ActionTypes.addTask
        onDispatched: {
            model.append({task: message.task});
        }
    }

}

It is not suggested to use nested AppListener in a Store component. Because nested AppListener do not share the same AppListener::listenerId, it will be difficult to control the order of message reception between store component.

In contrast, Filter share the same listenerId with its parent, and therefore it is a solution for above problem.

Changes

AppScript

1. Added "autoExit" property

examples/todo

1. Migrated to use KeyTable and Filter
2. Added StoreAdapter to demonstrate how to use "waitFor" between stores.

StoreAdapter.qml

import QtQuick 2.0
import "../stores"

Item {

    Component.onCompleted: {
        TodoStore.waitFor = [UserPrefsStore.listenerId];
    }

}