[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-core-devel
Subject: Review Request: New action class proposal: KDualAction
From: Aurélien Gâteau <agateau () kde ! org>
Date: 2010-09-02 22:17:33
Message-ID: 20100902221733.19196.70202 () vidsolbach ! de
[Download RAW message or body]
-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
http://svn.reviewboard.kde.org/r/5237/
-----------------------------------------------------------
Review request for kdelibs.
Summary
-------
This review-request introduces a new class named KDualAction. The goal of t=
his class is to make it easy to create a dual-state action: an action which=
represents two actions, switching from one to the other whenever it is tri=
ggered. KDualAction can be used to implement actions such as the Play/Pause=
action of a media player or the Reload/Stop action of a web browser.
Right now some applications mis-use KToggleAction to implement such dual-st=
ate actions: They set the first action as the unchecked state and provide a=
n alternative KGuiItem for the checked state with KToggleAction::setChecked=
State(). This is wrong because when the user clicks a button representing t=
he action in a toolbar, the button stays down. The appropriate use cases f=
or toggle buttons (and thus KToggleAction) are documented in a recent addit=
ion to the HIG:
http://techbase.kde.org/Projects/Usability/HIG/Toggle_Buttons
Potential users for this class:
- Dragon, Juk, Amarok to implement their Play/Pause action.
- Rekonq to implement its Reload/Stop action. Konqueror could also use this=
but it does not feature a dual reload/stop action as far as I know.
- Dolphin could maybe use it to implement its Split/Close action (although =
it's a bit more involved in this case because the close action changes depe=
nding on which panel it is going to close)
- <insert-your-app-here>
I already have a patch to make Dragon use KDualAction (I used Dragon as a t=
est application) and I plan to port other applications if the class is acce=
pted in kdelibs (I also plan to fix some applications which mis-use KToggle=
Action so that they don't use setCheckedState() when it is not appropriate).
Diffs
-----
trunk/KDE/kdelibs/kdeui/actions/kdualaction_p.h PRE-CREATION =
trunk/KDE/kdelibs/kdeui/tests/CMakeLists.txt 1171068 =
trunk/KDE/kdelibs/kdeui/tests/kdualactiontest.cpp PRE-CREATION =
trunk/KDE/kdelibs/kdeui/actions/kdualaction.cpp PRE-CREATION =
trunk/KDE/kdelibs/kdeui/CMakeLists.txt 1171068 =
trunk/KDE/kdelibs/kdeui/actions/kdualaction.h PRE-CREATION =
Diff: http://svn.reviewboard.kde.org/r/5237/diff
Testing
-------
The class comes with unit-tests. I tested the API made sense while porting =
Dragon to it.
Thanks,
Aur=C3=A9lien
[Attachment #3 (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://svn.reviewboard.kde.org/r/5237/">http://svn.reviewboard.kde.org/r/5237/</a>
</td>
</tr>
</table>
<br />
<table bgcolor="#fefadf" width="100%" cellspacing="0" cellpadding="8" \
style="background-image: \
url('http://svn.reviewboard.kde.orgrb/images/review_request_box_top_bg.png'); \
background-position: left top; background-repeat: repeat-x; border: 1px black \
solid;"> <tr>
<td>
<div>Review request for kdelibs.</div>
<div>By Aurélien Gâteau.</div>
<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;">This review-request introduces a new class named KDualAction. The goal \
of this class is to make it easy to create a dual-state action: an action which \
represents two actions, switching from one to the other whenever it is triggered. \
KDualAction can be used to implement actions such as the Play/Pause action of a media \
player or the Reload/Stop action of a web browser.
Right now some applications mis-use KToggleAction to implement such dual-state \
actions: They set the first action as the unchecked state and provide an alternative \
KGuiItem for the checked state with KToggleAction::setCheckedState(). This is wrong \
because when the user clicks a button representing the action in a toolbar, the \
button stays down. The appropriate use cases for toggle buttons (and thus \
KToggleAction) are documented in a recent addition to the HIG: \
http://techbase.kde.org/Projects/Usability/HIG/Toggle_Buttons
Potential users for this class:
- Dragon, Juk, Amarok to implement their Play/Pause action.
- Rekonq to implement its Reload/Stop action. Konqueror could also use this but it \
does not feature a dual reload/stop action as far as I know.
- Dolphin could maybe use it to implement its Split/Close action (although it's a \
bit more involved in this case because the close action changes depending on which \
panel it is going to close)
- <insert-your-app-here>
I already have a patch to make Dragon use KDualAction (I used Dragon as a test \
application) and I plan to port other applications if the class is accepted in \
kdelibs (I also plan to fix some applications which mis-use KToggleAction so that \
they don't use setCheckedState() when it is not appropriate).</pre> </td>
</tr>
</table>
<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Testing </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;">The class comes with unit-tests. I tested the API made sense while \
porting Dragon to it.</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>trunk/KDE/kdelibs/kdeui/actions/kdualaction_p.h <span style="color: \
grey">(PRE-CREATION)</span></li>
<li>trunk/KDE/kdelibs/kdeui/tests/CMakeLists.txt <span style="color: \
grey">(1171068)</span></li>
<li>trunk/KDE/kdelibs/kdeui/tests/kdualactiontest.cpp <span style="color: \
grey">(PRE-CREATION)</span></li>
<li>trunk/KDE/kdelibs/kdeui/actions/kdualaction.cpp <span style="color: \
grey">(PRE-CREATION)</span></li>
<li>trunk/KDE/kdelibs/kdeui/CMakeLists.txt <span style="color: \
grey">(1171068)</span></li>
<li>trunk/KDE/kdelibs/kdeui/actions/kdualaction.h <span style="color: \
grey">(PRE-CREATION)</span></li>
</ul>
<p><a href="http://svn.reviewboard.kde.org/r/5237/diff/" style="margin-left: \
3em;">View Diff</a></p>
</td>
</tr>
</table>
</div>
</body>
</html>
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic