Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
QWindowsForeignWindow Class Reference

Window wrapping a foreign native window. More...

#include <qwindowswindow.h>

+ Inheritance diagram for QWindowsForeignWindow:
+ Collaboration diagram for QWindowsForeignWindow:

Public Member Functions

 QWindowsForeignWindow (QWindow *window, HWND hwnd)
 
void setParent (const QPlatformWindow *window) override
 This function is called to enable native child window in QPA.
 
void setGeometry (const QRect &rect) override
 This function is called by Qt whenever a window is moved or resized using the QWindow API.
 
void setVisible (bool visible) override
 Reimplemented in subclasses to show the surface if visible is true, and hide it if visible is false.
 
void raise () override
 Reimplement to be able to let Qt raise windows to the top of the desktop.
 
void lower () override
 Reimplement to be able to let Qt lower windows to the bottom of the desktop.
 
void setWindowTitle (const QString &title) override
 Reimplement to set the window title to title.
 
bool isForeignWindow () const override
 
- Public Member Functions inherited from QWindowsBaseWindow
 QWindowsBaseWindow (QWindow *window)
 
WId winId () const override
 Reimplement in subclasses to return a handle to the native window.
 
QRect geometry () const override
 Returns the current geometry of a window.
 
QMargins frameMargins () const override
 
QPoint mapToGlobal (const QPoint &pos) const override
 Translates the window coordinate pos to global screen coordinates using native methods.
 
QPoint mapFromGlobal (const QPoint &pos) const override
 Translates the global screen coordinate pos to window coordinates using native methods.
 
virtual QMargins fullFrameMargins () const
 
void setHasBorderInFullScreen (bool border) override
 
bool hasBorderInFullScreen () const override
 
QMargins customMargins () const override
 
void setCustomMargins (const QMargins &margins) override
 
virtual bool isTopLevel () const
 
unsigned style () const
 
unsigned exStyle () const
 
QPlatformScreen * screenForGeometry (const QRect &newGeometry) const
 Helper function for finding the new screen for newGeometry in response to a geometry changed event.
 
- Public Member Functions inherited from QPlatformWindow
 QPlatformWindow (QWindow *window)
 Constructs a platform window with the given top level window.
 
 ~QPlatformWindow () override
 Virtual destructor does not delete its top level window.
 
virtual void initialize ()
 Called as part of QWindow::create(), after constructing the window.
 
QWindow * window () const
 Returns the window which belongs to the QPlatformWindow.
 
QPlatformWindow * parent () const
 Returns the parent platform window (or \nullptr if orphan).
 
QPlatformScreen * screen () const override
 Returns the platform screen handle corresponding to this platform window, or null if the window is not associated with a screen.
 
virtual QSurfaceFormat format () const override
 Returns the actual surface format of the window.
 
virtual QRect normalGeometry () const
 Returns the geometry of a window in 'normal' state (neither maximized, fullscreen nor minimized) for saving geometries to application settings.
 
virtual QMargins safeAreaMargins () const
 The safe area margins of a window represent the area that is safe to place content within, without intersecting areas of the screen where system UI is placed, or where a screen bezel may cover the content.
 
virtual void setWindowFlags (Qt::WindowFlags flags)
 Requests setting the window flags of this surface to flags.
 
virtual void setWindowState (Qt::WindowStates state)
 Requests setting the window state of this surface to type.
 
virtual void setWindowFilePath (const QString &title)
 Reimplement to set the window file path to filePath.
 
virtual void setWindowIcon (const QIcon &icon)
 Reimplement to set the window icon to icon.
 
virtual bool close ()
 Reimplement to let the platform handle non-spontaneous window close.
 
virtual bool isExposed () const
 Returns if this window is exposed in the windowing system.
 
virtual bool isActive () const
 Returns true if the window should appear active from a style perspective.
 
virtual bool isAncestorOf (const QPlatformWindow *child) const
 Returns true if the window is an ancestor of the given child.
 
virtual bool isEmbedded () const
 Returns true if the window is a child of a non-Qt window.
 
QPointF mapToGlobalF (const QPointF &pos) const
 
QPointF mapFromGlobalF (const QPointF &pos) const
 
virtual void propagateSizeHints ()
 Reimplement to propagate the size hints of the QWindow.
 
virtual void setOpacity (qreal level)
 Reimplement to be able to let Qt set the opacity level of a window.
 
virtual void setMask (const QRegion &region)
 Reimplement to be able to let Qt set the mask of a window.
 
virtual void requestActivateWindow ()
 Reimplement to let Qt be able to request activation/focus for a window.
 
virtual void handleContentOrientationChange (Qt::ScreenOrientation orientation)
 Handle changes to the orientation of the platform window's contents.
 
virtual qreal devicePixelRatio () const
 Reimplement this function in subclass to return the device pixel ratio for the window.
 
virtual bool setKeyboardGrabEnabled (bool grab)
 
virtual bool setMouseGrabEnabled (bool grab)
 
virtual bool setWindowModified (bool modified)
 Reimplement to be able to let Qt indicate that the window has been modified.
 
virtual bool windowEvent (QEvent *event)
 Reimplement this method to be able to do any platform specific event handling.
 
virtual bool startSystemResize (Qt::Edges edges)
 Reimplement this method to start a system resize operation if the system supports it and return true to indicate success.
 
virtual bool startSystemMove ()
 Reimplement this method to start a system move operation if the system supports it and return true to indicate success.
 
virtual void setFrameStrutEventsEnabled (bool enabled)
 Reimplement this method to set whether frame strut events should be sent to enabled.
 
virtual bool frameStrutEventsEnabled () const
 Reimplement this method to return whether frame strut events are enabled.
 
virtual void setAlertState (bool enabled)
 Reimplement this method to set whether the window demands attention (for example, by flashing the taskbar icon) depending on enabled.
 
virtual bool isAlertState () const
 Reimplement this method return whether the window is in an alert state.
 
virtual void invalidateSurface ()
 Invalidates the window's surface by releasing its surface buffers.
 
virtual void requestUpdate ()
 Requests an QEvent::UpdateRequest event.
 
bool hasPendingUpdateRequest () const
 Returns true if the window has a pending update request.
 
virtual void deliverUpdateRequest ()
 Delivers an QEvent::UpdateRequest event to the window.
 
QSize windowMinimumSize () const
 Returns the QWindow minimum size.
 
QSize windowMaximumSize () const
 Returns the QWindow maximum size.
 
QSize windowBaseSize () const
 Returns the QWindow base size.
 
QSize windowSizeIncrement () const
 Returns the QWindow size increment.
 
QRect windowGeometry () const
 Returns the QWindow geometry.
 
QRect windowFrameGeometry () const
 Returns the QWindow frame geometry.
 
QRectF windowClosestAcceptableGeometry (const QRectF &nativeRect) const
 
- Public Member Functions inherited from QPlatformSurface
virtual ~QPlatformSurface ()
 
QSurface * surface () const
 

Protected Member Functions

HWND handle () const override
 
- Protected Member Functions inherited from QWindowsBaseWindow
HWND parentHwnd () const
 
bool isTopLevel_sys () const
 
QRect frameGeometry_sys () const
 
QRect geometry_sys () const
 
void setGeometry_sys (const QRect &rect) const
 
QMargins frameMargins_sys () const
 
std::optional< TouchWindowTouchTypes > touchWindowTouchTypes_sys () const
 
void hide_sys ()
 
void raise_sys ()
 
void lower_sys ()
 
void setWindowTitle_sys (const QString &title)
 
- Protected Member Functions inherited from QPlatformWindow
QPlatformScreen * screenForGeometry (const QRect &newGeometry) const
 Helper function for finding the new screen for newGeometry in response to a geometry changed event.
 

Additional Inherited Members

- Public Types inherited from QWindowsBaseWindow
using TouchWindowTouchType = QNativeInterface::Private::QWindowsApplication::TouchWindowTouchType
 
using TouchWindowTouchTypes = QNativeInterface::Private::QWindowsApplication::TouchWindowTouchTypes
 
- Static Public Member Functions inherited from QWindowsBaseWindow
static bool isRtlLayout (HWND hwnd)
 
static QWindowsBaseWindow * baseWindowOf (const QWindow *w)
 
static HWND handleOf (const QWindow *w)
 
- Static Public Member Functions inherited from QPlatformWindow
static QRect initialGeometry (const QWindow *w, const QRect &initialGeometry, int defaultWidth, int defaultHeight, const QScreen **resultingScreenReturn=nullptr)
 Helper function to get initial geometry on windowing systems which do not do smart positioning and also do not provide a means of centering a transient window w.r.t.
 
static QRectF closestAcceptableGeometry (const QWindow *w, const QRectF &nativeRect)
 Returns the closest acceptable geometry for a given geometry before a resize/move event for platforms that support it, for example to implement heightForWidth().
 
- Static Public Member Functions inherited from QPlatformSurface
static bool isRasterSurface (QSurface *surface)
 
- Static Protected Member Functions inherited from QPlatformWindow
static QString formatWindowTitle (const QString &title, const QString &separator)
 Call this method to put together a window title composed of title separator the application display name.
 
static QSize constrainWindowSize (const QSize &size)
 Returns a size with both dimensions bounded to [0, QWINDOWSIZE_MAX].
 
- Protected Attributes inherited from QPlatformWindow
QScopedPointer< QPlatformWindowPrivate > d_ptr
 

Detailed Description

Window wrapping a foreign native window.

QWindowsForeignWindow stores a native HWND and implements getters for geometry, margins, etc. reparenting and geometry manipulation for use as a child window in Qt.

Since
5.6

Definition at line 158 of file qwindowswindow.h.

Constructor & Destructor Documentation

◆ QWindowsForeignWindow()

QWindowsForeignWindow::QWindowsForeignWindow ( QWindow * window,
HWND hwnd )
explicit

Definition at line 1356 of file qwindowswindow.cpp.

References QPlatformWindow::parent(), and setParent().

+ Here is the call graph for this function:

Member Function Documentation

◆ handle()

HWND QWindowsForeignWindow::handle ( ) const
inlineoverrideprotectedvirtual

Implements QWindowsBaseWindow.

Definition at line 172 of file qwindowswindow.h.

Referenced by setVisible().

+ Here is the caller graph for this function:

◆ isForeignWindow()

bool QWindowsForeignWindow::isForeignWindow ( ) const
inlineoverridevirtual

Reimplemented from QPlatformWindow.

Definition at line 169 of file qwindowswindow.h.

◆ lower()

void QWindowsForeignWindow::lower ( )
inlineoverridevirtual

Reimplement to be able to let Qt lower windows to the bottom of the desktop.

Reimplemented from QPlatformWindow.

Definition at line 167 of file qwindowswindow.h.

References QWindowsBaseWindow::lower_sys().

+ Here is the call graph for this function:

◆ raise()

void QWindowsForeignWindow::raise ( )
inlineoverridevirtual

Reimplement to be able to let Qt raise windows to the top of the desktop.

Reimplemented from QPlatformWindow.

Definition at line 166 of file qwindowswindow.h.

References QWindowsBaseWindow::raise_sys().

+ Here is the call graph for this function:

◆ setGeometry()

void QWindowsForeignWindow::setGeometry ( const QRect & rect)
inlineoverridevirtual

This function is called by Qt whenever a window is moved or resized using the QWindow API.

Unless you also override QPlatformWindow::geometry(), you need to call the baseclass implementation of this function in any override of QPlatformWindow::setGeometry(), as QWindow::geometry() is expected to report back the set geometry until a confirmation (or rejection) of the new geometry comes back from the window manager and is reported via QWindowSystemInterface::handleGeometryChange().

Window move/resizes can also be triggered spontaneously by the window manager, or as a response to an earlier requested move/resize via the Qt APIs. There is no need to call this function from the window manager callback, instead call QWindowSystemInterface::handleGeometryChange().

The position(x, y) part of the rect might be inclusive or exclusive of the window frame as returned by frameMargins(). You can detect this in the plugin by checking qt_window_private(window())->positionPolicy.

Reimplemented from QPlatformWindow.

Definition at line 164 of file qwindowswindow.h.

References rect, and QWindowsBaseWindow::setGeometry_sys().

+ Here is the call graph for this function:

◆ setParent()

void QWindowsForeignWindow::setParent ( const QPlatformWindow * parent)
overridevirtual

This function is called to enable native child window in QPA.

It is common not to support this feature in Window systems, but can be faked. When this function is called all geometry of this platform window will be relative to the parent.

Reimplemented from QPlatformWindow.

Definition at line 1365 of file qwindowswindow.cpp.

References debugWinStyle(), QWindowsBaseWindow::isTopLevel(), QWindowsBaseWindow::isTopLevel_sys(), qCDebug, QWindowsBaseWindow::style(), and QPlatformWindow::window().

Referenced by QWindowsForeignWindow().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setVisible()

void QWindowsForeignWindow::setVisible ( bool visible)
overridevirtual

Reimplemented in subclasses to show the surface if visible is true, and hide it if visible is false.

The default implementation sends a synchronous expose event.

Reimplemented from QPlatformWindow.

Definition at line 1387 of file qwindowswindow.cpp.

References handle(), QWindowsBaseWindow::hide_sys(), qCDebug, and QPlatformWindow::window().

+ Here is the call graph for this function:

◆ setWindowTitle()

void QWindowsForeignWindow::setWindowTitle ( const QString & title)
inlineoverridevirtual

Reimplement to set the window title to title.

The implementation might want to append the application display name to the window title, like Windows and Linux do.

See also
QGuiApplication::applicationDisplayName()

Reimplemented from QPlatformWindow.

Definition at line 168 of file qwindowswindow.h.

References QWindowsBaseWindow::setWindowTitle_sys(), and title.

+ Here is the call graph for this function:
The documentation for this class was generated from the following files: