[KDE/Mac] Review Request 126198: [OS X] adaptations for the KdePlatformTheme (and autotests)

Wed Dec 2 21:38:02 UTC 2015

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://git.reviewboard.kde.org/r/126198/
-----------------------------------------------------------

(Updated Dec. 2, 2015, 10:38 p.m.)

Review request for KDE Software on Mac OS X, KDE Frameworks and Valorie Zimmerman.

Changes
-------

This revision is a probably heavy-handed attempt at implementing Martin's suggestion to re-use as much code as possible using inheritance. There's less code that can be reused than I'd have liked, and I have a strong impression that my implementation actually does quite a few things twice. Meaning once in the parent class and once in my own class, despite probably overly liberal use of `virtual` keywords. Then again it seems hard to avoid this given that the parent KdePlatformTheme class has KHintsSettings and KFontsSettings instances, and my KdeMacTheme has KHintsSettingsMac and KFontsSettingsMac instances.
Clear this isn't yet my strongest subject yet, so I hope I haven't made a complete mess of this :-/

I've made the private members protected, in order to be able to inherit them, and I've introduce a `KdePlatformTheme::fontType()` method so that it becomes possible to have a central `QPlatformTheme::Font -> KFontSettingsData::FontType` translation, and then do a platform-specific lookup in the dedicated `m_fontsData` array. Maybe that `fontType()` method should be in `KFontDataSettings`?

New in this revision is also `KFontDataSettingsMac`, which exists in order to obtain the default fonts from the system (though the sizes are hardcoded, currently). The current algorithm isn't very satisfactory, as it turns out to be a more or less known Qt issue that it doesn't provide this information reliably on OS X. Surprise, surprise :) I'll have to look if this information can be obtained through Cocoa.

The reason to do this dynamically (and leave the default colour palette to whatever Qt sets it to, for now) instead of using a predefined config file is that this information can change between OS versions. OS X 10.11 introduced a new system font (or 2), and the default colours aren't set in stone either (and users can chose the `Graphite` or default "Aqua" theme, as well as the more recent "Dark mode").

Repository: frameworkintegration

Description
-------

The KdePlatformTheme plugin can be enabled on OS X with a minimal patch to Qt5; all that is required is to include the `qgenericunixservices` and `qgenericunixthemes` components in the build, and to append `"kde"` to the list returned by `QCocoaIntegration::themeNames()` for instance under the condition that `KDE_SESSION_VERSION` is set to a suitable value in the environment.

This will allow KF5 and Qt5 applications to use the theme selected through KDE if FrameworkIntegration is installed and KDE_SESSION_VERSION is set, which seems like a sufficiently specific set of conditions that is easy to avoid by users who prefer to use the Mac native theme.

While requestion the KDE theme is also possible through `-style kde` or `env QT_STYLE_OVERRIDE=kde` the use of the KdePlatformTheme plugin appears to be the only way to get the full theme, including the font and colour selection. In my opinion it is above all the font customisation which is a very welcome feature for Qt/Mac; by default Qt applications use the default system font (Lucida Grande 13pt or even 14pt) throughout. This is a good UI font, but not at that size (and most "native" OS X applications indeed use a range of smaller sizes, depending on role.

It does have introduce a number of regressions, which the current patch aims to address. The most visible and problematic of these regressions is the loss of the Mac-style menu bar and thus of all menu items (actions).

The fix is straightforward : on OS X (and similarly affected platforms?), an instance of the native Cocoa platform theme is created through the private API, and used as a fallback rather than immediately falling back to the default implementations from `QPlatformTheme`. In addition, methods missing from (not overridden by) `KdePlatformTheme` are provided on OS X and call the corresponding methods from the native theme. It is this change which restores the menubar and even the Dock menu functionality.
One minor regression remains but should be easy to fix (elsewhere?): the Preferences menu loses its keyboard shortcut (Command-,).

Given the fallback nature of the native platform instance I have preferred to print a warning rather than using something like `qFatal`, above all because the message printed by qFatal tends to get lost on OS X. I can replace my use of `qWarning` with a dialog giving the choice between continuing or exiting the application - code that would be called in the menu methods because only there is it certain that the application actually needs a menubar.

In line with experience and feedback from the KDE(4)-Mac community I have decided to force the use of native dialogs rather than the ones from the KdePlatformPlugin.

In addition I set the fallback value for `ShowIconsOnPushButtons` to false in line with platform guidelines, and ensure that the autotests are not built as app bundles.

Diffs (updated)
-----

  autotests/CMakeLists.txt 7c2129c 
  src/kstyle/CMakeLists.txt bc26667 
  src/platformtheme/CMakeLists.txt 23f590e 
  src/platformtheme/kdeplatformtheme.h 97d09df 
  src/platformtheme/kdeplatformtheme.cpp 80dbcb7 
  src/platformtheme/kfontsettingsdata.h 4b92c7d 
  src/platformtheme/khintssettings.h ec064d3 

Diff: https://git.reviewboard.kde.org/r/126198/diff/

Testing
-------

On Mac OS X with Qt 5.5.1, KF5 frameworks 5.16.0 and QtCurve git/head.

I have not verified to what extent my use of a private `QGuiApplication` API links builds to a specific Qt version (I consider that nothing shocking and a minor price to pay).
>>> Do I need to add some glue to the CMake file so that it will warn if the private headerfiles are not available? Apparently no changes were required to find them.

File Attachments
----------------

purely native OS X theme
  https://git.reviewboard.kde.org/media/uploaded/files/2015/11/30/650d0da7-52b3-40d1-a1f9-cb610494cf77__Screen_Shot_2015-11-30_at_15.42.31.png
native theme but with `-style kde`
  https://git.reviewboard.kde.org/media/uploaded/files/2015/11/30/72e2a6aa-2a7c-465b-b404-fc1e52b6fc69__Screen_Shot_2015-11-30_at_15.43.02.png
using the KDEPlatformTheme
  https://git.reviewboard.kde.org/media/uploaded/files/2015/11/30/309e5995-74fa-42fb-a6f3-936cedbf5246__Screen_Shot_2015-11-30_at_15.43.31.png
on Linux, using a purely "native" theme
  https://git.reviewboard.kde.org/media/uploaded/files/2015/11/30/eaa1d907-bf05-4ca2-821b-83dc062aea04__QtCreatorNativeLNX.png
KDEPlatformTheme with the "macintosh" native theme selected
  https://git.reviewboard.kde.org/media/uploaded/files/2015/12/01/de55a91f-3500-4db8-8a3b-d252fd7ea169__Screen_Shot_2015-12-01_at_13.52.35.png

Thanks,

René J.V. Bertin

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-mac/attachments/20151202/f950c081/attachment.html>