[prev in list] [next in list] [prev in thread] [next in thread]
List: kwin
Subject: Re: Review Request 109604: Model to provide easy access to KWin's Clients from QML
From: "Marco Martin" <notmart () gmail ! com>
Date: 2013-04-03 10:48:14
Message-ID: 20130403104814.1498.99392 () vidsolbach ! de
[Download RAW message or body]
[Attachment #2 (multipart/alternative)]
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
http://git.reviewboard.kde.org/r/109604/#review30310
-----------------------------------------------------------
Ship it!
Ship It!
- Marco Martin
On April 2, 2013, 3:41 p.m., Martin Gräßlin wrote:
>
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> http://git.reviewboard.kde.org/r/109604/
> -----------------------------------------------------------
>
> (Updated April 2, 2013, 3:41 p.m.)
>
>
> Review request for kwin and Plasma.
>
>
> Description
> -------
>
> Model to provide easy access to KWin's Clients from QML
>
> A new ClientModel is added which provides multiple different views on
> KWin's Clients. The model is organized as a tree model supporting the
> following levels:
> * activities
> * virtual desktops
> * screens
> * none
>
> The levels can be ordered in whatever way one wants. That is the tree
> structure can have an ordering of activities then virtual desktops or
> the other way around.
>
> In addition the model provides Exclusion flags to exclude clients of
> certain types. E.g. it's possible to exclude all windows which are not on
> the current desktop or all windows which are of type dock.
>
> The model gets automatically updated whenever a Client is added/removed
> or changes a state in a way that it should be excluded/included.
>
> The ClientModel is not directly exported to QML. Instead there are
> specific sub classes for certain common orderings. This solutions is
> chosen to workaround some limitations of QML. The initial idea was to
> use a property taking a list of the levels, but this doesn't work because
> we are not notified when the QDeclarativeListProperty changes.
>
> Currently the following models are provided to QML:
> * ClientModel -> no restrictions
> * ClientModelByScreen -> ordering by screen
> * ClientModelByScreenAndDesktop -> screen, then desktop
>
> These can be used to get all Clients:
> ClientModel {
> }
>
> Or to get the classic Present Windows on current desktop:
> ClientModelByScreen {
> exclusions: ClientModel.OtherDesktopsExclusion | ClientModel.NotAcceptingFocusExclusion | ...
> }
>
> Or to get the classic Present Windows on all desktops:
> ClientModelByScreen {
> exclusions: ClientModel.NotAcceptingFocusExclusion | ...
> }
>
> Or our well known desktop grid:
> ClientModelByScreenAndDesktop {
> id: desktopGrid
> exclusions: ClientModel.NotAcceptingFocusExclusion | ...
> }
>
> To support filtering as known by the Present Windows effect one can use
> a ClientFilterModel, which is a QSortFilterProxyModel filtering on
> window caption, role and class:
> ClientFilterModel {
> id: filterModel
> clientModel: desktopGrid
> filter: filterItem.text
> }
>
> In case it's a tree level obviously QML does not support this correctly.
> So we need to use a VisualDataModel:
> VisualDataModel {
> id: clientModel
> model: filterModel
> Component.onCompleted: {
> clientModel.rootIndex = modelIndex(0);
> clientModel.rootIndex = modelIndex(0);
> clientModel.delegate = thumbnailDelegate;
> }
> }
>
> As we can see, the rootIndex has to be set to the level which contains
> the Clients. Also it seems to be important to create the delegate after
> the model index has been set. The idea is to have only one ClientModel
> and multiple VisualDataModels if multiple views on the data is needed.
>
> The model has been tested with a painful modeltest session. It looks good
> so far modulo the listed limitations and that modeltest is not liking
> closing Yakuake in the ClientModelByScreenAndDesktop setup, though it
> works fine in real world testing.
>
> Add a client property to ThumbnailItem
>
> Makes it a little bit easier to use a ThumbnailItem for a Client. E.g.
> ThumbnailItem {
> client: model.client
> }
>
> instead of mapping the windowIds, which is rather uncomfty.
>
> Support saturation/brightness in ThumbnailItem
>
> Two new properties saturation and brightness are added to the
> ThumbnailItem which can be set from QML.
>
> The properties are honoured by the Scene when rendering the thumbnail.
>
>
> Diffs
> -----
>
> kwin/CMakeLists.txt f0795b4873ac58a06c737b200559fa76e3c9c11e
> kwin/scene.cpp 939f000f0c3d09ffacccb0b25c50f83f0010ef47
> kwin/scripting/scripting.cpp e124827174317ab6adbfdb90cec796a02e7bd2b7
> kwin/scripting/scripting_model.h PRE-CREATION
> kwin/scripting/scripting_model.cpp PRE-CREATION
> kwin/thumbnailitem.h f7dc4fe621e9cf2786794d1be55930ce79ca5c7c
> kwin/thumbnailitem.cpp 66b665a685188767201ada7d5cfbb32a0ea7ff0a
>
> Diff: http://git.reviewboard.kde.org/r/109604/diff/
>
>
> Testing
> -------
>
>
> File Attachments
> ----------------
>
> Example PresentWindows/DesktopGrid QML
> http://git.reviewboard.kde.org/media/uploaded/files/2013/03/20/main.qml
> WindowItemComponent.qml - needed for the example
> http://git.reviewboard.kde.org/media/uploaded/files/2013/03/20/WindowItemComponent.qml
>
>
> Thanks,
>
> Martin Gräßlin
>
>
[Attachment #5 (text/html)]
<html>
<body>
<div style="font-family: Verdana, Arial, Helvetica, Sans-Serif;">
<table bgcolor="#f9f3c9" width="100%" cellpadding="8" style="border: 1px #c9c399 \
solid;"> <tr>
<td>
This is an automatically generated e-mail. To reply, visit:
<a href="http://git.reviewboard.kde.org/r/109604/">http://git.reviewboard.kde.org/r/109604/</a>
</td>
</tr>
</table>
<br />
<p>Ship it!</p>
<pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: \
-pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word;">Ship It!</pre> <br />
<p>- Marco</p>
<br />
<p>On April 2nd, 2013, 3:41 p.m. UTC, Martin Gräßlin wrote:</p>
<table bgcolor="#fefadf" width="100%" cellspacing="0" cellpadding="8" \
style="background-image: \
url('http://git.reviewboard.kde.org/static/rb/images/review_request_box_top_bg.ab6f3b1072c9.png'); \
background-position: left top; background-repeat: repeat-x; border: 1px black \
solid;"> <tr>
<td>
<div>Review request for kwin and Plasma.</div>
<div>By Martin Gräßlin.</div>
<p style="color: grey;"><i>Updated April 2, 2013, 3:41 p.m.</i></p>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Description </h1>
<table width="100%" bgcolor="#ffffff" cellspacing="0" cellpadding="10" \
style="border: 1px solid #b8b5a0"> <tr>
<td>
<pre style="margin: 0; padding: 0; white-space: pre-wrap; white-space: \
-moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: \
break-word;">Model to provide easy access to KWin's Clients from QML
A new ClientModel is added which provides multiple different views on
KWin's Clients. The model is organized as a tree model supporting the
following levels:
* activities
* virtual desktops
* screens
* none
The levels can be ordered in whatever way one wants. That is the tree
structure can have an ordering of activities then virtual desktops or
the other way around.
In addition the model provides Exclusion flags to exclude clients of
certain types. E.g. it's possible to exclude all windows which are not on
the current desktop or all windows which are of type dock.
The model gets automatically updated whenever a Client is added/removed
or changes a state in a way that it should be excluded/included.
The ClientModel is not directly exported to QML. Instead there are
specific sub classes for certain common orderings. This solutions is
chosen to workaround some limitations of QML. The initial idea was to
use a property taking a list of the levels, but this doesn't work because
we are not notified when the QDeclarativeListProperty changes.
Currently the following models are provided to QML:
* ClientModel -> no restrictions
* ClientModelByScreen -> ordering by screen
* ClientModelByScreenAndDesktop -> screen, then desktop
These can be used to get all Clients:
ClientModel {
}
Or to get the classic Present Windows on current desktop:
ClientModelByScreen {
exclusions: ClientModel.OtherDesktopsExclusion | \
ClientModel.NotAcceptingFocusExclusion | ... }
Or to get the classic Present Windows on all desktops:
ClientModelByScreen {
exclusions: ClientModel.NotAcceptingFocusExclusion | ...
}
Or our well known desktop grid:
ClientModelByScreenAndDesktop {
id: desktopGrid
exclusions: ClientModel.NotAcceptingFocusExclusion | ...
}
To support filtering as known by the Present Windows effect one can use
a ClientFilterModel, which is a QSortFilterProxyModel filtering on
window caption, role and class:
ClientFilterModel {
id: filterModel
clientModel: desktopGrid
filter: filterItem.text
}
In case it's a tree level obviously QML does not support this correctly.
So we need to use a VisualDataModel:
VisualDataModel {
id: clientModel
model: filterModel
Component.onCompleted: {
clientModel.rootIndex = modelIndex(0);
clientModel.rootIndex = modelIndex(0);
clientModel.delegate = thumbnailDelegate;
}
}
As we can see, the rootIndex has to be set to the level which contains
the Clients. Also it seems to be important to create the delegate after
the model index has been set. The idea is to have only one ClientModel
and multiple VisualDataModels if multiple views on the data is needed.
The model has been tested with a painful modeltest session. It looks good
so far modulo the listed limitations and that modeltest is not liking
closing Yakuake in the ClientModelByScreenAndDesktop setup, though it
works fine in real world testing.
Add a client property to ThumbnailItem
Makes it a little bit easier to use a ThumbnailItem for a Client. E.g.
ThumbnailItem {
client: model.client
}
instead of mapping the windowIds, which is rather uncomfty.
Support saturation/brightness in ThumbnailItem
Two new properties saturation and brightness are added to the
ThumbnailItem which can be set from QML.
The properties are honoured by the Scene when rendering the thumbnail.</pre>
</td>
</tr>
</table>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Diffs</b> </h1>
<ul style="margin-left: 3em; padding-left: 0;">
<li>kwin/CMakeLists.txt <span style="color: \
grey">(f0795b4873ac58a06c737b200559fa76e3c9c11e)</span></li>
<li>kwin/scene.cpp <span style="color: \
grey">(939f000f0c3d09ffacccb0b25c50f83f0010ef47)</span></li>
<li>kwin/scripting/scripting.cpp <span style="color: \
grey">(e124827174317ab6adbfdb90cec796a02e7bd2b7)</span></li>
<li>kwin/scripting/scripting_model.h <span style="color: \
grey">(PRE-CREATION)</span></li>
<li>kwin/scripting/scripting_model.cpp <span style="color: \
grey">(PRE-CREATION)</span></li>
<li>kwin/thumbnailitem.h <span style="color: \
grey">(f7dc4fe621e9cf2786794d1be55930ce79ca5c7c)</span></li>
<li>kwin/thumbnailitem.cpp <span style="color: \
grey">(66b665a685188767201ada7d5cfbb32a0ea7ff0a)</span></li>
</ul>
<p><a href="http://git.reviewboard.kde.org/r/109604/diff/" style="margin-left: \
3em;">View Diff</a></p>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">File Attachments \
</h1>
<ul>
<li><a href="http://git.reviewboard.kde.org/media/uploaded/files/2013/03/20/main.qml">Example \
PresentWindows/DesktopGrid QML</a></li>
<li><a href="http://git.reviewboard.kde.org/media/uploaded/files/2013/03/20/WindowItemComponent.qml">WindowItemComponent.qml \
- needed for the example</a></li>
</ul>
</td>
</tr>
</table>
</div>
</body>
</html>
_______________________________________________
kwin mailing list
kwin@kde.org
https://mail.kde.org/mailman/listinfo/kwin
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic