1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 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/. */
7 #ifndef __nsIRollupListener_h__
8 #define __nsIRollupListener_h__
15 class nsIRollupListener
{
19 * Notifies the object to rollup, optionally returning the node that
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.
27 * Returns true if the event that the caller is processing should be consumed.
29 virtual bool Rollup(uint32_t aCount
, nsIContent
** aLastRolledUp
) = 0;
32 * Asks the RollupListener if it should rollup on mouse wheel events
34 virtual bool ShouldRollupOnMouseWheelEvent() = 0;
37 * Asks the RollupListener if it should consume mouse wheel events
39 virtual bool ShouldConsumeOnMouseWheelEvent() = 0;
42 * Asks the RollupListener if it should rollup on mouse activate, eg. X-Mouse
44 virtual bool ShouldRollupOnMouseActivate() = 0;
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.
54 virtual uint32_t GetSubmenuWidgetChain(nsTArray
<nsIWidget
*> *aWidgetChain
) = 0;
57 * Notify the RollupListener that the widget did a Move or Resize.
59 virtual void NotifyGeometryChange() = 0;
61 virtual nsIWidget
* GetRollupWidget() = 0;
64 #endif /* __nsIRollupListener_h__ */