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
  12 class nsIContent;
  13 class nsIWidget;
  14
  15 class nsIRollupListener {
  16  public:
  17
  18   /**
  19    * Notifies the object to rollup, optionally returning the node that
  20    * was just rolled up.
  21    *
  22    * aCount is the number of popups in a chain to close. If this is
  23    * UINT32_MAX, then all popups are closed.
  24    * If aLastRolledUp is non-null, it will be set to the last rolled up popup,
  25    * if this is supported. aLastRolledUp is not addrefed.
  26    *
  27    * Returns true if the event that the caller is processing should be consumed.
  28    */
  29   virtual bool Rollup(uint32_t aCount, nsIContent** aLastRolledUp) = 0;
  30
  31   /**
  32    * Asks the RollupListener if it should rollup on mouse wheel events
  33    */
  34   virtual bool ShouldRollupOnMouseWheelEvent() = 0;
  35
  36   /**
  37    * Asks the RollupListener if it should consume mouse wheel events
  38    */
  39   virtual bool ShouldConsumeOnMouseWheelEvent() = 0;
  40
  41   /**
  42    * Asks the RollupListener if it should rollup on mouse activate, eg. X-Mouse
  43    */
  44   virtual bool ShouldRollupOnMouseActivate() = 0;
  45
  46   /*
  47    * Retrieve the widgets for open menus and store them in the array
  48    * aWidgetChain. The number of menus of the same type should be returned,
  49    * for example, if a context menu is open, return only the number of menus
  50    * that are part of the context menu chain. This allows closing up only
  51    * those menus in different situations. The returned value should be exactly
  52    * the same number of widgets added to aWidgetChain.
  53    */
  54   virtual uint32_t GetSubmenuWidgetChain(nsTArray<nsIWidget*> *aWidgetChain) = 0;
  55
  56   /**
  57    * Notify the RollupListener that the widget did a Move or Resize.
  58    */
  59   virtual void NotifyGeometryChange() = 0;
  60
  61   virtual nsIWidget* GetRollupWidget() = 0;
  62 };
  63
  64 #endif /* __nsIRollupListener_h__ */