| OLD | NEW |
| 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
| 4 | 4 |
| 5 #ifndef ASH_LAUNCHER_LAUNCHER_DELEGATE_H_ | 5 #ifndef ASH_LAUNCHER_LAUNCHER_DELEGATE_H_ |
| 6 #define ASH_LAUNCHER_LAUNCHER_DELEGATE_H_ | 6 #define ASH_LAUNCHER_LAUNCHER_DELEGATE_H_ |
| 7 | 7 |
| 8 #include "ash/ash_export.h" | 8 #include "ash/ash_export.h" |
| 9 #include "ash/launcher/launcher_types.h" | 9 #include "ash/launcher/launcher_types.h" |
| 10 #include "base/strings/string16.h" | |
| 11 #include "ui/base/models/simple_menu_model.h" | |
| 12 | |
| 13 namespace aura { | |
| 14 class RootWindow; | |
| 15 } | |
| 16 | |
| 17 namespace ui { | |
| 18 class Event; | |
| 19 } | |
| 20 | 10 |
| 21 namespace ash { | 11 namespace ash { |
| 22 class Launcher; | 12 class Launcher; |
| 23 | 13 |
| 24 // A special menu model which keeps track of an "active" menu item. | |
| 25 class ASH_EXPORT LauncherMenuModel : public ui::SimpleMenuModel { | |
| 26 public: | |
| 27 explicit LauncherMenuModel(ui::SimpleMenuModel::Delegate* delegate) | |
| 28 : ui::SimpleMenuModel(delegate) {} | |
| 29 | |
| 30 // Returns |true| when the given |command_id| is active and needs to be drawn | |
| 31 // in a special state. | |
| 32 virtual bool IsCommandActive(int command_id) const = 0; | |
| 33 | |
| 34 private: | |
| 35 DISALLOW_COPY_AND_ASSIGN(LauncherMenuModel); | |
| 36 }; | |
| 37 | |
| 38 // Delegate for the Launcher. | 14 // Delegate for the Launcher. |
| 39 class ASH_EXPORT LauncherDelegate { | 15 class ASH_EXPORT LauncherDelegate { |
| 40 public: | 16 public: |
| 41 // Launcher owns the delegate. | 17 // Launcher owns the delegate. |
| 42 virtual ~LauncherDelegate() {} | 18 virtual ~LauncherDelegate() {} |
| 43 | 19 |
| 44 // Invoked when the user clicks on a window entry in the launcher. | |
| 45 // |event| is the click event. The |event| is dispatched by a view | |
| 46 // and has an instance of |views::View| as the event target | |
| 47 // but not |aura::Window|. If the |event| is of type KeyEvent, it is assumed | |
| 48 // that this was triggered by keyboard action (Alt+<number>) and special | |
| 49 // handling might happen. | |
| 50 virtual void ItemSelected(const LauncherItem& item, | |
| 51 const ui::Event& event) = 0; | |
| 52 | |
| 53 // Returns the title to display for the specified launcher item. | |
| 54 virtual base::string16 GetTitle(const LauncherItem& item) = 0; | |
| 55 | |
| 56 // Returns the context menumodel for the specified item on | |
| 57 // |root_window|. Return NULL if there should be no context | |
| 58 // menu. The caller takes ownership of the returned model. | |
| 59 virtual ui::MenuModel* CreateContextMenu(const LauncherItem& item, | |
| 60 aura::RootWindow* root_window) = 0; | |
| 61 | |
| 62 // Returns the application menu model for the specified item. There are three | |
| 63 // possible return values: | |
| 64 // - A return of NULL indicates that no menu is wanted for this item. | |
| 65 // - A return of a menu with one item means that only the name of the | |
| 66 // application/item was added and there are no active applications. | |
| 67 // Note: This is useful for hover menus which also show context help. | |
| 68 // - A list containing the title and the active list of items. | |
| 69 // The caller takes ownership of the returned model. | |
| 70 // |event_flags| specifies the flags of the event which triggered this menu. | |
| 71 virtual LauncherMenuModel* CreateApplicationMenu( | |
| 72 const LauncherItem& item, | |
| 73 int event_flags) = 0; | |
| 74 | |
| 75 // Returns the id of the item associated with the specified window, or 0 if | 20 // Returns the id of the item associated with the specified window, or 0 if |
| 76 // there isn't one. | 21 // there isn't one. |
| 77 // Note: Windows of tabbed browsers will return the |LauncherID| of the | 22 // Note: Windows of tabbed browsers will return the |LauncherID| of the |
| 78 // currently active tab or selected tab. | 23 // currently active tab or selected tab. |
| 79 virtual LauncherID GetIDByWindow(aura::Window* window) = 0; | 24 virtual LauncherID GetIDByWindow(aura::Window* window) = 0; |
| 80 | 25 |
| 81 // Whether the given launcher item is draggable. | |
| 82 virtual bool IsDraggable(const LauncherItem& item) = 0; | |
| 83 | |
| 84 // Returns true if a tooltip should be shown for the item. | |
| 85 virtual bool ShouldShowTooltip(const LauncherItem& item) = 0; | |
| 86 | |
| 87 // Callback used to allow delegate to perform initialization actions that | 26 // Callback used to allow delegate to perform initialization actions that |
| 88 // depend on the Launcher being in a known state. | 27 // depend on the Launcher being in a known state. |
| 89 virtual void OnLauncherCreated(Launcher* launcher) = 0; | 28 virtual void OnLauncherCreated(Launcher* launcher) = 0; |
| 90 | 29 |
| 91 // Callback used to inform the delegate that a specific launcher no longer | 30 // Callback used to inform the delegate that a specific launcher no longer |
| 92 // exists. | 31 // exists. |
| 93 virtual void OnLauncherDestroyed(Launcher* launcher) = 0; | 32 virtual void OnLauncherDestroyed(Launcher* launcher) = 0; |
| 94 | 33 |
| 95 // Get the launcher ID from an application ID. | 34 // Get the launcher ID from an application ID. |
| 96 virtual LauncherID GetLauncherIDForAppID(const std::string& app_id) = 0; | 35 virtual LauncherID GetLauncherIDForAppID(const std::string& app_id) = 0; |
| 97 | 36 |
| 98 // Get the application ID for a given launcher ID. | 37 // Get the application ID for a given launcher ID. |
| 99 virtual const std::string& GetAppIDForLauncherID(LauncherID id) = 0; | 38 virtual const std::string& GetAppIDForLauncherID(LauncherID id) = 0; |
| 100 | 39 |
| 101 // Pins an app with |app_id| to launcher. A running instance will get pinned. | 40 // Pins an app with |app_id| to launcher. A running instance will get pinned. |
| 102 // In case there is no running instance a new launcher item is created and | 41 // In case there is no running instance a new launcher item is created and |
| 103 // pinned. | 42 // pinned. |
| 104 virtual void PinAppWithID(const std::string& app_id) = 0; | 43 virtual void PinAppWithID(const std::string& app_id) = 0; |
| 105 | 44 |
| 106 // Check if the app with |app_id_| is pinned to the launcher. | 45 // Check if the app with |app_id_| is pinned to the launcher. |
| 107 virtual bool IsAppPinned(const std::string& app_id) = 0; | 46 virtual bool IsAppPinned(const std::string& app_id) = 0; |
| 108 | 47 |
| 109 // Unpins app item with |app_id|. | 48 // Unpins app item with |app_id|. |
| 110 virtual void UnpinAppWithID(const std::string& app_id) = 0; | 49 virtual void UnpinAppWithID(const std::string& app_id) = 0; |
| 111 }; | 50 }; |
| 112 | 51 |
| 113 } // namespace ash | 52 } // namespace ash |
| 114 | 53 |
| 115 #endif // ASH_LAUNCHER_LAUNCHER_DELEGATE_H_ | 54 #endif // ASH_LAUNCHER_LAUNCHER_DELEGATE_H_ |
| OLD | NEW |