widget/NativeMenu.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef mozilla_widget_NativeMenu_h
   7 #define mozilla_widget_NativeMenu_h
   8
   9 #include "nsISupportsImpl.h"
  10 #include "Units.h"
  11
  12 namespace mozilla {
  13 using Modifiers = uint16_t;
  14 class ErrorResult;
  15 }  // namespace mozilla
  16
  17 namespace mozilla::dom {
  18 class Element;
  19 }
  20
  21 namespace mozilla::widget {
  22
  23 class NativeMenu {
  24  public:
  25   NS_INLINE_DECL_REFCOUNTING(NativeMenu)
  26
  27   // Show this menu as a context menu at the specified position.
  28   // This call assumes that the popupshowing event for the root popup has
  29   // already been sent and "approved", i.e. preventDefault() was not called.
  30   virtual void ShowAsContextMenu(const mozilla::DesktopPoint& aPosition) = 0;
  31
  32   // Close the menu and synchronously fire popuphiding / popuphidden events.
  33   // Returns false if the menu wasn't open.
  34   virtual bool Close() = 0;
  35
  36   // Activate aItemElement and close this menu.
  37   // aItemElement can be nested arbitrarily deeply within submenus inside this
  38   // menu. Only works while this menu (and any submenus on the path to the
  39   // item) is open, otherwise aRv reports an error.
  40   virtual void ActivateItem(dom::Element* aItemElement, Modifiers aModifiers,
  41                             int16_t aButton, ErrorResult& aRv) = 0;
  42
  43   // Open, or simulate the opening of, a submenu.
  44   // aMenuElement can be nested arbitrarily deeply within submenus inside this
  45   // menu. Only works while this menu (and any submenus on the path to the
  46   // submenu) is open.
  47   virtual void OpenSubmenu(dom::Element* aMenuElement) = 0;
  48
  49   // Closing, or simulate the closing of, a submenu.
  50   // aMenuElement can be nested arbitrarily deeply within submenus inside this
  51   // menu. Only works while this menu (and any submenus on the path to the
  52   // submenu) is open.
  53   virtual void CloseSubmenu(dom::Element* aMenuElement) = 0;
  54
  55   // Return this NativeMenu's DOM element.
  56   virtual RefPtr<dom::Element> Element() = 0;
  57
  58   class Observer {
  59    public:
  60     // Called when the menu opened, after popupshown.
  61     // No strong reference is held to the observer during the call.
  62     virtual void OnNativeMenuOpened() = 0;
  63
  64     // Called when the menu closed, after popuphidden.
  65     // No strong reference is held to the observer during the call.
  66     virtual void OnNativeMenuClosed() = 0;
  67
  68     // Called before the popupshowing event of a submenu fires.
  69     virtual void OnNativeSubMenuWillOpen(dom::Element* aPopupElement) = 0;
  70
  71     // Called after the popupshown event of a submenu fired.
  72     virtual void OnNativeSubMenuDidOpen(dom::Element* aPopupElement) = 0;
  73
  74     // Called after the popuphidden event of a submenu fired.
  75     virtual void OnNativeSubMenuClosed(dom::Element* aPopupElement) = 0;
  76
  77     // Called before the command event of an activated menu item fires.
  78     virtual void OnNativeMenuWillActivateItem(
  79         dom::Element* aMenuItemElement) = 0;
  80   };
  81
  82   // Add an observer that gets notified of menu opening and closing.
  83   // The menu does not keep a strong reference the observer. The observer must
  84   // remove itself before it is destroyed.
  85   virtual void AddObserver(Observer* aObserver) = 0;
  86
  87   // Remove an observer that was previously added with AddObserver.
  88   virtual void RemoveObserver(Observer* aObserver) = 0;
  89
  90  protected:
  91   virtual ~NativeMenu() = default;
  92 };
  93
  94 }  // namespace mozilla::widget
  95
  96 #endif  // mozilla_widget_NativeMenu_h