diff options
Diffstat (limited to 'widget/nsIWidgetListener.h')
| -rw-r--r-- | widget/nsIWidgetListener.h | 194 |
1 files changed, 194 insertions, 0 deletions
diff --git a/widget/nsIWidgetListener.h b/widget/nsIWidgetListener.h new file mode 100644 index 0000000000..aff753aaec --- /dev/null +++ b/widget/nsIWidgetListener.h @@ -0,0 +1,194 @@ +/* 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 nsIWidgetListener_h__ +#define nsIWidgetListener_h__ + +#include <stdint.h> + +#include "mozilla/EventForwards.h" +#include "mozilla/layers/LayersTypes.h" +#include "mozilla/TimeStamp.h" + +#include "nsRegionFwd.h" +#include "Units.h" + +class nsView; +class nsIWidget; +class nsIAppWindow; + +namespace mozilla { +class PresShell; +} // namespace mozilla + +/** + * sizemode is an adjunct to widget size + */ +enum nsSizeMode { + nsSizeMode_Normal = 0, + nsSizeMode_Minimized, + nsSizeMode_Maximized, + nsSizeMode_Fullscreen, + nsSizeMode_Invalid +}; + +/** + * different types of (top-level) window z-level positioning + */ +enum nsWindowZ { + nsWindowZTop = 0, // on top + nsWindowZBottom, // on bottom + nsWindowZRelative // just below some specified widget +}; + +class nsIWidgetListener { + public: + /** + * If this listener is for an nsIAppWindow, return it. If this is null, then + * this is likely a listener for a view, which can be determined using + * GetView. If both methods return null, this will be an nsWebBrowser. + */ + virtual nsIAppWindow* GetAppWindow(); + + /** + * If this listener is for an nsView, return it. + */ + virtual nsView* GetView(); + + /** + * Return the presshell for this widget listener. + */ + virtual mozilla::PresShell* GetPresShell(); + + /** + * Called when a window is moved to location (x, y). Returns true if the + * notification was handled. Coordinates are outer window screen coordinates. + */ + enum class ByMoveToRect : bool { No, Yes }; + virtual bool WindowMoved(nsIWidget* aWidget, int32_t aX, int32_t aY, + ByMoveToRect); + + /** + * Called when a window is resized to (width, height). Returns true if the + * notification was handled. Coordinates are outer window screen coordinates. + */ + virtual bool WindowResized(nsIWidget* aWidget, int32_t aWidth, + int32_t aHeight); + + /** + * Called when the size mode (minimized, maximized, fullscreen) is changed. + */ + virtual void SizeModeChanged(nsSizeMode aSizeMode); + + /** + * Called when the DPI (device resolution scaling factor) is changed, + * such that UI elements may need to be rescaled. + */ + virtual void UIResolutionChanged(); + +#if defined(MOZ_WIDGET_ANDROID) + virtual void DynamicToolbarMaxHeightChanged(mozilla::ScreenIntCoord aHeight); + virtual void DynamicToolbarOffsetChanged(mozilla::ScreenIntCoord aOffset); +#endif + + /** + * Called when the z-order of the window is changed. Returns true if the + * notification was handled. aPlacement indicates the new z order. If + * placement is nsWindowZRelative, then aRequestBelow should be the + * window to place below. On return, aActualBelow will be set to the + * window actually behind. This generally only applies to Windows. + */ + virtual bool ZLevelChanged(bool aImmediate, nsWindowZ* aPlacement, + nsIWidget* aRequestBelow, + nsIWidget** aActualBelow); + + /** + * Called when the macOS titlebar is shown while in fullscreen. + */ + virtual void MacFullscreenMenubarOverlapChanged( + mozilla::DesktopCoord aOverlapAmount); + + /** + * Called when the occlusion state is changed. + */ + virtual void OcclusionStateChanged(bool aIsFullyOccluded); + + /** + * Called when the window is activated and focused. + */ + virtual void WindowActivated(); + + /** + * Called when the window is deactivated and no longer focused. + */ + virtual void WindowDeactivated(); + + /** + * Called when the show/hide toolbar button on the Mac titlebar is pressed. + */ + virtual void OSToolbarButtonPressed(); + + /** + * Called when a request is made to close the window. Returns true if the + * notification was handled. Returns true if the notification was handled. + */ + virtual bool RequestWindowClose(nsIWidget* aWidget); + + /* + * Indicate that a paint is about to occur on this window. This is called + * at a time when it's OK to change the geometry of this widget or of + * other widgets. Must be called before every call to PaintWindow. + */ + MOZ_CAN_RUN_SCRIPT_BOUNDARY + virtual void WillPaintWindow(nsIWidget* aWidget); + + /** + * Paint the specified region of the window. Returns true if the + * notification was handled. + * This is called at a time when it is not OK to change the geometry of + * this widget or of other widgets. + */ + MOZ_CAN_RUN_SCRIPT_BOUNDARY + virtual bool PaintWindow(nsIWidget* aWidget, + mozilla::LayoutDeviceIntRegion aRegion); + + /** + * Indicates that a paint occurred. + * This is called at a time when it is OK to change the geometry of + * this widget or of other widgets. + * Must be called after every call to PaintWindow. + */ + MOZ_CAN_RUN_SCRIPT_BOUNDARY + virtual void DidPaintWindow(); + + virtual void DidCompositeWindow(mozilla::layers::TransactionId aTransactionId, + const mozilla::TimeStamp& aCompositeStart, + const mozilla::TimeStamp& aCompositeEnd); + + /** + * Request that layout schedules a repaint on the next refresh driver tick. + */ + virtual void RequestRepaint(); + + /** + * Returns true if this is a popup that should not be visible. If this + * is a popup that is visible, not a popup or this state is unknown, + * returns false. + */ + virtual bool ShouldNotBeVisible(); + + /** + * Handle an event. + */ + virtual nsEventStatus HandleEvent(mozilla::WidgetGUIEvent* aEvent, + bool aUseAttachedEvents); + + /** + * Called when safe area insets are changed. + */ + virtual void SafeAreaInsetsChanged( + const mozilla::ScreenIntMargin& aSafeAreaInsets); +}; + +#endif |