PySide6.QtGui¶

Detailed Description¶

The Qt GUI module provides classes for windowing system integration, event handling, OpenGL and OpenGL ES integration, 2D graphics, basic imaging, fonts, and text. These classes are used internally by Qt’s user interface technologies and can also be used directly, for instance to write applications using low-level OpenGL ES graphics APIs.

For application developers writing user interfaces, Qt provides higher level APIs, like Qt Quick, that are much more suitable than the enablers found in the Qt GUI module.

Application Windows¶

The most important classes in the Qt GUI module are QGuiApplication and QWindow . A Qt application that wants to show content on screen will need to make use of these. QGuiApplication contains the main event loop, where all events from the window system and other sources are processed and dispatched. It also handles the application’s initialization and finalization.

The QWindow class represents a window in the underlying windowing system. It provides a number of virtual functions to handle events ( QEvent ) from the windowing system, such as touch-input, exposure, focus, key strokes, and geometry changes.

2D Graphics¶

The Qt GUI module contains classes for 2D graphics, imaging, fonts, and advanced typography.

A QWindow created with the surface type RasterSurface can be used in combination with QBackingStore and QPainter , Qt’s highly optimized 2D vector graphics API. QPainter supports drawing lines, polygons, vector paths, images, and text. For more information, see Paint System and Raster Window Example .

Qt can load and save images using the QImage and QPixmap classes. By default, Qt supports the most common image formats including JPEG and PNG among others. Users can add support for additional formats via the QImageIOPlugin class. For more information, see Reading and Writing Image Files .

Typography in Qt is done with QTextDocument , which uses the QPainter API in combination with Qt’s font classes, primarily QFont . Applications that prefer more low-level APIs to text and font handling can use classes like QRawFont and QGlyphRun .

OpenGL and OpenGL ES Integration¶

QWindow supports rendering using OpenGL and OpenGL ES, depending on what the platform supports. OpenGL rendering is enabled by setting the QWindow ‘s surface type to OpenGLSurface , choosing the format attributes with QSurfaceFormat , and then creating a QOpenGLContext to manage the native OpenGL context. In addition, Qt has QOpenGLPaintDevice , which enables the use of OpenGL accelerated QPainter rendering, as well as convenience classes that simplify the writing of OpenGL code and hides the complexities of extension handling and the differences between OpenGL ES 2 and desktop OpenGL. The convenience classes include QOpenGLFunctions that lets an application use all the OpenGL ES 2 functions on desktop OpenGL without having to manually resolve the OpenGL function pointers. This enables cross-platform development of applications targeting mobile or embedded devices, and provides classes that wrap native OpenGL functionality in a simpler Qt API.

For more information, see the OpenGL Window Example .

The Qt GUI module also contains a few math classes to aid with the most common mathematical operations related to 3D graphics. These classes include QMatrix4x4 , QVector4D , and QQuaternion .

A QWindow created with the OpenGLSurface can be used in combination with QPainter and QOpenGLPaintDevice to have OpenGL hardware-accelerated 2D graphics by sacrificing some of the visual quality.

Vulkan Integration¶

Qt GUI has support for the Vulkan API. Qt applications require the presence of the LunarG Vulkan SDK .

On Windows, the SDK sets the environment variable VULKAN_SDK, which will be detected by the configure script.

On Android, Vulkan headers were added in API level 24 of the NDK.

Relevant classes:

QVulkanDeviceFunctions
- QVulkanExtension
- QVulkanFunctions
- QVulkanInfoVector
- QVulkanInstance
- QVulkanWindow
- QVulkanWindowRenderer

For more information, see the Hello Vulkan Widget Example and the Hello Vulkan Window Example .

Drag and Drop¶

Qt GUI includes support for drag and drop. The Drag and Drop overview has more information.

Using the Module¶

To include the definitions of modules classes, use the following directive:

import PySide6.QtGui

List of Classes¶

A	`Attribute`	`QAbstractFileIconProvider`	`QAbstractTextDocumentLayout`
	`QAccessible`	`QAccessibleActionInterface`	`QAccessibleAnnouncementEvent`
	`QAccessibleAttributesInterface`	`QAccessibleEditableTextInterface`	`QAccessibleEvent`
	`QAccessibleInterface`	`QAccessibleObject`	`QAccessibleSelectionInterface`
	`QAccessibleStateChangeEvent`	`QAccessibleTableCellInterface`	`QAccessibleTableModelChangeEvent`
	`QAccessibleTextCursorEvent`	`QAccessibleTextInsertEvent`	`QAccessibleTextInterface`
	`QAccessibleTextRemoveEvent`	`QAccessibleTextSelectionEvent`	`QAccessibleTextUpdateEvent`
	`QAccessibleValueChangeEvent`	`QAccessibleValueInterface`	`QAction`
	`QActionEvent`	`QActionGroup`
B	`QBackingStore`	`QBitmap`	`QBrush`
C	`QChildWindowEvent`	`QClipboard`	`QCloseEvent`
	`QColor`	`QColorConstants`	`QColorSpace`
	`QColorTransform`	`QConicalGradient`	`QContextMenuEvent`
	`QCursor`
D	`QDesktopServices`	`QDoubleValidator`	`QDrag`
	`QDragEnterEvent`	`QDragLeaveEvent`	`QDragMoveEvent`
	`QDropEvent`
E	`Element`	`QEnterEvent`	`QEventPoint`
	`QExposeEvent`
F	`FormatRange`	`QFileOpenEvent`	`QFocusEvent`
	`QFont`	`QFontDatabase`	`QFontInfo`
	`QFontMetrics`	`QFontMetricsF`
G	`QGlyphRun`	`QGradient`	`QGuiApplication`
H	`QHelpEvent`	`QHideEvent`	`QHoverEvent`
I	`QIcon`	`QIconDragEvent`	`QIconEngine`
	`QImage`	`QImageIOHandler`	`QImageReader`
	`QImageWriter`	`QInputDevice`	`QInputEvent`
	`QInputMethod`	`QInputMethodEvent`	`QInputMethodQueryEvent`
	`QIntValidator`	`iterator`	`iterator`
K	`Key`	`QKeyEvent`	`QKeySequence`
L	`QLinearGradient`
M	`QMatrix2x2`	`QMatrix2x3`	`QMatrix2x4`
	`QMatrix3x2`	`QMatrix3x3`	`QMatrix3x4`
	`QMatrix4x2`	`QMatrix4x3`	`QMatrix4x4`
	`QMouseEvent`	`QMoveEvent`	`QMovie`
N	`QNativeGestureEvent`	`QNativeInterface`
O	`QOffscreenSurface`	`QOpenGLContext`	`QOpenGLContextGroup`
	`QOpenGLExtraFunctions`	`QOpenGLFunctions`
P	`PaintContext`	`PixmapFragment`	`QPageLayout`
	`QPageRanges`	`QPageSize`	`QPagedPaintDevice`
	`QPaintDevice`	`QPaintDeviceWindow`	`QPaintEngine`
	`QPaintEngineState`	`QPaintEvent`	`QPainter`
	`QPainterPath`	`QPainterPathStroker`	`QPalette`
	`QPdfWriter`	`QPen`	`QPicture`
	`QPixelFormat`	`QPixmap`	`QPixmapCache`
	`QPlatformSurfaceEvent`	`QPointerEvent`	`QPointingDevice`
	`QPointingDeviceUniqueId`	`QPolygon`	`QPolygonF`
Q	`QQuaternion`	`Qt`
R	`QRadialGradient`	`QRasterWindow`	`QRawFont`
	`QRegion`	`QRegularExpressionValidator`	`QResizeEvent`
	`QRgba64`	`Range`
S	`QScreen`	`QScrollEvent`	`QScrollPrepareEvent`
	`QSessionManager`	`QShortcut`	`QShortcutEvent`
	`QShowEvent`	`QSinglePointEvent`	`QStandardItem`
	`QStandardItemModel`	`QStaticText`	`QStatusTipEvent`
	`QStyleHints`	`QSurface`	`QSurfaceFormat`
	`QSyntaxHighlighter`	`ScaledPixmapArgument`	`Selection`
	`State`	`Svg`
T	`QTabletEvent`	`QTextBlock`	`QTextBlockFormat`
	`QTextBlockGroup`	`QTextBlockUserData`	`QTextCharFormat`
	`QTextCursor`	`QTextDocument`	`QTextDocumentFragment`
	`QTextDocumentWriter`	`QTextFormat`	`QTextFragment`
	`QTextFrame`	`QTextFrameFormat`	`QTextImageFormat`
	`QTextInlineObject`	`QTextItem`	`QTextLayout`
	`QTextLength`	`QTextLine`	`QTextList`
	`QTextListFormat`	`QTextObject`	`QTextObjectInterface`
	`QTextOption`	`QTextTable`	`QTextTableCell`
	`QTextTableCellFormat`	`QTextTableFormat`	`QToolBarChangeEvent`
	`QTouchEvent`	`QTransform`	`Tab`
	`Tag`
U	`QUndoCommand`	`QUndoGroup`	`QUndoStack`
V	`QValidator`	`QVector2D`	`QVector3D`
	`QVector4D`
W	`QWhatsThisClickedEvent`	`QWheelEvent`	`QWindow`
	`QWindowStateChangeEvent`
X	`QX11Application`

List of Functions¶

A	`qAlpha()`
B	`qBlue()`
F	`qFuzzyCompare()`
G	`qGray()`	`qGreen()`
I	`qIsGray()`
P	`qPixelFormatAlpha()`	`qPixelFormatCmyk()`	`qPixelFormatGrayscale()`
	`qPixelFormatHsl()`	`qPixelFormatHsv()`	`qPixelFormatRgba()`
	`qPixelFormatYuv()`
R	`qRed()`	`qRgb()`	`qRgba()`