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 nsIXULWindow;
  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 nsIXULWindow, 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 nsIXULWindow* GetXULWindow();
  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   /**
  89    * Called when the z-order of the window is changed. Returns true if the
  90    * notification was handled. aPlacement indicates the new z order. If
  91    * placement is nsWindowZRelative, then aRequestBelow should be the
  92    * window to place below. On return, aActualBelow will be set to the
  93    * window actually behind. This generally only applies to Windows.
  94    */
  95   virtual bool ZLevelChanged(bool aImmediate, nsWindowZ* aPlacement,
  96                              nsIWidget* aRequestBelow,
  97                              nsIWidget** aActualBelow);
  98
  99   /**
 100    * Called when the window will enter or leave the fullscreen state.
 101    */
 102   virtual void FullscreenWillChange(bool aInFullscreen);
 103
 104   /**
 105    * Called when the window entered or left the fullscreen state.
 106    */
 107   virtual void FullscreenChanged(bool aInFullscreen);
 108
 109   /**
 110    * Called when the occlusion state is changed.
 111    */
 112   virtual void OcclusionStateChanged(bool aIsFullyOccluded);
 113
 114   /**
 115    * Called when the window is activated and focused.
 116    */
 117   virtual void WindowActivated();
 118
 119   /**
 120    * Called when the window is deactivated and no longer focused.
 121    */
 122   virtual void WindowDeactivated();
 123
 124   /**
 125    * Called when the show/hide toolbar button on the Mac titlebar is pressed.
 126    */
 127   virtual void OSToolbarButtonPressed();
 128
 129   /**
 130    * Called when a request is made to close the window. Returns true if the
 131    * notification was handled. Returns true if the notification was handled.
 132    */
 133   virtual bool RequestWindowClose(nsIWidget* aWidget);
 134
 135   /*
 136    * Indicate that a paint is about to occur on this window. This is called
 137    * at a time when it's OK to change the geometry of this widget or of
 138    * other widgets. Must be called before every call to PaintWindow.
 139    */
 140   MOZ_CAN_RUN_SCRIPT_BOUNDARY
 141   virtual void WillPaintWindow(nsIWidget* aWidget);
 142
 143   /**
 144    * Paint the specified region of the window. Returns true if the
 145    * notification was handled.
 146    * This is called at a time when it is not OK to change the geometry of
 147    * this widget or of other widgets.
 148    */
 149   MOZ_CAN_RUN_SCRIPT_BOUNDARY
 150   virtual bool PaintWindow(nsIWidget* aWidget,
 151                            mozilla::LayoutDeviceIntRegion aRegion);
 152
 153   /**
 154    * Indicates that a paint occurred.
 155    * This is called at a time when it is OK to change the geometry of
 156    * this widget or of other widgets.
 157    * Must be called after every call to PaintWindow.
 158    */
 159   MOZ_CAN_RUN_SCRIPT_BOUNDARY
 160   virtual void DidPaintWindow();
 161
 162   virtual void DidCompositeWindow(mozilla::layers::TransactionId aTransactionId,
 163                                   const mozilla::TimeStamp& aCompositeStart,
 164                                   const mozilla::TimeStamp& aCompositeEnd);
 165
 166   /**
 167    * Request that layout schedules a repaint on the next refresh driver tick.
 168    */
 169   virtual void RequestRepaint();
 170
 171   /**
 172    * Returns true if this is a popup that should not be visible. If this
 173    * is a popup that is visible, not a popup or this state is unknown,
 174    * returns false.
 175    */
 176   virtual bool ShouldNotBeVisible();
 177
 178   /**
 179    * Handle an event.
 180    */
 181   virtual nsEventStatus HandleEvent(mozilla::WidgetGUIEvent* aEvent,
 182                                     bool aUseAttachedEvents);
 183 };
 184
 185 #endif