1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2026-01-20 13:41:00 +00:00
serenity/Servers/WindowServer/WSMenu.h
Shannon Booth 4683424e7a WSMenu: Support menu navigation through key presses
Add event handling for key presses for navigating a menu. The currently
hovered menu item is tracked through an index which is either
incremented or decremented on up or down arrow key presses, changing the
hovered item.

Whenever there is a mouse move event, we ensure that the current index
matches the currently hovered item so that the mouse and keyboard do not
get out of sync.

If the right key is pressed, and we are on a submenu menu item, we
'enter' that submenu. While we are currently in a submenu, we forward
all keypress events to that submenu for handling. This allows us to
traverse the heirachy of a menu. While in a submenu, if the left key is
pressed, we leave that submenu and start handling the keypresses
ourselves again.

There is currently a small issue where the mouse hover and key hover can
get out of sync. The mouse can be traversing a submenu, but the parent
menu has no idea that the mouse has 'entered' a submenu, so will handle
the key presses itself, instead of forwarding them to the submenu. One
potential fix for this is for a menu to tell its menu parent that the
submenu is being traversed.
2020-01-08 11:36:49 +01:00

115 lines
3.5 KiB
C++

#pragma once
#include <AK/String.h>
#include <AK/NonnullOwnPtrVector.h>
#include <AK/WeakPtr.h>
#include <LibCore/CObject.h>
#include <LibDraw/Rect.h>
#include <WindowServer/WSCursor.h>
#include <WindowServer/WSMenuItem.h>
#include <WindowServer/WSWindow.h>
class WSClientConnection;
class WSMenuBar;
class WSEvent;
class Font;
class WSMenu final : public CObject {
C_OBJECT(WSMenu)
public:
WSMenu(WSClientConnection*, int menu_id, const String& name);
virtual ~WSMenu() override;
WSClientConnection* client() { return m_client; }
const WSClientConnection* client() const { return m_client; }
int menu_id() const { return m_menu_id; }
WSMenuBar* menubar() { return m_menubar; }
const WSMenuBar* menubar() const { return m_menubar; }
void set_menubar(WSMenuBar* menubar) { m_menubar = menubar; }
bool is_empty() const { return m_items.is_empty(); }
int item_count() const { return m_items.size(); }
const WSMenuItem& item(int index) const { return m_items.at(index); }
WSMenuItem& item(int index) { return m_items.at(index); }
void add_item(NonnullOwnPtr<WSMenuItem>&& item) { m_items.append(move(item)); }
String name() const { return m_name; }
template<typename Callback>
void for_each_item(Callback callback) const
{
for (auto& item : m_items)
callback(item);
}
Rect text_rect_in_menubar() const { return m_text_rect_in_menubar; }
void set_text_rect_in_menubar(const Rect& rect) { m_text_rect_in_menubar = rect; }
Rect rect_in_menubar() const { return m_rect_in_menubar; }
void set_rect_in_menubar(const Rect& rect) { m_rect_in_menubar = rect; }
WSWindow* menu_window() { return m_menu_window.ptr(); }
WSWindow& ensure_menu_window();
WSWindow* window_menu_of() { return m_window_menu_of; }
void set_window_menu_of(WSWindow& window) { m_window_menu_of = window.make_weak_ptr(); }
bool is_window_menu_open() { return m_is_window_menu_open; }
void set_window_menu_open(bool is_open) { m_is_window_menu_open = is_open; }
int width() const;
int height() const;
int item_height() const { return 20; }
int frame_thickness() const { return 3; }
int horizontal_padding() const { return left_padding() + right_padding(); }
int left_padding() const { return 14; }
int right_padding() const { return 14; }
void draw();
const Font& font() const;
WSMenuItem* item_with_identifier(unsigned);
WSMenuItem* item_at(const Point&);
void redraw();
const WSMenuItem* hovered_item() const { return m_hovered_item; }
void clear_hovered_item();
Function<void(WSMenuItem&)> on_item_activation;
void close();
void popup(const Point&, bool is_submenu = false);
bool is_menu_ancestor_of(const WSMenu&) const;
void redraw_if_theme_changed();
private:
virtual void event(CEvent&) override;
int padding_between_text_and_shortcut() const { return 50; }
void did_activate(WSMenuItem&);
void open_hovered_item();
void redraw_for_new_hovered_item();
void decend_into_submenu_at_hovered_item();
WSClientConnection* m_client { nullptr };
int m_menu_id { 0 };
String m_name;
Rect m_rect_in_menubar;
Rect m_text_rect_in_menubar;
WSMenuBar* m_menubar { nullptr };
WSMenuItem* m_hovered_item { nullptr };
NonnullOwnPtrVector<WSMenuItem> m_items;
RefPtr<WSWindow> m_menu_window;
WeakPtr<WSWindow> m_window_menu_of;
bool m_is_window_menu_open = { false };
int m_theme_index_at_last_paint { -1 };
int m_current_index { 0 };
bool m_in_submenu { false };
};