QtWin

PyQt5.QtWinExtras.QtWin

Description

TODO

Enums

HBitmapFormat

This enum defines how the conversion between HBITMAP and QPixmap is performed.

See also

fromHBITMAP()toHBITMAP().

Member	Value	Description
HBitmapAlpha	2	The HBITMAP is treated as having a plain alpha channel. This is the preferred format if the HBITMAP is going to be used as an application icon or a systray icon.
HBitmapNoAlpha	0	The alpha channel is ignored and always treated as being set to fully opaque. This is preferred if the HBITMAP is used with standard GDI calls, such as BitBlt().
HBitmapPremultipliedAlpha	1	The HBITMAP is treated as having an alpha channel and premultiplied colors. This is preferred if the HBITMAP is accessed through the AlphaBlend() GDI function.

---

WindowFlip3DPolicy

This enum type specifies the Flip3D window policy.

See also

setWindowFlip3DPolicy().

Member	Value	Description
FlipDefault	0	Let the OS decide whether to include the window in the Flip3D rendering.
FlipExcludeAbove	2	Exclude the window from Flip3D and display it above the Flip3D rendering.
FlipExcludeBelow	1	Exclude the window from Flip3D and display it below the Flip3D rendering.

Methods

@staticmethod
colorizationColor() → (QColor, bool)

TODO

---

@staticmethod
createMask(QBitmap) → sip.voidptr

TODO

---

@staticmethod
disableBlurBehindWindow(QWindow)

Disables the previously enabled blur effect for the specified window.

See also

enableBlurBehindWindow().

---

@staticmethod
disableBlurBehindWindow(QWidget)

TODO

---

@staticmethod
enableBlurBehindWindow(QWindow)

Enables the blur effect for the specified window.

See also

disableBlurBehindWindow().

---

@staticmethod
enableBlurBehindWindow(QWidget)

TODO

---

@staticmethod
enableBlurBehindWindow(QWindow, QRegion)

TODO

---

@staticmethod
enableBlurBehindWindow(QWidget, QRegion)

TODO

---

@staticmethod
errorStringFromHresult(int) → str

TODO

---

@staticmethod
extendFrameIntoClientArea(QWindow, QMargins)

This function overloads extendFrameIntoClientArea().

Extends the glass frame into the client area of the specified window using the specified margins.

---

@staticmethod
extendFrameIntoClientArea(QWidget, QMargins)

TODO

---

@staticmethod
extendFrameIntoClientArea(QWindow, int, int, int, int)

Extends the glass frame into the client area of the specified window using the left, top, right, and bottom margin values.

Pass -1 as values for any of the four margins to fully extend the frame, creating a sheet of glass effect.

If you want the extended frame to act like a standard window border, you should handle that yourself.

Note: If window is a QWidget handle, set the WA_NoSystemBackground attribute for your widget.

See also

resetExtendedFrame().

---

@staticmethod
extendFrameIntoClientArea(QWidget, int, int, int, int)

TODO

---

@staticmethod
fromHBITMAP(sip.voidptr, format: HBitmapFormat = HBitmapNoAlpha) → QPixmap

TODO

---

@staticmethod
fromHICON(sip.voidptr) → QPixmap

TODO

---

@staticmethod
fromHRGN(sip.voidptr) → QRegion

TODO

---

@staticmethod
imageFromHBITMAP(sip.voidptr, sip.voidptr, int, int) → QImage

TODO

---

@staticmethod
isCompositionEnabled() → bool

Returns the DWM composition state.

---

@staticmethod
isCompositionOpaque() → bool

Returns whether the colorization color is an opaque blend.

---

@staticmethod
isWindowExcludedFromPeek(QWindow) → bool

Returns true if the specified window is excluded from Aero Peek.

---

@staticmethod
isWindowExcludedFromPeek(QWidget) → bool

TODO

---

@staticmethod
isWindowPeekDisallowed(QWindow) → bool

Returns true if Aero Peek is disallowed on the thumbnail of the specified window.

---

@staticmethod
isWindowPeekDisallowed(QWidget) → bool

TODO

---

@staticmethod
markFullscreenWindow(QWindow, fullscreen: bool = True)

Marks the specified window as running in the full-screen mode if fullscreen is true, so that the shell handles it correctly. Otherwise, removes the mark.

Note: You do not usually need to call this function, because the Windows taskbar always tries to determine whether a window is running in the full-screen mode.

---

@staticmethod
markFullscreenWindow(QWidget, fullscreen: bool = True)

TODO

---

@staticmethod
realColorizationColor() → QColor

TODO

---

@staticmethod
resetExtendedFrame(QWindow)

Resets the glass frame and restores the window attributes.

This convenience function calls extendFrameIntoClientArea() with margins set to 0.

Note: You must unset the WA_NoSystemBackground attribute for extendFrameIntoClientArea() to work.

See also

extendFrameIntoClientArea().

---

@staticmethod
resetExtendedFrame(QWidget)

TODO

---

@staticmethod
setCompositionEnabled(bool)

Sets whether the Windows Desktop composition is enabled.

Note: The underlying function was declared deprecated as of Windows 8 and takes no effect.

See also

isCompositionEnabled().

---

@staticmethod
setCurrentProcessExplicitAppUserModelID(str)

TODO

---

@staticmethod
setWindowDisallowPeek(QWindow, bool)

Disables Aero Peek for the specified window when hovering over the taskbar thumbnail of the window with the mouse pointer if disallow is true; otherwise allows it.

The default is false.

---

@staticmethod
setWindowDisallowPeek(QWidget, bool)

TODO

---

@staticmethod
setWindowExcludedFromPeek(QWindow, bool)

Excludes the specified window from Aero Peek if exclude is true.

See also

isWindowExcludedFromPeek().

---

@staticmethod
setWindowExcludedFromPeek(QWidget, bool)

TODO

---

@staticmethod
setWindowFlip3DPolicy(QWindow, WindowFlip3DPolicy)

Sets the Flip3D policy policy for the specified window.

See also

windowFlip3DPolicy().

---

@staticmethod
setWindowFlip3DPolicy(QWidget, WindowFlip3DPolicy)

TODO

---

@staticmethod
stringFromHresult(int) → str

TODO

---

@staticmethod
taskbarActivateTab(QWindow)

Activates an item on the taskbar without activating the window itself.

---

@staticmethod
taskbarActivateTab(QWidget)

TODO

---

@staticmethod
taskbarActivateTabAlt(QWindow)

Marks the item that represents the specified window on the taskbar as active, but does not activate it visually.

---

@staticmethod
taskbarActivateTabAlt(QWidget)

TODO

---

@staticmethod
taskbarAddTab(QWindow)

Adds an item for the specified window to the taskbar.

---

@staticmethod
taskbarAddTab(QWidget)

TODO

---

@staticmethod
taskbarDeleteTab(QWindow)

Removes the specified window from the taskbar.

---

@staticmethod
taskbarDeleteTab(QWidget)

TODO

---

@staticmethod
toHBITMAP(QPixmap, format: HBitmapFormat = HBitmapNoAlpha) → sip.voidptr

TODO

---

@staticmethod
toHICON(QPixmap) → sip.voidptr

TODO

---

@staticmethod
toHRGN(QRegion) → sip.voidptr

TODO

---

@staticmethod
windowFlip3DPolicy(QWindow) → WindowFlip3DPolicy

TODO

---

@staticmethod
windowFlip3DPolicy(QWidget) → WindowFlip3DPolicy

See also

setWindowFlip3DPolicy().