PyQt5 Reference Guide¶

Introduction
- License
- PyQt5 Components
- An Explanation of Version Numbers
Potential Incompatibilities with Earlier Versions
- PyQt5 v5.3
Installing PyQt5
- Downloading SIP
- Downloading PyQt5
- Configuring PyQt5
- Building PyQt5
- Co-existence with PyQt4
- Configuring with Configuration Files
Differences Between PyQt4 and PyQt5
- Supported Python Versions
- Deprecated Features
- Multiple APIs
- Old-style Signals and Slots
- New-style Signals and Slots
- QtDeclarative, QtScript and QtScriptTools Modules
- QtGui Module
- QtOpenGL Module
- QtWebKit Module
- QtXml Module
- pyqtconfig Module
- dbus.mainloop.qt Module
- QDataStream
- QFileDialog
- QGraphicsItemAnimation
- QMatrix
- QPyTextObject
- QSet
- pyuic5
- pyrcc5
- Cooperative Multi-inheritance
- Releasing the GIL
- Object Destruction on Exit
PyQt5 Class Reference
- Enginio
- EnginioClient
- EnginioClientConnection
- EnginioIdentity
- EnginioModel
- EnginioOAuth2Authentication
- EnginioReply
- QAbstractAnimation
- QAbstractButton
- QAbstractEventDispatcher
- QAbstractExtensionFactory
- QAbstractExtensionManager
- QAbstractFormBuilder
- QAbstractGraphicsShapeItem
- QAbstractItemDelegate
- QAbstractItemModel
- QAbstractItemView
- QAbstractListModel
- QAbstractMessageHandler
- QAbstractNativeEventFilter
- QAbstractNetworkCache
- QAbstractPrintDialog
- QAbstractProxyModel
- QAbstractScrollArea
- QAbstractSlider
- QAbstractSocket
- QAbstractSpinBox
- QAbstractState
- QAbstractTableModel
- QAbstractTextDocumentLayout
- QAbstractTransition
- QAbstractUriResolver
- QAbstractVideoBuffer
- QAbstractVideoSurface
- QAbstractXmlNodeModel
- QAbstractXmlReceiver
- QAccelerometer
- QAccelerometerFilter
- QAccelerometerReading
- QAction
- QActionEvent
- QActionGroup
- QAltimeter
- QAltimeterFilter
- QAltimeterReading
- QAmbientLightFilter
- QAmbientLightReading
- QAmbientLightSensor
- QAmbientTemperatureFilter
- QAmbientTemperatureReading
- QAmbientTemperatureSensor
- QAnimationGroup
- QApplication
- QAudio
- QAudioBuffer
- QAudioDecoder
- QAudioDeviceInfo
- QAudioEncoderSettings
- QAudioFormat
- QAudioInput
- QAudioOutput
- QAudioProbe
- QAudioRecorder
- QAuthenticator
- QAxBase
- QAxObject
- QAxWidget
- QBackingStore
- QBasicTimer
- QBitArray
- QBitmap
- QBluetoothAddress
- QBluetoothDeviceDiscoveryAgent
- QBluetoothDeviceInfo
- QBluetoothHostInfo
- QBluetoothLocalDevice
- QBluetoothServer
- QBluetoothServiceDiscoveryAgent
- QBluetoothServiceInfo
- QBluetoothSocket
- QBluetoothTransferManager
- QBluetoothTransferReply
- QBluetoothTransferRequest
- QBluetoothUuid
- QBoxLayout
- QBrush
- QBuffer
- QButtonGroup
- QByteArray
- QByteArrayMatcher
- QCalendarWidget
- QCamera
- QCameraExposure
- QCameraFocus
- QCameraFocusZone
- QCameraImageCapture
- QCameraImageProcessing
- QCameraInfo
- QCameraViewFinder
- QCheckBox
- QChildEvent
- QClipboard
- QCloseEvent
- QCollator
- QCollatorSortKey
- QColor
- QColorDialog
- QColumnView
- QComboBox
- QCommandLineOption
- QCommandLineParser
- QCommandLinkButton
- QCommonStyle
- QCompass
- QCompassFilter
- QCompassReading
- QCompleter
- QConicalGradient
- QContextMenuEvent
- QCoreApplication
- QCryptographicHash
- QCursor
- QDataStream
- QDataWidgetMapper
- QDate
- QDateEdit
- QDateTime
- QDateTimeEdit
- QDBus
- QDBusAbstractAdaptor
- QDBusAbstractInterface
- QDBusArgument
- QDBusConnection
- QDBusConnectionInterface
- QDBusError
- QDBusInterface
- QDBusMessage
- QDBusObjectPath
- QDBusPendingCall
- QDBusPendingCallWatcher
- QDBusPendingReply
- QDBusReply
- QDBusServiceWatcher
- QDBusSignature
- QDBusUnixFileDescriptor
- QDBusVariant
- QDesignerActionEditorInterface
- QDesignerContainerExtension
- QDesignerCustomWidgetCollectionInterface
- QDesignerCustomWidgetInterface
- QDesignerFormEditorInterface
- QDesignerFormWindowCursorInterface
- QDesignerFormWindowInterface
- QDesignerFormWindowManagerInterface
- QDesignerMemberSheetExtension
- QDesignerObjectInspectorInterface
- QDesignerPropertyEditorInterface
- QDesignerPropertySheetExtension
- QDesignerTaskMenuExtension
- QDesignerWidgetBoxInterface
- QDesktopServices
- QDesktopWidget
- QDial
- QDialog
- QDialogButtonBox
- QDir
- QDirIterator
- QDirModel
- QDnsDomainNameRecord
- QDnsHostAddressRecord
- QDnsLookup
- QDnsMailExchangeRecord
- QDnsServiceRecord
- QDnsTextRecord
- QDockWidget
- QDoubleSpinBox
- QDoubleValidator
- QDrag
- QDragEnterEvent
- QDragLeaveEvent
- QDragMoveEvent
- QDropEvent
- QDynamicPropertyChangeEvent
- QEasingCurve
- QElapsedTimer
- QEnterEvent
- QErrorMessage
- QEvent
- QEventLoop
- QEventLoopLocker
- QEventTransition
- QExposeEvent
- QExtensionFactory
- QExtensionManager
- QFile
- QFileDevice
- QFileDialog
- QFileIconProvider
- QFileInfo
- QFileOpenEvent
- QFileSelector
- QFileSystemModel
- QFileSystemWatcher
- QFinalState
- QFocusEvent
- QFocusFrame
- QFont
- QFontComboBox
- QFontDatabase
- QFontDialog
- QFontInfo
- QFontMetrics
- QFontMetricsF
- QFormBuilder
- QFormLayout
- QFrame
- QGenericArgument
- QGenericReturnArgument
- QGeoAddress
- QGeoAreaMonitorInfo
- QGeoAreaMonitorSource
- QGeoCircle
- QGeoCoordinate
- QGeoLocation
- QGeoPositionInfo
- QGeoPositionInfoSource
- QGeoRectangle
- QGeoSatelliteInfo
- QGeoSatelliteInfoSource
- QGeoShape
- QGesture
- QGestureEvent
- QGestureRecognizer
- QGL
- QGLContext
- QGLFormat
- QGLWidget
- QGlyphRun
- QGradient
- QGraphicsAnchor
- QGraphicsAnchorLayout
- QGraphicsBlurEffect
- QGraphicsColorizeEffect
- QGraphicsDropShadowEffect
- QGraphicsEffect
- QGraphicsEllipseItem
- QGraphicsGridLayout
- QGraphicsItem
- QGraphicsItemGroup
- QGraphicsLayout
- QGraphicsLayoutItem
- QGraphicsLinearLayout
- QGraphicsLineItem
- QGraphicsObject
- QGraphicsOpacityEffect
- QGraphicsPathItem
- QGraphicsPixmapItem
- QGraphicsPolygonItem
- QGraphicsProxyWidget
- QGraphicsRectItem
- QGraphicsRotation
- QGraphicsScale
- QGraphicsScene
- QGraphicsSceneContextMenuEvent
- QGraphicsSceneDragDropEvent
- QGraphicsSceneEvent
- QGraphicsSceneHelpEvent
- QGraphicsSceneHoverEvent
- QGraphicsSceneMouseEvent
- QGraphicsSceneMoveEvent
- QGraphicsSceneResizeEvent
- QGraphicsSceneWheelEvent
- QGraphicsSimpleTextItem
- QGraphicsSvgItem
- QGraphicsTextItem
- QGraphicsTransform
- QGraphicsVideoItem
- QGraphicsView
- QGraphicsWebView
- QGraphicsWidget
- QGridLayout
- QGroupBox
- QGuiApplication
- QGyroscope
- QGyroscopeFilter
- QGyroscopeReading
- QHBoxLayout
- QHeaderView
- QHelpContentItem
- QHelpContentModel
- QHelpContentWidget
- QHelpEngine
- QHelpEngineCore
- QHelpEvent
- QHelpIndexModel
- QHelpIndexWidget
- QHelpSearchEngine
- QHelpSearchQuery
- QHelpSearchQueryWidget
- QHelpSearchResultWidget
- QHideEvent
- QHistoryState
- QHolsterFilter
- QHolsterReading
- QHolsterSensor
- QHostAddress
- QHostInfo
- QHoverEvent
- QHttpMultiPart
- QHttpPart
- QIcon
- QIconDragEvent
- QIconEngine
- QIdentityProxyModel
- QImage
- QImageEncoderSettings
- QImageIOHandler
- QImageReader
- QImageWriter
- QInputDialog
- QInputEvent
- QInputMethod
- QInputMethodEvent
- QInputMethodQueryEvent
- QIntValidator
- QIODevice
- QIRProximityFilter
- QIRProximityReading
- QIRProximitySensor
- QItemDelegate
- QItemEditorCreatorBase
- QItemEditorFactory
- QItemSelection
- QItemSelectionModel
- QItemSelectionRange
- QJSEngine
- QJsonArray
- QJsonDocument
- QJsonObject
- QJsonParseError
- QJsonValue
- QJSValue
- QJSValueIterator
- QKeyEvent
- QKeyEventTransition
- QKeySequence
- QKeySequenceEdit
- QLabel
- QLayout
- QLayoutItem
- QLCDNumber
- QLibrary
- QLibraryInfo
- QLightFilter
- QLightReading
- QLightSensor
- QLine
- QLinearGradient
- QLineEdit
- QLineF
- QListView
- QListWidget
- QListWidgetItem
- QLocale
- QLocalServer
- QLocalSocket
- QLockFile
- QMacPasteboardMime
- QMagnetometer
- QMagnetometerFilter
- QMagnetometerReading
- QMainWindow
- QMargins
- QMarginsF
- QMaskGenerator
- QMatrix2x2
- QMatrix2x3
- QMatrix2x4
- QMatrix3x2
- QMatrix3x3
- QMatrix3x4
- QMatrix4x2
- QMatrix4x3
- QMatrix4x4
- QMdiArea
- QMdiSubWindow
- QMediaBindableInterface
- QMediaContent
- QMediaControl
- QMediaMetaData
- QMediaObject
- QMediaPlayer
- QMediaPlaylist
- QMediaRecorder
- QMediaResource
- QMediaService
- QMediaTimeInterval
- QMediaTimeRange
- QMenu
- QMenuBar
- QMessageAuthenticationCode
- QMessageBox
- QMessageLogContext
- QMessageLogger
- QMetaClassInfo
- QMetaEnum
- QMetaMethod
- QMetaObject
- QMetaProperty
- QMetaType
- QMimeData
- QMimeDatabase
- QMimeType
- QModelIndex
- QMouseEvent
- QMouseEventTransition
- QMoveEvent
- QMovie
- QMultimedia
- QMutex
- QMutexLocker
- QNetworkAccessManager
- QNetworkAddressEntry
- QNetworkCacheMetaData
- QNetworkConfiguration
- QNetworkConfigurationManager
- QNetworkCookie
- QNetworkCookieJar
- QNetworkDiskCache
- QNetworkInterface
- QNetworkProxy
- QNetworkProxyFactory
- QNetworkProxyQuery
- QNetworkReply
- QNetworkRequest
- QNetworkSession
- QNmeaPositionInfoSource
- QObject
- QObjectCleanupHandler
- QOffscreenSurface
- QOpenGLBuffer
- QOpenGLContext
- QOpenGLContextGroup
- QOpenGLDebugLogger
- QOpenGLDebugMessage
- QOpenGLFramebufferObject
- QOpenGLFramebufferObjectFormat
- QOpenGLPaintDevice
- QOpenGLShader
- QOpenGLShaderProgram
- QOpenGLTexture
- QOpenGLTimeMonitor
- QOpenGLTimerQuery
- QOpenGLVertexArrayObject
- QOrientationFilter
- QOrientationReading
- QOrientationSensor
- QPagedPaintDevice
- QPageLayout
- QPageSetupDialog
- QPageSize
- QPaintDevice
- QPaintEngine
- QPaintEngineState
- QPainter
- QPainterPath
- QPainterPathStroker
- QPaintEvent
- QPalette
- QPanGesture
- QParallelAnimationGroup
- QPauseAnimation
- QPdfWriter
- QPen
- QPersistentModelIndex
- QPicture
- QPictureIO
- QPinchGesture
- QPixmap
- QPixmapCache
- QPlainTextDocumentLayout
- QPlainTextEdit
- QPluginLoader
- QPoint
- QPointF
- QPolygon
- QPolygonF
- QPressureFilter
- QPressureReading
- QPressureSensor
- QPrintDialog
- QPrintEngine
- QPrinter
- QPrinterInfo
- QPrintPreviewDialog
- QPrintPreviewWidget
- QProcess
- QProcessEnvironment
- QProgressBar
- QProgressDialog
- QPropertyAnimation
- QProximityFilter
- QProximityReading
- QProximitySensor
- QPushButton
- QQmlAbstractUrlInterceptor
- QQmlApplicationEngine
- QQmlComponent
- QQmlContext
- QQmlEngine
- QQmlError
- QQmlExpression
- QQmlExtensionPlugin
- QQmlFileSelector
- QQmlImageProviderBase
- QQmlIncubator
- QQmlIncubatorControl
- QQmlListProperty
- QQmlListReference
- QQmlNetworkAccessManagerFactory
- QQmlParserStatus
- QQmlProperty
- QQmlPropertyMap
- QQmlPropertyValueSource
- QQmlScriptString
- QQuaternion
- QQuickFramebufferObject
- QQuickImageProvider
- QQuickItem
- QQuickPaintedItem
- QQuickTextDocument
- QQuickTextureFactory
- QQuickView
- QQuickWidget
- QQuickWindow
- QRadialGradient
- QRadioButton
- QRadioData
- QRadioTuner
- QRawFont
- QReadLocker
- QReadWriteLock
- QRect
- QRectF
- QRegExp
- QRegExpValidator
- QRegion
- QRegularExpression
- QRegularExpressionMatch
- QRegularExpressionMatchIterator
- QRegularExpressionValidator
- QResizeEvent
- QResource
- QRotationFilter
- QRotationReading
- QRotationSensor
- QRubberBand
- QRunnable
- QSaveFile
- QScreen
- QScrollArea
- QScrollBar
- QScroller
- QScrollerProperties
- QScrollEvent
- QScrollPrepareEvent
- QSemaphore
- QSensor
- QSensorFilter
- QSensorReading
- QSequentialAnimationGroup
- QSerialPort
- QSerialPortInfo
- QSessionManager
- QSettings
- QSGBasicGeometryNode
- QSGClipNode
- QSGDynamicTexture
- QSGFlatColorMaterial
- QSGGeometry
- QSGGeometryNode
- QSGMaterial
- QSGMaterialShader
- QSGMaterialType
- QSGNode
- QSGOpacityNode
- QSGOpaqueTextureMaterial
- QSGSimpleRectNode
- QSGSimpleTextureNode
- QSGTexture
- QSGTextureMaterial
- QSGTextureProvider
- QSGTransformNode
- QSGVertexColorMaterial
- QSharedMemory
- QShortcut
- QShortcutEvent
- QShowEvent
- QSignalBlocker
- QSignalMapper
- QSignalSpy
- QSignalTransition
- QSimpleXmlNodeModel
- QSize
- QSizeF
- QSizeGrip
- QSizePolicy
- QSlider
- QSocketNotifier
- QSortFilterProxyModel
- QSound
- QSoundEffect
- QSourceLocation
- QSpacerItem
- QSpinBox
- QSplashScreen
- QSplitter
- QSplitterHandle
- QSql
- QSqlDatabase
- QSqlDriver
- QSqlDriverCreatorBase
- QSqlError
- QSqlField
- QSqlIndex
- QSqlQuery
- QSqlQueryModel
- QSqlRecord
- QSqlRelation
- QSqlRelationalDelegate
- QSqlRelationalTableModel
- QSqlResult
- QSqlTableModel
- QSsl
- QSslCertificate
- QSslCertificateExtension
- QSslCipher
- QSslConfiguration
- QSslError
- QSslKey
- QSslSocket
- QStackedLayout
- QStackedWidget
- QStandardItem
- QStandardItemModel
- QStandardPaths
- QState
- QStateMachine
- QStaticText
- QStatusBar
- QStatusTipEvent
- QStringListModel
- QStyle
- QStyledItemDelegate
- QStyleFactory
- QStyleHintReturn
- QStyleHintReturnMask
- QStyleHintReturnVariant
- QStyleHints
- QStyleOption
- QStyleOptionButton
- QStyleOptionComboBox
- QStyleOptionComplex
- QStyleOptionDockWidget
- QStyleOptionFocusRect
- QStyleOptionFrame
- QStyleOptionGraphicsItem
- QStyleOptionGroupBox
- QStyleOptionHeader
- QStyleOptionMenuItem
- QStyleOptionProgressBar
- QStyleOptionRubberBand
- QStyleOptionSizeGrip
- QStyleOptionSlider
- QStyleOptionSpinBox
- QStyleOptionTab
- QStyleOptionTabBarBase
- QStyleOptionTabWidgetFrame
- QStyleOptionTitleBar
- QStyleOptionToolBar
- QStyleOptionToolBox
- QStyleOptionToolButton
- QStyleOptionViewItem
- QStylePainter
- QSurface
- QSurfaceFormat
- QSvgGenerator
- QSvgRenderer
- QSvgWidget
- QSwipeGesture
- QSyntaxHighlighter
- QSysInfo
- QSystemSemaphore
- QSystemTrayIcon
- Qt
- QTabBar
- QTabletEvent
- QTableView
- QTableWidget
- QTableWidgetItem
- QTableWidgetSelectionRange
- QTabWidget
- QTapAndHoldGesture
- QTapFilter
- QTapGesture
- QTapReading
- QTapSensor
- QTcpServer
- QTcpSocket
- QTemporaryDir
- QTemporaryFile
- QTest
- QTextBlock
- QTextBlockFormat
- QTextBlockGroup
- QTextBlockUserData
- QTextBoundaryFinder
- QTextBrowser
- QTextCharFormat
- QTextCodec
- QTextCursor
- QTextDecoder
- QTextDocument
- QTextDocumentFragment
- QTextDocumentWriter
- QTextEdit
- QTextEncoder
- QTextFormat
- QTextFragment
- QTextFrame
- QTextFrameFormat
- QTextImageFormat
- QTextInlineObject
- QTextItem
- QTextLayout
- QTextLength
- QTextLine
- QTextList
- QTextListFormat
- QTextObject
- QTextObjectInterface
- QTextOption
- QTextStream
- QTextStreamManipulator
- QTextTable
- QTextTableCell
- QTextTableCellFormat
- QTextTableFormat
- QThread
- QThreadPool
- QTiltFilter
- QTiltReading
- QTiltSensor
- QTime
- QTimeEdit
- QTimeLine
- QTimer
- QTimerEvent
- QTimeZone
- QToolBar
- QToolBox
- QToolButton
- QToolTip
- QTouchDevice
- QTouchEvent
- QTransform
- QTranslator
- QTreeView
- QTreeWidget
- QTreeWidgetItem
- QTreeWidgetItemIterator
- QtWin
- QUdpSocket
- QUndoCommand
- QUndoGroup
- QUndoStack
- QUndoView
- QUrl
- QUrlQuery
- QUuid
- QValidator
- QVariant
- QVariantAnimation
- QVBoxLayout
- QVector2D
- QVector3D
- QVector4D
- QVideoEncoderSettings
- QVideoFrame
- QVideoProbe
- QVideoSurfaceFormat
- QVideoWidget
- QWaitCondition
- QWebDatabase
- QWebElement
- QWebElementCollection
- QWebFrame
- QWebHistory
- QWebHistoryInterface
- QWebHistoryItem
- QWebHitTestResult
- QWebInspector
- QWebPage
- QWebPluginFactory
- QWebSecurityOrigin
- QWebSettings
- QWebSocket
- QWebSocketCorsAuthenticator
- QWebSocketProtocol
- QWebSocketServer
- QWebView
- QWhatsThis
- QWhatsThisClickedEvent
- QWheelEvent
- QWidget
- QWidgetAction
- QWidgetItem
- QWindow
- QWindowStateChangeEvent
- QWinJumpList
- QWinJumpListCategory
- QWinJumpListItem
- QWinTaskbarButton
- QWinTaskbarProgress
- QWinThumbnailToolBar
- QWinThumbnailToolButton
- QWizard
- QWizardPage
- QWriteLocker
- QX11Info
- QXmlFormatter
- QXmlItem
- QXmlName
- QXmlNamePool
- QXmlNodeModelIndex
- QXmlQuery
- QXmlResultItems
- QXmlSchema
- QXmlSchemaValidator
- QXmlSerializer
- QXmlStreamAttribute
- QXmlStreamAttributes
- QXmlStreamEntityDeclaration
- QXmlStreamEntityResolver
- QXmlStreamNamespaceDeclaration
- QXmlStreamNotationDeclaration
- QXmlStreamReader
- QXmlStreamWriter
Support for Signals and Slots
- Unbound and Bound Signals
- Defining New Signals with pyqtSignal()
- Connecting, Disconnecting and Emitting Signals
- Connecting Signals Using Keyword Arguments
- The pyqtSlot() Decorator
- Connecting Slots By Name
Support for Qt Properties
- Defining New Qt Properties
Other Support for Dynamic Meta-objects
- Q_ENUMS() and Q_FLAGS()
- Q_CLASSINFO()
Support for OpenGL
Support for Qt Interfaces
Support for QVariant
Support for QSettings
Integrating Python and QML
- Registering Python Types
- A Simple Example
- Using QQmlListProperty
- Using Attached Properties
- Using Property Value Sources
- Using QQmlParserStatus
- Writing Python Plugins for qmlscene
Support for Cooperative Multi-inheritance
Things to be Aware Of
- Keyword Arguments
- Python Strings, Qt Strings and Unicode
- Garbage Collection
- Multiple Inheritance
- Access to Protected Member Functions
- None and NULL
- Support for void *
Using Qt Designer
- Using the Generated Code
- The uic Module
- pyuic5
- Writing Qt Designer Plugins
The PyQt5 Resource System
- pyrcc5
Support for Pickling
Using PyQt5 from the Python Shell
Internationalisation of PyQt5 Applications
- pylupdate5
- Differences Between PyQt5 and Qt
DBus Support
- QtDBus
- dbus.mainloop.pyqt5
Deploying Commercial PyQt5 Applications
The PyQt5 Extension API
- Python API
- C++ API

Next topic