[Kde-games-devel] Re: Review Request: new libkdegames class KGameBasicWindow to replace KXmlGuiWindow on mobile formfactors

[Stefan Majewsky]

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
http://svn.reviewboard.kde.org/r/6744/
-----------------------------------------------------------

(Updated July 9, 2011, 6:53 p.m.)


Review request for KDE Games and usability.


Changes
-------

new features:
- toolbar position configurable through a configuration file that is shared between games; this is intended to be used as a hook for packagers to adjust the layout to the specific device
- make navigation actions ("Settings"/"Help"/"Back") stand out to distinguish them from normal actions


Summary (updated)
-------

General outline: Many games present only a small set of menuitems and toolbar actions to the user. Even on mobile form factors, all relevant actions can in many cases easily fit in the toolbar, thus removing the need for the (touch-unfriendly) and redundant menubar. On the implementation side, it would be beneficial to replace KXmlGuiWindow, which provides important features to desktop apps, but overcomplicates the problem for apps as simple as most games.

Solution: The new KGameBasicWindow class provides a hard-coded toolbar arrangement, in which only one toolbar is created at the top of the window. The most relevant actions are placed here directly, like one expects for a toolbar. Less used actions (like those commonly found in the "Settings" and "Help" menu) can be placed in a hierarchy, but only one level of the hierarchy is made visible at once in the toolbar.

For example, if the user wants to open the handbook, he finds the "Help" button on the toolbar. Upon clicking it, the toolbar changes and displays all actions in the "Help" group (plus a "Back" button). After selecting the "Handbook" action (and thus opening the handbook), the toolbar automatically returns to its default setup and presents the "important" actions again.

Implementation: KGameBasicWindow is a new class in libkdegames. Besides this new class, the only change is in KGameDifficulty, whose init() function may now take not only KXmlGuiWindows, but also KGameBasicWindows. This change is trivial because KGameBasicWindow provides an action collection, too.

What's missing? The standard dialog for editing shortcuts. Also, I have not yet decided on how to decide between KXmlGuiWindow and KGameBasicWindow. Do you think it should be offered as a compile-time or run-time option? (Obviously, this question depends on the open question above.)


Diffs (updated)
-----

  /trunk/KDE/kdegames/kdiamond/src/mainwindow.h 1240604 
  /trunk/KDE/kdegames/kdiamond/src/mainwindow.cpp 1240604 
  /trunk/KDE/kdegames/libkdegames/CMakeLists.txt 1240604 
  /trunk/KDE/kdegames/libkdegames/includes/CMakeLists.txt 1240604 
  /trunk/KDE/kdegames/libkdegames/includes/KGameBasicWindow PRE-CREATION 
  /trunk/KDE/kdegames/libkdegames/kgamebasicwindow.h PRE-CREATION 
  /trunk/KDE/kdegames/libkdegames/kgamebasicwindow.cpp PRE-CREATION 
  /trunk/KDE/kdegames/libkdegames/kgamedifficulty.h 1240604 
  /trunk/KDE/kdegames/libkdegames/kgamedifficulty.cpp 1240604 

Diff: http://svn.reviewboard.kde.org/r/6744/diff


Testing (updated)
-------

As usual, my guinea pig is KDiamond. The needed changes are included in this patch. Everything works fine here.


Screenshots (updated)
-----------

Side-by-side comparison of KXmlGuiWindow (back) and KGameBasicWindow (front) for KDiamond
  http://svn.reviewboard.kde.org/r/6744/s/616/
Overview of available toolbar states for KDiamond: main category, Settings subcategory, Help subcategory
  http://svn.reviewboard.kde.org/r/6744/s/617/


Thanks,

Stefan

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.kde.org/pipermail/kde-games-devel/attachments/20110709/d358ea51/attachment-0001.htm