widget/nsIRollupListener.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef __nsIRollupListener_h__
   8 #define __nsIRollupListener_h__
   9
  10 #include "nsTArray.h"
  11 #include "nsPoint.h"
  12
  13 class nsIContent;
  14 class nsIWidget;
  15
  16 class nsIRollupListener {
  17  public:
  18   /**
  19    * Notifies the object to rollup, optionally returning the node that
  20    * was just rolled up.
  21    *
  22    * If aFlush is true, then views should be flushed after the rollup.
  23    *
  24    * aPoint is the mouse pointer position where the event that triggered the
  25    * rollup occurred, which may be nullptr.
  26    *
  27    * aCount is the number of popups in a chain to close. If this is
  28    * UINT32_MAX, then all popups are closed.
  29    * If aLastRolledUp is non-null, it will be set to the last rolled up popup,
  30    * if this is supported. aLastRolledUp is not addrefed.
  31    *
  32    * Returns true if the event that the caller is processing should be consumed.
  33    */
  34   MOZ_CAN_RUN_SCRIPT_BOUNDARY
  35   virtual bool Rollup(uint32_t aCount, bool aFlush,
  36                       const mozilla::LayoutDeviceIntPoint* aPoint,
  37                       nsIContent** aLastRolledUp) = 0;
  38
  39   /**
  40    * Asks the RollupListener if it should rollup on mouse wheel events
  41    */
  42   virtual bool ShouldRollupOnMouseWheelEvent() = 0;
  43
  44   /**
  45    * Asks the RollupListener if it should consume mouse wheel events
  46    */
  47   virtual bool ShouldConsumeOnMouseWheelEvent() = 0;
  48
  49   /**
  50    * Asks the RollupListener if it should rollup on mouse activate, eg. X-Mouse
  51    */
  52   virtual bool ShouldRollupOnMouseActivate() = 0;
  53
  54   /*
  55    * Retrieve the widgets for open menus and store them in the array
  56    * aWidgetChain. The number of menus of the same type should be returned,
  57    * for example, if a context menu is open, return only the number of menus
  58    * that are part of the context menu chain. This allows closing up only
  59    * those menus in different situations. The returned value should be exactly
  60    * the same number of widgets added to aWidgetChain.
  61    */
  62   virtual uint32_t GetSubmenuWidgetChain(
  63       nsTArray<nsIWidget*>* aWidgetChain) = 0;
  64
  65   /**
  66    * Notify the RollupListener that the widget did a Move or Resize.
  67    */
  68   virtual void NotifyGeometryChange() = 0;
  69
  70   virtual nsIWidget* GetRollupWidget() = 0;
  71
  72   /**
  73    * If a native menu is currently shown, closes the menu.
  74    * Returns true if a native menu was open.
  75    */
  76   virtual bool RollupNativeMenu() { return false; }
  77 };
  78
  79 #endif /* __nsIRollupListener_h__ */