widget/nsIWidgetListener.h

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is mozila.org code.
  15  *
  16  * The Initial Developer of the Original Code is Mozilla Foundation.
  17  * Portions created by the Initial Developer are Copyright (C) 2011
  18  * the Initial Developer. All Rights Reserved.
  19  *
  20  * Contributor(s):
  21  *
  22  * Alternatively, the contents of this file may be used under the terms of
  23  * either the GNU General Public License Version 2 or later (the "GPL"), or
  24  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  25  * in which case the provisions of the GPL or the LGPL are applicable instead
  26  * of those above. If you wish to allow use of your version of this file only
  27  * under the terms of either the GPL or the LGPL, and not to allow others to
  28  * use your version of this file under the terms of the MPL, indicate your
  29  * decision by deleting the provisions above and replace them with the notice
  30  * and other provisions required by the GPL or the LGPL. If you do not delete
  31  * the provisions above, a recipient may use your version of this file under
  32  * the terms of any one of the MPL, the GPL or the LGPL.
  33  *
  34  * ***** END LICENSE BLOCK ***** */
  35
  36 #ifndef nsIWidgetListener_h__
  37 #define nsIWidgetListener_h__
  38
  39 #include "nscore.h"
  40 #include "nsGUIEvent.h"
  41 #include "nsIXULWindow.h"
  42
  43 class nsIView;
  44 class nsIPresShell;
  45
  46 class nsIWidgetListener
  47 {
  48 public:
  49
  50   /**
  51    * If this listener is for an nsIXULWindow, return it. If this is null, then
  52    * this is likely a listener for a view, which can be determined using
  53    * GetView. If both methods return null, this will be an nsWebBrowser.
  54    */
  55   virtual nsIXULWindow* GetXULWindow() { return nullptr; }
  56
  57   /**
  58    * If this listener is for an nsIView, return it.
  59    */
  60   virtual nsIView* GetView() { return nullptr; }
  61
  62   /**
  63    * Return the presshell for this widget listener.
  64    */
  65   virtual nsIPresShell* GetPresShell() { return nullptr; }
  66
  67   /**
  68    * Called when a window is moved to location (x, y). Returns true if the
  69    * notification was handled. Coordinates are outer window screen coordinates.
  70    */
  71   virtual bool WindowMoved(nsIWidget* aWidget, int32_t aX, int32_t aY) { return false; }
  72
  73   /**
  74    * Called when a window is resized to (width, height). Returns true if the
  75    * notification was handled. Coordinates are outer window screen coordinates.
  76    */
  77   virtual bool WindowResized(nsIWidget* aWidget, int32_t aWidth, int32_t aHeight) { return false; }
  78
  79   /**
  80    * Called when the size mode (minimized, maximized, fullscreen) is changed.
  81    */
  82   virtual void SizeModeChanged(nsSizeMode sizeMode) { }
  83
  84   /**
  85    * Called when the z-order of the window is changed. Returns true if the
  86    * notification was handled. aPlacement indicates the new z order. If
  87    * placement is nsWindowZRelative, then aRequestBelow should be the
  88    * window to place below. On return, aActualBelow will be set to the
  89    * window actually behind. This generally only applies to Windows.
  90    */
  91   virtual bool ZLevelChanged(bool aImmediate, nsWindowZ *aPlacement,
  92                              nsIWidget* aRequestBelow, nsIWidget** aActualBelow) { return false; }
  93
  94   /**
  95    * Called when the window is activated and focused.
  96    */
  97   virtual void WindowActivated() { }
  98
  99   /**
 100    * Called when the window is deactivated and no longer focused.
 101    */
 102   virtual void WindowDeactivated() { }
 103
 104   /**
 105    * Called when the show/hide toolbar button on the Mac titlebar is pressed.
 106    */
 107   virtual void OSToolbarButtonPressed() { }
 108
 109   /**
 110    * Called when a request is made to close the window. Returns true if the
 111    * notification was handled. Returns true if the notification was handled.
 112    */
 113   virtual bool RequestWindowClose(nsIWidget* aWidget) { return false; }
 114
 115   /*
 116    * Indicate that a paint is about to occur on this window.
 117    */
 118   virtual void WillPaintWindow(nsIWidget* aWidget, bool aWillSendDidPaint) { }
 119
 120   /**
 121    * Paint the specified region of the window. Returns true if the
 122    * notification was handled.
 123    */
 124   enum {
 125     SENT_WILL_PAINT = 1 << 0, /* WillPaintWindow has already been called */
 126     WILL_SEND_DID_PAINT = 1 << 1, /* A call to DidPaintWindow will be made afterwards. */
 127     PAINT_IS_ALTERNATE = 1 << 2 /* We are painting something other than the normal widget */
 128   };
 129   virtual bool PaintWindow(nsIWidget* aWidget, nsIntRegion aRegion, uint32_t aFlags) { return false; }
 130
 131   /**
 132    * On some platforms, indicates that a paint occurred.
 133    */
 134   virtual void DidPaintWindow() { }
 135
 136   /**
 137    * Handle an event.
 138    */
 139   virtual nsEventStatus HandleEvent(nsGUIEvent* event, bool useAttachedEvents)
 140   {
 141     return nsEventStatus_eIgnore;
 142   }
 143 };
 144
 145 #endif