widget/nsIWidgetListener.h

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 #ifndef nsIWidgetListener_h__
   6 #define nsIWidgetListener_h__
   7
   8 #include <stdint.h>
   9
  10 #include "mozilla/EventForwards.h"
  11 #include "mozilla/layers/LayersTypes.h"
  12 #include "mozilla/TimeStamp.h"
  13
  14 #include "nsRegionFwd.h"
  15 #include "Units.h"
  16
  17 class nsView;
  18 class nsIWidget;
  19 class nsIAppWindow;
  20
  21 namespace mozilla {
  22 class PresShell;
  23 }  // namespace mozilla
  24
  25 /**
  26  * sizemode is an adjunct to widget size
  27  */
  28 enum nsSizeMode {
  29   nsSizeMode_Normal = 0,
  30   nsSizeMode_Minimized,
  31   nsSizeMode_Maximized,
  32   nsSizeMode_Fullscreen,
  33   nsSizeMode_Invalid
  34 };
  35
  36 /**
  37  * different types of (top-level) window z-level positioning
  38  */
  39 enum nsWindowZ {
  40   nsWindowZTop = 0,  // on top
  41   nsWindowZBottom,   // on bottom
  42   nsWindowZRelative  // just below some specified widget
  43 };
  44
  45 class nsIWidgetListener {
  46  public:
  47   /**
  48    * If this listener is for an nsIAppWindow, return it. If this is null, then
  49    * this is likely a listener for a view, which can be determined using
  50    * GetView. If both methods return null, this will be an nsWebBrowser.
  51    */
  52   virtual nsIAppWindow* GetAppWindow();
  53
  54   /**
  55    * If this listener is for an nsView, return it.
  56    */
  57   virtual nsView* GetView();
  58
  59   /**
  60    * Return the presshell for this widget listener.
  61    */
  62   virtual mozilla::PresShell* GetPresShell();
  63
  64   /**
  65    * Called when a window is moved to location (x, y). Returns true if the
  66    * notification was handled. Coordinates are outer window screen coordinates.
  67    */
  68   virtual bool WindowMoved(nsIWidget* aWidget, int32_t aX, int32_t aY);
  69
  70   /**
  71    * Called when a window is resized to (width, height). Returns true if the
  72    * notification was handled. Coordinates are outer window screen coordinates.
  73    */
  74   virtual bool WindowResized(nsIWidget* aWidget, int32_t aWidth,
  75                              int32_t aHeight);
  76
  77   /**
  78    * Called when the size mode (minimized, maximized, fullscreen) is changed.
  79    */
  80   virtual void SizeModeChanged(nsSizeMode aSizeMode);
  81
  82   /**
  83    * Called when the DPI (device resolution scaling factor) is changed,
  84    * such that UI elements may need to be rescaled.
  85    */
  86   virtual void UIResolutionChanged();
  87
  88 #if defined(MOZ_WIDGET_ANDROID)
  89   virtual void DynamicToolbarMaxHeightChanged(mozilla::ScreenIntCoord aHeight);
  90   virtual void DynamicToolbarOffsetChanged(mozilla::ScreenIntCoord aOffset);
  91 #endif
  92
  93   /**
  94    * Called when the z-order of the window is changed. Returns true if the
  95    * notification was handled. aPlacement indicates the new z order. If
  96    * placement is nsWindowZRelative, then aRequestBelow should be the
  97    * window to place below. On return, aActualBelow will be set to the
  98    * window actually behind. This generally only applies to Windows.
  99    */
 100   virtual bool ZLevelChanged(bool aImmediate, nsWindowZ* aPlacement,
 101                              nsIWidget* aRequestBelow,
 102                              nsIWidget** aActualBelow);
 103
 104   /**
 105    * Called when the window will enter or leave the fullscreen state.
 106    */
 107   virtual void FullscreenWillChange(bool aInFullscreen);
 108
 109   /**
 110    * Called when the window entered or left the fullscreen state.
 111    */
 112   virtual void FullscreenChanged(bool aInFullscreen);
 113
 114   /**
 115    * Called when the macOS titlebar is shown while in fullscreen.
 116    */
 117   virtual void MacFullscreenMenubarOverlapChanged(
 118       mozilla::DesktopCoord aOverlapAmount);
 119
 120   /**
 121    * Called when the occlusion state is changed.
 122    */
 123   virtual void OcclusionStateChanged(bool aIsFullyOccluded);
 124
 125   /**
 126    * Called when the window is activated and focused.
 127    */
 128   virtual void WindowActivated();
 129
 130   /**
 131    * Called when the window is deactivated and no longer focused.
 132    */
 133   virtual void WindowDeactivated();
 134
 135   /**
 136    * Called when the show/hide toolbar button on the Mac titlebar is pressed.
 137    */
 138   virtual void OSToolbarButtonPressed();
 139
 140   /**
 141    * Called when a request is made to close the window. Returns true if the
 142    * notification was handled. Returns true if the notification was handled.
 143    */
 144   virtual bool RequestWindowClose(nsIWidget* aWidget);
 145
 146   /*
 147    * Indicate that a paint is about to occur on this window. This is called
 148    * at a time when it's OK to change the geometry of this widget or of
 149    * other widgets. Must be called before every call to PaintWindow.
 150    */
 151   MOZ_CAN_RUN_SCRIPT_BOUNDARY
 152   virtual void WillPaintWindow(nsIWidget* aWidget);
 153
 154   /**
 155    * Paint the specified region of the window. Returns true if the
 156    * notification was handled.
 157    * This is called at a time when it is not OK to change the geometry of
 158    * this widget or of other widgets.
 159    */
 160   MOZ_CAN_RUN_SCRIPT_BOUNDARY
 161   virtual bool PaintWindow(nsIWidget* aWidget,
 162                            mozilla::LayoutDeviceIntRegion aRegion);
 163
 164   /**
 165    * Indicates that a paint occurred.
 166    * This is called at a time when it is OK to change the geometry of
 167    * this widget or of other widgets.
 168    * Must be called after every call to PaintWindow.
 169    */
 170   MOZ_CAN_RUN_SCRIPT_BOUNDARY
 171   virtual void DidPaintWindow();
 172
 173   virtual void DidCompositeWindow(mozilla::layers::TransactionId aTransactionId,
 174                                   const mozilla::TimeStamp& aCompositeStart,
 175                                   const mozilla::TimeStamp& aCompositeEnd);
 176
 177   /**
 178    * Request that layout schedules a repaint on the next refresh driver tick.
 179    */
 180   virtual void RequestRepaint();
 181
 182   /**
 183    * Returns true if this is a popup that should not be visible. If this
 184    * is a popup that is visible, not a popup or this state is unknown,
 185    * returns false.
 186    */
 187   virtual bool ShouldNotBeVisible();
 188
 189   /**
 190    * Handle an event.
 191    */
 192   virtual nsEventStatus HandleEvent(mozilla::WidgetGUIEvent* aEvent,
 193                                     bool aUseAttachedEvents);
 194
 195   /**
 196    * Called when safe area insets are changed.
 197    */
 198   virtual void SafeAreaInsetsChanged(
 199       const mozilla::ScreenIntMargin& aSafeAreaInsets);
 200 };
 201
 202 #endif