1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* vim: set ts=2 et sw=2 tw=80: */
3 /* This Source Code Form is subject to the terms of the Mozilla Public
4 * License, v. 2.0. If a copy of the MPL was not distributed with this
5 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
12 #include "imgIContainer.h"
13 #include "ErrorList.h"
15 #include "mozilla/AlreadyAddRefed.h"
16 #include "mozilla/Assertions.h"
17 #include "mozilla/Attributes.h"
18 #include "mozilla/EventForwards.h"
19 #include "mozilla/Maybe.h"
20 #include "mozilla/RefPtr.h"
21 #include "mozilla/TimeStamp.h"
22 #include "mozilla/UniquePtr.h"
23 #include "mozilla/gfx/Matrix.h"
24 #include "mozilla/gfx/Rect.h"
25 #include "mozilla/layers/LayersTypes.h"
26 #include "mozilla/layers/ScrollableLayerGuid.h"
27 #include "mozilla/layers/ZoomConstraints.h"
28 #include "mozilla/image/Resolution.h"
29 #include "mozilla/widget/IMEData.h"
34 #include "nsIObserver.h"
35 #include "nsISupports.h"
38 #include "nsIWidgetListener.h"
41 #include "nsStringFwd.h"
43 #include "nsTHashMap.h"
44 #include "mozilla/widget/InitData.h"
45 #include "nsXULAppAPI.h"
47 // forward declarations
48 class nsIBidiKeyboard
;
49 class nsIRollupListener
;
55 enum class NativeKeyBindingsType
: uint8_t;
56 class VsyncDispatcher
;
58 class WidgetInputEvent
;
59 class WidgetKeyboardEvent
;
61 enum class ColorScheme
: uint8_t;
62 enum class WindowButtonType
: uint8_t;
64 enum class WindowShadow
: uint8_t {
71 #if defined(MOZ_WIDGET_ANDROID)
75 #endif // defined(MOZ_WIDGET_ANDROID)
78 enum class CallerType
: uint32_t;
82 class AsyncDragMetrics
;
84 class CompositorBridgeChild
;
87 class WebRenderBridgeChild
;
90 class TextEventDispatcher
;
91 class TextEventDispatcherListener
;
92 class CompositorWidget
;
93 class CompositorWidgetInitData
;
97 class DisplayListBuilder
;
98 class IpcResourceUpdateQueue
;
99 enum class RenderRoot
: uint8_t;
101 } // namespace mozilla
104 * Callback function that processes events.
106 * The argument is actually a subtype (subclass) of WidgetEvent which carries
107 * platform specific information about the event. Platform specific code
108 * knows how to deal with it.
110 * The return value determines whether or not the default action should take
113 typedef nsEventStatus (*EVENT_CALLBACK
)(mozilla::WidgetGUIEvent
* aEvent
);
115 // Hide the native window system's real window type so as to avoid
116 // including native window system types and APIs. This is necessary
117 // to ensure cross-platform code.
118 typedef void* nsNativeWidget
;
121 * Values for the GetNativeData function
123 #define NS_NATIVE_WINDOW 0
124 #define NS_NATIVE_GRAPHIC 1
125 #define NS_NATIVE_WIDGET 3
126 #define NS_NATIVE_REGION 5
127 #define NS_NATIVE_OFFSETX 6
128 #define NS_NATIVE_OFFSETY 7
129 #define NS_NATIVE_SCREEN 9
130 // The toplevel GtkWidget containing this nsIWidget:
131 #define NS_NATIVE_SHELLWIDGET 10
132 #define NS_NATIVE_OPENGL_CONTEXT 12
133 // This is available only with GetNativeData() in parent process. Anybody
134 // shouldn't access this pointer as a valid pointer since the result may be
135 // special value like NS_ONLY_ONE_NATIVE_IME_CONTEXT. So, the result is just
136 // an identifier of distinguishing a text composition is caused by which native
137 // IME context. Note that the result is only valid in the process. So,
138 // XP code should use nsIWidget::GetNativeIMEContext() instead of using this.
139 #define NS_RAW_NATIVE_IME_CONTEXT 14
140 #define NS_NATIVE_WINDOW_WEBRTC_DEVICE_ID 15
142 # define NS_NATIVE_TSF_THREAD_MGR 100
143 # define NS_NATIVE_TSF_CATEGORY_MGR 101
144 # define NS_NATIVE_TSF_DISPLAY_ATTR_MGR 102
145 # define NS_NATIVE_ICOREWINDOW 103 // winrt specific
147 #if defined(MOZ_WIDGET_GTK)
148 # define NS_NATIVE_EGL_WINDOW 106
150 #ifdef MOZ_WIDGET_ANDROID
151 # define NS_JAVA_SURFACE 100
154 #define MOZ_WIDGET_MAX_SIZE 16384
155 #define MOZ_WIDGET_INVALID_SCALE 0.0
157 // Must be kept in sync with xpcom/rust/xpcom/src/interfaces/nonidl.rs
158 #define NS_IWIDGET_IID \
160 0x06396bf6, 0x2dd8, 0x45e5, { \
161 0xac, 0x45, 0x75, 0x26, 0x53, 0xb1, 0xc9, 0x80 \
169 enum nsCursor
{ ///(normal cursor, usually rendered as an arrow)
171 ///(system is busy, usually rendered as a hourglass or watch)
173 ///(Selecting something, usually rendered as an IBeam)
175 ///(can hyper-link, usually rendered as a human hand)
177 ///(north/south/west/east edge sizing)
190 eCursor_copy
, // CSS3
192 eCursor_context_menu
,
203 eCursor_vertical_text
,
210 // This one is used for array sizing, and so better be the last
211 // one in this list...
214 // ...except for this one.
215 eCursorInvalid
= eCursorCount
+ 1
218 enum nsTopLevelWidgetZPlacement
{ // for PlaceBehind()
219 eZPlacementBottom
= 0, // bottom of the window stack
220 eZPlacementBelow
, // just below another widget
221 eZPlacementTop
// top of the window stack
225 * Before the OS goes to sleep, this topic is notified.
227 #define NS_WIDGET_SLEEP_OBSERVER_TOPIC "sleep_notification"
230 * After the OS wakes up, this topic is notified.
232 #define NS_WIDGET_WAKE_OBSERVER_TOPIC "wake_notification"
235 * Before the OS suspends the current process, this topic is notified. Some
236 * OS will kill processes that are suspended instead of resuming them.
237 * For that reason this topic may be useful to safely close down resources.
239 #define NS_WIDGET_SUSPEND_PROCESS_OBSERVER_TOPIC "suspend_process_notification"
242 * After the current process resumes from being suspended, this topic is
245 #define NS_WIDGET_RESUME_PROCESS_OBSERVER_TOPIC "resume_process_notification"
248 * When an app(-shell) is activated by the OS, this topic is notified.
249 * Currently, this only happens on Mac OSX.
251 #define NS_WIDGET_MAC_APP_ACTIVATE_OBSERVER_TOPIC "mac_app_activate"
253 namespace mozilla::widget
{
256 * Size constraints for setting the minimum and maximum size of a widget.
257 * Values are in device pixels.
259 struct SizeConstraints
{
261 : mMaxSize(MOZ_WIDGET_MAX_SIZE
, MOZ_WIDGET_MAX_SIZE
),
262 mScale(MOZ_WIDGET_INVALID_SCALE
) {}
264 SizeConstraints(mozilla::LayoutDeviceIntSize aMinSize
,
265 mozilla::LayoutDeviceIntSize aMaxSize
,
266 mozilla::DesktopToLayoutDeviceScale aScale
)
267 : mMinSize(aMinSize
), mMaxSize(aMaxSize
), mScale(aScale
) {
268 if (mMaxSize
.width
> MOZ_WIDGET_MAX_SIZE
) {
269 mMaxSize
.width
= MOZ_WIDGET_MAX_SIZE
;
271 if (mMaxSize
.height
> MOZ_WIDGET_MAX_SIZE
) {
272 mMaxSize
.height
= MOZ_WIDGET_MAX_SIZE
;
276 mozilla::LayoutDeviceIntSize mMinSize
;
277 mozilla::LayoutDeviceIntSize mMaxSize
;
280 * The scale used to convert from desktop to device dimensions.
281 * MOZ_WIDGET_INVALID_SCALE if the value is not known.
283 * Bug 1701109 is filed to revisit adding of 'mScale' and deal
284 * with multi-monitor scaling issues in more complete way across
285 * all widget implementations.
287 mozilla::DesktopToLayoutDeviceScale mScale
;
290 struct AutoObserverNotifier
{
291 AutoObserverNotifier(nsIObserver
* aObserver
, const char* aTopic
)
292 : mObserver(aObserver
), mTopic(aTopic
) {}
294 void SkipNotification() { mObserver
= nullptr; }
296 uint64_t SaveObserver() {
300 uint64_t observerId
= ++sObserverId
;
301 sSavedObservers
.InsertOrUpdate(observerId
, mObserver
);
306 ~AutoObserverNotifier() {
308 mObserver
->Observe(nullptr, mTopic
, nullptr);
312 static void NotifySavedObserver(const uint64_t& aObserverId
,
313 const char* aTopic
) {
314 nsCOMPtr
<nsIObserver
> observer
= sSavedObservers
.Get(aObserverId
);
316 MOZ_ASSERT(aObserverId
== 0,
317 "We should always find a saved observer for nonzero IDs");
321 sSavedObservers
.Remove(aObserverId
);
322 observer
->Observe(nullptr, aTopic
, nullptr);
326 nsCOMPtr
<nsIObserver
> mObserver
;
330 static uint64_t sObserverId
;
331 static nsTHashMap
<uint64_t, nsCOMPtr
<nsIObserver
>> sSavedObservers
;
334 } // namespace mozilla::widget
337 * The base class for all the widgets. It provides the interface for
338 * all basic and necessary functionality.
340 class nsIWidget
: public nsISupports
{
342 typedef mozilla::dom::BrowserChild BrowserChild
;
345 typedef mozilla::layers::CompositorBridgeChild CompositorBridgeChild
;
346 typedef mozilla::layers::AsyncDragMetrics AsyncDragMetrics
;
347 typedef mozilla::layers::FrameMetrics FrameMetrics
;
348 typedef mozilla::layers::LayerManager LayerManager
;
349 typedef mozilla::WindowRenderer WindowRenderer
;
350 typedef mozilla::layers::LayersBackend LayersBackend
;
351 typedef mozilla::layers::LayersId LayersId
;
352 typedef mozilla::layers::ScrollableLayerGuid ScrollableLayerGuid
;
353 typedef mozilla::layers::ZoomConstraints ZoomConstraints
;
354 typedef mozilla::widget::IMEEnabled IMEEnabled
;
355 typedef mozilla::widget::IMEMessage IMEMessage
;
356 typedef mozilla::widget::IMENotification IMENotification
;
357 typedef mozilla::widget::IMENotificationRequests IMENotificationRequests
;
358 typedef mozilla::widget::IMEState IMEState
;
359 typedef mozilla::widget::InputContext InputContext
;
360 typedef mozilla::widget::InputContextAction InputContextAction
;
361 typedef mozilla::widget::NativeIMEContext NativeIMEContext
;
362 typedef mozilla::widget::SizeConstraints SizeConstraints
;
363 typedef mozilla::widget::TextEventDispatcher TextEventDispatcher
;
364 typedef mozilla::widget::TextEventDispatcherListener
365 TextEventDispatcherListener
;
366 typedef mozilla::LayoutDeviceIntMargin LayoutDeviceIntMargin
;
367 typedef mozilla::LayoutDeviceIntPoint LayoutDeviceIntPoint
;
368 typedef mozilla::LayoutDeviceIntRect LayoutDeviceIntRect
;
369 typedef mozilla::LayoutDeviceIntRegion LayoutDeviceIntRegion
;
370 typedef mozilla::LayoutDeviceIntSize LayoutDeviceIntSize
;
371 typedef mozilla::ScreenIntPoint ScreenIntPoint
;
372 typedef mozilla::ScreenIntMargin ScreenIntMargin
;
373 typedef mozilla::ScreenIntSize ScreenIntSize
;
374 typedef mozilla::ScreenPoint ScreenPoint
;
375 typedef mozilla::CSSToScreenScale CSSToScreenScale
;
376 typedef mozilla::DesktopIntRect DesktopIntRect
;
377 typedef mozilla::DesktopPoint DesktopPoint
;
378 typedef mozilla::DesktopIntPoint DesktopIntPoint
;
379 typedef mozilla::DesktopRect DesktopRect
;
380 typedef mozilla::DesktopSize DesktopSize
;
381 typedef mozilla::CSSPoint CSSPoint
;
382 typedef mozilla::CSSRect CSSRect
;
384 using InitData
= mozilla::widget::InitData
;
385 using WindowType
= mozilla::widget::WindowType
;
386 using PopupType
= mozilla::widget::PopupType
;
387 using PopupLevel
= mozilla::widget::PopupLevel
;
388 using BorderStyle
= mozilla::widget::BorderStyle
;
389 using TransparencyMode
= mozilla::widget::TransparencyMode
;
390 using Screen
= mozilla::widget::Screen
;
392 // Used in UpdateThemeGeometries.
393 struct ThemeGeometry
{
394 // The ThemeGeometryType value for the themed widget, see
395 // nsITheme::ThemeGeometryTypeForWidget.
396 nsITheme::ThemeGeometryType mType
;
397 // The device-pixel rect within the window for the themed widget
398 LayoutDeviceIntRect mRect
;
400 ThemeGeometry(nsITheme::ThemeGeometryType aType
,
401 const LayoutDeviceIntRect
& aRect
)
402 : mType(aType
), mRect(aRect
) {}
405 NS_DECLARE_STATIC_IID_ACCESSOR(NS_IWIDGET_IID
)
408 : mLastChild(nullptr),
409 mPrevSibling(nullptr),
410 mOnDestroyCalled(false),
411 mWindowType(WindowType::Child
),
415 ClearNativeTouchSequence(nullptr);
419 * Create and initialize a widget.
421 * All the arguments can be null in which case a top level window
422 * with size 0 is created. The event callback function has to be
423 * provided only if the caller wants to deal with the events this
424 * widget receives. The event callback is basically a preprocess
425 * hook called synchronously. The return value determines whether
426 * the event goes to the default window procedure or it is hidden
427 * to the os. The assumption is that if the event handler returns
428 * false the widget does not see the event. The widget should not
429 * automatically clear the window to the background color. The
430 * calling code must handle paint messages and clear the background
433 * In practice at least one of aParent and aNativeParent will be null. If
434 * both are null the widget isn't parented (e.g. context menus or
435 * independent top level windows).
437 * The dimensions given in aRect are specified in the parent's
438 * device coordinate system.
439 * This must not be called for parentless widgets such as top-level
440 * windows, which use the desktop pixel coordinate system; a separate
441 * method is provided for these.
443 * @param aParent parent nsIWidget
444 * @param aNativeParent native parent widget
445 * @param aRect the widget dimension
446 * @param aInitData data that is used for widget initialization
449 [[nodiscard
]] virtual nsresult
Create(nsIWidget
* aParent
,
450 nsNativeWidget aNativeParent
,
451 const LayoutDeviceIntRect
& aRect
,
452 InitData
* = nullptr) = 0;
455 * As above, but with aRect specified in DesktopPixel units (for top-level
457 * Default implementation just converts aRect to device pixels and calls
458 * through to device-pixel Create, but platforms may override this if the
459 * mapping is not straightforward or the native platform needs to use the
460 * desktop pixel values directly.
462 [[nodiscard
]] virtual nsresult
Create(nsIWidget
* aParent
,
463 nsNativeWidget aNativeParent
,
464 const DesktopIntRect
& aRect
,
465 InitData
* aInitData
= nullptr) {
466 LayoutDeviceIntRect devPixRect
=
467 RoundedToInt(aRect
* GetDesktopToDeviceScale());
468 return Create(aParent
, aNativeParent
, devPixRect
, aInitData
);
472 * Allocate, initialize, and return a widget that is a child of
473 * |this|. The returned widget (if nonnull) has gone through the
474 * equivalent of CreateInstance(widgetCID) + Create(...).
476 * |CreateChild()| lets widget backends decide whether to parent
477 * the new child widget to this, nonnatively parent it, or both.
478 * This interface exists to support the PuppetWidget backend,
479 * which is entirely non-native. All other params are the same as
482 * |aForceUseIWidgetParent| forces |CreateChild()| to only use the
483 * |nsIWidget*| this, not its native widget (if it exists), when
484 * calling |Create()|. This is a timid hack around poorly
485 * understood code, and shouldn't be used in new code.
487 virtual already_AddRefed
<nsIWidget
> CreateChild(
488 const LayoutDeviceIntRect
& aRect
, InitData
* = nullptr,
489 bool aForceUseIWidgetParent
= false) = 0;
492 * Attach to a top level widget.
494 * In cases where a top level chrome widget is being used as a content
495 * container, attach a secondary listener and update the device
496 * context. The primary widget listener will continue to be called for
497 * notifications relating to the top-level window, whereas other
498 * notifications such as painting and events will instead be called via
499 * the attached listener. SetAttachedWidgetListener should be used to
500 * assign the attached listener.
502 * aUseAttachedEvents if true, events are sent to the attached listener
503 * instead of the normal listener.
505 virtual void AttachViewToTopLevel(bool aUseAttachedEvents
) = 0;
508 * Accessor functions to get and set the attached listener. Used by
509 * nsView in connection with AttachViewToTopLevel above.
511 virtual void SetAttachedWidgetListener(nsIWidgetListener
* aListener
) = 0;
512 virtual nsIWidgetListener
* GetAttachedWidgetListener() const = 0;
513 virtual void SetPreviouslyAttachedWidgetListener(
514 nsIWidgetListener
* aListener
) = 0;
515 virtual nsIWidgetListener
* GetPreviouslyAttachedWidgetListener() = 0;
518 * Notifies the root widget of a non-blank paint.
520 virtual void DidGetNonBlankPaint() {}
523 * Accessor functions to get and set the listener which handles various
524 * actions for the widget.
527 virtual nsIWidgetListener
* GetWidgetListener() const = 0;
528 virtual void SetWidgetListener(nsIWidgetListener
* alistener
) = 0;
532 * Close and destroy the internal native window.
533 * This method does not delete the widget.
536 virtual void Destroy() = 0;
539 * Destroyed() returns true if Destroy() has been called already.
542 bool Destroyed() const { return mOnDestroyCalled
; }
547 * Change the widget's parent. Null parents are allowed.
549 * @param aNewParent new parent
551 virtual void SetParent(nsIWidget
* aNewParent
) = 0;
554 * Return the parent Widget of this Widget or nullptr if this is a
557 * @return the parent widget or nullptr if it does not have a parent
560 virtual nsIWidget
* GetParent(void) = 0;
563 * Return the top level Widget of this Widget
565 * @return the top level widget
567 virtual nsIWidget
* GetTopLevelWidget() = 0;
570 * Return the top (non-sheet) parent of this Widget if it's a sheet,
571 * or nullptr if this isn't a sheet (or some other error occurred).
572 * Sheets are only supported on some platforms (currently only macOS).
574 * @return the top (non-sheet) parent widget or nullptr
577 virtual nsIWidget
* GetSheetWindowParent(void) = 0;
580 * Return the physical DPI of the screen containing the window ...
581 * the number of device pixels per inch.
583 virtual float GetDPI() = 0;
586 * Fallback DPI for when there's no widget available.
588 static float GetFallbackDPI();
591 * Return the scaling factor between device pixels and the platform-
592 * dependent "desktop pixels" used to manage window positions on a
593 * potentially multi-screen, mixed-resolution desktop.
595 virtual mozilla::DesktopToLayoutDeviceScale
GetDesktopToDeviceScale() = 0;
598 * Return the scaling factor between device pixels and the platform-
599 * dependent "desktop pixels" by looking up the screen by the position
602 virtual mozilla::DesktopToLayoutDeviceScale
603 GetDesktopToDeviceScaleByScreen() = 0;
606 * Return the default scale factor for the window. This is the
607 * default number of device pixels per CSS pixel to use. This should
608 * depend on OS/platform settings such as the Mac's "UI scale factor"
609 * or Windows' "font DPI". This will take into account Gecko preferences
610 * overriding the system setting.
612 mozilla::CSSToLayoutDeviceScale
GetDefaultScale();
615 * Fallback default scale for when there's no widget available.
617 static mozilla::CSSToLayoutDeviceScale
GetFallbackDefaultScale();
620 * Return the first child of this widget. Will return null if
621 * there are no children.
623 nsIWidget
* GetFirstChild() const { return mFirstChild
; }
626 * Return the last child of this widget. Will return null if
627 * there are no children.
629 nsIWidget
* GetLastChild() const { return mLastChild
; }
632 * Return the next sibling of this widget
634 nsIWidget
* GetNextSibling() const { return mNextSibling
; }
637 * Set the next sibling of this widget
639 void SetNextSibling(nsIWidget
* aSibling
) { mNextSibling
= aSibling
; }
642 * Return the previous sibling of this widget
644 nsIWidget
* GetPrevSibling() const { return mPrevSibling
; }
647 * Set the previous sibling of this widget
649 void SetPrevSibling(nsIWidget
* aSibling
) { mPrevSibling
= aSibling
; }
652 * Show or hide this widget
654 * @param aState true to show the Widget, false to hide it
657 virtual void Show(bool aState
) = 0;
660 * Whether or not a widget must be recreated after being hidden to show
663 virtual bool NeedsRecreateToReshow() { return false; }
666 * Make the window modal.
668 virtual void SetModal(bool aModal
) = 0;
671 * Are we app modal. Currently only implemented on Cocoa.
673 virtual bool IsRunningAppModal() { return false; }
676 * The maximum number of simultaneous touch contacts supported by the device.
677 * In the case of devices with multiple digitizers (e.g. multiple touch
678 * screens), the value will be the maximum of the set of maximum supported
679 * contacts by each individual digitizer.
681 virtual uint32_t GetMaxTouchPoints() const = 0;
684 * Returns whether the window is visible
687 virtual bool IsVisible() const = 0;
690 * Returns whether the window has allocated resources so
691 * we can paint into it.
692 * Recently it's used on Linux/Gtk where we should not paint
693 * to invisible window.
695 virtual bool IsMapped() const { return true; }
698 * Perform platform-dependent sanity check on a potential window position.
699 * This is guaranteed to work only for top-level windows.
701 virtual void ConstrainPosition(DesktopIntPoint
&) = 0;
706 * For a top-level window widget, the "parent's coordinate system" is the
707 * "global" display pixel coordinate space, *not* device pixels (which
708 * may be inconsistent between multiple screens, at least in the Mac OS
709 * case with mixed hi-dpi and lo-dpi displays). This applies to all the
710 * following Move and Resize widget APIs.
712 * The display-/device-pixel distinction becomes important for (at least)
713 * macOS with Hi-DPI (retina) displays, and Windows when the UI scale factor
714 * is set to other than 100%.
716 * The Move and Resize methods take floating-point parameters, rather than
717 * integer ones. This is important when manipulating top-level widgets,
718 * where the coordinate system may not be an integral multiple of the
719 * device-pixel space.
725 * Coordinates refer to the top-left of the widget. For toplevel windows
726 * with decorations, this is the top-left of the titlebar and frame .
728 * @param aX the new x position expressed in the parent's coordinate system
729 * @param aY the new y position expressed in the parent's coordinate system
732 virtual void Move(double aX
, double aY
) = 0;
735 * Reposition this widget so that the client area has the given offset.
737 * @param aOffset the new offset of the client area expressed as an
738 * offset from the origin of the client area of the parent
739 * widget (for root widgets and popup widgets it is in
740 * screen coordinates)
742 virtual void MoveClient(const DesktopPoint
& aOffset
) = 0;
745 * Resize this widget. Any size constraints set for the window by a
746 * previous call to SetSizeConstraints will be applied.
748 * @param aWidth the new width expressed in the parent's coordinate system
749 * @param aHeight the new height expressed in the parent's coordinate
751 * @param aRepaint whether the widget should be repainted
753 virtual void Resize(double aWidth
, double aHeight
, bool aRepaint
) = 0;
756 * Lock the aspect ratio of a Window
758 * @param aShouldLock bool
761 virtual void LockAspectRatio(bool aShouldLock
){};
764 * Move or resize this widget. Any size constraints set for the window by
765 * a previous call to SetSizeConstraints will be applied.
767 * @param aX the new x position expressed in the parent's coordinate
769 * @param aY the new y position expressed in the parent's coordinate
771 * @param aWidth the new width expressed in the parent's coordinate system
772 * @param aHeight the new height expressed in the parent's coordinate
774 * @param aRepaint whether the widget should be repainted if the size
778 virtual void Resize(double aX
, double aY
, double aWidth
, double aHeight
,
782 * Resize the widget so that the inner client area has the given size.
784 * @param aSize the new size of the client area.
785 * @param aRepaint whether the widget should be repainted
787 virtual void ResizeClient(const DesktopSize
& aSize
, bool aRepaint
) = 0;
790 * Resize and reposition the widget so tht inner client area has the given
793 * @param aRect the new offset and size of the client area. The offset is
794 * expressed as an offset from the origin of the client area
795 * of the parent widget (for root widgets and popup widgets it
796 * is in screen coordinates).
797 * @param aRepaint whether the widget should be repainted
799 virtual void ResizeClient(const DesktopRect
& aRect
, bool aRepaint
) = 0;
802 * Sets the widget's z-index.
804 virtual void SetZIndex(int32_t aZIndex
) = 0;
807 * Gets the widget's z-index.
809 int32_t GetZIndex() { return mZIndex
; }
812 * Position this widget just behind the given widget. (Used to
813 * control z-order for top-level widgets. Get/SetZIndex by contrast
814 * control z-order for child widgets of other widgets.)
815 * @param aPlacement top, bottom, or below a widget
816 * (if top or bottom, param aWidget is ignored)
817 * @param aWidget widget to place this widget behind
818 * (only if aPlacement is eZPlacementBelow).
819 * null is equivalent to aPlacement of eZPlacementTop
820 * @param aActivate true to activate the widget after placing it
822 virtual void PlaceBehind(nsTopLevelWidgetZPlacement aPlacement
,
823 nsIWidget
* aWidget
, bool aActivate
) = 0;
826 * Minimize, maximize or normalize the window size.
827 * Takes a value from nsSizeMode (see nsIWidgetListener.h)
829 virtual void SetSizeMode(nsSizeMode aMode
) = 0;
831 virtual void GetWorkspaceID(nsAString
& workspaceID
) = 0;
833 virtual void MoveToWorkspace(const nsAString
& workspaceID
) = 0;
836 * Suppress animations that are applied to a window by OS.
838 virtual void SuppressAnimation(bool aSuppress
) {}
841 * Return size mode (minimized, maximized, normalized).
842 * Returns a value from nsSizeMode (see nsIWidgetListener.h)
844 virtual nsSizeMode
SizeMode() = 0;
847 * Ask whether the window is tiled.
849 virtual bool IsTiled() const = 0;
852 * Ask wether the widget is fully occluded
854 virtual bool IsFullyOccluded() const = 0;
857 * Enable or disable this Widget
859 * @param aState true to enable the Widget, false to disable it.
861 virtual void Enable(bool aState
) = 0;
864 * Ask whether the widget is enabled
866 virtual bool IsEnabled() const = 0;
869 * Whether we should request activation of this widget's toplevel window.
877 * Request activation of this window or give focus to this widget.
879 virtual void SetFocus(Raise
, mozilla::dom::CallerType aCallerType
) = 0;
882 * Get this widget's outside dimensions relative to its parent widget. For
883 * popup widgets the returned rect is in screen coordinates and not
884 * relative to its parent widget.
886 * @return the x, y, width and height of this widget.
888 virtual LayoutDeviceIntRect
GetBounds() = 0;
891 * Get this widget's outside dimensions in device coordinates. This
892 * includes any title bar on the window.
894 * @return the x, y, width and height of this widget.
896 virtual LayoutDeviceIntRect
GetScreenBounds() = 0;
899 * Similar to GetScreenBounds except that this function will always
900 * get the size when the widget is in the nsSizeMode_Normal size mode
901 * even if the current size mode is not nsSizeMode_Normal.
902 * This method will fail if the size mode is not nsSizeMode_Normal and
903 * the platform doesn't have the ability.
904 * This method will always succeed if the current size mode is
907 * @param aRect On return it holds the x, y, width and height of
910 [[nodiscard
]] virtual nsresult
GetRestoredBounds(
911 LayoutDeviceIntRect
& aRect
) = 0;
914 * Get this widget's client area bounds, if the window has a 3D border
915 * appearance this returns the area inside the border. The position is the
916 * position of the client area relative to the client area of the parent
917 * widget (for root widgets and popup widgets it is in screen coordinates).
919 * @return the x, y, width and height of the client area of this widget.
921 virtual LayoutDeviceIntRect
GetClientBounds() = 0;
924 * Sets the non-client area dimensions of the window. Pass -1 to restore
925 * the system default frame size for that border. Pass zero to remove
926 * a border, or pass a specific value adjust a border. Units are in
927 * pixels. (DPI dependent)
930 * Windows: shrinking top non-client height will remove application
931 * icon and window title text. Glass desktops will refuse to set
932 * dimensions between zero and size < system default.
934 virtual nsresult
SetNonClientMargins(const LayoutDeviceIntMargin
&) = 0;
937 * Sets the region around the edges of the window that can be dragged to
938 * resize the window. All four sides of the window will get the same margin.
940 virtual void SetResizeMargin(mozilla::LayoutDeviceIntCoord aResizeMargin
) = 0;
942 * Get the client offset from the window origin.
944 * @return the x and y of the offset.
946 virtual LayoutDeviceIntPoint
GetClientOffset() = 0;
949 * Returns the slop from the screen edges in device pixels.
950 * @see Window.screenEdgeSlop{X,Y}
952 virtual LayoutDeviceIntPoint
GetScreenEdgeSlop() { return {}; }
955 * Equivalent to GetClientBounds but only returns the size.
957 virtual LayoutDeviceIntSize
GetClientSize() {
958 // Depending on the backend, overloading this method may be useful if
959 // requesting the client offset is expensive.
960 return GetClientBounds().Size();
964 * Set the background color for this widget
966 * @param aColor the new background color
970 virtual void SetBackgroundColor(const nscolor
& aColor
) {}
973 * If a cursor type is currently cached locally for this widget, clear the
974 * cached cursor to force an update on the next SetCursor call.
977 virtual void ClearCachedCursor() = 0;
980 // The system cursor chosen by the page. This is used if there's no custom
981 // cursor, or if we fail to use the custom cursor in some way (if the image
982 // fails to load, for example).
983 nsCursor mDefaultCursor
= eCursor_standard
;
984 // May be null, to represent no custom cursor image.
985 nsCOMPtr
<imgIContainer
> mContainer
;
986 uint32_t mHotspotX
= 0;
987 uint32_t mHotspotY
= 0;
988 mozilla::ImageResolution mResolution
;
990 bool IsCustom() const { return !!mContainer
; }
992 bool operator==(const Cursor
& aOther
) const {
993 return mDefaultCursor
== aOther
.mDefaultCursor
&&
994 mContainer
.get() == aOther
.mContainer
.get() &&
995 mHotspotX
== aOther
.mHotspotX
&& mHotspotY
== aOther
.mHotspotY
&&
996 mResolution
== aOther
.mResolution
;
999 bool operator!=(const Cursor
& aOther
) const { return !(*this == aOther
); }
1003 * Sets the cursor for this widget.
1005 virtual void SetCursor(const Cursor
&) = 0;
1007 virtual void SetCustomCursorAllowed(bool) = 0;
1009 static nsIntSize
CustomCursorSize(const Cursor
&);
1012 * Get the window type of this widget.
1014 WindowType
GetWindowType() const { return mWindowType
; }
1017 * Set the transparency mode of the top-level window containing this widget.
1018 * So, e.g., if you call this on the widget for an IFRAME, the top level
1019 * browser window containing the IFRAME actually gets set. Be careful.
1021 * This can fail if the platform doesn't support
1022 * transparency/glass. By default widgets are not
1023 * transparent. This will also fail if the toplevel window is not
1024 * a Mozilla window, e.g., if the widget is in an embedded
1027 * After transparency/glass has been enabled, the initial alpha channel
1028 * value for all pixels is 1, i.e., opaque.
1029 * If the window is resized then the alpha channel values for
1030 * all pixels are reset to 1.
1031 * Pixel RGB color values are already premultiplied with alpha channel values.
1033 virtual void SetTransparencyMode(TransparencyMode aMode
) = 0;
1036 * Get the transparency mode of the top-level window that contains this
1039 virtual TransparencyMode
GetTransparencyMode() = 0;
1042 * Set the shadow style of the window.
1044 * Ignored on child widgets and on non-Mac platforms.
1046 virtual void SetWindowShadowStyle(mozilla::WindowShadow aStyle
) = 0;
1049 * Set the opacity of the window.
1050 * Values need to be between 0.0f (invisible) and 1.0f (fully opaque).
1052 * Ignored on child widgets and on non-Mac platforms.
1054 virtual void SetWindowOpacity(float aOpacity
) {}
1057 * Set the transform of the window. Values are in device pixels,
1058 * the origin is the top left corner of the window.
1060 * Ignored on child widgets and on non-Mac platforms.
1062 virtual void SetWindowTransform(const mozilla::gfx::Matrix
& aTransform
) {}
1065 * Set the preferred color-scheme for the widget.
1066 * Ignored on non-Mac platforms.
1068 virtual void SetColorScheme(const mozilla::Maybe
<mozilla::ColorScheme
>&) {}
1071 * Set whether the window should ignore mouse events or not, and if it should
1072 * not, what input margin should it use.
1074 * This is only used on popup windows. The margin is only implemented on
1077 struct InputRegion
{
1078 bool mFullyTransparent
= false;
1079 mozilla::LayoutDeviceIntCoord mMargin
= 0;
1081 virtual void SetInputRegion(const InputRegion
&) {}
1084 * On macOS, this method shows or hides the pill button in the titlebar
1085 * that's used to collapse the toolbar.
1087 * Ignored on child widgets and on non-Mac platforms.
1089 virtual void SetShowsToolbarButton(bool aShow
) = 0;
1092 * On macOS, this method determines whether we tell cocoa that the window
1093 * supports native full screen. If we do so, and another window is in
1094 * native full screen, this window will also appear in native full screen.
1096 * We generally only want to do this for primary application windows.
1098 * Ignored on child widgets and on non-Mac platforms.
1100 virtual void SetSupportsNativeFullscreen(bool aSupportsNativeFullscreen
) = 0;
1102 enum WindowAnimationType
{
1103 eGenericWindowAnimation
,
1104 eDocumentWindowAnimation
1108 * Sets the kind of top-level window animation this widget should have. On
1109 * macOS, this causes a particular kind of animation to be shown when the
1110 * window is first made visible.
1112 * Ignored on child widgets and on non-Mac platforms.
1114 virtual void SetWindowAnimationType(WindowAnimationType aType
) = 0;
1117 * Specifies whether the window title should be drawn even if the window
1118 * contents extend into the titlebar. Ignored on windows that don't draw
1119 * in the titlebar. Only implemented on macOS.
1121 virtual void SetDrawsTitle(bool aDrawTitle
) {}
1124 * Hide window chrome (borders, buttons) for this widget.
1127 virtual void HideWindowChrome(bool aShouldHide
) = 0;
1129 enum FullscreenTransitionStage
{
1130 eBeforeFullscreenToggle
,
1131 eAfterFullscreenToggle
1135 * Prepares for fullscreen transition and returns whether the widget
1136 * supports fullscreen transition. If this method returns false,
1137 * PerformFullscreenTransition() must never be called. Otherwise,
1138 * caller should call that method twice with "before" and "after"
1139 * stages respectively in order. In the latter case, this method may
1140 * return some data via aData pointer. Caller must pass that data to
1141 * PerformFullscreenTransition() if any, and caller is responsible
1142 * for releasing that data.
1144 virtual bool PrepareForFullscreenTransition(nsISupports
** aData
) = 0;
1147 * Performs fullscreen transition. This method returns immediately,
1148 * and will post aCallback to the main thread when the transition
1151 virtual void PerformFullscreenTransition(FullscreenTransitionStage aStage
,
1154 nsIRunnable
* aCallback
) = 0;
1157 * Perform any actions needed after the fullscreen transition has ended.
1159 virtual void CleanupFullscreenTransition() = 0;
1162 * Return the screen the widget is in, or null if we don't know.
1164 virtual already_AddRefed
<Screen
> GetWidgetScreen() = 0;
1167 * Put the toplevel window into or out of fullscreen mode.
1169 * @return NS_OK if the widget is setup properly for fullscreen and
1170 * FullscreenChanged callback has been or will be called. If other
1171 * value is returned, the caller should continue the change itself.
1173 virtual nsresult
MakeFullScreen(bool aFullScreen
) = 0;
1176 * Same as MakeFullScreen, except that, on systems which natively
1177 * support fullscreen transition, calling this method explicitly
1178 * requests that behavior.
1179 * It is currently only supported on macOS 10.7+.
1181 virtual nsresult
MakeFullScreenWithNativeTransition(bool aFullScreen
) {
1182 return MakeFullScreen(aFullScreen
);
1186 * Invalidate a specified rect for a widget so that it will be repainted
1189 virtual void Invalidate(const LayoutDeviceIntRect
& aRect
) = 0;
1191 enum LayerManagerPersistence
{
1192 LAYER_MANAGER_CURRENT
= 0,
1193 LAYER_MANAGER_PERSISTENT
1197 * Return the widget's LayerManager. The layer tree for that LayerManager is
1198 * what gets rendered to the widget.
1200 * Note that this tries to create a renderer if it doesn't exist.
1202 virtual WindowRenderer
* GetWindowRenderer() = 0;
1205 * Returns whether there's an existing window renderer.
1207 virtual bool HasWindowRenderer() const = 0;
1210 * Called before each layer manager transaction to allow any preparation
1211 * for DrawWindowUnderlay/Overlay that needs to be on the main thread.
1213 * Always called on the main thread.
1215 virtual void PrepareWindowEffects() = 0;
1218 * Called when Gecko knows which themed widgets exist in this window.
1219 * The passed array contains an entry for every themed widget of the right
1220 * type (currently only StyleAppearance::Toolbar) within the window, except
1221 * for themed widgets which are transformed or have effects applied to them
1222 * (e.g. CSS opacity or filters).
1223 * This could sometimes be called during display list construction
1224 * outside of painting.
1225 * If called during painting, it will be called before we actually
1228 virtual void UpdateThemeGeometries(
1229 const nsTArray
<ThemeGeometry
>& aThemeGeometries
) = 0;
1232 * Informs the widget about the region of the window that is opaque.
1234 * @param aOpaqueRegion the region of the window that is opaque.
1236 virtual void UpdateOpaqueRegion(const LayoutDeviceIntRegion
& aOpaqueRegion
) {}
1239 * Informs the widget about the region of the window that is draggable.
1241 virtual void UpdateWindowDraggingRegion(
1242 const LayoutDeviceIntRegion
& aRegion
) {}
1245 * Tells the widget whether the given input block results in a swipe.
1246 * Should be called in response to a WidgetWheelEvent that has
1247 * mFlags.mCanTriggerSwipe set on it.
1249 virtual void ReportSwipeStarted(uint64_t aInputBlockId
, bool aStartSwipe
) {}
1256 virtual void AddChild(nsIWidget
* aChild
) = 0;
1257 virtual void RemoveChild(nsIWidget
* aChild
) = 0;
1258 virtual void* GetNativeData(uint32_t aDataType
) = 0;
1259 virtual void FreeNativeData(void* data
, uint32_t aDataType
) = 0; //~~~
1264 * Set the widget's title.
1265 * Must be called after Create.
1267 * @param aTitle string displayed as the title of the widget
1269 virtual nsresult
SetTitle(const nsAString
& aTitle
) = 0;
1272 * Set the widget's icon.
1273 * Must be called after Create.
1275 * @param aIconSpec string specifying the icon to use; convention is to
1276 * pass a resource: URL from which a platform-dependent
1277 * resource file name will be constructed
1279 virtual void SetIcon(const nsAString
& aIconSpec
) = 0;
1282 * Return this widget's origin in screen coordinates.
1284 * @return screen coordinates stored in the x,y members
1286 virtual LayoutDeviceIntPoint
WidgetToScreenOffset() = 0;
1289 * The same as WidgetToScreenOffset(), except in the case of
1290 * PuppetWidget where this method omits the chrome offset.
1292 virtual LayoutDeviceIntPoint
TopLevelWidgetToScreenOffset() {
1293 return WidgetToScreenOffset();
1297 * For a PuppetWidget, returns the transform from the coordinate
1298 * space of the PuppetWidget to the coordinate space of the
1299 * top-level native widget.
1301 * Identity transform in other cases.
1303 virtual mozilla::LayoutDeviceToLayoutDeviceMatrix4x4
1304 WidgetToTopLevelWidgetTransform() {
1305 return mozilla::LayoutDeviceToLayoutDeviceMatrix4x4();
1308 mozilla::LayoutDeviceIntPoint
WidgetToTopLevelWidgetOffset() {
1309 return mozilla::LayoutDeviceIntPoint::Round(
1310 WidgetToTopLevelWidgetTransform().TransformPoint(
1311 mozilla::LayoutDevicePoint()));
1315 * Returns the margins that are applied to go from client sizes to window
1316 * sizes (which includes window borders and titlebar).
1317 * This method should work even when the window is not yet visible.
1319 virtual LayoutDeviceIntMargin
ClientToWindowMargin() { return {}; }
1321 LayoutDeviceIntSize
ClientToWindowSizeDifference();
1324 * Dispatches an event to the widget
1326 virtual nsresult
DispatchEvent(mozilla::WidgetGUIEvent
* event
,
1327 nsEventStatus
& aStatus
) = 0;
1330 * Dispatches an event to APZ only.
1331 * No-op in the child process.
1333 virtual void DispatchEventToAPZOnly(mozilla::WidgetInputEvent
* aEvent
) = 0;
1336 * Dispatch a gecko event for this widget.
1337 * Returns true if it's consumed. Otherwise, false.
1339 virtual bool DispatchWindowEvent(mozilla::WidgetGUIEvent
& event
) = 0;
1341 // A structure that groups the statuses from APZ dispatch and content
1343 struct ContentAndAPZEventStatus
{
1344 // Either of these may not be set if the event was not dispatched
1345 // to APZ or to content.
1346 nsEventStatus mApzStatus
= nsEventStatus_eIgnore
;
1347 nsEventStatus mContentStatus
= nsEventStatus_eIgnore
;
1351 * Dispatches an event that must be handled by APZ first, when APZ is
1352 * enabled. If invoked in the child process, it is forwarded to the
1353 * parent process synchronously.
1355 virtual ContentAndAPZEventStatus
DispatchInputEvent(
1356 mozilla::WidgetInputEvent
* aEvent
) = 0;
1359 * Confirm an APZ-aware event target. This should be used when APZ will
1360 * not need a layers update to process the event.
1362 virtual void SetConfirmedTargetAPZC(
1363 uint64_t aInputBlockId
,
1364 const nsTArray
<ScrollableLayerGuid
>& aTargets
) const = 0;
1367 * Returns true if APZ is in use, false otherwise.
1369 virtual bool AsyncPanZoomEnabled() const = 0;
1373 virtual void SwipeFinished() = 0;
1376 * Enables the dropping of files to a widget.
1378 virtual void EnableDragDrop(bool aEnable
) = 0;
1379 virtual nsresult
AsyncEnableDragDrop(bool aEnable
) = 0;
1382 * Classify the window for the window manager. Mostly for X11.
1384 * @param xulWinType The window type. Characters other than [A-Za-z0-9_-] are
1385 * converted to '_'. Anything before the first colon is
1386 * assigned to name, anything after it to role. If there's
1387 * no colon, assign the whole thing to both role and name.
1389 * @param xulWinClass The window class. If set, overrides the normal value.
1390 * Otherwise, the program class it used.
1392 * @param xulWinName The window name. If set, overrides the value specified in
1393 * window type. Otherwise, name from window type is used.
1396 virtual void SetWindowClass(const nsAString
& xulWinType
,
1397 const nsAString
& xulWinClass
,
1398 const nsAString
& xulWinName
) = 0;
1401 * Enables/Disables system capture of any and all events that would cause a
1402 * popup to be rolled up. aListener should be set to a non-null value for
1403 * any popups that are not managed by the popup manager.
1404 * @param aDoCapture true enables capture, false disables capture
1407 virtual void CaptureRollupEvents(bool aDoCapture
) = 0;
1410 * Bring this window to the user's attention. This is intended to be a more
1411 * gentle notification than popping the window to the top or putting up an
1412 * alert. See, for example, Win32 FlashWindow or the NotificationManager on
1413 * the Mac. The notification should be suppressed if the window is already
1414 * in the foreground and should be dismissed when the user brings this window
1415 * to the foreground.
1416 * @param aCycleCount Maximum number of times to animate the window per system
1417 * conventions. If set to -1, cycles indefinitely until
1418 * window is brought into the foreground.
1420 [[nodiscard
]] virtual nsresult
GetAttention(int32_t aCycleCount
) = 0;
1423 * Ask whether there user input events pending. All input events are
1424 * included, including those not targeted at this nsIwidget instance.
1426 virtual bool HasPendingInputEvent() = 0;
1429 * Determine whether the widget shows a resize widget. If it does,
1430 * aResizerRect returns the resizer's rect.
1432 * Returns false on any platform that does not support it.
1434 * @param aResizerRect The resizer's rect in device pixels.
1435 * @return Whether a resize widget is shown.
1437 virtual bool ShowsResizeIndicator(LayoutDeviceIntRect
* aResizerRect
) = 0;
1439 // TODO: Make this an enum class with MOZ_MAKE_ENUM_CLASS_BITWISE_OPERATORS or
1441 enum Modifiers
: uint32_t {
1442 NO_MODIFIERS
= 0x00000000,
1443 CAPS_LOCK
= 0x00000001, // when CapsLock is active
1444 NUM_LOCK
= 0x00000002, // when NumLock is active
1445 SHIFT_L
= 0x00000100,
1446 SHIFT_R
= 0x00000200,
1447 CTRL_L
= 0x00000400,
1448 CTRL_R
= 0x00000800,
1449 ALT_L
= 0x00001000, // includes Option
1451 COMMAND_L
= 0x00004000,
1452 COMMAND_R
= 0x00008000,
1454 ALTGRAPH
= 0x00020000, // AltGr key on Windows. This emulates
1455 // AltRight key behavior of keyboard
1456 // layouts which maps AltGr to AltRight
1458 FUNCTION
= 0x00100000,
1459 NUMERIC_KEY_PAD
= 0x01000000 // when the key is coming from the keypad
1462 * Utility method intended for testing. Dispatches native key events
1463 * to this widget to simulate the press and release of a key.
1464 * @param aNativeKeyboardLayout a *platform-specific* constant.
1465 * On Mac, this is the resource ID for a 'uchr' or 'kchr' resource.
1466 * On Windows, it is converted to a hex string and passed to
1467 * LoadKeyboardLayout, see
1468 * http://msdn.microsoft.com/en-us/library/ms646305(VS.85).aspx
1469 * @param aNativeKeyCode a *platform-specific* keycode.
1470 * On Windows, this is the virtual key code.
1471 * @param aModifiers some combination of the above 'Modifiers' flags;
1472 * not all flags will apply to all platforms. Mac ignores the _R
1473 * modifiers. Windows ignores COMMAND, NUMERIC_KEY_PAD, HELP and
1475 * @param aCharacters characters that the OS would decide to generate
1476 * from the event. On Windows, this is the charCode passed by
1478 * @param aUnmodifiedCharacters characters that the OS would decide
1479 * to generate from the event if modifier keys (other than shift)
1480 * were assumed inactive. Needed on Mac, ignored on Windows.
1481 * @param aObserver the observer that will get notified once the events
1482 * have been dispatched.
1483 * @return NS_ERROR_NOT_AVAILABLE to indicate that the keyboard
1484 * layout is not supported and the event was not fired
1486 virtual nsresult
SynthesizeNativeKeyEvent(
1487 int32_t aNativeKeyboardLayout
, int32_t aNativeKeyCode
,
1488 uint32_t aModifierFlags
, const nsAString
& aCharacters
,
1489 const nsAString
& aUnmodifiedCharacters
, nsIObserver
* aObserver
) = 0;
1492 * Utility method intended for testing. Dispatches native mouse events
1493 * may even move the mouse cursor. On Mac the events are guaranteed to
1494 * be sent to the window containing this widget, but on Windows they'll go
1495 * to whatever's topmost on the screen at that position, so for
1496 * cross-platform testing ensure that your window is at the top of the
1498 * @param aPoint screen location of the mouse, in device
1499 * pixels, with origin at the top left
1500 * @param aNativeMessage abstract native message.
1501 * @param aButton Mouse button defined by DOM UI Events.
1502 * @param aModifierFlags Some values of nsIWidget::Modifiers.
1503 * FYI: On Windows, Android and Headless widget on all
1504 * platroms, this hasn't been handled yet.
1505 * @param aObserver the observer that will get notified once the events
1506 * have been dispatched.
1508 enum class NativeMouseMessage
: uint32_t {
1509 ButtonDown
, // button down
1510 ButtonUp
, // button up
1511 Move
, // mouse cursor move
1512 EnterWindow
, // mouse cursor comes into a window
1513 LeaveWindow
, // mouse cursor leaves from a window
1515 virtual nsresult
SynthesizeNativeMouseEvent(
1516 LayoutDeviceIntPoint aPoint
, NativeMouseMessage aNativeMessage
,
1517 mozilla::MouseButton aButton
, nsIWidget::Modifiers aModifierFlags
,
1518 nsIObserver
* aObserver
) = 0;
1521 * A shortcut to SynthesizeNativeMouseEvent, abstracting away the native
1522 * message. aPoint is location in device pixels to which the mouse pointer
1524 * @param aObserver the observer that will get notified once the events
1525 * have been dispatched.
1527 virtual nsresult
SynthesizeNativeMouseMove(LayoutDeviceIntPoint aPoint
,
1528 nsIObserver
* aObserver
) = 0;
1531 * Utility method intended for testing. Dispatching native mouse scroll
1532 * events may move the mouse cursor.
1534 * @param aPoint Mouse cursor position in screen coordinates.
1535 * In device pixels, the origin at the top left of
1536 * the primary display.
1537 * @param aNativeMessage Platform native message.
1538 * @param aDeltaX The delta value for X direction. If the native
1539 * message doesn't indicate X direction scrolling,
1540 * this may be ignored.
1541 * @param aDeltaY The delta value for Y direction. If the native
1542 * message doesn't indicate Y direction scrolling,
1543 * this may be ignored.
1544 * @param aDeltaZ The delta value for Z direction. If the native
1545 * message doesn't indicate Z direction scrolling,
1546 * this may be ignored.
1547 * @param aModifierFlags Must be values of Modifiers, or zero.
1548 * @param aAdditionalFlags See nsIDOMWidnowUtils' consts and their
1550 * @param aObserver The observer that will get notified once the
1551 * events have been dispatched.
1553 virtual nsresult
SynthesizeNativeMouseScrollEvent(
1554 LayoutDeviceIntPoint aPoint
, uint32_t aNativeMessage
, double aDeltaX
,
1555 double aDeltaY
, double aDeltaZ
, uint32_t aModifierFlags
,
1556 uint32_t aAdditionalFlags
, nsIObserver
* aObserver
) = 0;
1559 * TouchPointerState states for SynthesizeNativeTouchPoint. Match
1560 * touch states in nsIDOMWindowUtils.idl.
1562 enum TouchPointerState
{
1563 // The pointer is in a hover state above the digitizer
1564 TOUCH_HOVER
= (1 << 0),
1565 // The pointer is in contact with the digitizer
1566 TOUCH_CONTACT
= (1 << 1),
1567 // The pointer has been removed from the digitizer detection area
1568 TOUCH_REMOVE
= (1 << 2),
1569 // The pointer has been canceled. Will cancel any pending os level
1570 // gestures that would triggered as a result of completion of the
1571 // input sequence. This may not cancel moz platform related events
1572 // that might get tirggered by input already delivered.
1573 TOUCH_CANCEL
= (1 << 3),
1575 // ALL_BITS used for validity checking during IPC serialization
1576 ALL_BITS
= (1 << 4) - 1
1579 * TouchpadGesturePhase states for SynthesizeNativeTouchPadPinch and
1580 * SynthesizeNativeTouchpadPan. Match phase states in nsIDOMWindowUtils.idl.
1582 enum TouchpadGesturePhase
{
1588 * Create a new or update an existing touch pointer on the digitizer.
1589 * To trigger os level gestures, individual touch points should
1590 * transition through a complete set of touch states which should be
1591 * sent as individual messages.
1593 * @param aPointerId The touch point id to create or update.
1594 * @param aPointerState one or more of the touch states listed above
1595 * @param aPoint coords of this event
1596 * @param aPressure 0.0 -> 1.0 float val indicating pressure
1597 * @param aOrientation 0 -> 359 degree value indicating the
1598 * orientation of the pointer. Use 90 for normal taps.
1599 * @param aObserver The observer that will get notified once the events
1600 * have been dispatched.
1602 virtual nsresult
SynthesizeNativeTouchPoint(uint32_t aPointerId
,
1603 TouchPointerState aPointerState
,
1604 LayoutDeviceIntPoint aPoint
,
1605 double aPointerPressure
,
1606 uint32_t aPointerOrientation
,
1607 nsIObserver
* aObserver
) = 0;
1609 * See nsIDOMWindowUtils.sendNativeTouchpadPinch().
1611 virtual nsresult
SynthesizeNativeTouchPadPinch(
1612 TouchpadGesturePhase aEventPhase
, float aScale
,
1613 LayoutDeviceIntPoint aPoint
, int32_t aModifierFlags
) = 0;
1616 * Helper for simulating a simple tap event with one touch point. When
1617 * aLongTap is true, simulates a native long tap with a duration equal to
1618 * ui.click_hold_context_menus.delay. This pref is compatible with the
1619 * apzc long tap duration. Defaults to 1.5 seconds.
1620 * @param aObserver The observer that will get notified once the events
1621 * have been dispatched.
1623 virtual nsresult
SynthesizeNativeTouchTap(LayoutDeviceIntPoint aPoint
,
1625 nsIObserver
* aObserver
);
1627 virtual nsresult
SynthesizeNativePenInput(uint32_t aPointerId
,
1628 TouchPointerState aPointerState
,
1629 LayoutDeviceIntPoint aPoint
,
1631 uint32_t aRotation
, int32_t aTiltX
,
1632 int32_t aTiltY
, int32_t aButton
,
1633 nsIObserver
* aObserver
) = 0;
1636 * Cancels all active simulated touch input points and pending long taps.
1637 * Native widgets should track existing points such that they can clear the
1638 * digitizer state when this call is made.
1639 * @param aObserver The observer that will get notified once the touch
1640 * sequence has been cleared.
1642 virtual nsresult
ClearNativeTouchSequence(nsIObserver
* aObserver
);
1645 * Send a native event as if the user double tapped the touchpad with two
1648 virtual nsresult
SynthesizeNativeTouchpadDoubleTap(
1649 LayoutDeviceIntPoint aPoint
, uint32_t aModifierFlags
) = 0;
1652 * See nsIDOMWindowUtils.sendNativeTouchpadPan().
1654 virtual nsresult
SynthesizeNativeTouchpadPan(TouchpadGesturePhase aEventPhase
,
1655 LayoutDeviceIntPoint aPoint
,
1656 double aDeltaX
, double aDeltaY
,
1657 int32_t aModifierFlags
,
1658 nsIObserver
* aObserver
) = 0;
1660 virtual void StartAsyncScrollbarDrag(
1661 const AsyncDragMetrics
& aDragMetrics
) = 0;
1664 * Notify APZ to start autoscrolling.
1665 * @param aAnchorLocation the location of the autoscroll anchor
1666 * @param aGuid identifies the scroll frame to be autoscrolled
1667 * @return true if APZ has been successfully notified
1669 virtual bool StartAsyncAutoscroll(const ScreenPoint
& aAnchorLocation
,
1670 const ScrollableLayerGuid
& aGuid
) = 0;
1673 * Notify APZ to stop autoscrolling.
1674 * @param aGuid identifies the scroll frame which is being autoscrolled.
1676 virtual void StopAsyncAutoscroll(const ScrollableLayerGuid
& aGuid
) = 0;
1678 virtual LayersId
GetRootLayerTreeId() = 0;
1680 // If this widget supports out-of-process compositing, it can override
1681 // this method to provide additional information to the compositor.
1682 virtual void GetCompositorWidgetInitData(
1683 mozilla::widget::CompositorWidgetInitData
* aInitData
) {}
1686 * Setter/Getter of the system font setting for testing.
1688 virtual nsresult
SetSystemFont(const nsCString
& aFontName
) {
1689 return NS_ERROR_NOT_IMPLEMENTED
;
1691 virtual nsresult
GetSystemFont(nsCString
& aFontName
) {
1692 return NS_ERROR_NOT_IMPLEMENTED
;
1696 * Wayland specific routines.
1698 virtual LayoutDeviceIntSize
GetMoveToRectPopupSize() const {
1699 NS_WARNING("GetLayoutPopupRect implemented only for wayland");
1700 return LayoutDeviceIntSize();
1704 * If this widget uses native pointer lock instead of warp-to-center
1705 * (currently only GTK on Wayland), these methods provide access to that
1708 virtual void SetNativePointerLockCenter(
1709 const LayoutDeviceIntPoint
& aLockCenter
) {}
1710 virtual void LockNativePointer() {}
1711 virtual void UnlockNativePointer() {}
1714 * Get safe area insets except to cutout.
1715 * See https://drafts.csswg.org/css-env-1/#safe-area-insets.
1717 virtual mozilla::ScreenIntMargin
GetSafeAreaInsets() const {
1718 return mozilla::ScreenIntMargin();
1724 LongTapInfo(int32_t aPointerId
, LayoutDeviceIntPoint
& aPoint
,
1725 mozilla::TimeDuration aDuration
, nsIObserver
* aObserver
)
1726 : mPointerId(aPointerId
),
1728 mDuration(aDuration
),
1729 mObserver(aObserver
),
1730 mStamp(mozilla::TimeStamp::Now()) {}
1733 LayoutDeviceIntPoint mPosition
;
1734 mozilla::TimeDuration mDuration
;
1735 nsCOMPtr
<nsIObserver
> mObserver
;
1736 mozilla::TimeStamp mStamp
;
1739 static void OnLongTapTimerCallback(nsITimer
* aTimer
, void* aClosure
);
1741 static already_AddRefed
<nsIBidiKeyboard
> CreateBidiKeyboardContentProcess();
1742 static already_AddRefed
<nsIBidiKeyboard
> CreateBidiKeyboardInner();
1744 mozilla::UniquePtr
<LongTapInfo
> mLongTapTouchPoint
;
1745 nsCOMPtr
<nsITimer
> mLongTapTimer
;
1746 static int32_t sPointerIdCounter
;
1750 * If key events have not been handled by content or XBL handlers, they can
1751 * be offered to the system (for custom application shortcuts set in system
1752 * preferences, for example).
1754 virtual void PostHandleKeyEvent(mozilla::WidgetKeyboardEvent
* aEvent
);
1757 * Activates a native menu item at the position specified by the index
1758 * string. The index string is a string of positive integers separated
1759 * by the "|" (pipe) character. The last integer in the string represents
1760 * the item index in a submenu located using the integers preceding it.
1763 * In this string, the first integer represents the top-level submenu
1764 * in the native menu bar. Since the integer is 1, it is the second submeu
1765 * in the native menu bar. Within that, the first item (index 0) is a
1766 * submenu, and we want to activate the 5th item within that submenu.
1768 virtual nsresult
ActivateNativeMenuItemAt(const nsAString
& indexString
) = 0;
1771 * This is used for native menu system testing.
1773 * Updates a native menu at the position specified by the index string.
1774 * The index string is a string of positive integers separated by the "|"
1778 * In this string, the first integer represents the top-level submenu
1779 * in the native menu bar. Since the integer is 1, it is the second submeu
1780 * in the native menu bar. Within that, the first item (index 0) is a
1781 * submenu, and we want to update submenu at index 4 within that submenu.
1783 * If this is called with an empty string it forces a full reload of the
1786 virtual nsresult
ForceUpdateNativeMenuAt(const nsAString
& indexString
) = 0;
1789 * This is used for testing macOS service menu code.
1791 * @param aResult - the current text selection. Is empty if no selection.
1792 * @return nsresult - whether or not aResult was assigned the selected text.
1794 [[nodiscard
]] virtual nsresult
GetSelectionAsPlaintext(nsAString
& aResult
) {
1795 return NS_ERROR_NOT_IMPLEMENTED
;
1799 * Notify IME of the specified notification.
1801 * @return If the notification is mouse button event and it's consumed by
1802 * IME, this returns NS_SUCCESS_EVENT_CONSUMED.
1804 virtual nsresult
NotifyIME(const IMENotification
& aIMENotification
) = 0;
1807 * MaybeDispatchInitialFocusEvent will dispatch a focus event after creation
1808 * of the widget, in the event that we were not able to observe and respond to
1809 * the initial focus event. This is necessary for the early skeleton UI
1810 * window, which is displayed and receives its initial focus event before we
1811 * can actually respond to it.
1813 virtual void MaybeDispatchInitialFocusEvent() {}
1816 * Notifies the input context changes.
1818 virtual void SetInputContext(const InputContext
& aContext
,
1819 const InputContextAction
& aAction
) = 0;
1822 * Get current input context.
1824 virtual InputContext
GetInputContext() = 0;
1827 * Get native IME context. This is different from GetNativeData() with
1828 * NS_RAW_NATIVE_IME_CONTEXT, the result is unique even if in a remote
1831 virtual NativeIMEContext
GetNativeIMEContext() = 0;
1834 * Given a WidgetKeyboardEvent, this method synthesizes a corresponding
1835 * native (OS-level) event for it. This method allows tests to simulate
1836 * keystrokes that trigger native key bindings (which require a native
1839 [[nodiscard
]] virtual nsresult
AttachNativeKeyEvent(
1840 mozilla::WidgetKeyboardEvent
& aEvent
) = 0;
1843 * Retrieve edit commands when the key combination of aEvent is used
1844 * in platform native applications.
1846 MOZ_CAN_RUN_SCRIPT
virtual bool GetEditCommands(
1847 mozilla::NativeKeyBindingsType aType
,
1848 const mozilla::WidgetKeyboardEvent
& aEvent
,
1849 nsTArray
<mozilla::CommandInt
>& aCommands
);
1852 * Retrieves a reference to notification requests of IME. Note that the
1853 * reference is valid while the nsIWidget instance is alive. So, if you
1854 * need to store the reference for a long time, you need to grab the widget
1857 const IMENotificationRequests
& IMENotificationRequestsRef();
1860 * Call this method when a dialog is opened which has a default button.
1861 * The button's rectangle should be supplied in aButtonRect.
1863 [[nodiscard
]] virtual nsresult
OnDefaultButtonLoaded(
1864 const LayoutDeviceIntRect
& aButtonRect
) = 0;
1867 * Return true if this process shouldn't use platform widgets, and
1868 * so should use PuppetWidgets instead. If this returns true, the
1869 * result of creating and using a platform widget is undefined,
1870 * and likely to end in crashes or other buggy behavior.
1872 static bool UsePuppetWidgets() { return XRE_IsContentProcess(); }
1874 static already_AddRefed
<nsIWidget
> CreateTopLevelWindow();
1876 static already_AddRefed
<nsIWidget
> CreateChildWindow();
1879 * Allocate and return a "puppet widget" that doesn't directly
1880 * correlate to a platform widget; platform events and data must
1881 * be fed to it. Currently used in content processes. NULL is
1882 * returned if puppet widgets aren't supported in this build
1883 * config, on this platform, or for this process type.
1885 * This function is called "Create" to match CreateInstance().
1886 * The returned widget must still be nsIWidget::Create()d.
1888 static already_AddRefed
<nsIWidget
> CreatePuppetWidget(
1889 BrowserChild
* aBrowserChild
);
1891 static already_AddRefed
<nsIWidget
> CreateHeadlessWidget();
1894 * Reparent this widget's native widget.
1895 * @param aNewParent the native widget of aNewParent is the new native
1898 virtual void ReparentNativeWidget(nsIWidget
* aNewParent
) = 0;
1901 * Return true if widget has it's own GL context
1903 virtual bool HasGLContext() { return false; }
1906 * Returns true to indicate that this widget paints an opaque background
1907 * that we want to be visible under the page, so layout should not force
1908 * a default background.
1910 virtual bool WidgetPaintsBackground() { return false; }
1912 virtual bool NeedsPaint() { return IsVisible() && !GetBounds().IsEmpty(); }
1915 * Get the natural bounds of this widget. This method is only
1916 * meaningful for widgets for which Gecko implements screen
1917 * rotation natively. When this is the case, GetBounds() returns
1918 * the widget bounds taking rotation into account, and
1919 * GetNaturalBounds() returns the bounds *not* taking rotation
1922 * No code outside of the composition pipeline should know or care
1923 * about this. If you're not an agent of the compositor, you
1924 * probably shouldn't call this method.
1926 virtual LayoutDeviceIntRect
GetNaturalBounds() { return GetBounds(); }
1929 * Set size constraints on the window size such that it is never less than
1930 * the specified minimum size and never larger than the specified maximum
1931 * size. The size constraints are sizes of the outer rectangle including
1932 * the window frame and title bar. Use 0 for an unconstrained minimum size
1933 * and NS_MAXSIZE for an unconstrained maximum size. Note that this method
1934 * does not necessarily change the size of a window to conform to this size,
1935 * thus Resize should be called afterwards.
1937 * @param aConstraints: the size constraints in device pixels
1939 virtual void SetSizeConstraints(const SizeConstraints
& aConstraints
) = 0;
1942 * Return the size constraints currently observed by the widget.
1944 * @return the constraints in device pixels
1946 virtual const SizeConstraints
GetSizeConstraints() = 0;
1949 * Apply the current size constraints to the given size.
1951 * @param aWidth width to constrain
1952 * @param aHeight height to constrain
1954 virtual void ConstrainSize(int32_t* aWidth
, int32_t* aHeight
) = 0;
1957 * If this is owned by a BrowserChild, return that. Otherwise return
1960 virtual BrowserChild
* GetOwningBrowserChild() { return nullptr; }
1963 * If this isn't directly compositing to its window surface,
1964 * return the compositor which is doing that on our behalf.
1966 virtual CompositorBridgeChild
* GetRemoteRenderer() { return nullptr; }
1969 * If there is a remote renderer, pause or resume it.
1971 virtual void PauseOrResumeCompositor(bool aPause
);
1974 * Clear WebRender resources
1976 virtual void ClearCachedWebrenderResources() {}
1979 * Clear WebRender animation resources
1981 virtual void ClearWebrenderAnimationResources() {}
1984 * Request fast snapshot at RenderCompositor of WebRender.
1985 * Since readback of Windows DirectComposition is very slow.
1987 virtual bool SetNeedFastSnaphot() { return false; }
1990 * If this widget has its own vsync dispatcher, return it, otherwise return
1991 * nullptr. An example of such a local vsync dispatcher would be Wayland frame
1994 virtual RefPtr
<mozilla::VsyncDispatcher
> GetVsyncDispatcher();
1997 * Returns true if the widget requires synchronous repaints on resize,
2000 virtual bool SynchronouslyRepaintOnResize() { return true; }
2003 * Some platforms (only cocoa right now) round widget coordinates to the
2004 * nearest even pixels (see bug 892994), this function allows us to
2005 * determine how widget coordinates will be rounded.
2007 virtual int32_t RoundsWidgetCoordinatesTo() { return 1; }
2009 virtual void UpdateZoomConstraints(
2010 const uint32_t& aPresShellId
, const ScrollableLayerGuid::ViewID
& aViewId
,
2011 const mozilla::Maybe
<ZoomConstraints
>& aConstraints
){};
2014 * GetTextEventDispatcher() returns TextEventDispatcher belonging to the
2015 * widget. Note that this never returns nullptr.
2017 virtual TextEventDispatcher
* GetTextEventDispatcher() = 0;
2020 * GetNativeTextEventDispatcherListener() returns a
2021 * TextEventDispatcherListener instance which is used when the widget
2022 * instance handles native IME and/or keyboard events.
2024 virtual TextEventDispatcherListener
*
2025 GetNativeTextEventDispatcherListener() = 0;
2028 * Trigger an animation to zoom to the given |aRect|.
2029 * |aRect| should be relative to the layout viewport of the widget's root
2032 virtual void ZoomToRect(const uint32_t& aPresShellId
,
2033 const ScrollableLayerGuid::ViewID
& aViewId
,
2034 const CSSRect
& aRect
, const uint32_t& aFlags
) = 0;
2037 * LookUpDictionary shows the dictionary for the word around current point.
2039 * @param aText the word to look up dictiorary.
2040 * @param aFontRangeArray text decoration of aText
2041 * @param aIsVertical true if the word is vertical layout
2042 * @param aPoint top-left point of aText
2044 virtual void LookUpDictionary(
2045 const nsAString
& aText
,
2046 const nsTArray
<mozilla::FontRange
>& aFontRangeArray
,
2047 const bool aIsVertical
, const LayoutDeviceIntPoint
& aPoint
) {}
2049 virtual void RequestFxrOutput() {
2050 MOZ_ASSERT(false, "This function should only execute in Windows");
2053 #if defined(MOZ_WIDGET_ANDROID)
2055 * RecvToolbarAnimatorMessageFromCompositor receive message from compositor
2058 * @param aMessage message being sent to Android UI thread.
2060 virtual void RecvToolbarAnimatorMessageFromCompositor(int32_t aMessage
) = 0;
2063 * UpdateRootFrameMetrics steady state frame metrics send from compositor
2066 * @param aScrollOffset page scroll offset value in screen pixels.
2067 * @param aZoom current page zoom.
2069 virtual void UpdateRootFrameMetrics(const ScreenPoint
& aScrollOffset
,
2070 const CSSToScreenScale
& aZoom
) = 0;
2073 * RecvScreenPixels Buffer containing the pixel from the frame buffer. Used
2074 * for android robocop tests.
2076 * @param aMem shared memory containing the frame buffer pixels.
2077 * @param aSize size of the buffer in screen pixels.
2079 virtual void RecvScreenPixels(mozilla::ipc::Shmem
&& aMem
,
2080 const ScreenIntSize
& aSize
,
2081 bool aNeedsYFlip
) = 0;
2083 virtual void UpdateDynamicToolbarMaxHeight(mozilla::ScreenIntCoord aHeight
) {}
2084 virtual mozilla::ScreenIntCoord
GetDynamicToolbarMaxHeight() const {
2089 static already_AddRefed
<nsIBidiKeyboard
> CreateBidiKeyboard();
2092 * Like GetDefaultScale, but taking into account only the system settings
2093 * and ignoring Gecko preferences.
2095 virtual double GetDefaultScaleInternal() { return 1.0; }
2097 using WindowButtonType
= mozilla::WindowButtonType
;
2100 * Layout uses this to alert the widget to the client rect representing
2101 * the window maximize button. An empty rect indicates there is no
2102 * maximize button (for example, in fullscreen). This is only implemented
2105 virtual void SetWindowButtonRect(WindowButtonType aButtonType
,
2106 const LayoutDeviceIntRect
& aClientRect
) {}
2109 virtual nsresult
SetHiDPIMode(bool aHiDPI
) {
2110 return NS_ERROR_NOT_IMPLEMENTED
;
2112 virtual nsresult
RestoreHiDPIMode() { return NS_ERROR_NOT_IMPLEMENTED
; }
2116 // keep the list of children. We also keep track of our siblings.
2117 // The ownership model is as follows: parent holds a strong ref to
2118 // the first element of the list, and each element holds a strong
2119 // ref to the next element in the list. The prevsibling and
2120 // lastchild pointers are weak, which is fine as long as they are
2121 // maintained properly.
2122 nsCOMPtr
<nsIWidget
> mFirstChild
;
2123 nsIWidget
* MOZ_NON_OWNING_REF mLastChild
;
2124 nsCOMPtr
<nsIWidget
> mNextSibling
;
2125 nsIWidget
* MOZ_NON_OWNING_REF mPrevSibling
;
2126 // When Destroy() is called, the sub class should set this true.
2127 bool mOnDestroyCalled
;
2128 WindowType mWindowType
;
2132 NS_DEFINE_STATIC_IID_ACCESSOR(nsIWidget
, NS_IWIDGET_IID
)
2134 #endif // nsIWidget_h__