CompizShortcutModeller: implement a basic compiz shortcut Modeller

(bzr r2919.3.51)

3 files changed, 348 insertions, 0 deletions

diff --git a/shortcuts/CMakeLists.txt b/shortcuts/CMakeLists.txt
index 99f0593ac..463eb6f23 100644
--- a/shortcuts/CMakeLists.txt
+++ b/shortcuts/CMakeLists.txt
@@ -18,7 +18,9 @@ include_directories (.. ../services ../UnityCore ${UNITY_SRC} ${CMAKE_BINARY_DIR
 #
 set (SHORTCUTS_SOURCES
 AbstractShortcutHint.h
+ AbstractShortcutModeller.h
 BaseWindowRaiserImp.cpp
+ CompizShortcutModeller.cpp
 MockShortcutHint.h
 ShortcutController.cpp
 ShortcutController.h
diff --git a/shortcuts/CompizShortcutModeller.cpp b/shortcuts/CompizShortcutModeller.cpp
new file mode 100644
index 000000000..e6b9bf70e
--- /dev/null
+++ b/shortcuts/CompizShortcutModeller.cpp
@@ -0,0 +1,301 @@
+/*
+ * Copyright 2013 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 3, as published
+ * by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranties of
+ * MERCHANTABILITY, SATISFACTORY QUALITY or FITNESS FOR A PARTICULAR
+ * PURPOSE. See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * version 3 along with this program. If not, see
+ * <http://www.gnu.org/licenses/>
+ *
+ * Authored by: Marco Trevisan <marco.trevisan@canonical.com>
+ */
+
+#include "config.h"
+#include <glib/gi18n-lib.h>
+#include "CompizShortcutModeller.h"
+#include "ShortcutHint.h"
+
+namespace unity
+{
+namespace shortcut
+{
+namespace
+{
+ // Compiz' plug-in names
+ const std::string CORE_PLUGIN_NAME = "core";
+ const std::string EXPO_PLUGIN_NAME = "expo";
+ const std::string GRID_PLUGIN_NAME = "grid";
+ const std::string MOVE_PLUGIN_NAME = "move";
+ const std::string RESIZE_PLUGIN_NAME = "resize";
+ const std::string SCALE_PLUGIN_NAME = "scale";
+ const std::string UNITYSHELL_PLUGIN_NAME = "unityshell";
+ const std::string WALL_PLUGIN_NAME = "wall";
+
+ // Compiz Core Options
+ const std::string CORE_OPTION_SHOW_DESKTOP_KEY = "show_desktop_key";
+ const std::string CORE_OPTION_MAXIMIZE_WINDOW_KEY = "maximize_window_key";
+ const std::string CORE_OPTION_UNMAXIMIZE_WINDOW_KEY = "unmaximize_window_key";
+ const std::string CORE_OPTION_CLOSE_WINDOW_KEY = "close_window_key";
+ const std::string CORE_OPTION_WINDOW_MENU_KEY = "window_menu_key";
+
+ // Compiz Expo Options
+ const std::string EXPO_OPTION_EXPO_KEY = "expo_key";
+
+ // Compiz Grid Options
+ const std::string GRID_OPTION_PUT_LEFT_KEY = "put_left_key";
+
+ // Compiz Move Options
+ const std::string MOVE_OPTION_INITIATE_BUTTON = "initiate_button";
+
+ // Compiz Resize Options
+ const std::string RESIZE_OPTION_INITIATE_BUTTON = "initiate_button";
+
+ // Compiz Scale Options
+ const std::string SCALE_OPTION_INITIATE_ALL_KEY = "initiate_all_key";
+
+ // Compiz Unityshell Options
+ const std::string UNITYSHELL_OPTION_SHOW_LAUNCHER = "show_launcher";
+ const std::string UNITYSHELL_OPTION_KEYBOARD_FOCUS = "keyboard_focus";
+ const std::string UNITYSHELL_OPTION_LAUNCHER_SWITCHER_FORWARD = "launcher_switcher_forward";
+ const std::string UNITYSHELL_OPTION_SHOW_HUD = "show_hud";
+ const std::string UNITYSHELL_OPTION_PANEL_FIRST_MENU = "panel_first_menu";
+ const std::string UNITYSHELL_OPTION_ALT_TAB_FORWARD = "alt_tab_forward";
+ const std::string UNITYSHELL_OPTION_ALT_TAB_NEXT_WINDOW = "alt_tab_next_window";
+
+ // Compiz Wall Options
+ const std::string WALL_OPTION_LEFT_KEY = "left_key";
+ const std::string WALL_OPTION_LEFT_WINDOW_KEY = "left_window_key";
+}
+
+CompizModeller::CompizModeller()
+{
+ // Launcher...
+ const std::string launcher(_("Launcher"));
+
+ std::list<shortcut::AbstractHint::Ptr> hints;
+ hints.push_back(std::make_shared<shortcut::Hint>(launcher, "", _(" (Hold)"),
+ _("Opens the Launcher, displays shortcuts."),
+ shortcut::OptionType::COMPIZ_KEY,
+ UNITYSHELL_PLUGIN_NAME,
+ UNITYSHELL_OPTION_SHOW_LAUNCHER));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(launcher, "", "",
+ _("Opens Launcher keyboard navigation mode."),
+ shortcut::OptionType::COMPIZ_KEY,
+ UNITYSHELL_PLUGIN_NAME,
+ UNITYSHELL_OPTION_KEYBOARD_FOCUS));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(launcher, "", "",
+ _("Switches applications via the Launcher."),
+ shortcut::OptionType::COMPIZ_KEY,
+ UNITYSHELL_PLUGIN_NAME,
+ UNITYSHELL_OPTION_LAUNCHER_SWITCHER_FORWARD));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(launcher, "", _(" + 1 to 9"),
+ _("Same as clicking on a Launcher icon."),
+ shortcut::OptionType::COMPIZ_KEY,
+ UNITYSHELL_PLUGIN_NAME,
+ UNITYSHELL_OPTION_SHOW_LAUNCHER));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(launcher, "", _(" + Shift + 1 to 9"),
+ _("Opens a new window in the app."),
+ shortcut::OptionType::COMPIZ_KEY,
+ UNITYSHELL_PLUGIN_NAME,
+ UNITYSHELL_OPTION_SHOW_LAUNCHER));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(launcher, "", " + T",
+ _("Opens the Trash."),
+ shortcut::OptionType::COMPIZ_KEY,
+ UNITYSHELL_PLUGIN_NAME,
+ UNITYSHELL_OPTION_SHOW_LAUNCHER));
+
+
+ // Dash...
+ static const std::string dash( _("Dash"));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(dash, "", _(" (Tap)"),
+ _("Opens the Dash Home."),
+ shortcut::OptionType::COMPIZ_KEY,
+ UNITYSHELL_PLUGIN_NAME,
+ UNITYSHELL_OPTION_SHOW_LAUNCHER));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(dash, "", " + A",
+ _("Opens the Dash App Lens."),
+ shortcut::OptionType::COMPIZ_KEY,
+ UNITYSHELL_PLUGIN_NAME,
+ UNITYSHELL_OPTION_SHOW_LAUNCHER));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(dash, "", " + F",
+ _("Opens the Dash Files Lens."),
+ shortcut::OptionType::COMPIZ_KEY,
+ UNITYSHELL_PLUGIN_NAME,
+ UNITYSHELL_OPTION_SHOW_LAUNCHER));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(dash, "", " + M",
+ _("Opens the Dash Music Lens."),
+ shortcut::OptionType::COMPIZ_KEY,
+ UNITYSHELL_PLUGIN_NAME,
+ UNITYSHELL_OPTION_SHOW_LAUNCHER));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(dash, "", " + V",
+ _("Opens the Dash Video Lens."),
+ shortcut::OptionType::COMPIZ_KEY,
+ UNITYSHELL_PLUGIN_NAME,
+ UNITYSHELL_OPTION_SHOW_LAUNCHER));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(dash, "", "",
+ _("Switches between Lenses."),
+ shortcut::OptionType::HARDCODED,
+ _("Ctrl + Tab")));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(dash, "", "",
+ _("Moves the focus."),
+ shortcut::OptionType::HARDCODED,
+ _("Arrow Keys")));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(dash, "", "",
+ _("Opens the currently focused item."),
+ shortcut::OptionType::HARDCODED,
+ _("Enter")));
+
+ // Menu Bar
+ static const std::string menubar(_("HUD & Menu Bar"));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(menubar, "", _(" (Tap)"),
+ _("Opens the HUD."),
+ shortcut::OptionType::COMPIZ_KEY,
+ UNITYSHELL_PLUGIN_NAME,
+ UNITYSHELL_OPTION_SHOW_HUD));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(menubar, "", _(" (Hold)"),
+ _("Reveals the application menu."),
+ shortcut::OptionType::HARDCODED,
+ "Alt"));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(menubar, "", "",
+ _("Opens the indicator menu."),
+ shortcut::OptionType::COMPIZ_KEY,
+ UNITYSHELL_PLUGIN_NAME,
+ UNITYSHELL_OPTION_PANEL_FIRST_MENU));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(menubar, "", "",
+ _("Moves focus between indicators."),
+ shortcut::OptionType::HARDCODED,
+ _("Cursor Left or Right")));
+
+ // Switching
+ static const std::string switching(_("Switching"));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(switching, "", "",
+ _("Switches between applications."),
+ shortcut::OptionType::COMPIZ_KEY,
+ UNITYSHELL_PLUGIN_NAME,
+ UNITYSHELL_OPTION_ALT_TAB_FORWARD));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(switching, "", "",
+ _("Switches windows of current applications."),
+ shortcut::OptionType::COMPIZ_KEY,
+ UNITYSHELL_PLUGIN_NAME,
+ UNITYSHELL_OPTION_ALT_TAB_NEXT_WINDOW));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(switching, "", "",
+ _("Moves the focus."),
+ shortcut::OptionType::HARDCODED,
+ _("Cursor Left or Right")));
+
+ // Workspaces
+ static const std::string workspaces(_("Workspaces"));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(workspaces, "", "",
+ _("Switches between workspaces."),
+ shortcut::OptionType::COMPIZ_KEY,
+ EXPO_PLUGIN_NAME,
+ EXPO_OPTION_EXPO_KEY));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(workspaces, "", _(" + Arrow Keys"),
+ _("Switches workspaces."),
+ shortcut::OptionType::COMPIZ_KEY,
+ WALL_PLUGIN_NAME,
+ WALL_OPTION_LEFT_KEY));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(workspaces, "", _(" + Arrow Keys"),
+ _("Moves focused window to another workspace."),
+ shortcut::OptionType::COMPIZ_KEY,
+ WALL_PLUGIN_NAME,
+ WALL_OPTION_LEFT_WINDOW_KEY));
+
+
+ // Windows
+ static const std::string windows(_("Windows"));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(windows, "", "",
+ _("Spreads all windows in the current workspace."),
+ shortcut::OptionType::COMPIZ_KEY,
+ SCALE_PLUGIN_NAME,
+ SCALE_OPTION_INITIATE_ALL_KEY));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(windows, "", "",
+ _("Minimises all windows."),
+ shortcut::OptionType::COMPIZ_KEY,
+ CORE_PLUGIN_NAME,
+ CORE_OPTION_SHOW_DESKTOP_KEY));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(windows, "", "",
+ _("Maximises the current window."),
+ shortcut::OptionType::COMPIZ_KEY,
+ CORE_PLUGIN_NAME,
+ CORE_OPTION_MAXIMIZE_WINDOW_KEY));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(windows, "", "",
+ _("Restores or minimises the current window."),
+ shortcut::OptionType::COMPIZ_KEY,
+ CORE_PLUGIN_NAME,
+ CORE_OPTION_UNMAXIMIZE_WINDOW_KEY));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(windows, "", _(" or Right"),
+ _("Semi-maximise the current window."),
+ shortcut::OptionType::COMPIZ_KEY,
+ GRID_PLUGIN_NAME,
+ GRID_OPTION_PUT_LEFT_KEY));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(windows, "", "",
+ _("Closes the current window."),
+ shortcut::OptionType::COMPIZ_KEY,
+ CORE_PLUGIN_NAME,
+ CORE_OPTION_CLOSE_WINDOW_KEY));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(windows, "", "",
+ _("Opens the window accessibility menu."),
+ shortcut::OptionType::COMPIZ_KEY,
+ CORE_PLUGIN_NAME,
+ CORE_OPTION_WINDOW_MENU_KEY));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(windows, "", "",
+ _("Places the window in corresponding position."),
+ shortcut::OptionType::HARDCODED,
+ _("Ctrl + Alt + Num")));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(windows, "", _(" Drag"),
+ _("Moves the window."),
+ shortcut::OptionType::COMPIZ_MOUSE,
+ MOVE_PLUGIN_NAME,
+ MOVE_OPTION_INITIATE_BUTTON));
+
+ hints.push_back(std::make_shared<shortcut::Hint>(windows, "", _(" Drag"),
+ _("Resizes the window."),
+ shortcut::OptionType::COMPIZ_MOUSE,
+ RESIZE_PLUGIN_NAME,
+ RESIZE_OPTION_INITIATE_BUTTON));
+
+ model_ = std::make_shared<shortcut::Model>(hints);
+}
+
+}
+}
diff --git a/shortcuts/CompizShortcutModeller.h b/shortcuts/CompizShortcutModeller.h
new file mode 100644
index 000000000..61e1ca3ea
--- /dev/null
+++ b/shortcuts/CompizShortcutModeller.h
@@ -0,0 +1,45 @@
+/*
+ * Copyright 2013 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 3, as published
+ * by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranties of
+ * MERCHANTABILITY, SATISFACTORY QUALITY or FITNESS FOR A PARTICULAR
+ * PURPOSE. See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * version 3 along with this program. If not, see
+ * <http://www.gnu.org/licenses/>
+ *
+ * Authored by: Marco Trevisan <marco.trevisan@canonical.com>
+ */
+
+#ifndef UNITYSHELL_COMPIZ_SHORTCUT_MODELLER_H
+#define UNITYSHELL_COMPIZ_SHORTCUT_MODELLER_H
+
+#include "AbstractShortcutModeller.h"
+
+namespace unity
+{
+namespace shortcut
+{
+
+class CompizModeller : public AbstractModeller
+{
+public:
+ CompizModeller();
+ Model::Ptr GetCurrentModel() const {return model_;}
+
+ sigc::signal<void, Model::Ptr const&> model_changed;
+
+private:
+ Model::Ptr model_;
+};
+
+}
+}
+
+#endif