Adding upstream version 110.0.1.upstream/110.0.1upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 75 insertions, 0 deletions

diff --git a/widget/nsIRollupListener.h b/widget/nsIRollupListener.h
new file mode 100644
index 0000000000..1b5b1d6efc
--- /dev/null
+++ b/widget/nsIRollupListener.h
@@ -0,0 +1,75 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef __nsIRollupListener_h__
+#define __nsIRollupListener_h__
+
+#include "nsTArray.h"
+#include "nsPoint.h"
+#include "Units.h"
+
+class nsIContent;
+class nsIWidget;
+
+class nsIRollupListener {
+ public:
+  /**
+   * Notifies the object to rollup, optionally returning the node that
+   * was just rolled up.
+   *
+   * If aFlush is true, then views should be flushed after the rollup.
+   *
+   * aPoint is the mouse pointer position where the event that triggered the
+   * rollup occurred, which may be nullptr.
+   *
+   * aCount is the number of popups in a chain to close. If this is
+   * UINT32_MAX, then all popups are closed.
+   * If aLastRolledUp is non-null, it will be set to the last rolled up popup,
+   * if this is supported. aLastRolledUp is not addrefed.
+   *
+   * Returns true if the event that the caller is processing should be consumed.
+   */
+  MOZ_CAN_RUN_SCRIPT_BOUNDARY
+  virtual bool Rollup(uint32_t aCount, bool aFlush,
+                      const mozilla::LayoutDeviceIntPoint* aPoint,
+                      nsIContent** aLastRolledUp) = 0;
+
+  /**
+   * Asks the RollupListener if it should rollup on mouse wheel events
+   */
+  virtual bool ShouldRollupOnMouseWheelEvent() = 0;
+
+  /**
+   * Asks the RollupListener if it should consume mouse wheel events
+   */
+  virtual bool ShouldConsumeOnMouseWheelEvent() = 0;
+
+  /**
+   * Asks the RollupListener if it should rollup on mouse activate, eg. X-Mouse
+   */
+  virtual bool ShouldRollupOnMouseActivate() = 0;
+
+  /*
+   * Retrieve the widgets for open menus and store them in the array
+   * aWidgetChain. The number of menus of the same type should be returned,
+   * for example, if a context menu is open, return only the number of menus
+   * that are part of the context menu chain. This allows closing up only
+   * those menus in different situations. The returned value should be exactly
+   * the same number of widgets added to aWidgetChain.
+   */
+  virtual uint32_t GetSubmenuWidgetChain(
+      nsTArray<nsIWidget*>* aWidgetChain) = 0;
+
+  virtual nsIWidget* GetRollupWidget() = 0;
+
+  /**
+   * If a native menu is currently shown, closes the menu.
+   * Returns true if a native menu was open.
+   */
+  virtual bool RollupNativeMenu() { return false; }
+};
+
+#endif /* __nsIRollupListener_h__ */