Merge lp:~mcintire-evan/unity/add_screenshot_shortcut_hints into lp:unity

[Evan McIntire]

ShortcutHint: Add key shortcut hints for Screenshot and Window Screenshot

Key bindings are dynamically taken from gnome settings.

ShortcutHint: Add key shortcut hints for Screenshot and Window Screenshot

Key bindings are dynamically taken from gnome settings.

[Marco Trevisan (Treviño) (3v1n0)]

Hi, thanks for you contribution.

Please, revert the changes in the po folder, these are generated automatically.

As for making this option dynamic I think there's some little more work involved:
 - enable the GNOME option type in AbstractShortcutHint.h
 - inside ShortcutHint.cpp read the options from:
   org.gnome.settings-daemon.plugins.media-keys <key_name>
   You can see how to read gsettings from UnitySettings.cpp,
   while in GnomeGrabber::Impl::GrabDBusAccelerator you can see how
   to parse them.
 - In CompizShortcutModeller.cpp you should add something like:
     std::make_shared<shortcut::Hint>(menubar, "", "", _("Take a screenshot."),
                                      shortcut::OptionType::GNOME,
                                      "screenshot")
     std::make_shared<shortcut::Hint>(menubar, "", "", _("Take a screenshot of the current window."),
                                      shortcut::OptionType::GNOME,
                                      "window-screenshot")

It should be fun :)

[Evan McIntire (mcintire-evan)]

Thanks! Do I read and parse the settings in the files you mentioned or in ShortcitHint.cpp? Other than that, everything is pretty clear

[Marco Trevisan (Treviño) (3v1n0)]

> Thanks! Do I read and parse the settings in the files you mentioned or in
> ShortcitHint.cpp? Other than that, everything is pretty clear

I'd do that in ShortcutHint.cpp, in CompizShortcutModeller just create the hint with a type and a setting key.

[Marco Trevisan (Treviño) (3v1n0)]

That's great, there are some fixes to do though...

See the inline comments for details, main fixes are at http://pastebin.ubuntu.com/14072232/

[Marco Trevisan (Treviño) (3v1n0)]

Looks great now.

Thanks a lot!!

review: Approve

[Marco Trevisan (Treviño) (3v1n0)]

Sorry, there's a compilation issue because a different variable name has been used:

/«BUILDDIR»/unity-7.4.0+16.04.20151217/shortcuts/ShortcutHint.cpp: In member function 'virtual bool unity::shortcut::Hint::Fill()':
/«BUILDDIR»/unity-7.4.0+16.04.20151217/shortcuts/ShortcutHint.cpp:161:46: error: 'settings' was not declared in this scope
       glib::String key(g_settings_get_string(settings, arg1().c_str()));

review: Needs Fixing

[lp:~mcintire-evan/unity/add_screenshot_shortcut_hints]

4040. By Evan McIntire on 2015-12-17

ShortcutHint: Add key shortcut hints for Screenshot and Window Screenshot

Key bindings are dynamically taken from gnome settings.

[Marco Trevisan (Treviño) (3v1n0)]

Thanks, it compiles fine now.

review: Approve

=== modified file 'shortcuts/AbstractShortcutHint.h'
--- shortcuts/AbstractShortcutHint.h	2013-01-21 14:06:15 +0000
+++ shortcuts/AbstractShortcutHint.h	2015-12-17 21:58:02 +0000
@@ -36,7 +36,8 @@
   COMPIZ_KEY = 0,
   COMPIZ_METAKEY,
   COMPIZ_MOUSE,
-  HARDCODED
+  HARDCODED,
+  GNOME
   /* GSETTINGS,
    * GCONF */
 };

=== modified file 'shortcuts/CompizShortcutModeller.cpp'
--- shortcuts/CompizShortcutModeller.cpp	2015-12-11 12:44:53 +0000
+++ shortcuts/CompizShortcutModeller.cpp	2015-12-17 21:58:02 +0000
@@ -242,6 +242,16 @@
                                                    _("Moves focus between indicators."),
                                                    shortcut::OptionType::HARDCODED,
                                                    _("Cursor Left or Right")));
+
+  hints.push_back(std::make_shared<shortcut::Hint>(menubar, "", "",
+                                                   _("Take a screenshot."),
+                                                   shortcut::OptionType::GNOME,
+                                                   "screenshot"));
+
+  hints.push_back(std::make_shared<shortcut::Hint>(menubar, "", "",
+                                                   _("Take a screenshot of the current window."),
+                                                   shortcut::OptionType::GNOME,
+                                                   "window-screenshot"));
 }
 
 void CompizModeller::AddSwitcherHints(std::list<shortcut::AbstractHint::Ptr> &hints, bool ws_enabled)

=== modified file 'shortcuts/MockShortcutHint.h'
--- shortcuts/MockShortcutHint.h	2013-01-19 00:37:45 +0000
+++ shortcuts/MockShortcutHint.h	2015-12-17 21:58:02 +0000
@@ -59,6 +59,9 @@
         value = arg1();
         shortkey = prefix() + value() + postfix();
         return true;
+      case OptionType::GNOME:
+        value = arg1();
+        return true;
     }
 
     return false;

=== modified file 'shortcuts/ShortcutHint.cpp'
--- shortcuts/ShortcutHint.cpp	2013-01-19 00:37:45 +0000
+++ shortcuts/ShortcutHint.cpp	2015-12-17 21:58:02 +0000
@@ -21,16 +21,19 @@
 
 #include <core/core.h> // Compiz...
 #include <NuxCore/Logger.h>
+#include <UnityCore/GLibWrapper.h>
 
 #include "ShortcutHintPrivate.h"
 
-DECLARE_LOGGER(logger, "unity.shortcut");
-
 namespace unity
 {
 namespace shortcut
 {
-
+namespace
+{
+    const std::string GNOME_MEDIA_SETTINGS = "org.gnome.settings-daemon.plugins.media-keys";
+    DECLARE_LOGGER(logger, "unity.shortcut");
+}
 // Ctor
 Hint::Hint(std::string const& category,
            std::string const& prefix,
@@ -152,6 +155,22 @@
         shortkey = prefix() + value() + postfix();
       }
       return true;
+    case OptionType::GNOME:
+    {
+      glib::Object<GSettings> key_settings(g_settings_new(GNOME_MEDIA_SETTINGS.c_str()));
+      glib::String key(g_settings_get_string(key_settings, arg1().c_str()));
+
+      std::string temp(impl::GetTranslatableLabel(key.Str()));
+      temp = impl::ProperCase(temp);
+      
+      if (value() != temp)
+      {
+        value = temp;
+        shortkey = value();
+      }
+      
+      return true;
+    }
 
     default:
       LOG_WARNING(logger) << "Unable to find the option type" << static_cast<unsigned>(type());