Action.cpp 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344
  1. /*
  2. * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
  3. * All rights reserved.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions are met:
  7. *
  8. * 1. Redistributions of source code must retain the above copyright notice, this
  9. * list of conditions and the following disclaimer.
  10. *
  11. * 2. Redistributions in binary form must reproduce the above copyright notice,
  12. * this list of conditions and the following disclaimer in the documentation
  13. * and/or other materials provided with the distribution.
  14. *
  15. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  16. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  18. * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  19. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  21. * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  22. * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  23. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25. */
  26. #include <AK/WeakPtr.h>
  27. #include <LibGUI/AboutDialog.h>
  28. #include <LibGUI/Action.h>
  29. #include <LibGUI/ActionGroup.h>
  30. #include <LibGUI/Application.h>
  31. #include <LibGUI/Button.h>
  32. #include <LibGUI/Icon.h>
  33. #include <LibGUI/MenuItem.h>
  34. #include <LibGUI/Window.h>
  35. namespace GUI {
  36. namespace CommonActions {
  37. NonnullRefPtr<Action> make_about_action(const String& app_name, const Icon& app_icon, Window* parent)
  38. {
  39. auto weak_parent = AK::try_make_weak_ptr<Window>(parent);
  40. return Action::create(String::formatted("&About {}", app_name), app_icon.bitmap_for_size(16), [=](auto&) {
  41. AboutDialog::show(app_name, app_icon.bitmap_for_size(32), weak_parent.ptr());
  42. });
  43. }
  44. NonnullRefPtr<Action> make_open_action(Function<void(Action&)> callback, Core::Object* parent)
  45. {
  46. auto action = Action::create("&Open...", { Mod_Ctrl, Key_O }, Gfx::Bitmap::load_from_file("/res/icons/16x16/open.png"), move(callback), parent);
  47. action->set_status_tip("Open an existing file");
  48. return action;
  49. }
  50. NonnullRefPtr<Action> make_save_action(Function<void(Action&)> callback, Core::Object* parent)
  51. {
  52. auto action = Action::create("&Save", { Mod_Ctrl, Key_S }, Gfx::Bitmap::load_from_file("/res/icons/16x16/save.png"), move(callback), parent);
  53. action->set_status_tip("Save the current file");
  54. return action;
  55. }
  56. NonnullRefPtr<Action> make_save_as_action(Function<void(Action&)> callback, Core::Object* parent)
  57. {
  58. auto action = Action::create("Save &As...", { Mod_Ctrl | Mod_Shift, Key_S }, Gfx::Bitmap::load_from_file("/res/icons/16x16/save.png"), move(callback), parent);
  59. action->set_status_tip("Save the current file with a new name");
  60. return action;
  61. }
  62. NonnullRefPtr<Action> make_move_to_front_action(Function<void(Action&)> callback, Core::Object* parent)
  63. {
  64. return Action::create("Move to &Front", { Mod_Ctrl | Mod_Shift, Key_Up }, Gfx::Bitmap::load_from_file("/res/icons/16x16/move-to-front.png"), move(callback), parent);
  65. }
  66. NonnullRefPtr<Action> make_move_to_back_action(Function<void(Action&)> callback, Core::Object* parent)
  67. {
  68. return Action::create("Move to &Back", { Mod_Ctrl | Mod_Shift, Key_Down }, Gfx::Bitmap::load_from_file("/res/icons/16x16/move-to-back.png"), move(callback), parent);
  69. }
  70. NonnullRefPtr<Action> make_undo_action(Function<void(Action&)> callback, Core::Object* parent)
  71. {
  72. return Action::create("&Undo", { Mod_Ctrl, Key_Z }, Gfx::Bitmap::load_from_file("/res/icons/16x16/undo.png"), move(callback), parent);
  73. }
  74. NonnullRefPtr<Action> make_redo_action(Function<void(Action&)> callback, Core::Object* parent)
  75. {
  76. return Action::create("&Redo", { Mod_Ctrl, Key_Y }, Gfx::Bitmap::load_from_file("/res/icons/16x16/redo.png"), move(callback), parent);
  77. }
  78. NonnullRefPtr<Action> make_delete_action(Function<void(Action&)> callback, Core::Object* parent)
  79. {
  80. return Action::create("&Delete", { Mod_None, Key_Delete }, Gfx::Bitmap::load_from_file("/res/icons/16x16/delete.png"), move(callback), parent);
  81. }
  82. NonnullRefPtr<Action> make_cut_action(Function<void(Action&)> callback, Core::Object* parent)
  83. {
  84. return Action::create("Cu&t", { Mod_Ctrl, Key_X }, Gfx::Bitmap::load_from_file("/res/icons/16x16/edit-cut.png"), move(callback), parent);
  85. }
  86. NonnullRefPtr<Action> make_copy_action(Function<void(Action&)> callback, Core::Object* parent)
  87. {
  88. return Action::create("&Copy", { Mod_Ctrl, Key_C }, Gfx::Bitmap::load_from_file("/res/icons/16x16/edit-copy.png"), move(callback), parent);
  89. }
  90. NonnullRefPtr<Action> make_paste_action(Function<void(Action&)> callback, Core::Object* parent)
  91. {
  92. return Action::create("&Paste", { Mod_Ctrl, Key_V }, Gfx::Bitmap::load_from_file("/res/icons/16x16/paste.png"), move(callback), parent);
  93. }
  94. NonnullRefPtr<Action> make_fullscreen_action(Function<void(Action&)> callback, Core::Object* parent)
  95. {
  96. return Action::create("&Fullscreen", { Mod_None, Key_F11 }, move(callback), parent);
  97. }
  98. NonnullRefPtr<Action> make_quit_action(Function<void(Action&)> callback)
  99. {
  100. return Action::create("&Quit", { Mod_Alt, Key_F4 }, move(callback));
  101. }
  102. NonnullRefPtr<Action> make_help_action(Function<void(Action&)> callback, Core::Object* parent)
  103. {
  104. return Action::create("&Contents", { Mod_None, Key_F1 }, Gfx::Bitmap::load_from_file("/res/icons/16x16/app-help.png"), move(callback), parent);
  105. }
  106. NonnullRefPtr<Action> make_go_back_action(Function<void(Action&)> callback, Core::Object* parent)
  107. {
  108. return Action::create("Go &Back", { Mod_Alt, Key_Left }, Gfx::Bitmap::load_from_file("/res/icons/16x16/go-back.png"), move(callback), parent);
  109. }
  110. NonnullRefPtr<Action> make_go_forward_action(Function<void(Action&)> callback, Core::Object* parent)
  111. {
  112. return Action::create("Go &Forward", { Mod_Alt, Key_Right }, Gfx::Bitmap::load_from_file("/res/icons/16x16/go-forward.png"), move(callback), parent);
  113. }
  114. NonnullRefPtr<Action> make_go_home_action(Function<void(Action&)> callback, Core::Object* parent)
  115. {
  116. return Action::create("Go &Home", { Mod_Alt, Key_Home }, Gfx::Bitmap::load_from_file("/res/icons/16x16/go-home.png"), move(callback), parent);
  117. }
  118. NonnullRefPtr<Action> make_reload_action(Function<void(Action&)> callback, Core::Object* parent)
  119. {
  120. return Action::create("&Reload", { Mod_Ctrl, Key_R }, Gfx::Bitmap::load_from_file("/res/icons/16x16/reload.png"), move(callback), parent);
  121. }
  122. NonnullRefPtr<Action> make_select_all_action(Function<void(Action&)> callback, Core::Object* parent)
  123. {
  124. return Action::create("Select &All", { Mod_Ctrl, Key_A }, Gfx::Bitmap::load_from_file("/res/icons/16x16/select-all.png"), move(callback), parent);
  125. }
  126. NonnullRefPtr<Action> make_properties_action(Function<void(Action&)> callback, Core::Object* parent)
  127. {
  128. return Action::create("&Properties", { Mod_Alt, Key_Return }, Gfx::Bitmap::load_from_file("/res/icons/16x16/properties.png"), move(callback), parent);
  129. }
  130. }
  131. NonnullRefPtr<Action> Action::create(String text, Function<void(Action&)> callback, Core::Object* parent)
  132. {
  133. return adopt(*new Action(move(text), move(callback), parent));
  134. }
  135. NonnullRefPtr<Action> Action::create(String text, RefPtr<Gfx::Bitmap> icon, Function<void(Action&)> callback, Core::Object* parent)
  136. {
  137. return adopt(*new Action(move(text), move(icon), move(callback), parent));
  138. }
  139. NonnullRefPtr<Action> Action::create(String text, const Shortcut& shortcut, Function<void(Action&)> callback, Core::Object* parent)
  140. {
  141. return adopt(*new Action(move(text), shortcut, move(callback), parent));
  142. }
  143. NonnullRefPtr<Action> Action::create(String text, const Shortcut& shortcut, RefPtr<Gfx::Bitmap> icon, Function<void(Action&)> callback, Core::Object* parent)
  144. {
  145. return adopt(*new Action(move(text), shortcut, move(icon), move(callback), parent));
  146. }
  147. NonnullRefPtr<Action> Action::create_checkable(String text, Function<void(Action&)> callback, Core::Object* parent)
  148. {
  149. return adopt(*new Action(move(text), move(callback), parent, true));
  150. }
  151. NonnullRefPtr<Action> Action::create_checkable(String text, RefPtr<Gfx::Bitmap> icon, Function<void(Action&)> callback, Core::Object* parent)
  152. {
  153. return adopt(*new Action(move(text), move(icon), move(callback), parent, true));
  154. }
  155. NonnullRefPtr<Action> Action::create_checkable(String text, const Shortcut& shortcut, Function<void(Action&)> callback, Core::Object* parent)
  156. {
  157. return adopt(*new Action(move(text), shortcut, move(callback), parent, true));
  158. }
  159. NonnullRefPtr<Action> Action::create_checkable(String text, const Shortcut& shortcut, RefPtr<Gfx::Bitmap> icon, Function<void(Action&)> callback, Core::Object* parent)
  160. {
  161. return adopt(*new Action(move(text), shortcut, move(icon), move(callback), parent, true));
  162. }
  163. Action::Action(String text, Function<void(Action&)> on_activation_callback, Core::Object* parent, bool checkable)
  164. : Action(move(text), Shortcut {}, nullptr, move(on_activation_callback), parent, checkable)
  165. {
  166. }
  167. Action::Action(String text, RefPtr<Gfx::Bitmap> icon, Function<void(Action&)> on_activation_callback, Core::Object* parent, bool checkable)
  168. : Action(move(text), Shortcut {}, move(icon), move(on_activation_callback), parent, checkable)
  169. {
  170. }
  171. Action::Action(String text, const Shortcut& shortcut, Function<void(Action&)> on_activation_callback, Core::Object* parent, bool checkable)
  172. : Action(move(text), shortcut, nullptr, move(on_activation_callback), parent, checkable)
  173. {
  174. }
  175. Action::Action(String text, const Shortcut& shortcut, RefPtr<Gfx::Bitmap> icon, Function<void(Action&)> on_activation_callback, Core::Object* parent, bool checkable)
  176. : Core::Object(parent)
  177. , on_activation(move(on_activation_callback))
  178. , m_text(move(text))
  179. , m_icon(move(icon))
  180. , m_shortcut(shortcut)
  181. , m_checkable(checkable)
  182. {
  183. if (parent && is<Widget>(*parent)) {
  184. m_scope = ShortcutScope::WidgetLocal;
  185. } else if (parent && is<Window>(*parent)) {
  186. m_scope = ShortcutScope::WindowLocal;
  187. } else {
  188. m_scope = ShortcutScope::ApplicationGlobal;
  189. if (auto* app = Application::the()) {
  190. app->register_global_shortcut_action({}, *this);
  191. }
  192. }
  193. }
  194. Action::~Action()
  195. {
  196. if (m_shortcut.is_valid() && m_scope == ShortcutScope::ApplicationGlobal) {
  197. if (auto* app = Application::the())
  198. app->unregister_global_shortcut_action({}, *this);
  199. }
  200. }
  201. void Action::activate(Core::Object* activator)
  202. {
  203. if (!on_activation)
  204. return;
  205. if (activator)
  206. m_activator = activator->make_weak_ptr();
  207. if (is_checkable()) {
  208. if (m_action_group) {
  209. if (m_action_group->is_unchecking_allowed())
  210. set_checked(!is_checked());
  211. else
  212. set_checked(true);
  213. } else {
  214. set_checked(!is_checked());
  215. }
  216. }
  217. on_activation(*this);
  218. m_activator = nullptr;
  219. }
  220. void Action::register_button(Badge<Button>, Button& button)
  221. {
  222. m_buttons.set(&button);
  223. }
  224. void Action::unregister_button(Badge<Button>, Button& button)
  225. {
  226. m_buttons.remove(&button);
  227. }
  228. void Action::register_menu_item(Badge<MenuItem>, MenuItem& menu_item)
  229. {
  230. m_menu_items.set(&menu_item);
  231. }
  232. void Action::unregister_menu_item(Badge<MenuItem>, MenuItem& menu_item)
  233. {
  234. m_menu_items.remove(&menu_item);
  235. }
  236. template<typename Callback>
  237. void Action::for_each_toolbar_button(Callback callback)
  238. {
  239. for (auto& it : m_buttons)
  240. callback(*it);
  241. }
  242. template<typename Callback>
  243. void Action::for_each_menu_item(Callback callback)
  244. {
  245. for (auto& it : m_menu_items)
  246. callback(*it);
  247. }
  248. void Action::set_enabled(bool enabled)
  249. {
  250. if (m_enabled == enabled)
  251. return;
  252. m_enabled = enabled;
  253. for_each_toolbar_button([enabled](auto& button) {
  254. button.set_enabled(enabled);
  255. });
  256. for_each_menu_item([enabled](auto& item) {
  257. item.set_enabled(enabled);
  258. });
  259. }
  260. void Action::set_checked(bool checked)
  261. {
  262. if (m_checked == checked)
  263. return;
  264. m_checked = checked;
  265. if (m_checked && m_action_group) {
  266. m_action_group->for_each_action([this](auto& other_action) {
  267. if (this == &other_action)
  268. return IterationDecision::Continue;
  269. if (other_action.is_checkable())
  270. other_action.set_checked(false);
  271. return IterationDecision::Continue;
  272. });
  273. }
  274. for_each_toolbar_button([checked](auto& button) {
  275. button.set_checked(checked);
  276. });
  277. for_each_menu_item([checked](MenuItem& item) {
  278. item.set_checked(checked);
  279. });
  280. }
  281. void Action::set_group(Badge<ActionGroup>, ActionGroup* group)
  282. {
  283. m_action_group = AK::try_make_weak_ptr(group);
  284. }
  285. void Action::set_icon(const Gfx::Bitmap* icon)
  286. {
  287. m_icon = icon;
  288. }
  289. }