Serenity Operating System
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
27#pragma once
28
29#include <AK/NonnullOwnPtrVector.h>
30#include <LibCore/Object.h>
31#include <LibGUI/Forward.h>
32#include <LibGfx/Forward.h>
33
34namespace GUI {
35
36class Menu final : public Core::Object {
37 C_OBJECT(Menu)
38public:
39 explicit Menu(const StringView& name = "");
40 virtual ~Menu() override;
41
42 void realize_menu_if_needed()
43 {
44 if (menu_id() == -1)
45 realize_menu();
46 }
47
48 static Menu* from_menu_id(int);
49 int menu_id() const { return m_menu_id; }
50
51 const String& name() const { return m_name; }
52
53 Action* action_at(size_t);
54
55 void add_action(NonnullRefPtr<Action>);
56 void add_separator();
57 void add_submenu(NonnullRefPtr<Menu>);
58
59 void popup(const Gfx::Point& screen_position);
60 void dismiss();
61
62private:
63 friend class MenuBar;
64
65 int realize_menu();
66 void unrealize_menu();
67 void realize_if_needed();
68
69 int m_menu_id { -1 };
70 String m_name;
71 NonnullOwnPtrVector<MenuItem> m_items;
72};
73
74}