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   enum class ByMoveToRect : bool { No, Yes };
  69   virtual bool WindowMoved(nsIWidget* aWidget, int32_t aX, int32_t aY,
  70                            ByMoveToRect);
  71
  72   /**
  73    * Called when a window is resized to (width, height). Returns true if the
  74    * notification was handled. Coordinates are outer window screen coordinates.
  75    */
  76   virtual bool WindowResized(nsIWidget* aWidget, int32_t aWidth,
  77                              int32_t aHeight);
  78
  79   /**
  80    * Called when the size mode (minimized, maximized, fullscreen) is changed.
  81    */
  82   virtual void SizeModeChanged(nsSizeMode aSizeMode);
  83
  84   /**
  85    * Called when the DPI (device resolution scaling factor) is changed,
  86    * such that UI elements may need to be rescaled.
  87    */
  88   virtual void UIResolutionChanged();
  89
  90 #if defined(MOZ_WIDGET_ANDROID)
  91   virtual void DynamicToolbarMaxHeightChanged(mozilla::ScreenIntCoord aHeight);
  92   virtual void DynamicToolbarOffsetChanged(mozilla::ScreenIntCoord aOffset);
  93 #endif
  94
  95   /**
  96    * Called when the z-order of the window is changed. Returns true if the
  97    * notification was handled. aPlacement indicates the new z order. If
  98    * placement is nsWindowZRelative, then aRequestBelow should be the
  99    * window to place below. On return, aActualBelow will be set to the
 100    * window actually behind. This generally only applies to Windows.
 101    */
 102   virtual bool ZLevelChanged(bool aImmediate, nsWindowZ* aPlacement,
 103                              nsIWidget* aRequestBelow,
 104                              nsIWidget** aActualBelow);
 105
 106   /**
 107    * Called when the window will enter or leave the fullscreen state.
 108    */
 109   virtual void FullscreenWillChange(bool aInFullscreen);
 110
 111   /**
 112    * Called when the window entered or left the fullscreen state.
 113    */
 114   virtual void FullscreenChanged(bool aInFullscreen);
 115
 116   /**
 117    * Called when the macOS titlebar is shown while in fullscreen.
 118    */
 119   virtual void MacFullscreenMenubarOverlapChanged(
 120       mozilla::DesktopCoord aOverlapAmount);
 121
 122   /**
 123    * Called when the occlusion state is changed.
 124    */
 125   virtual void OcclusionStateChanged(bool aIsFullyOccluded);
 126
 127   /**
 128    * Called when the window is activated and focused.
 129    */
 130   virtual void WindowActivated();
 131
 132   /**
 133    * Called when the window is deactivated and no longer focused.
 134    */
 135   virtual void WindowDeactivated();
 136
 137   /**
 138    * Called when the show/hide toolbar button on the Mac titlebar is pressed.
 139    */
 140   virtual void OSToolbarButtonPressed();
 141
 142   /**
 143    * Called when a request is made to close the window. Returns true if the
 144    * notification was handled. Returns true if the notification was handled.
 145    */
 146   virtual bool RequestWindowClose(nsIWidget* aWidget);
 147
 148   /*
 149    * Indicate that a paint is about to occur on this window. This is called
 150    * at a time when it's OK to change the geometry of this widget or of
 151    * other widgets. Must be called before every call to PaintWindow.
 152    */
 153   MOZ_CAN_RUN_SCRIPT_BOUNDARY
 154   virtual void WillPaintWindow(nsIWidget* aWidget);
 155
 156   /**
 157    * Paint the specified region of the window. Returns true if the
 158    * notification was handled.
 159    * This is called at a time when it is not OK to change the geometry of
 160    * this widget or of other widgets.
 161    */
 162   MOZ_CAN_RUN_SCRIPT_BOUNDARY
 163   virtual bool PaintWindow(nsIWidget* aWidget,
 164                            mozilla::LayoutDeviceIntRegion aRegion);
 165
 166   /**
 167    * Indicates that a paint occurred.
 168    * This is called at a time when it is OK to change the geometry of
 169    * this widget or of other widgets.
 170    * Must be called after every call to PaintWindow.
 171    */
 172   MOZ_CAN_RUN_SCRIPT_BOUNDARY
 173   virtual void DidPaintWindow();
 174
 175   virtual void DidCompositeWindow(mozilla::layers::TransactionId aTransactionId,
 176                                   const mozilla::TimeStamp& aCompositeStart,
 177                                   const mozilla::TimeStamp& aCompositeEnd);
 178
 179   /**
 180    * Request that layout schedules a repaint on the next refresh driver tick.
 181    */
 182   virtual void RequestRepaint();
 183
 184   /**
 185    * Returns true if this is a popup that should not be visible. If this
 186    * is a popup that is visible, not a popup or this state is unknown,
 187    * returns false.
 188    */
 189   virtual bool ShouldNotBeVisible();
 190
 191   /**
 192    * Handle an event.
 193    */
 194   virtual nsEventStatus HandleEvent(mozilla::WidgetGUIEvent* aEvent,
 195                                     bool aUseAttachedEvents);
 196
 197   /**
 198    * Called when safe area insets are changed.
 199    */
 200   virtual void SafeAreaInsetsChanged(
 201       const mozilla::ScreenIntMargin& aSafeAreaInsets);
 202 };
 203
 204 #endif