src/ui/popup-menu.h

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /** @file
   3  * Helpers to connect signals to events that popup a menu in both GTK3 and GTK4.
   4  * Plus miscellaneous helpers primarily useful with widgets used as popop menus.
   5  */
   6 /*
   7  * Authors:
   8  *   Daniel Boles <dboles.src+inkscape@gmail.com>
   9  *
  10  * Copyright (C) 2023 Daniel Boles
  11  *
  12  * Released under GNU GPL v2+, read the file 'COPYING' for more information.
  13  */
  14
  15 #ifndef SEEN_UI_POPUP_MENU_H
  16 #define SEEN_UI_POPUP_MENU_H
  17
  18 #include <memory>
  19 #include <optional>
  20 #include <sigc++/connection.h>
  21 #include <sigc++/slot.h>
  22
  23 namespace Geom {
  24 class Point;
  25 } // namespace Geom
  26
  27 namespace Gdk {
  28 class Rectangle;
  29 } // namespace Gdk
  30
  31 namespace Gtk {
  32 class Popover;
  33 class Widget;
  34 } // namespace Gtk
  35
  36 namespace Inkscape::UI {
  37
  38 /// Information from a GestureClick if a popup menu was opened by click
  39 struct PopupMenuClick { int n_press{}; double x{}, y{}; };
  40 /// Optional: not present if popup wasnʼt triggered by click.
  41 using PopupMenuOptionalClick = std::optional<PopupMenuClick>;
  42
  43 /// Return whether a popup was activated.
  44 /// Click param is nullopt if popup wasnʼt triggered by a click.
  45 using PopupMenuSlot = sigc::slot<bool (PopupMenuOptionalClick)>;
  46
  47 /// Connect slot to a widgetʼs key and button events that traditionally trigger a popup menu, i.e.:
  48 /// * The keys used by GTK3ʼs signal Widget::popup-menu: the Menu key, or the Shift+F10 combination
  49 /// * The right mouse button or other platform convention, as per gtk_event_triggers_context_menu()
  50 void on_popup_menu(Gtk::Widget &widget, PopupMenuSlot slot);
  51
  52 /// Replace Gtk::Menu::popup_at_pointer. If x or y
  53 /// offsets != 0, :pointing-to is set to {x,y,1,1}
  54 /// else it is set to the full allocation of @a widget, translated into the coordinate space of the
  55 /// @a popoverʼs parent (:relative-to) widget. Hence, the @a widget must be the @a popoverʼs parent
  56 /// (:relative-to) widget or a descendant thereof.
  57 void popup_at(Gtk::Popover &popover, Gtk::Widget &widget,
  58               double x_offset = 0.0, double y_offset = 0.0);
  59 /// @copydoc popup_at()
  60 void popup_at(Gtk::Popover &popover, Gtk::Widget &widget,
  61               std::optional<Geom::Point> const &offset);
  62
  63 /// As popup_at() but point to center of widget
  64 void popup_at_center(Gtk::Popover &popover, Gtk::Widget &widget);
  65
  66 /// As popup_at() but point to center of @a rect
  67 /// @a rect must be valid within the coords of @widget, & @awidget must be a descendant of @parent.
  68 void popup_at(Gtk::Popover &popover, Gtk::Widget &widget, Gdk::Rectangle const &rect);
  69
  70 } // namespace Inkscape::UI
  71
  72 #endif // SEEN_UI_POPUP_MENU_H
  73
  74 /*
  75   Local Variables:
  76   mode:c++
  77   c-file-style:"stroustrup"
  78   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
  79   indent-tabs-mode:nil
  80   fill-column:99
  81   End:
  82 */
  83 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:fileencoding=utf-8:textwidth=99 :