QWidget

The QWidget class is the base class of all user interface objects. More…

Inherited by: QChartView, QHelpContentWidget, QHelpFilterSettingsWidget, QHelpIndexWidget, QHelpSearchQueryWidget, QHelpSearchResultWidget, QCameraViewfinder, QVideoWidget, QGLWidget, QAbstractPrintDialog, QPageSetupDialog, QPrintDialog, QPrintPreviewDialog, QPrintPreviewWidget, QQuickWidget, QSvgWidget, QWebEngineView, QAbstractButton, QAbstractItemView, QAbstractScrollArea, QAbstractSlider, QAbstractSpinBox, QCalendarWidget, QCheckBox, QColorDialog, QColumnView, QComboBox, QCommandLinkButton, QDateEdit, QDateTimeEdit, QDesktopWidget, QDial, QDialog, QDialogButtonBox, QDockWidget, QDoubleSpinBox, QErrorMessage, QFileDialog, QFocusFrame, QFontComboBox, QFontDialog, QFrame, QGraphicsView, QGroupBox, QHeaderView, QInputDialog, QKeySequenceEdit, QLCDNumber, QLabel, QLineEdit, QListView, QListWidget, QMainWindow, QMdiArea, QMdiSubWindow, QMenu, QMenuBar, QMessageBox, QOpenGLWidget, QPlainTextEdit, QProgressBar, QProgressDialog, QPushButton, QRadioButton, QRubberBand, QScrollArea, QScrollBar, QSizeGrip, QSlider, QSpinBox, QSplashScreen, QSplitter, QSplitterHandle, QStackedWidget, QStatusBar, QTabBar, QTabWidget, QTableView, QTableWidget, QTextBrowser, QTextEdit, QTimeEdit, QToolBar, QToolBox, QToolButton, QTreeView, QTreeWidget, QUndoView, QWizard, QWizardPage

Synopsis

Functions

• def acceptDrops ()

• def accessibleDescription ()

• def accessibleName ()

• def actions ()

• def activateWindow ()

• def addAction (action)

• def addActions (actions)

• def adjustSize ()

• def autoFillBackground ()

• def backgroundRole ()

• def backingStore ()

• def baseSize ()

• def childAt (p)

• def childAt (x, y)

• def childrenRect ()

• def childrenRegion ()

• def clearFocus ()

• def clearMask ()

• def contentsMargins ()

• def contentsRect ()

• def contextMenuPolicy ()

• def create ([arg__1=0[, initializeWindow=true[, destroyOldWindow=true]]])

• def createWinId ()

• def cursor ()

• def destroy ([destroyWindow=true[, destroySubWindows=true]])

• def effectiveWinId ()

• def ensurePolished ()

• def focusNextChild ()

• def focusPolicy ()

• def focusPreviousChild ()

• def focusProxy ()

• def focusWidget ()

• def font ()

• def fontInfo ()

• def fontMetrics ()

• def foregroundRole ()

• def frameGeometry ()

• def frameSize ()

• def geometry ()

• def getContentsMargins ()

• def grab ([rectangle=QRect(QPoint(0, 0), QSize(-1, -1))])

• def grabGesture (type[, flags=Qt.GestureFlags()])

• def grabKeyboard ()

• def grabMouse ()

• def grabMouse (arg__1)

• def grabShortcut (key[, context=Qt.WindowShortcut])

• def graphicsEffect ()

• def graphicsProxyWidget ()

• def hasFocus ()

• def hasMouseTracking ()

• def hasTabletTracking ()

• def inputMethodHints ()

• def insertAction (before, action)

• def insertActions (before, actions)

• def internalWinId ()

• def isActiveWindow ()

• def isAncestorOf (child)

• def isEnabled ()

• def isEnabledTo (arg__1)

• def isEnabledToTLW ()

• def isFullScreen ()

• def isHidden ()

• def isLeftToRight ()

• def isMaximized ()

• def isMinimized ()

• def isModal ()

• def isRightToLeft ()

• def isTopLevel ()

• def isVisible ()

• def isVisibleTo (arg__1)

• def isWindow ()

• def isWindowModified ()

• def layout ()

• def layoutDirection ()

• def locale ()

• def mapFrom (arg__1, arg__2)

• def mapFromGlobal (arg__1)

• def mapFromParent (arg__1)

• def mapTo (arg__1, arg__2)

• def mapToGlobal (arg__1)

• def mapToParent (arg__1)

• def mask ()

• def maximumHeight ()

• def maximumSize ()

• def maximumWidth ()

• def minimumHeight ()

• def minimumSize ()

• def minimumWidth ()

• def move (arg__1)

• def move (x, y)

• def nativeParentWidget ()

• def nextInFocusChain ()

• def normalGeometry ()

• def overrideWindowFlags (type)

• def overrideWindowState (state)

• def palette ()

• def parentWidget ()

• def pos ()

• def previousInFocusChain ()

• def rect ()

• def releaseKeyboard ()

• def releaseMouse ()

• def releaseShortcut (id)

• def removeAction (action)

• def render (painter, targetOffset[, sourceRegion=QRegion()[, renderFlags=QWidget.RenderFlags(DrawWindowBackground | DrawChildren)]])

• def render (target[, targetOffset=QPoint()[, sourceRegion=QRegion()[, renderFlags=QWidget.RenderFlags(DrawWindowBackground | DrawChildren)]]])

• def repaint (arg__1)

• def repaint (arg__1)

• def repaint (x, y, w, h)

• def resize (arg__1)

• def resize (w, h)

• def restoreGeometry (geometry)

• def saveGeometry ()

• def screen ()

• def scroll (dx, dy)

• def scroll (dx, dy, arg__3)

• def setAcceptDrops (on)

• def setAccessibleDescription (description)

• def setAccessibleName (name)

• def setAttribute (arg__1[, on=true])

• def setAutoFillBackground (enabled)

• def setBackgroundRole (arg__1)

• def setBaseSize (arg__1)

• def setBaseSize (basew, baseh)

• def setContentsMargins (left, top, right, bottom)

• def setContentsMargins (margins)

• def setContextMenuPolicy (policy)

• def setCursor (arg__1)

• def setFixedHeight (h)

• def setFixedSize (arg__1)

• def setFixedSize (w, h)

• def setFixedWidth (w)

• def setFocus (reason)

• def setFocusPolicy (policy)

• def setFocusProxy (arg__1)

• def setFont (arg__1)

• def setForegroundRole (arg__1)

• def setGeometry (arg__1)

• def setGeometry (x, y, w, h)

• def setGraphicsEffect (effect)

• def setInputMethodHints (hints)

• def setLayout (arg__1)

• def setLayoutDirection (direction)

• def setLocale (locale)

• def setMask (arg__1)

• def setMask (arg__1)

• def setMaximumHeight (maxh)

• def setMaximumSize (arg__1)

• def setMaximumSize (maxw, maxh)

• def setMaximumWidth (maxw)

• def setMinimumHeight (minh)

• def setMinimumSize (arg__1)

• def setMinimumSize (minw, minh)

• def setMinimumWidth (minw)

• def setMouseTracking (enable)

• def setPalette (arg__1)

• def setParent (parent)

• def setParent (parent, f)

• def setShortcutAutoRepeat (id[, enable=true])

• def setShortcutEnabled (id[, enable=true])

• def setSizeIncrement (arg__1)

• def setSizeIncrement (w, h)

• def setSizePolicy (arg__1)

• def setSizePolicy (horizontal, vertical)

• def setStatusTip (arg__1)

• def setStyle (arg__1)

• def setTabletTracking (enable)

• def setToolTip (arg__1)

• def setToolTipDuration (msec)

• def setUpdatesEnabled (enable)

• def setWhatsThis (arg__1)

• def setWindowFilePath (filePath)

• def setWindowFlag (arg__1[, on=true])

• def setWindowFlags (type)

• def setWindowIcon (icon)

• def setWindowIconText (arg__1)

• def setWindowModality (windowModality)

• def setWindowOpacity (level)

• def setWindowRole (arg__1)

• def setWindowState (state)

• def size ()

• def sizeIncrement ()

• def sizePolicy ()

• def stackUnder (arg__1)

• def statusTip ()

• def style ()

• def styleSheet ()

• def testAttribute (arg__1)

• def toolTip ()

• def toolTipDuration ()

• def topLevelWidget ()

• def underMouse ()

• def ungrabGesture (type)

• def unsetCursor ()

• def unsetLayoutDirection ()

• def unsetLocale ()

• def update (arg__1)

• def update (arg__1)

• def update (x, y, w, h)

• def updateGeometry ()

• def updatesEnabled ()

• def visibleRegion ()

• def whatsThis ()

• def winId ()

• def window ()

• def windowFilePath ()

• def windowFlags ()

• def windowHandle ()

• def windowIcon ()

• def windowIconText ()

• def windowModality ()

• def windowOpacity ()

• def windowRole ()

• def windowState ()

• def windowTitle ()

• def windowType ()

• def x ()

• def y ()

Virtual functions

• def actionEvent (event)

• def changeEvent (event)

• def closeEvent (event)

• def contextMenuEvent (event)

• def dragEnterEvent (event)

• def dragLeaveEvent (event)

• def dragMoveEvent (event)

• def dropEvent (event)

• def enterEvent (event)

• def focusInEvent (event)

• def focusNextPrevChild (next)

• def focusOutEvent (event)

• def hasHeightForWidth ()

• def heightForWidth (arg__1)

• def hideEvent (event)

• def inputMethodEvent (event)

• def inputMethodQuery (arg__1)

• def keyPressEvent (event)

• def keyReleaseEvent (event)

• def leaveEvent (event)

• def minimumSizeHint ()

• def mouseDoubleClickEvent (event)

• def mouseMoveEvent (event)

• def mousePressEvent (event)

• def mouseReleaseEvent (event)

• def moveEvent (event)

• def nativeEvent (eventType, message)

• def paintEvent (event)

• def resizeEvent (event)

• def setVisible (visible)

• def showEvent (event)

• def sizeHint ()

• def tabletEvent (event)

• def wheelEvent (event)

Slots

• def close ()

• def hide ()

• def lower ()

• def raise_ ()

• def repaint ()

• def setDisabled (arg__1)

• def setEnabled (arg__1)

• def setFocus ()

• def setHidden (hidden)

• def setStyleSheet (styleSheet)

• def setWindowModified (arg__1)

• def setWindowTitle (arg__1)

• def show ()

• def showFullScreen ()

• def showMaximized ()

• def showMinimized ()

• def showNormal ()

• def update ()

• def updateMicroFocus ()

Signals

• def customContextMenuRequested (pos)

• def windowIconChanged (icon)

• def windowIconTextChanged (iconText)

• def windowTitleChanged (title)

Static functions

• def createWindowContainer (window[, parent=None[, flags=Qt.WindowFlags()]])

• def find (arg__1)

• def keyboardGrabber ()

• def mouseGrabber ()

• def setTabOrder (arg__1, arg__2)

Detailed Description

The widget is the atom of the user interface: it receives mouse, keyboard and other events from the window system, and paints a representation of itself on the screen. Every widget is rectangular, and they are sorted in a Z-order. A widget is clipped by its parent and by the widgets in front of it.

A widget that is not embedded in a parent widget is called a window. Usually, windows have a frame and a title bar, although it is also possible to create windows without such decoration using suitable window flags ). In Qt, QMainWindow and the various subclasses of QDialog are the most common window types.

Every widget’s constructor accepts one or two standard arguments:

1. QWidget *parent = nullptr is the parent of the new widget. If it is None (the default), the new widget will be a window. If not, it will be a child of parent, and be constrained by parent’s geometry (unless you specify Window as window flag).

2. Qt::WindowFlags f = { } (where available) sets the window flags; the default is suitable for almost all widgets, but to get, for example, a window without a window system frame, you must use special flags.

QWidget has many member functions, but some of them have little direct functionality; for example, QWidget has a font property, but never uses this itself. There are many subclasses which provide real functionality, such as QLabel , QPushButton , QListWidget , and QTabWidget .

Top-Level and Child Widgets

A widget without a parent widget is always an independent window (top-level widget). For these widgets, setWindowTitle() and setWindowIcon() set the title bar and icon respectively.

Non-window widgets are child widgets, displayed within their parent widgets. Most widgets in Qt are mainly useful as child widgets. For example, it is possible to display a button as a top-level window, but most people prefer to put their buttons inside other widgets, such as QDialog .

The diagram above shows a QGroupBox widget being used to hold various child widgets in a layout provided by QGridLayout . The QLabel child widgets have been outlined to indicate their full sizes.

If you want to use a QWidget to hold child widgets you will usually want to add a layout to the parent QWidget . See Layout Management for more information.

Composite Widgets

When a widget is used as a container to group a number of child widgets, it is known as a composite widget. These can be created by constructing a widget with the required visual properties - a QFrame , for example - and adding child widgets to it, usually managed by a layout. The above diagram shows such a composite widget that was created using Qt Designer.

Composite widgets can also be created by subclassing a standard widget, such as QWidget or QFrame , and adding the necessary layout and child widgets in the constructor of the subclass. Many of the examples provided with Qt use this approach, and it is also covered in the Qt Tutorials .

Custom Widgets and Painting

Since QWidget is a subclass of QPaintDevice , subclasses can be used to display custom content that is composed using a series of painting operations with an instance of the QPainter class. This approach contrasts with the canvas-style approach used by the Graphics View Framework where items are added to a scene by the application and are rendered by the framework itself.

Each widget performs all painting operations from within its paintEvent() function. This is called whenever the widget needs to be redrawn, either as a result of some external change or when requested by the application.

The Analog Clock example shows how a simple widget can handle paint events.

Size Hints and Size Policies

When implementing a new widget, it is almost always useful to reimplement sizeHint() to provide a reasonable default size for the widget and to set the correct size policy with setSizePolicy() .

By default, composite widgets which do not provide a size hint will be sized according to the space requirements of their child widgets.

The size policy lets you supply good default behavior for the layout management system, so that other widgets can contain and manage yours easily. The default size policy indicates that the size hint represents the preferred size of the widget, and this is often good enough for many widgets.

Note

The size of top-level widgets are constrained to 2/3 of the desktop’s height and width. You can resize() the widget manually if these bounds are inadequate.

Events

Widgets respond to events that are typically caused by user actions. Qt delivers events to widgets by calling specific event handler functions with instances of QEvent subclasses containing information about each event.

If your widget only contains child widgets, you probably do not need to implement any event handlers. If you want to detect a mouse click in a child widget call the child’s underMouse() function inside the widget’s mousePressEvent() .

The Scribble example implements a wider set of events to handle mouse movement, button presses, and window resizing.

You will need to supply the behavior and content for your own widgets, but here is a brief overview of the events that are relevant to QWidget , starting with the most common ones:

• paintEvent() is called whenever the widget needs to be repainted. Every widget displaying custom content must implement it. Painting using a QPainter can only take place in a paintEvent() or a function called by a paintEvent() .

• resizeEvent() is called when the widget has been resized.

• mousePressEvent() is called when a mouse button is pressed while the mouse cursor is inside the widget, or when the widget has grabbed the mouse using grabMouse() . Pressing the mouse without releasing it is effectively the same as calling grabMouse() .

• mouseReleaseEvent() is called when a mouse button is released. A widget receives mouse release events when it has received the corresponding mouse press event. This means that if the user presses the mouse inside your widget, then drags the mouse somewhere else before releasing the mouse button, your widget receives the release event. There is one exception: if a popup menu appears while the mouse button is held down, this popup immediately steals the mouse events.

• mouseDoubleClickEvent() is called when the user double-clicks in the widget. If the user double-clicks, the widget receives a mouse press event, a mouse release event, (a mouse click event,) a second mouse press, this event and finally a second mouse release event. (Some mouse move events may also be received if the mouse is not held steady during this operation.) It is not possible to distinguish a click from a double-click until the second click arrives. (This is one reason why most GUI books recommend that double-clicks be an extension of single-clicks, rather than trigger a different action.)

Widgets that accept keyboard input need to reimplement a few more event handlers:

• keyPressEvent() is called whenever a key is pressed, and again when a key has been held down long enough for it to auto-repeat. The Tab and Shift+Tab keys are only passed to the widget if they are not used by the focus-change mechanisms. To force those keys to be processed by your widget, you must reimplement event() .

• focusInEvent() is called when the widget gains keyboard focus (assuming you have called setFocusPolicy() ). Well-behaved widgets indicate that they own the keyboard focus in a clear but discreet way.

• focusOutEvent() is called when the widget loses keyboard focus.

You may be required to also reimplement some of the less common event handlers:

• mouseMoveEvent() is called whenever the mouse moves while a mouse button is held down. This can be useful during drag and drop operations. If you call setMouseTracking (true), you get mouse move events even when no buttons are held down. (See also the Drag and Drop guide.)

• keyReleaseEvent() is called whenever a key is released and while it is held down (if the key is auto-repeating). In that case, the widget will receive a pair of key release and key press event for every repeat. The Tab and Shift+Tab keys are only passed to the widget if they are not used by the focus-change mechanisms. To force those keys to be processed by your widget, you must reimplement event() .

• wheelEvent() is called whenever the user turns the mouse wheel while the widget has the focus.

• enterEvent() is called when the mouse enters the widget’s screen space. (This excludes screen space owned by any of the widget’s children.)

• leaveEvent() is called when the mouse leaves the widget’s screen space. If the mouse enters a child widget it will not cause a leaveEvent() .

• moveEvent() is called when the widget has been moved relative to its parent.

• closeEvent() is called when the user closes the widget (or when close() is called).

There are also some rather obscure events described in the documentation for Type . To handle these events, you need to reimplement event() directly.

The default implementation of event() handles Tab and Shift+Tab (to move the keyboard focus), and passes on most of the other events to one of the more specialized handlers above.

Events and the mechanism used to deliver them are covered in The Event System .

Groups of Functions and Properties

Context	Functions and Properties
Window functions	show() , hide() , raise() , lower() , close() .
Top-level windows	windowModified , windowTitle , windowIcon , isActiveWindow , activateWindow() , minimized , showMinimized() , maximized , showMaximized() , fullScreen , showFullScreen() , showNormal() .
Window contents	update() , repaint() , scroll() .
Geometry	pos , x() , y() , rect , size , width() , height() , move() , resize() , sizePolicy , sizeHint() , minimumSizeHint() , updateGeometry() , layout() , frameGeometry , geometry , childrenRect , childrenRegion , adjustSize() , mapFromGlobal() , mapToGlobal() , mapFromParent() , mapToParent() , maximumSize , minimumSize , sizeIncrement , baseSize , setFixedSize()
Mode	visible , isVisibleTo() , enabled , isEnabledTo() , modal , isWindow() , mouseTracking , updatesEnabled , visibleRegion() .
Look and feel	style() , setStyle() , styleSheet , cursor , font , palette , backgroundRole() , setBackgroundRole() , fontInfo() , fontMetrics() .
Keyboard focus functions	focus , focusPolicy , setFocus() , clearFocus() , setTabOrder() , setFocusProxy() , focusNextChild() , focusPreviousChild() .
Mouse and keyboard grabbing	grabMouse() , releaseMouse() , grabKeyboard() , releaseKeyboard() , mouseGrabber() , keyboardGrabber() .
Event handlers	event() , mousePressEvent() , mouseReleaseEvent() , mouseDoubleClickEvent() , mouseMoveEvent() , keyPressEvent() , keyReleaseEvent() , focusInEvent() , focusOutEvent() , wheelEvent() , enterEvent() , leaveEvent() , paintEvent() , moveEvent() , resizeEvent() , closeEvent() , dragEnterEvent() , dragMoveEvent() , dragLeaveEvent() , dropEvent() , childEvent() , showEvent() , hideEvent() , customEvent() . changeEvent() ,
System functions	parentWidget() , window() , setParent() , winId() , find() , metric() .
Context menu	contextMenuPolicy , contextMenuEvent() , customContextMenuRequested() , actions()
Interactive help	setToolTip() , setWhatsThis()

Widget Style Sheets

In addition to the standard widget styles for each platform, widgets can also be styled according to rules specified in a style sheet . This feature enables you to customize the appearance of specific widgets to provide visual cues to users about their purpose. For example, a button could be styled in a particular way to indicate that it performs a destructive action.

The use of widget style sheets is described in more detail in the Qt Style Sheets document.

Transparency and Double Buffering

Since Qt 4.0, QWidget automatically double-buffers its painting, so there is no need to write double-buffering code in paintEvent() to avoid flicker.

Since Qt 4.1, the contents of parent widgets are propagated by default to each of their children as long as WA_PaintOnScreen is not set. Custom widgets can be written to take advantage of this feature by updating irregular regions (to create non-rectangular child widgets), or painting with colors that have less than full alpha component. The following diagram shows how attributes and properties of a custom widget can be fine-tuned to achieve different effects.

In the above diagram, a semi-transparent rectangular child widget with an area removed is constructed and added to a parent widget (a QLabel showing a pixmap). Then, different properties and widget attributes are set to achieve different effects:

• The left widget has no additional properties or widget attributes set. This default state suits most custom widgets using transparency, are irregularly-shaped, or do not paint over their entire area with an opaque brush.

• The center widget has the autoFillBackground property set. This property is used with custom widgets that rely on the widget to supply a default background, and do not paint over their entire area with an opaque brush.

• The right widget has the WA_OpaquePaintEvent widget attribute set. This indicates that the widget will paint over its entire area with opaque colors. The widget’s area will initially be uninitialized, represented in the diagram with a red diagonal grid pattern that shines through the overpainted area. The Qt::WA_OpaquePaintArea attribute is useful for widgets that need to paint their own specialized contents quickly and do not need a default filled background.

To rapidly update custom widgets with simple background colors, such as real-time plotting or graphing widgets, it is better to define a suitable background color (using setBackgroundRole() with the Window role), set the autoFillBackground property, and only implement the necessary drawing functionality in the widget’s paintEvent() .

To rapidly update custom widgets that constantly paint over their entire areas with opaque content, e.g., video streaming widgets, it is better to set the widget’s WA_OpaquePaintEvent , avoiding any unnecessary overhead associated with repainting the widget’s background.

If a widget has both the WA_OpaquePaintEvent widget attribute and the autoFillBackground property set, the WA_OpaquePaintEvent attribute takes precedence. Depending on your requirements, you should choose either one of them.

Since Qt 4.1, the contents of parent widgets are also propagated to standard Qt widgets. This can lead to some unexpected results if the parent widget is decorated in a non-standard way, as shown in the diagram below.

The scope for customizing the painting behavior of standard Qt widgets, without resorting to subclassing, is slightly less than that possible for custom widgets. Usually, the desired appearance of a standard widget can be achieved by setting its autoFillBackground property.

Creating Translucent Windows

Since Qt 4.5, it has been possible to create windows with translucent regions on window systems that support compositing.

To enable this feature in a top-level widget, set its WA_TranslucentBackground attribute with setAttribute() and ensure that its background is painted with non-opaque colors in the regions you want to be partially transparent.

Platform notes:

• X11: This feature relies on the use of an X server that supports ARGB visuals and a compositing window manager.

• Windows: The widget needs to have the FramelessWindowHint window flag set for the translucency to work.

• macOS: The widget needs to have the FramelessWindowHint window flag set for the translucency to work.

Native Widgets vs Alien Widgets

Introduced in Qt 4.4, alien widgets are widgets unknown to the windowing system. They do not have a native window handle associated with them. This feature significantly speeds up widget painting, resizing, and removes flicker.

Should you require the old behavior with native windows, you can choose one of the following options:

1. Use the QT_USE_NATIVE_WINDOWS=1 in your environment.

2. Set the AA_NativeWindows attribute on your application. All widgets will be native widgets.

3. Set the WA_NativeWindow attribute on widgets: The widget itself and all of its ancestors will become native (unless WA_DontCreateNativeAncestors is set).

4. Call winId to enforce a native window (this implies 3).

5. Set the WA_PaintOnScreen attribute to enforce a native window (this implies 3).

See also

QEvent QPainter QGridLayout QBoxLayout

class PySide2.QtWidgets.QWidget([parent=None[, f=Qt.WindowFlags()]])

param f:

WindowFlags

param parent:

PySide2.QtWidgets.QWidget

Constructs a widget which is a child of parent , with widget flags set to f .

If parent is None , the new widget becomes a window. If parent is another widget, this widget becomes a child window inside parent . The new widget is deleted when its parent is deleted.

The widget flags argument, f , is normally 0, but it can be set to customize the frame of a window (i.e. parent must be None ). To customize the frame, use a value composed from the bitwise OR of any of the window flags .

If you add a child widget to an already visible widget you must explicitly show the child to make it visible.

Note that the X11 version of Qt may not be able to deliver all combinations of style flags on all systems. This is because on X11, Qt can only ask the window manager, and the window manager can override the application’s settings. On Windows, Qt can set whatever flags you want.

See also

windowFlags

PySide2.QtWidgets.QWidget.RenderFlag

This enum describes how to render the widget when calling render() .

Constant	Description
QWidget.DrawWindowBackground	If you enable this option, the widget’s background is rendered into the target even if autoFillBackground is not set. By default, this option is enabled.
QWidget.DrawChildren	If you enable this option, the widget’s children are rendered recursively into the target. By default, this option is enabled.
QWidget.IgnoreMask	If you enable this option, the widget’s mask() is ignored when rendering into the target. By default, this option is disabled.

PySide2.QtWidgets.QWidget.acceptDrops()

Return type:

bool

This property holds whether drop events are enabled for this widget.

Setting this property to true announces to the system that this widget may be able to accept drop events.

If the widget is the desktop ( windowType() == Desktop ), this may fail if another application is using the desktop; you can call to test if this occurs.

Warning

Do not modify this property in a drag and drop event handler.

By default, this property is false .

See also

Drag and Drop

PySide2.QtWidgets.QWidget.accessibleDescription()

Return type:

str

This property holds the widget’s description as seen by assistive technologies.

The accessible description of a widget should convey what a widget does. While the accessibleName should be a short and concise string (e.g. Save ), the description should give more context, such as Saves the current document .

This property has to be localized.

By default, this property contains an empty string and Qt falls back to using the tool tip to provide this information.

See also

accessibleName text()

PySide2.QtWidgets.QWidget.accessibleName()

Return type:

str

This property holds the widget’s name as seen by assistive technologies.

This is the primary name by which assistive technology such as screen readers announce this widget. For most widgets setting this property is not required. For example for QPushButton the button’s text will be used.

It is important to set this property when the widget does not provide any text. For example a button that only contains an icon needs to set this property to work with screen readers. The name should be short and equivalent to the visual information conveyed by the widget.

This property has to be localized.

By default, this property contains an empty string.

See also

accessibleDescription text()

PySide2.QtWidgets.QWidget.actionEvent(event)

Parameters:

event – PySide2.QtGui.QActionEvent

This event handler is called with the given event whenever the widget’s actions are changed.

See also

addAction() insertAction() removeAction() actions() QActionEvent

PySide2.QtWidgets.QWidget.actions()

Return type:

Returns the (possibly empty) list of this widget’s actions.

See also

contextMenuPolicy insertAction() removeAction()

PySide2.QtWidgets.QWidget.activateWindow()

Sets the top-level widget containing this widget to be the active window.

An active window is a visible top-level window that has the keyboard input focus.

This function performs the same operation as clicking the mouse on the title bar of a top-level window. On X11, the result depends on the Window Manager. If you want to ensure that the window is stacked on top as well you should also call raise() . Note that the window must be visible, otherwise has no effect.

On Windows, if you are calling this when the application is not currently the active one then it will not make it the active window. It will change the color of the taskbar entry to indicate that the window has changed in some way. This is because Microsoft does not allow an application to interrupt what the user is currently doing in another application.

See also

isActiveWindow() window() show() setWindowActivationBehavior()

PySide2.QtWidgets.QWidget.addAction(action)

Parameters:

action – PySide2.QtWidgets.QAction

Appends the action action to this widget’s list of actions.

All QWidgets have a list of QAction s, however they can be represented graphically in many different ways. The default use of the QAction list (as returned by actions() ) is to create a context QMenu .

A QWidget should only have one of each action and adding an action it already has will not cause the same action to be in the widget twice.

The ownership of action is not transferred to this QWidget .

See also

removeAction() insertAction() actions() QMenu

PySide2.QtWidgets.QWidget.addActions(actions)

Parameters:

actions –

Appends the actions actions to this widget’s list of actions.

See also

removeAction() QMenu addAction()

PySide2.QtWidgets.QWidget.adjustSize()

Adjusts the size of the widget to fit its contents.

This function uses sizeHint() if it is valid, i.e., the size hint’s width and height are >= 0. Otherwise, it sets the size to the children rectangle that covers all child widgets (the union of all child widget rectangles).

For windows, the screen size is also taken into account. If the sizeHint() is less than (200, 100) and the size policy is expanding , the window will be at least (200, 100). The maximum size of a window is 2/3 of the screen’s width and height.

See also

sizeHint() childrenRect()

PySide2.QtWidgets.QWidget.autoFillBackground()

Return type:

bool

This property holds whether the widget background is filled automatically.

If enabled, this property will cause Qt to fill the background of the widget before invoking the paint event. The color used is defined by the Window color role from the widget’s palette .

In addition, Windows are always filled with Window , unless the WA_OpaquePaintEvent or WA_NoSystemBackground attributes are set.

This property cannot be turned off (i.e., set to false) if a widget’s parent has a static gradient for its background.

Warning

Use this property with caution in conjunction with Qt Style Sheets . When a widget has a style sheet with a valid background or a border-image, this property is automatically disabled.

By default, this property is false .

See also

WA_OpaquePaintEvent WA_NoSystemBackground Transparency and Double Buffering

PySide2.QtWidgets.QWidget.backgroundRole()

Return type:

ColorRole

Returns the background role of the widget.

The background role defines the brush from the widget’s palette that is used to render the background.

If no explicit background role is set, the widget inherts its parent widget’s background role.

See also

setBackgroundRole() foregroundRole()

PySide2.QtWidgets.QWidget.backingStore()

Return type:

PySide2.QtGui.QBackingStore

Returns the QBackingStore this widget will be drawn into.

PySide2.QtWidgets.QWidget.baseSize()

Return type:

PySide2.QtCore.QSize

This property holds the base size of the widget.

The base size is used to calculate a proper widget size if the widget defines sizeIncrement() .

By default, for a newly-created widget, this property contains a size with zero width and height.

See also

setSizeIncrement()

PySide2.QtWidgets.QWidget.changeEvent(event)

Parameters:

event – PySide2.QtCore.QEvent

This event handler can be reimplemented to handle state changes.

The state being changed in this event can be retrieved through the event supplied.

Change events include: ToolBarChange , ActivationChange , EnabledChange , FontChange , StyleChange , PaletteChange , WindowTitleChange , IconTextChange , ModifiedChange , MouseTrackingChange , ParentChange , WindowStateChange , LanguageChange , LocaleChange , LayoutDirectionChange , ReadOnlyChange .

PySide2.QtWidgets.QWidget.childAt(x, y)

Parameters:

• x – int

• y – int

Return type:

PySide2.QtWidgets.QWidget

Returns the visible child widget at the position (x , y ) in the widget’s coordinate system. If there is no visible child widget at the specified position, the function returns None .

PySide2.QtWidgets.QWidget.childAt(p)

Parameters:

p – PySide2.QtCore.QPoint

Return type:

PySide2.QtWidgets.QWidget

This is an overloaded function.

Returns the visible child widget at point p in the widget’s own coordinate system.

PySide2.QtWidgets.QWidget.childrenRect()

Return type:

PySide2.QtCore.QRect

This property holds the bounding rectangle of the widget’s children.

Hidden children are excluded.

By default, for a widget with no children, this property contains a rectangle with zero width and height located at the origin.

See also

childrenRegion() geometry()

PySide2.QtWidgets.QWidget.childrenRegion()

Return type:

PySide2.QtGui.QRegion

This property holds the combined region occupied by the widget’s children.

Hidden children are excluded.

By default, for a widget with no children, this property contains an empty region.

See also

childrenRect() geometry() mask()

PySide2.QtWidgets.QWidget.clearFocus()

Takes keyboard input focus from the widget.

If the widget has active focus, a focus out event is sent to this widget to tell it that it has lost the focus.

This widget must enable focus setting in order to get the keyboard input focus, i.e. it must call setFocusPolicy() .

See also

hasFocus() setFocus() focusInEvent() focusOutEvent() setFocusPolicy() focusWidget()

PySide2.QtWidgets.QWidget.clearMask()

Removes any mask set by setMask() .

See also

setMask()

PySide2.QtWidgets.QWidget.close()

Return type:

bool

Closes this widget. Returns true if the widget was closed; otherwise returns false .

First it sends the widget a QCloseEvent . The widget is hidden if it accepts the close event. If it ignores the event, nothing happens. The default implementation of closeEvent() accepts the close event.

If the widget has the WA_DeleteOnClose flag, the widget is also deleted. A close events is delivered to the widget no matter if the widget is visible or not.

The lastWindowClosed() signal is emitted when the last visible primary window (i.e. window with no parent) with the WA_QuitOnClose attribute set is closed. By default this attribute is set for all widgets except transient windows such as splash screens, tool windows, and popup menus.

PySide2.QtWidgets.QWidget.closeEvent(event)

Parameters:

event – PySide2.QtGui.QCloseEvent

This event handler is called with the given event when Qt receives a window close request for a top-level widget from the window system.

By default, the event is accepted and the widget is closed. You can reimplement this function to change the way the widget responds to window close requests. For example, you can prevent the window from closing by calling ignore() on all events.

Main window applications typically use reimplementations of this function to check whether the user’s work has been saved and ask for permission before closing. For example, the Application Example uses a helper function to determine whether or not to close the window:

def closeEvent(self, event):
    if maybeSave():
        writeSettings()
        event.accept()
    else:
        event.ignore()

See also

event() hide() close() QCloseEvent Application Example

PySide2.QtWidgets.QWidget.contentsMargins()

Return type:

PySide2.QtCore.QMargins

The function returns the widget’s contents margins.

See also

setContentsMargins() contentsRect()

PySide2.QtWidgets.QWidget.contentsRect()

Return type:

PySide2.QtCore.QRect

Returns the area inside the widget’s margins.

See also

setContentsMargins() contentsMargins()

PySide2.QtWidgets.QWidget.contextMenuEvent(event)

Parameters:

event – PySide2.QtGui.QContextMenuEvent

This event handler, for event event , can be reimplemented in a subclass to receive widget context menu events.

The handler is called when the widget’s contextMenuPolicy is DefaultContextMenu .

The default implementation ignores the context event. See the QContextMenuEvent documentation for more details.

See also

event() QContextMenuEvent customContextMenuRequested()

PySide2.QtWidgets.QWidget.contextMenuPolicy()

Return type:

ContextMenuPolicy

This property holds how the widget shows a context menu.

The default value of this property is DefaultContextMenu , which means the contextMenuEvent() handler is called. Other values are NoContextMenu , PreventContextMenu , ActionsContextMenu , and CustomContextMenu . With CustomContextMenu , the signal customContextMenuRequested() is emitted.

See also

contextMenuEvent() customContextMenuRequested() actions()

PySide2.QtWidgets.QWidget.create([arg__1=0[, initializeWindow=true[, destroyOldWindow=true]]])

Parameters:

• arg__1 – WId

• initializeWindow – bool

• destroyOldWindow – bool

Creates a new widget window.

The parameters window , initializeWindow , and destroyOldWindow are ignored in Qt 5. Please use fromWinId() to create a QWindow wrapping a foreign window and pass it to createWindowContainer() instead.

See also

createWindowContainer() fromWinId()

PySide2.QtWidgets.QWidget.createWinId()

Ensures that the widget has a window system identifier, i.e. that it is known to the windowing system.

static PySide2.QtWidgets.QWidget.createWindowContainer(window[, parent=None[, flags=Qt.WindowFlags()]])

Parameters:

• window – PySide2.QtGui.QWindow

• parent – PySide2.QtWidgets.QWidget

• flags – WindowFlags

Return type:

PySide2.QtWidgets.QWidget

Creates a QWidget that makes it possible to embed window into a QWidget -based application.

The window container is created as a child of parent and with window flags flags .

Once the window has been embedded into the container, the container will control the window’s geometry and visibility. Explicit calls to setGeometry() , show() or hide() on an embedded window is not recommended.

The container takes over ownership of window . The window can be removed from the window container with a call to setParent() .

The window container is attached as a native child window to the toplevel window it is a child of. When a window container is used as a child of a QAbstractScrollArea or QMdiArea , it will create a native window for every widget in its parent chain to allow for proper stacking and clipping in this use case. Creating a native window for the window container also allows for proper stacking and clipping. This must be done before showing the window container. Applications with many native child windows may suffer from performance issues.

The window container has a number of known limitations:

• Stacking order; The embedded window will stack on top of the widget hierarchy as an opaque box. The stacking order of multiple overlapping window container instances is undefined.

• Rendering Integration; The window container does not interoperate with QGraphicsProxyWidget , render() or similar functionality.

• Focus Handling; It is possible to let the window container instance have any focus policy and it will delegate focus to the window via a call to requestActivate() . However, returning to the normal focus chain from the QWindow instance will be up to the QWindow instance implementation itself. For instance, when entering a Qt Quick based window with tab focus, it is quite likely that further tab presses will only cycle inside the QML application. Also, whether requestActivate() actually gives the window focus, is platform dependent.

• Using many window container instances in a QWidget -based application can greatly hurt the overall performance of the application.

PySide2.QtWidgets.QWidget.cursor()

Return type:

PySide2.QtGui.QCursor

This property holds the cursor shape for this widget.

The mouse cursor will assume this shape when it’s over this widget. See the list of predefined cursor objects for a range of useful shapes.

An editor widget might use an I-beam cursor:

widget.setCursor(Qt.IBeamCursor)

If no cursor has been set, or after a call to , the parent’s cursor is used.

By default, this property contains a cursor with the ArrowCursor shape.

Some underlying window implementations will reset the cursor if it leaves a widget even if the mouse is grabbed. If you want to have a cursor set for all widgets, even when outside the window, consider setOverrideCursor() .

See also

setOverrideCursor()

PySide2.QtWidgets.QWidget.customContextMenuRequested(pos)

Parameters:

pos – PySide2.QtCore.QPoint

PySide2.QtWidgets.QWidget.destroy([destroyWindow=true[, destroySubWindows=true]])

Parameters:

• destroyWindow – bool

• destroySubWindows – bool

Frees up window system resources. Destroys the widget window if destroyWindow is true.

calls itself recursively for all the child widgets, passing destroySubWindows for the destroyWindow parameter. To have more control over destruction of subwidgets, destroy subwidgets selectively first.

This function is usually called from the QWidget destructor.

PySide2.QtWidgets.QWidget.dragEnterEvent(event)

Parameters:

event – PySide2.QtGui.QDragEnterEvent

This event handler is called when a drag is in progress and the mouse enters this widget. The event is passed in the event parameter.

If the event is ignored, the widget won’t receive any drag move events .

See the Drag-and-drop documentation for an overview of how to provide drag-and-drop in your application.

See also

QDrag QDragEnterEvent

PySide2.QtWidgets.QWidget.dragLeaveEvent(event)

Parameters:

event – PySide2.QtGui.QDragLeaveEvent

This event handler is called when a drag is in progress and the mouse leaves this widget. The event is passed in the event parameter.

See the Drag-and-drop documentation for an overview of how to provide drag-and-drop in your application.

See also

QDrag QDragLeaveEvent

PySide2.QtWidgets.QWidget.dragMoveEvent(event)

Parameters:

event – PySide2.QtGui.QDragMoveEvent

This event handler is called if a drag is in progress, and when any of the following conditions occur: the cursor enters this widget, the cursor moves within this widget, or a modifier key is pressed on the keyboard while this widget has the focus. The event is passed in the event parameter.

See the Drag-and-drop documentation for an overview of how to provide drag-and-drop in your application.

See also

QDrag QDragMoveEvent

PySide2.QtWidgets.QWidget.dropEvent(event)

Parameters:

event – PySide2.QtGui.QDropEvent

This event handler is called when the drag is dropped on this widget. The event is passed in the event parameter.

See the Drag-and-drop documentation for an overview of how to provide drag-and-drop in your application.

See also

QDrag QDropEvent

PySide2.QtWidgets.QWidget.effectiveWinId()

Return type:

WId

Returns the effective window system identifier of the widget, i.e. the native parent’s window system identifier.

If the widget is native, this function returns the native widget ID. Otherwise, the window ID of the first native parent widget, i.e., the top-level widget that contains this widget, is returned.

Note

We recommend that you do not store this value as it is likely to change at run-time.

See also

nativeParentWidget()

PySide2.QtWidgets.QWidget.ensurePolished()

Ensures that the widget and its children have been polished by QStyle (i.e., have a proper font and palette).

QWidget calls this function after it has been fully constructed but before it is shown the very first time. You can call this function if you want to ensure that the widget is polished before doing an operation, e.g., the correct font size might be needed in the widget’s sizeHint() reimplementation. Note that this function is called from the default implementation of sizeHint() .

Polishing is useful for final initialization that must happen after all constructors (from base classes as well as from subclasses) have been called.

If you need to change some settings when a widget is polished, reimplement event() and handle the Polish event type.

Note

The function is declared const so that it can be called from other const functions (e.g., sizeHint() ).

See also

event()

PySide2.QtWidgets.QWidget.enterEvent(event)

Parameters:

event – PySide2.QtCore.QEvent

This event handler can be reimplemented in a subclass to receive widget enter events which are passed in the event parameter.

An event is sent to the widget when the mouse cursor enters the widget.

See also

leaveEvent() mouseMoveEvent() event()

static PySide2.QtWidgets.QWidget.find(arg__1)

Parameters:

arg__1 – WId

Return type:

PySide2.QtWidgets.QWidget

Returns a pointer to the widget with window identifier/handle id .

The window identifier type depends on the underlying window system, see qwindowdefs.h for the actual definition. If there is no widget with this identifier, None is returned.

PySide2.QtWidgets.QWidget.focusInEvent(event)

Parameters:

event – PySide2.QtGui.QFocusEvent

This event handler can be reimplemented in a subclass to receive keyboard focus events (focus received) for the widget. The event is passed in the event parameter

A widget normally must setFocusPolicy() to something other than NoFocus in order to receive focus events. (Note that the application programmer can call setFocus() on any widget, even those that do not normally accept focus.)

The default implementation updates the widget (except for windows that do not specify a focusPolicy() ).

See also

focusOutEvent() setFocusPolicy() keyPressEvent() keyReleaseEvent() event() QFocusEvent

PySide2.QtWidgets.QWidget.focusNextChild()

Return type:

bool

Finds a new widget to give the keyboard focus to, as appropriate for Tab, and returns true if it can find a new widget, or false if it can’t.

See also

focusPreviousChild()

PySide2.QtWidgets.QWidget.focusNextPrevChild(next)

Parameters:

next – bool

Return type:

bool

Finds a new widget to give the keyboard focus to, as appropriate for Tab and Shift+Tab, and returns true if it can find a new widget, or false if it can’t.

If next is true, this function searches forward, if next is false, it searches backward.

Sometimes, you will want to reimplement this function. For example, a web browser might reimplement it to move its “current active link” forward or backward, and call only when it reaches the last or first link on the “page”.

Child widgets call on their parent widgets, but only the window that contains the child widgets decides where to redirect focus. By reimplementing this function for an object, you thus gain control of focus traversal for all child widgets.

See also

focusNextChild() focusPreviousChild()

PySide2.QtWidgets.QWidget.focusOutEvent(event)

Parameters:

event – PySide2.QtGui.QFocusEvent

This event handler can be reimplemented in a subclass to receive keyboard focus events (focus lost) for the widget. The events is passed in the event parameter.

A widget normally must setFocusPolicy() to something other than NoFocus in order to receive focus events. (Note that the application programmer can call setFocus() on any widget, even those that do not normally accept focus.)

The default implementation updates the widget (except for windows that do not specify a focusPolicy() ).

See also

focusInEvent() setFocusPolicy() keyPressEvent() keyReleaseEvent() event() QFocusEvent

PySide2.QtWidgets.QWidget.focusPolicy()

Return type:

FocusPolicy

This property holds the way the widget accepts keyboard focus.

The policy is TabFocus if the widget accepts keyboard focus by tabbing, ClickFocus if the widget accepts focus by clicking, StrongFocus if it accepts both, and NoFocus (the default) if it does not accept focus at all.

You must enable keyboard focus for a widget if it processes keyboard events. This is normally done from the widget’s constructor. For instance, the QLineEdit constructor calls ( StrongFocus ).

If the widget has a focus proxy, then the focus policy will be propagated to it.

See also

focusInEvent() focusOutEvent() keyPressEvent() keyReleaseEvent() enabled

PySide2.QtWidgets.QWidget.focusPreviousChild()

Return type:

bool

Finds a new widget to give the keyboard focus to, as appropriate for Shift+Tab, and returns true if it can find a new widget, or false if it can’t.

See also

focusNextChild()

PySide2.QtWidgets.QWidget.focusProxy()

Return type:

PySide2.QtWidgets.QWidget

Returns the focus proxy, or None if there is no focus proxy.

See also

setFocusProxy()

PySide2.QtWidgets.QWidget.focusWidget()

Return type:

PySide2.QtWidgets.QWidget

Returns the last child of this widget that setFocus had been called on. For top level widgets this is the widget that will get focus in case this window gets activated

This is not the same as focusWidget() , which returns the focus widget in the currently active window.

PySide2.QtWidgets.QWidget.font()

Return type:

PySide2.QtGui.QFont

This property holds the font currently set for the widget.

This property describes the widget’s requested font. The font is used by the widget’s style when rendering standard components, and is available as a means to ensure that custom widgets can maintain consistency with the native platform’s look and feel. It’s common that different platforms, or different styles, define different fonts for an application.

When you assign a new font to a widget, the properties from this font are combined with the widget’s default font to form the widget’s final font. You can call fontInfo() to get a copy of the widget’s final font. The final font is also used to initialize QPainter ‘s font.

The default depends on the system environment. QApplication maintains a system/theme font which serves as a default for all widgets. There may also be special font defaults for certain types of widgets. You can also define default fonts for widgets yourself by passing a custom font and the name of a widget to setFont() . Finally, the font is matched against Qt’s font database to find the best match.

QWidget propagates explicit font properties from parent to child. If you change a specific property on a font and assign that font to a widget, that property will propagate to all the widget’s children, overriding any system defaults for that property. Note that fonts by default don’t propagate to windows (see isWindow() ) unless the WA_WindowPropagation attribute is enabled.

QWidget ‘s font propagation is similar to its palette propagation.

The current style, which is used to render the content of all standard Qt widgets, is free to choose to use the widget font, or in some cases, to ignore it (partially, or completely). In particular, certain styles like GTK style, Mac style, and Windows Vista style, apply special modifications to the widget font to match the platform’s native look and feel. Because of this, assigning properties to a widget’s font is not guaranteed to change the appearance of the widget. Instead, you may choose to apply a styleSheet .

Note

If Qt Style Sheets are used on the same widget as , style sheets will take precedence if the settings conflict.

See also

fontInfo() fontMetrics()

PySide2.QtWidgets.QWidget.fontInfo()

Return type:

PySide2.QtGui.QFontInfo

Returns the font info for the widget’s current font. Equivalent to QFontInfo(widget->font()) .

See also

font() fontMetrics() setFont()

PySide2.QtWidgets.QWidget.fontMetrics()

Return type:

PySide2.QtGui.QFontMetrics

Returns the font metrics for the widget’s current font. Equivalent to QFontMetrics(widget->font()) .

See also

font() fontInfo() setFont()

PySide2.QtWidgets.QWidget.foregroundRole()

Return type:

ColorRole

Returns the foreground role.

The foreground role defines the color from the widget’s palette that is used to draw the foreground.

If no explicit foreground role is set, the function returns a role that contrasts with the background role.

See also

setForegroundRole() backgroundRole()

PySide2.QtWidgets.QWidget.frameGeometry()

Return type:

PySide2.QtCore.QRect

This property holds geometry of the widget relative to its parent including any window frame.

See the Window Geometry documentation for an overview of geometry issues with windows.

By default, this property contains a value that depends on the user’s platform and screen geometry.

See also

geometry() x() y() pos()

PySide2.QtWidgets.QWidget.frameSize()

Return type:

PySide2.QtCore.QSize

This property holds the size of the widget including any window frame.

By default, this property contains a value that depends on the user’s platform and screen geometry.

PySide2.QtWidgets.QWidget.geometry()

Return type:

PySide2.QtCore.QRect

This property holds the geometry of the widget relative to its parent and excluding the window frame.

When changing the geometry, the widget, if visible, receives a move event ( moveEvent() ) and/or a resize event ( resizeEvent() ) immediately. If the widget is not currently visible, it is guaranteed to receive appropriate events before it is shown.

The size component is adjusted if it lies outside the range defined by minimumSize() and maximumSize() .

Warning

Calling inside resizeEvent() or moveEvent() can lead to infinite recursion.

See the Window Geometry documentation for an overview of geometry issues with windows.

By default, this property contains a value that depends on the user’s platform and screen geometry.

See also

frameGeometry() rect() move() resize() moveEvent() resizeEvent() minimumSize() maximumSize()

PySide2.QtWidgets.QWidget.getContentsMargins()

Note

This function is deprecated.

Use contentsMargins() .

Returns the widget’s contents margins for left , top , right , and bottom .

See also

setContentsMargins() contentsRect()

PySide2.QtWidgets.QWidget.grab([rectangle=QRect(QPoint(0, 0), QSize(-1, -1))])

Parameters:

rectangle – PySide2.QtCore.QRect

Return type:

PySide2.QtGui.QPixmap

Renders the widget into a pixmap restricted by the given rectangle . If the widget has any children, then they are also painted in the appropriate positions.

If a rectangle with an invalid size is specified (the default), the entire widget is painted.

See also

render() QPixmap

PySide2.QtWidgets.QWidget.grabGesture(type[, flags=Qt.GestureFlags()])

Parameters:

• type – GestureType

• flags – GestureFlags

Subscribes the widget to a given gesture with specific flags .

See also

ungrabGesture() QGestureEvent

PySide2.QtWidgets.QWidget.grabKeyboard()

Grabs the keyboard input.

This widget receives all keyboard events until releaseKeyboard() is called; other widgets get no keyboard events at all. Mouse events are not affected. Use grabMouse() if you want to grab that.

The focus widget is not affected, except that it doesn’t receive any keyboard events. setFocus() moves the focus as usual, but the new focus widget receives keyboard events only after releaseKeyboard() is called.

If a different widget is currently grabbing keyboard input, that widget’s grab is released first.

See also

releaseKeyboard() grabMouse() releaseMouse() focusWidget()

PySide2.QtWidgets.QWidget.grabMouse(arg__1)

Parameters:

arg__1 – PySide2.QtGui.QCursor

This function overloads grabMouse() .

Grabs the mouse input and changes the cursor shape.

The cursor will assume shape cursor (for as long as the mouse focus is grabbed) and this widget will be the only one to receive mouse events until releaseMouse() is called().

Warning

Grabbing the mouse might lock the terminal.

Note

See the note in grabMouse() .

See also

releaseMouse() grabKeyboard() releaseKeyboard() setCursor()

PySide2.QtWidgets.QWidget.grabMouse()

Grabs the mouse input.

This widget receives all mouse events until releaseMouse() is called; other widgets get no mouse events at all. Keyboard events are not affected. Use grabKeyboard() if you want to grab that.

Warning

Bugs in mouse-grabbing applications very often lock the terminal. Use this function with extreme caution, and consider using the -nograb command line option while debugging.

It is almost never necessary to grab the mouse when using Qt, as Qt grabs and releases it sensibly. In particular, Qt grabs the mouse when a mouse button is pressed and keeps it until the last button is released.

Note

Only visible widgets can grab mouse input. If isVisible() returns false for a widget, that widget cannot call .

Note

On Windows, only works when the mouse is inside a window owned by the process. On macOS, only works when the mouse is inside the frame of that widget.

See also

releaseMouse() grabKeyboard() releaseKeyboard()

PySide2.QtWidgets.QWidget.grabShortcut(key[, context=Qt.WindowShortcut])

Parameters:

• key – PySide2.QtGui.QKeySequence

• context – ShortcutContext

Return type:

int

Adds a shortcut to Qt’s shortcut system that watches for the given key sequence in the given context . If the context is ApplicationShortcut , the shortcut applies to the application as a whole. Otherwise, it is either local to this widget, WidgetShortcut , or to the window itself, WindowShortcut .

If the same key sequence has been grabbed by several widgets, when the key sequence occurs a Shortcut event is sent to all the widgets to which it applies in a non-deterministic order, but with the ``ambiguous’’ flag set to true.

Warning

You should not normally need to use this function; instead create QAction s with the shortcut key sequences you require (if you also want equivalent menu options and toolbar buttons), or create QShortcut s if you just need key sequences. Both QAction and QShortcut handle all the event filtering for you, and provide signals which are triggered when the user triggers the key sequence, so are much easier to use than this low-level function.

See also

releaseShortcut() setShortcutEnabled()

PySide2.QtWidgets.QWidget.graphicsEffect()

Return type:

PySide2.QtWidgets.QGraphicsEffect

The function returns a pointer to the widget’s graphics effect.

If the widget has no graphics effect, None is returned.

See also

setGraphicsEffect()

PySide2.QtWidgets.QWidget.graphicsProxyWidget()

Return type:

PySide2.QtWidgets.QGraphicsProxyWidget

Returns the proxy widget for the corresponding embedded widget in a graphics view; otherwise returns None .

See also

createProxyForChildWidget() addWidget()

PySide2.QtWidgets.QWidget.hasFocus()

Return type:

bool

This property holds whether this widget (or its focus proxy) has the keyboard input focus.

By default, this property is false .

Note

Obtaining the value of this property for a widget is effectively equivalent to checking whether focusWidget() refers to the widget.

See also

setFocus() clearFocus() setFocusPolicy() focusWidget()

PySide2.QtWidgets.QWidget.hasHeightForWidth()

Return type:

bool

Returns true if the widget’s preferred height depends on its width; otherwise returns false .

PySide2.QtWidgets.QWidget.hasMouseTracking()

Return type:

bool

This property holds whether mouse tracking is enabled for the widget.

If mouse tracking is disabled (the default), the widget only receives mouse move events when at least one mouse button is pressed while the mouse is being moved.

If mouse tracking is enabled, the widget receives mouse move events even if no buttons are pressed.

See also

mouseMoveEvent()

PySide2.QtWidgets.QWidget.hasTabletTracking()

Return type:

bool

This property holds whether tablet tracking is enabled for the widget.

If tablet tracking is disabled (the default), the widget only receives tablet move events when the stylus is in contact with the tablet, or at least one stylus button is pressed, while the stylus is being moved.

If tablet tracking is enabled, the widget receives tablet move events even while hovering in proximity. This is useful for monitoring position as well as the auxiliary properties such as rotation and tilt, and providing feedback in the UI.

See also

tabletEvent()

PySide2.QtWidgets.QWidget.heightForWidth(arg__1)

Parameters:

arg__1 – int

Return type:

int

Returns the preferred height for this widget, given the width w .

If this widget has a layout, the default implementation returns the layout’s preferred height. if there is no layout, the default implementation returns -1 indicating that the preferred height does not depend on the width.

PySide2.QtWidgets.QWidget.hide()

Hides the widget. This function is equivalent to setVisible (false).

Note

If you are working with QDialog or its subclasses and you invoke the show() function after this function, the dialog will be displayed in its original position.

See also

hideEvent() isHidden() show() setVisible() isVisible() close()

PySide2.QtWidgets.QWidget.hideEvent(event)

Parameters:

event – PySide2.QtGui.QHideEvent

This event handler can be reimplemented in a subclass to receive widget hide events. The event is passed in the event parameter.

Hide events are sent to widgets immediately after they have been hidden.

Note: A widget receives spontaneous show and hide events when its mapping status is changed by the window system, e.g. a spontaneous hide event when the user minimizes the window, and a spontaneous show event when the window is restored again. After receiving a spontaneous hide event, a widget is still considered visible in the sense of isVisible() .

See also

visible event() QHideEvent

PySide2.QtWidgets.QWidget.inputMethodEvent(event)

Parameters:

event – PySide2.QtGui.QInputMethodEvent

This event handler, for event event , can be reimplemented in a subclass to receive Input Method composition events. This handler is called when the state of the input method changes.

Note that when creating custom text editing widgets, the WA_InputMethodEnabled window attribute must be set explicitly (using the setAttribute() function) in order to receive input method events.

The default implementation calls event->ignore(), which rejects the Input Method event. See the QInputMethodEvent documentation for more details.

See also

event() QInputMethodEvent

PySide2.QtWidgets.QWidget.inputMethodHints()

Return type:

InputMethodHints

This property holds What input method specific hints the widget has..

This is only relevant for input widgets. It is used by the input method to retrieve hints as to how the input method should operate. For example, if the ImhFormattedNumbersOnly flag is set, the input method may change its visual components to reflect that only numbers can be entered.

Warning

Some widgets require certain flags in order to work as intended. To set a flag, do w->setInputMethodHints(w->inputMethodHints()|f) instead of w->setInputMethodHints(f) .

Note

The flags are only hints, so the particular input method implementation is free to ignore them. If you want to be sure that a certain type of characters are entered, you should also set a QValidator on the widget.

The default value is ImhNone .

See also

inputMethodQuery()

PySide2.QtWidgets.QWidget.inputMethodQuery(arg__1)

Parameters:

arg__1 – InputMethodQuery

Return type:

object

This method is only relevant for input widgets. It is used by the input method to query a set of properties of the widget to be able to support complex input method operations as support for surrounding text and reconversions.

query specifies which property is queried.

See also

inputMethodEvent() QInputMethodEvent QInputMethodQueryEvent inputMethodHints

PySide2.QtWidgets.QWidget.insertAction(before, action)

Parameters:

• before – PySide2.QtWidgets.QAction

• action – PySide2.QtWidgets.QAction

Inserts the action action to this widget’s list of actions, before the action before . It appends the action if before is None or before is not a valid action for this widget.

A QWidget should only have one of each action.

See also

removeAction() addAction() QMenu contextMenuPolicy actions()

PySide2.QtWidgets.QWidget.insertActions(before, actions)

Parameters:

• before – PySide2.QtWidgets.QAction

• actions –

Inserts the actions actions to this widget’s list of actions, before the action before . It appends the action if before is None or before is not a valid action for this widget.

A QWidget can have at most one of each action.

See also

removeAction() QMenu insertAction() contextMenuPolicy

PySide2.QtWidgets.QWidget.internalWinId()

Return type:

WId

PySide2.QtWidgets.QWidget.isActiveWindow()

Return type:

bool

This property holds whether this widget’s window is the active window.

The active window is the window that contains the widget that has keyboard focus (The window may still have focus if it has no widgets or none of its widgets accepts keyboard focus).

When popup windows are visible, this property is true for both the active window and for the popup.

By default, this property is false .

See also

activateWindow() activeWindow()

PySide2.QtWidgets.QWidget.isAncestorOf(child)

Parameters:

child – PySide2.QtWidgets.QWidget

Return type:

bool

Returns true if this widget is a parent, (or grandparent and so on to any level), of the given child , and both widgets are within the same window; otherwise returns false .

PySide2.QtWidgets.QWidget.isEnabled()

Return type:

bool

This property holds whether the widget is enabled.

In general an enabled widget handles keyboard and mouse events; a disabled widget does not. An exception is made with QAbstractButton .

Some widgets display themselves differently when they are disabled. For example a button might draw its label grayed out. If your widget needs to know when it becomes enabled or disabled, you can use the changeEvent() with type EnabledChange .

Disabling a widget implicitly disables all its children. Enabling respectively enables all child widgets unless they have been explicitly disabled. It it not possible to explicitly enable a child widget which is not a window while its parent widget remains disabled.

By default, this property is true .

See also

isEnabledTo() QKeyEvent QMouseEvent changeEvent()

PySide2.QtWidgets.QWidget.isEnabledTo(arg__1)

Parameters:

arg__1 – PySide2.QtWidgets.QWidget

Return type:

bool

Returns true if this widget would become enabled if ancestor is enabled; otherwise returns false .

This is the case if neither the widget itself nor every parent up to but excluding ancestor has been explicitly disabled.

0. returns false if this widget or any if its ancestors was explicitly disabled.

The word ancestor here means a parent widget within the same window.

Therefore (0) stops at this widget’s window, unlike isEnabled() which also takes parent windows into considerations.

See also

setEnabled() enabled

PySide2.QtWidgets.QWidget.isEnabledToTLW()

Return type:

bool

Note

This function is deprecated.

This function is deprecated. It is equivalent to isEnabled()

PySide2.QtWidgets.QWidget.isFullScreen()

Return type:

bool

This property holds whether the widget is shown in full screen mode.

A widget in full screen mode occupies the whole screen area and does not display window decorations, such as a title bar.

By default, this property is false .

See also

windowState() minimized maximized

PySide2.QtWidgets.QWidget.isHidden()

Return type:

bool

Returns true if the widget is hidden, otherwise returns false .

A hidden widget will only become visible when show() is called on it. It will not be automatically shown when the parent is shown.

To check visibility, use ! isVisible() instead (notice the exclamation mark).

implies ! isVisible() , but a widget can be not visible and not hidden at the same time. This is the case for widgets that are children of widgets that are not visible.

Widgets are hidden if:

• they were created as independent windows,

• they were created as children of visible widgets,

• hide() or setVisible (false) was called.

PySide2.QtWidgets.QWidget.isLeftToRight()

Return type:

bool

PySide2.QtWidgets.QWidget.isMaximized()

Return type:

bool

This property holds whether this widget is maximized.

This property is only relevant for windows.

Note

Due to limitations on some window systems, this does not always report the expected results (e.g., if the user on X11 maximizes the window via the window manager, Qt has no way of distinguishing this from any other resize). This is expected to improve as window manager protocols evolve.

By default, this property is false .

See also

windowState() showMaximized() visible show() hide() showNormal() minimized

PySide2.QtWidgets.QWidget.isMinimized()

Return type:

bool

This property holds whether this widget is minimized (iconified).

This property is only relevant for windows.

By default, this property is false .

See also

showMinimized() visible show() hide() showNormal() maximized

PySide2.QtWidgets.QWidget.isModal()

Return type:

bool

This property holds whether the widget is a modal widget.

This property only makes sense for windows. A modal widget prevents widgets in all other windows from getting any input.

By default, this property is false .

See also

isWindow() windowModality QDialog

PySide2.QtWidgets.QWidget.isRightToLeft()

Return type:

bool

PySide2.QtWidgets.QWidget.isTopLevel()

Return type:

bool

Use isWindow() instead.

PySide2.QtWidgets.QWidget.isVisible()

Return type:

bool

This property holds whether the widget is visible.

Calling (true) or show() sets the widget to visible status if all its parent widgets up to the window are visible. If an ancestor is not visible, the widget won’t become visible until all its ancestors are shown. If its size or position has changed, Qt guarantees that a widget gets move and resize events just before it is shown. If the widget has not been resized yet, Qt will adjust the widget’s size to a useful default using adjustSize() .

Calling (false) or hide() hides a widget explicitly. An explicitly hidden widget will never become visible, even if all its ancestors become visible, unless you show it.

A widget receives show and hide events when its visibility status changes. Between a hide and a show event, there is no need to waste CPU cycles preparing or displaying information to the user. A video application, for example, might simply stop generating new frames.

A widget that happens to be obscured by other windows on the screen is considered to be visible. The same applies to iconified windows and windows that exist on another virtual desktop (on platforms that support this concept). A widget receives spontaneous show and hide events when its mapping status is changed by the window system, e.g. a spontaneous hide event when the user minimizes the window, and a spontaneous show event when the window is restored again.

You almost never have to reimplement the function. If you need to change some settings before a widget is shown, use showEvent() instead. If you need to do some delayed initialization use the Polish event delivered to the event() function.

See also

show() hide() isHidden() isVisibleTo() isMinimized() showEvent() hideEvent()

PySide2.QtWidgets.QWidget.isVisibleTo(arg__1)

Parameters:

arg__1 – PySide2.QtWidgets.QWidget

Return type:

bool

Returns true if this widget would become visible if ancestor is shown; otherwise returns false .

The true case occurs if neither the widget itself nor any parent up to but excluding ancestor has been explicitly hidden.

This function will still return true if the widget is obscured by other windows on the screen, but could be physically visible if it or they were to be moved.

0. is identical to isVisible() .

See also

show() hide() isVisible()

PySide2.QtWidgets.QWidget.isWindow()

Return type:

bool

Returns true if the widget is an independent window, otherwise returns false .

A window is a widget that isn’t visually the child of any other widget and that usually has a frame and a window title .

A window can have a parent widget . It will then be grouped with its parent and deleted when the parent is deleted, minimized when the parent is minimized etc. If supported by the window manager, it will also have a common taskbar entry with its parent.

QDialog and QMainWindow widgets are by default windows, even if a parent widget is specified in the constructor. This behavior is specified by the Window flag.

See also

window() isModal() parentWidget()

PySide2.QtWidgets.QWidget.isWindowModified()

Return type:

bool

This property holds whether the document shown in the window has unsaved changes.

A modified window is a window whose content has changed but has not been saved to disk. This flag will have different effects varied by the platform. On macOS the close button will have a modified look; on other platforms, the window title will have an ‘*’ (asterisk).

The window title must contain a “[*]” placeholder, which indicates where the ‘*’ should appear. Normally, it should appear right after the file name (e.g., “document1.txt[*] - Text Editor”). If the window isn’t modified, the placeholder is simply removed.

Note that if a widget is set as modified, all its ancestors will also be set as modified. However, if you call setWindowModified(false) on a widget, this will not propagate to its parent because other children of the parent might have been modified.

See also

windowTitle Application Example SDI Example MDI Example

PySide2.QtWidgets.QWidget.keyPressEvent(event)

Parameters:

event – PySide2.QtGui.QKeyEvent

This event handler, for event event , can be reimplemented in a subclass to receive key press events for the widget.

A widget must call setFocusPolicy() to accept focus initially and have focus in order to receive a key press event.

If you reimplement this handler, it is very important that you call the base class implementation if you do not act upon the key.

The default implementation closes popup widgets if the user presses the key sequence for Cancel (typically the Escape key). Otherwise the event is ignored, so that the widget’s parent can interpret it.

Note that QKeyEvent starts with isAccepted() == true, so you do not need to call accept() - just do not call the base class implementation if you act upon the key.

See also

keyReleaseEvent() setFocusPolicy() focusInEvent() focusOutEvent() event() QKeyEvent Tetrix Example

PySide2.QtWidgets.QWidget.keyReleaseEvent(event)

Parameters:

event – PySide2.QtGui.QKeyEvent

This event handler, for event event , can be reimplemented in a subclass to receive key release events for the widget.

A widget must accept focus initially and have focus in order to receive a key release event.

If you reimplement this handler, it is very important that you call the base class implementation if you do not act upon the key.

The default implementation ignores the event, so that the widget’s parent can interpret it.

Note that QKeyEvent starts with isAccepted() == true, so you do not need to call accept() - just do not call the base class implementation if you act upon the key.

See also

keyPressEvent() ignore() setFocusPolicy() focusInEvent() focusOutEvent() event() QKeyEvent

static PySide2.QtWidgets.QWidget.keyboardGrabber()

Return type:

PySide2.QtWidgets.QWidget

Returns the widget that is currently grabbing the keyboard input.

If no widget in this application is currently grabbing the keyboard, None is returned.

See also

grabMouse() mouseGrabber()

PySide2.QtWidgets.QWidget.layout()

Return type:

PySide2.QtWidgets.QLayout

Returns the layout manager that is installed on this widget, or None if no layout manager is installed.

The layout manager sets the geometry of the widget’s children that have been added to the layout.

See also

setLayout() sizePolicy() Layout Management

PySide2.QtWidgets.QWidget.layoutDirection()

Return type:

LayoutDirection

This property holds the layout direction for this widget..

Note

This method no longer affects text layout direction since Qt 4.7.

By default, this property is set to LeftToRight .

When the layout direction is set on a widget, it will propagate to the widget’s children, but not to a child that is a window and not to a child for which has been explicitly called. Also, child widgets added after has been called for the parent do not inherit the parent’s layout direction.

See also

layoutDirection

PySide2.QtWidgets.QWidget.leaveEvent(event)

Parameters:

event – PySide2.QtCore.QEvent

This event handler can be reimplemented in a subclass to receive widget leave events which are passed in the event parameter.

A leave event is sent to the widget when the mouse cursor leaves the widget.

See also

enterEvent() mouseMoveEvent() event()

PySide2.QtWidgets.QWidget.locale()

Return type:

PySide2.QtCore.QLocale

This property holds the widget’s locale.

As long as no special locale has been set, this is either the parent’s locale or (if this widget is a top level widget), the default locale.

If the widget displays dates or numbers, these should be formatted using the widget’s locale.

See also

QLocale setDefault()

PySide2.QtWidgets.QWidget.lower()

Lowers the widget to the bottom of the parent widget’s stack.

After this call the widget will be visually behind (and therefore obscured by) any overlapping sibling widgets.

See also

raise() stackUnder()

PySide2.QtWidgets.QWidget.mapFrom(arg__1, arg__2)

Parameters:

• arg__1 – PySide2.QtWidgets.QWidget

• arg__2 – PySide2.QtCore.QPoint

Return type:

PySide2.QtCore.QPoint

Translates the widget coordinate pos from the coordinate system of parent to this widget’s coordinate system. The parent must not be None and must be a parent of the calling widget.

See also

mapTo() mapFromParent() mapFromGlobal() underMouse()

PySide2.QtWidgets.QWidget.mapFromGlobal(arg__1)

Parameters:

arg__1 – PySide2.QtCore.QPoint

Return type:

PySide2.QtCore.QPoint

Translates the global screen coordinate pos to widget coordinates.

See also

mapToGlobal() mapFrom() mapFromParent()

PySide2.QtWidgets.QWidget.mapFromParent(arg__1)

Parameters:

arg__1 – PySide2.QtCore.QPoint

Return type:

PySide2.QtCore.QPoint

Translates the parent widget coordinate pos to widget coordinates.

Same as mapFromGlobal() if the widget has no parent.

See also

mapToParent() mapFrom() mapFromGlobal() underMouse()

PySide2.QtWidgets.QWidget.mapTo(arg__1, arg__2)

Parameters:

• arg__1 – PySide2.QtWidgets.QWidget

• arg__2 – PySide2.QtCore.QPoint

Return type:

PySide2.QtCore.QPoint

Translates the widget coordinate pos to the coordinate system of parent . The parent must not be None and must be a parent of the calling widget.

See also

mapFrom() mapToParent() mapToGlobal() underMouse()

PySide2.QtWidgets.QWidget.mapToGlobal(arg__1)

Parameters:

arg__1 – PySide2.QtCore.QPoint

Return type:

PySide2.QtCore.QPoint

Translates the widget coordinate pos to global screen coordinates. For example, mapToGlobal(QPoint(0,0)) would give the global coordinates of the top-left pixel of the widget.

See also

mapFromGlobal() mapTo() mapToParent()

PySide2.QtWidgets.QWidget.mapToParent(arg__1)

Parameters:

arg__1 – PySide2.QtCore.QPoint

Return type:

PySide2.QtCore.QPoint

Translates the widget coordinate pos to a coordinate in the parent widget.

Same as mapToGlobal() if the widget has no parent.

See also

mapFromParent() mapTo() mapToGlobal() underMouse()

PySide2.QtWidgets.QWidget.mask()

Return type:

PySide2.QtGui.QRegion

Returns the mask currently set on a widget. If no mask is set the return value will be an empty region.

See also

setMask() clearMask() isEmpty() Shaped Clock Example

PySide2.QtWidgets.QWidget.maximumHeight()

Return type:

int

This property holds the widget’s maximum height in pixels.

This property corresponds to the height held by the maximumSize property.

By default, this property contains a value of 16777215.

Note

The definition of the QWIDGETSIZE_MAX macro limits the maximum size of widgets.

See also

maximumSize maximumWidth

PySide2.QtWidgets.QWidget.maximumSize()

Return type:

PySide2.QtCore.QSize

This property holds the widget’s maximum size in pixels.

The widget cannot be resized to a larger size than the maximum widget size.

By default, this property contains a size in which both width and height have values of 16777215.

Note

The definition of the QWIDGETSIZE_MAX macro limits the maximum size of widgets.

See also

maximumWidth maximumHeight minimumSize sizeIncrement

PySide2.QtWidgets.QWidget.maximumWidth()

Return type:

int

This property holds the widget’s maximum width in pixels.

This property corresponds to the width held by the maximumSize property.

By default, this property contains a value of 16777215.

Note

The definition of the QWIDGETSIZE_MAX macro limits the maximum size of widgets.

See also

maximumSize maximumHeight

PySide2.QtWidgets.QWidget.minimumHeight()

Return type:

int

This property holds the widget’s minimum height in pixels.

This property corresponds to the height held by the minimumSize property.

By default, this property has a value of 0.

See also

minimumSize minimumWidth

PySide2.QtWidgets.QWidget.minimumSize()

Return type:

PySide2.QtCore.QSize

This property holds the widget’s minimum size.

The widget cannot be resized to a smaller size than the minimum widget size. The widget’s size is forced to the minimum size if the current size is smaller.

The minimum size set by this function will override the minimum size defined by QLayout . In order to unset the minimum size, use a value of QSize(0, 0) .

By default, this property contains a size with zero width and height.

See also

minimumWidth minimumHeight maximumSize sizeIncrement

PySide2.QtWidgets.QWidget.minimumSizeHint()

Return type:

PySide2.QtCore.QSize

This property holds the recommended minimum size for the widget.

If the value of this property is an invalid size, no minimum size is recommended.

The default implementation of returns an invalid size if there is no layout for this widget, and returns the layout’s minimum size otherwise. Most built-in widgets reimplement .

QLayout will never resize a widget to a size smaller than the minimum size hint unless minimumSize() is set or the size policy is set to QSizePolicy::Ignore. If minimumSize() is set, the minimum size hint will be ignored.

See also

isValid() resize() setMinimumSize() sizePolicy()

PySide2.QtWidgets.QWidget.minimumWidth()

Return type:

int

This property holds the widget’s minimum width in pixels.

This property corresponds to the width held by the minimumSize property.

By default, this property has a value of 0.

See also

minimumSize minimumHeight

PySide2.QtWidgets.QWidget.mouseDoubleClickEvent(event)

Parameters:

event – PySide2.QtGui.QMouseEvent

This event handler, for event event , can be reimplemented in a subclass to receive mouse double click events for the widget.

The default implementation calls mousePressEvent() .

Note

The widget will also receive mouse press and mouse release events in addition to the double click event. And if another widget that overlaps this widget disappears in response to press or release events, then this widget will only receive the double click event. It is up to the developer to ensure that the application interprets these events correctly.

See also

mousePressEvent() mouseReleaseEvent() mouseMoveEvent() event() QMouseEvent

static PySide2.QtWidgets.QWidget.mouseGrabber()

Return type:

PySide2.QtWidgets.QWidget

Returns the widget that is currently grabbing the mouse input.

If no widget in this application is currently grabbing the mouse, None is returned.

See also

grabMouse() keyboardGrabber()

PySide2.QtWidgets.QWidget.mouseMoveEvent(event)

Parameters:

event – PySide2.QtGui.QMouseEvent

This event handler, for event event , can be reimplemented in a subclass to receive mouse move events for the widget.

If mouse tracking is switched off, mouse move events only occur if a mouse button is pressed while the mouse is being moved. If mouse tracking is switched on, mouse move events occur even if no mouse button is pressed.

pos() reports the position of the mouse cursor, relative to this widget. For press and release events, the position is usually the same as the position of the last mouse move event, but it might be different if the user’s hand shakes. This is a feature of the underlying window system, not Qt.

If you want to show a tooltip immediately, while the mouse is moving (e.g., to get the mouse coordinates with pos() and show them as a tooltip), you must first enable mouse tracking as described above. Then, to ensure that the tooltip is updated immediately, you must call showText() instead of setToolTip() in your implementation of .

See also

setMouseTracking() mousePressEvent() mouseReleaseEvent() mouseDoubleClickEvent() event() QMouseEvent Scribble Example

PySide2.QtWidgets.QWidget.mousePressEvent(event)

Parameters:

event – PySide2.QtGui.QMouseEvent

This event handler, for event event , can be reimplemented in a subclass to receive mouse press events for the widget.

If you create new widgets in the the mouseReleaseEvent() may not end up where you expect, depending on the underlying window system (or X11 window manager), the widgets’ location and maybe more.

The default implementation implements the closing of popup widgets when you click outside the window. For other widget types it does nothing.

See also

mouseReleaseEvent() mouseDoubleClickEvent() mouseMoveEvent() event() QMouseEvent Scribble Example

PySide2.QtWidgets.QWidget.mouseReleaseEvent(event)

Parameters:

event – PySide2.QtGui.QMouseEvent

This event handler, for event event , can be reimplemented in a subclass to receive mouse release events for the widget.

See also

mousePressEvent() mouseDoubleClickEvent() mouseMoveEvent() event() QMouseEvent Scribble Example

PySide2.QtWidgets.QWidget.move(x, y)

Parameters:

• x – int

• y – int

This is an overloaded function.

This corresponds to move( QPoint (x , y )).

PySide2.QtWidgets.QWidget.move(arg__1)

Parameters:

arg__1 – PySide2.QtCore.QPoint

This property holds the position of the widget within its parent widget.

If the widget is a window, the position is that of the widget on the desktop, including its frame.

When changing the position, the widget, if visible, receives a move event ( moveEvent() ) immediately. If the widget is not currently visible, it is guaranteed to receive an event before it is shown.

By default, this property contains a position that refers to the origin.

Warning

Calling or setGeometry() inside moveEvent() can lead to infinite recursion.

See the Window Geometry documentation for an overview of geometry issues with windows.

See also

frameGeometry size x() y()

PySide2.QtWidgets.QWidget.moveEvent(event)

Parameters:

event – PySide2.QtGui.QMoveEvent

This event handler can be reimplemented in a subclass to receive widget move events which are passed in the event parameter. When the widget receives this event, it is already at the new position.

The old position is accessible through oldPos() .

See also

resizeEvent() event() move() QMoveEvent

PySide2.QtWidgets.QWidget.nativeEvent(eventType, message)

Parameters:

• eventType – PySide2.QtCore.QByteArray

• message – void

Return type:

PyObject

This special event handler can be reimplemented in a subclass to receive native platform events identified by eventType which are passed in the message parameter.

In your reimplementation of this function, if you want to stop the event being handled by Qt, return true and set result . The result parameter has meaning only on Windows. If you return false, this native event is passed back to Qt, which translates the event into a Qt event and sends it to the widget.

Note

Events are only delivered to this event handler if the widget has a native window handle.

Note

This function superseedes the event filter functions x11Event(), winEvent() and macEvent() of Qt 4.

Platform	Event Type Identifier	Message Type	Result Type
Windows	“windows_generic_MSG”	MSG *	LRESULT
macOS	“NSEvent”	NSEvent *
XCB	“xcb_generic_event_t”	xcb_generic_event_t *

See also

QAbstractNativeEventFilter

PySide2.QtWidgets.QWidget.nativeParentWidget()

Return type:

PySide2.QtWidgets.QWidget

Returns the native parent for this widget, i.e. the next ancestor widget that has a system identifier, or None if it does not have any native parent.

See also

effectiveWinId()

PySide2.QtWidgets.QWidget.nextInFocusChain()

Return type:

PySide2.QtWidgets.QWidget

Returns the next widget in this widget’s focus chain.

See also

previousInFocusChain()

PySide2.QtWidgets.QWidget.normalGeometry()

Return type:

PySide2.QtCore.QRect

This property holds the geometry of the widget as it will appear when shown as a normal (not maximized or full screen) top-level widget.

For child widgets this property always holds an empty rectangle.

By default, this property contains an empty rectangle.

See also

windowState() geometry

PySide2.QtWidgets.QWidget.overrideWindowFlags(type)

Parameters:

type – WindowFlags

Sets the window flags for the widget to flags , without telling the window system.

Warning

Do not call this function unless you really know what you’re doing.

See also

setWindowFlags()

PySide2.QtWidgets.QWidget.overrideWindowState(state)

Parameters:

state – WindowStates

The function sets the window state on child widgets similar to setWindowState() . The difference is that the window state changed event has the isOverride() flag set. It exists mainly to keep QWorkspace working.

PySide2.QtWidgets.QWidget.paintEvent(event)

Parameters:

event – PySide2.QtGui.QPaintEvent

This event handler can be reimplemented in a subclass to receive paint events passed in event .

A paint event is a request to repaint all or part of a widget. It can happen for one of the following reasons:

• repaint() or update() was invoked,

• the widget was obscured and has now been uncovered, or

• many other reasons.

Many widgets can simply repaint their entire surface when asked to, but some slow widgets need to optimize by painting only the requested region: region() . This speed optimization does not change the result, as painting is clipped to that region during event processing. QListView and QTableView do this, for example.

Qt also tries to speed up painting by merging multiple paint events into one. When update() is called several times or the window system sends several paint events, Qt merges these events into one event with a larger region (see united() ). The repaint() function does not permit this optimization, so we suggest using update() whenever possible.

When the paint event occurs, the update region has normally been erased, so you are painting on the widget’s background.

The background can be set using setBackgroundRole() and setPalette() .

Since Qt 4.0, QWidget automatically double-buffers its painting, so there is no need to write double-buffering code in to avoid flicker.

Note

Generally, you should refrain from calling update() or repaint() inside a . For example, calling update() or repaint() on children inside a results in undefined behavior; the child may or may not get a paint event.

Warning

If you are using a custom paint engine without Qt’s backingstore, WA_PaintOnScreen must be set. Otherwise, paintEngine() will never be called; the backingstore will be used instead.

See also

event() repaint() update() QPainter QPixmap QPaintEvent Analog Clock Example

PySide2.QtWidgets.QWidget.palette()

Return type:

PySide2.QtGui.QPalette

This property holds the widget’s palette.

This property describes the widget’s palette. The palette is used by the widget’s style when rendering standard components, and is available as a means to ensure that custom widgets can maintain consistency with the native platform’s look and feel. It’s common that different platforms, or different styles, have different palettes.

When you assign a new palette to a widget, the color roles from this palette are combined with the widget’s default palette to form the widget’s final palette. The palette entry for the widget’s background role is used to fill the widget’s background (see autoFillBackground ), and the foreground role initializes QPainter ‘s pen.

The default depends on the system environment. QApplication maintains a system/theme palette which serves as a default for all widgets. There may also be special palette defaults for certain types of widgets (e.g., on Windows Vista, all classes that derive from QMenuBar have a special default palette). You can also define default palettes for widgets yourself by passing a custom palette and the name of a widget to setPalette() . Finally, the style always has the option of polishing the palette as it’s assigned (see polish() ).

QWidget propagates explicit palette roles from parent to child. If you assign a brush or color to a specific role on a palette and assign that palette to a widget, that role will propagate to all the widget’s children, overriding any system defaults for that role. Note that palettes by default don’t propagate to windows (see isWindow() ) unless the WA_WindowPropagation attribute is enabled.

QWidget ‘s palette propagation is similar to its font propagation.

The current style, which is used to render the content of all standard Qt widgets, is free to choose colors and brushes from the widget palette, or in some cases, to ignore the palette (partially, or completely). In particular, certain styles like GTK style, Mac style, and Windows Vista style, depend on third party APIs to render the content of widgets, and these styles typically do not follow the palette. Because of this, assigning roles to a widget’s palette is not guaranteed to change the appearance of the widget. Instead, you may choose to apply a styleSheet .

Warning

Do not use this function in conjunction with Qt Style Sheets . When using style sheets, the palette of a widget can be customized using the “color”, “background-color”, “selection-color”, “selection-background-color” and “alternate-background-color”.

See also

palette() font() Qt Style Sheets

PySide2.QtWidgets.QWidget.parentWidget()

Return type:

PySide2.QtWidgets.QWidget

Returns the parent of this widget, or None if it does not have any parent widget.

PySide2.QtWidgets.QWidget.pos()

Return type:

PySide2.QtCore.QPoint

This property holds the position of the widget within its parent widget.

If the widget is a window, the position is that of the widget on the desktop, including its frame.

When changing the position, the widget, if visible, receives a move event ( moveEvent() ) immediately. If the widget is not currently visible, it is guaranteed to receive an event before it is shown.

By default, this property contains a position that refers to the origin.

Warning

Calling or setGeometry() inside moveEvent() can lead to infinite recursion.

See the Window Geometry documentation for an overview of geometry issues with windows.

See also

frameGeometry size x() y()

PySide2.QtWidgets.QWidget.previousInFocusChain()

Return type:

PySide2.QtWidgets.QWidget

The function returns the previous widget in this widget’s focus chain.

See also

nextInFocusChain()

PySide2.QtWidgets.QWidget.raise_()

Raises this widget to the top of the parent widget’s stack.

After this call the widget will be visually in front of any overlapping sibling widgets.

Note

When using activateWindow() , you can call this function to ensure that the window is stacked on top.

See also

lower() stackUnder()

PySide2.QtWidgets.QWidget.rect()

Return type:

PySide2.QtCore.QRect

This property holds the internal geometry of the widget excluding any window frame.

The rect property equals QRect (0, 0, width() , height() ).

See the Window Geometry documentation for an overview of geometry issues with windows.

By default, this property contains a value that depends on the user’s platform and screen geometry.

See also

size

PySide2.QtWidgets.QWidget.releaseKeyboard()

Releases the keyboard grab.

See also

grabKeyboard() grabMouse() releaseMouse()

PySide2.QtWidgets.QWidget.releaseMouse()

Releases the mouse grab.

See also

grabMouse() grabKeyboard() releaseKeyboard()

PySide2.QtWidgets.QWidget.releaseShortcut(id)

Parameters:

id – int

Removes the shortcut with the given id from Qt’s shortcut system. The widget will no longer receive Shortcut events for the shortcut’s key sequence (unless it has other shortcuts with the same key sequence).

Warning

You should not normally need to use this function since Qt’s shortcut system removes shortcuts automatically when their parent widget is destroyed. It is best to use QAction or QShortcut to handle shortcuts, since they are easier to use than this low-level function. Note also that this is an expensive operation.

See also

grabShortcut() setShortcutEnabled()

PySide2.QtWidgets.QWidget.removeAction(action)

Parameters:

action – PySide2.QtWidgets.QAction

Removes the action action from this widget’s list of actions.

See also

insertAction() actions() insertAction()

PySide2.QtWidgets.QWidget.render(target[, targetOffset=QPoint()[, sourceRegion=QRegion()[, renderFlags=QWidget.RenderFlags(DrawWindowBackground | DrawChildren)]]])

Parameters:

• target – PySide2.QtGui.QPaintDevice

• targetOffset – PySide2.QtCore.QPoint

• sourceRegion – PySide2.QtGui.QRegion

• renderFlags – RenderFlags

PySide2.QtWidgets.QWidget.render(painter, targetOffset[, sourceRegion=QRegion()[, renderFlags=QWidget.RenderFlags(DrawWindowBackground | DrawChildren)]])

Parameters:

• painter – PySide2.QtGui.QPainter

• targetOffset – PySide2.QtCore.QPoint

• sourceRegion – PySide2.QtGui.QRegion

• renderFlags – RenderFlags

PySide2.QtWidgets.QWidget.repaint(x, y, w, h)

Parameters:

• x – int

• y – int

• w – int

• h – int

This is an overloaded function.

This version repaints a rectangle (x , y , w , h ) inside the widget.

If w is negative, it is replaced with width() - x , and if h is negative, it is replaced width height() - y .

PySide2.QtWidgets.QWidget.repaint(arg__1)

Parameters:

arg__1 – PySide2.QtCore.QRect

PySide2.QtWidgets.QWidget.repaint()

Repaints the widget directly by calling paintEvent() immediately, unless updates are disabled or the widget is hidden.

We suggest only using if you need an immediate repaint, for example during animation. In almost all circumstances update() is better, as it permits Qt to optimize for speed and minimize flicker.

Warning

If you call in a function which may itself be called from paintEvent() , you may get infinite recursion. The update() function never causes recursion.

See also

update() paintEvent() setUpdatesEnabled()

PySide2.QtWidgets.QWidget.repaint(arg__1)

Parameters:

arg__1 – PySide2.QtGui.QRegion

PySide2.QtWidgets.QWidget.resize(arg__1)

Parameters:

arg__1 – PySide2.QtCore.QSize

This property holds the size of the widget excluding any window frame.

If the widget is visible when it is being resized, it receives a resize event ( resizeEvent() ) immediately. If the widget is not currently visible, it is guaranteed to receive an event before it is shown.

The size is adjusted if it lies outside the range defined by minimumSize() and maximumSize() .

By default, this property contains a value that depends on the user’s platform and screen geometry.

Warning

Calling or setGeometry() inside resizeEvent() can lead to infinite recursion.

Note

Setting the size to QSize(0, 0) will cause the widget to not appear on screen. This also applies to windows.

See also

pos geometry minimumSize maximumSize resizeEvent() adjustSize()

PySide2.QtWidgets.QWidget.resize(w, h)

Parameters:

• w – int

• h – int

This is an overloaded function.

This corresponds to resize( QSize (w , h )).

PySide2.QtWidgets.QWidget.resizeEvent(event)

Parameters:

event – PySide2.QtGui.QResizeEvent

This event handler can be reimplemented in a subclass to receive widget resize events which are passed in the event parameter. When is called, the widget already has its new geometry. The old size is accessible through oldSize() .

The widget will be erased and receive a paint event immediately after processing the resize event. No drawing need be (or should be) done inside this handler.

See also

moveEvent() event() resize() QResizeEvent paintEvent() Scribble Example

PySide2.QtWidgets.QWidget.restoreGeometry(geometry)

Parameters:

geometry – PySide2.QtCore.QByteArray

Return type:

bool

Restores the geometry and state of top-level widgets stored in the byte array geometry . Returns true on success; otherwise returns false .

If the restored geometry is off-screen, it will be modified to be inside the available screen geometry.

To restore geometry saved using QSettings , you can use code like this:

settings = QSettings("MyCompany", "MyApp")
myWidget.restoreGeometry(settings.value("myWidget/geometry").toByteArray())

See the Window Geometry documentation for an overview of geometry issues with windows.

Use restoreState() to restore the geometry and the state of toolbars and dock widgets.

See also

saveGeometry() QSettings saveState() restoreState()

PySide2.QtWidgets.QWidget.saveGeometry()

Return type:

PySide2.QtCore.QByteArray

Saves the current geometry and state for top-level widgets.

To save the geometry when the window closes, you can implement a close event like this:

class MyWidget(QWidget):

    self.settings = None

    def closeEvent(event):
        # event is a QCloseEvent
        self.settings = QSettings("MyCompany", "MyApp")
        self.settings.setValue("geometry", self.saveGeometry())
        QWidget.closeEvent(self, event)

See the Window Geometry documentation for an overview of geometry issues with windows.

Use saveState() to save the geometry and the state of toolbars and dock widgets.

See also

restoreGeometry() saveState() restoreState()

PySide2.QtWidgets.QWidget.screen()

Return type:

PySide2.QtGui.QScreen

Returns the screen the widget is on.

See also

windowHandle()

PySide2.QtWidgets.QWidget.scroll(dx, dy)

Parameters:

• dx – int

• dy – int

Scrolls the widget including its children dx pixels to the right and dy downward. Both dx and dy may be negative.

After scrolling, the widgets will receive paint events for the areas that need to be repainted. For widgets that Qt knows to be opaque, this is only the newly exposed parts. For example, if an opaque widget is scrolled 8 pixels to the left, only an 8-pixel wide stripe at the right edge needs updating.

Since widgets propagate the contents of their parents by default, you need to set the autoFillBackground property, or use setAttribute() to set the WA_OpaquePaintEvent attribute, to make a widget opaque.

For widgets that use contents propagation, a scroll will cause an update of the entire scroll area.

See also

Transparency and Double Buffering

PySide2.QtWidgets.QWidget.scroll(dx, dy, arg__3)

Parameters:

• dx – int

• dy – int

• arg__3 – PySide2.QtCore.QRect

This is an overloaded function.

This version only scrolls r and does not move the children of the widget.

If r is empty or invalid, the result is undefined.

See also

QScrollArea

PySide2.QtWidgets.QWidget.setAcceptDrops(on)

Parameters:

on – bool

This property holds whether drop events are enabled for this widget.

Setting this property to true announces to the system that this widget may be able to accept drop events.

If the widget is the desktop ( windowType() == Desktop ), this may fail if another application is using the desktop; you can call to test if this occurs.

Warning

Do not modify this property in a drag and drop event handler.

By default, this property is false .

See also

Drag and Drop

PySide2.QtWidgets.QWidget.setAccessibleDescription(description)

Parameters:

description – str

This property holds the widget’s description as seen by assistive technologies.

The accessible description of a widget should convey what a widget does. While the accessibleName should be a short and concise string (e.g. Save ), the description should give more context, such as Saves the current document .

This property has to be localized.

By default, this property contains an empty string and Qt falls back to using the tool tip to provide this information.

See also

accessibleName text()

PySide2.QtWidgets.QWidget.setAccessibleName(name)

Parameters:

name – str

This property holds the widget’s name as seen by assistive technologies.

This is the primary name by which assistive technology such as screen readers announce this widget. For most widgets setting this property is not required. For example for QPushButton the button’s text will be used.

It is important to set this property when the widget does not provide any text. For example a button that only contains an icon needs to set this property to work with screen readers. The name should be short and equivalent to the visual information conveyed by the widget.

This property has to be localized.

By default, this property contains an empty string.

See also

accessibleDescription text()

PySide2.QtWidgets.QWidget.setAttribute(arg__1[, on=true])

Parameters:

• arg__1 – WidgetAttribute

• on – bool

Sets the attribute attribute on this widget if on is true; otherwise clears the attribute.

See also

testAttribute()

PySide2.QtWidgets.QWidget.setAutoFillBackground(enabled)

Parameters:

enabled – bool

This property holds whether the widget background is filled automatically.

If enabled, this property will cause Qt to fill the background of the widget before invoking the paint event. The color used is defined by the Window color role from the widget’s palette .

In addition, Windows are always filled with Window , unless the WA_OpaquePaintEvent or WA_NoSystemBackground attributes are set.

This property cannot be turned off (i.e., set to false) if a widget’s parent has a static gradient for its background.

Warning

Use this property with caution in conjunction with Qt Style Sheets . When a widget has a style sheet with a valid background or a border-image, this property is automatically disabled.

By default, this property is false .

See also

WA_OpaquePaintEvent WA_NoSystemBackground Transparency and Double Buffering

PySide2.QtWidgets.QWidget.setBackgroundRole(arg__1)

Parameters:

arg__1 – ColorRole

Sets the background role of the widget to role .

The background role defines the brush from the widget’s palette that is used to render the background.

If role is NoRole , then the widget inherits its parent’s background role.

Note that styles are free to choose any color from the palette. You can modify the palette or set a style sheet if you don’t achieve the result you want with .

See also

backgroundRole() foregroundRole()

PySide2.QtWidgets.QWidget.setBaseSize(arg__1)

Parameters:

arg__1 – PySide2.QtCore.QSize

This property holds the base size of the widget.

The base size is used to calculate a proper widget size if the widget defines sizeIncrement() .

By default, for a newly-created widget, this property contains a size with zero width and height.

See also

setSizeIncrement()

PySide2.QtWidgets.QWidget.setBaseSize(basew, baseh)

Parameters:

• basew – int

• baseh – int

This is an overloaded function.

This corresponds to setBaseSize ( QSize (basew , baseh )). Sets the widgets base size to width basew and height baseh .

PySide2.QtWidgets.QWidget.setContentsMargins(margins)

Parameters:

margins – PySide2.QtCore.QMargins

This is an overloaded function.

The setContentsMargins function sets the margins around the widget’s contents.

Sets the margins around the contents of the widget to have the sizes determined by margins . The margins are used by the layout system, and may be used by subclasses to specify the area to draw in (e.g. excluding the frame).

Changing the margins will trigger a resizeEvent() .

See also

contentsRect() contentsMargins()

PySide2.QtWidgets.QWidget.setContentsMargins(left, top, right, bottom)

Parameters:

• left – int

• top – int

• right – int

• bottom – int

Sets the margins around the contents of the widget to have the sizes left , top , right , and bottom . The margins are used by the layout system, and may be used by subclasses to specify the area to draw in (e.g. excluding the frame).

Changing the margins will trigger a resizeEvent() .

See also

contentsRect() contentsMargins()

PySide2.QtWidgets.QWidget.setContextMenuPolicy(policy)

Parameters:

policy – ContextMenuPolicy

This property holds how the widget shows a context menu.

The default value of this property is DefaultContextMenu , which means the contextMenuEvent() handler is called. Other values are NoContextMenu , PreventContextMenu , ActionsContextMenu , and CustomContextMenu . With CustomContextMenu , the signal customContextMenuRequested() is emitted.

See also

contextMenuEvent() customContextMenuRequested() actions()

PySide2.QtWidgets.QWidget.setCursor(arg__1)

Parameters:

arg__1 – PySide2.QtGui.QCursor

This property holds the cursor shape for this widget.

The mouse cursor will assume this shape when it’s over this widget. See the list of predefined cursor objects for a range of useful shapes.

An editor widget might use an I-beam cursor:

widget.setCursor(Qt.IBeamCursor)

If no cursor has been set, or after a call to , the parent’s cursor is used.

By default, this property contains a cursor with the ArrowCursor shape.

Some underlying window implementations will reset the cursor if it leaves a widget even if the mouse is grabbed. If you want to have a cursor set for all widgets, even when outside the window, consider setOverrideCursor() .

See also

setOverrideCursor()

PySide2.QtWidgets.QWidget.setDisabled(arg__1)

Parameters:

arg__1 – bool

Disables widget input events if disable is true; otherwise enables input events.

See the enabled documentation for more information.

See also

isEnabledTo() QKeyEvent QMouseEvent changeEvent()

PySide2.QtWidgets.QWidget.setEnabled(arg__1)

Parameters:

arg__1 – bool

This property holds whether the widget is enabled.

In general an enabled widget handles keyboard and mouse events; a disabled widget does not. An exception is made with QAbstractButton .

Some widgets display themselves differently when they are disabled. For example a button might draw its label grayed out. If your widget needs to know when it becomes enabled or disabled, you can use the changeEvent() with type EnabledChange .

Disabling a widget implicitly disables all its children. Enabling respectively enables all child widgets unless they have been explicitly disabled. It it not possible to explicitly enable a child widget which is not a window while its parent widget remains disabled.

By default, this property is true .

See also

isEnabledTo() QKeyEvent QMouseEvent changeEvent()

PySide2.QtWidgets.QWidget.setFixedHeight(h)

Parameters:

h – int

Sets both the minimum and maximum heights of the widget to h without changing the widths. Provided for convenience.

See also

sizeHint() minimumSize() maximumSize() setFixedSize()

PySide2.QtWidgets.QWidget.setFixedSize(arg__1)

Parameters:

arg__1 – PySide2.QtCore.QSize

Sets both the minimum and maximum sizes of the widget to s , thereby preventing it from ever growing or shrinking.

This will override the default size constraints set by QLayout .

To remove constraints, set the size to QWIDGETSIZE_MAX .

Alternatively, if you want the widget to have a fixed size based on its contents, you can call setSizeConstraint ( SetFixedSize );

See also

maximumSize minimumSize

PySide2.QtWidgets.QWidget.setFixedSize(w, h)

Parameters:

• w – int

• h – int

This is an overloaded function.

Sets the width of the widget to w and the height to h .

PySide2.QtWidgets.QWidget.setFixedWidth(w)

Parameters:

w – int

Sets both the minimum and maximum width of the widget to w without changing the heights. Provided for convenience.

See also

sizeHint() minimumSize() maximumSize() setFixedSize()

PySide2.QtWidgets.QWidget.setFocus(reason)

Parameters:

reason – FocusReason

Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the active window . The reason argument will be passed into any focus event sent from this function, it is used to give an explanation of what caused the widget to get focus. If the window is not active, the widget will be given the focus when the window becomes active.

First, a focus about to change event is sent to the focus widget (if any) to tell it that it is about to lose the focus. Then focus is changed, a focus out event is sent to the previous focus item and a focus in event is sent to the new item to tell it that it just received the focus. (Nothing happens if the focus in and focus out widgets are the same.)

Note

On embedded platforms, setFocus() will not cause an input panel to be opened by the input method. If you want this to happen, you have to send a RequestSoftwareInputPanel event to the widget yourself.

setFocus() gives focus to a widget regardless of its focus policy, but does not clear any keyboard grab (see grabKeyboard() ).

Be aware that if the widget is hidden, it will not accept focus until it is shown.

Warning

If you call setFocus() in a function which may itself be called from focusOutEvent() or focusInEvent() , you may get an infinite recursion.

See also

hasFocus() clearFocus() focusInEvent() focusOutEvent() setFocusPolicy() focusWidget() focusWidget() grabKeyboard() grabMouse() Keyboard Focus in Widgets RequestSoftwareInputPanel

PySide2.QtWidgets.QWidget.setFocus()

This is an overloaded function.

Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the active window .

PySide2.QtWidgets.QWidget.setFocusPolicy(policy)

Parameters:

policy – FocusPolicy

This property holds the way the widget accepts keyboard focus.

The policy is TabFocus if the widget accepts keyboard focus by tabbing, ClickFocus if the widget accepts focus by clicking, StrongFocus if it accepts both, and NoFocus (the default) if it does not accept focus at all.

You must enable keyboard focus for a widget if it processes keyboard events. This is normally done from the widget’s constructor. For instance, the QLineEdit constructor calls ( StrongFocus ).

If the widget has a focus proxy, then the focus policy will be propagated to it.

See also

focusInEvent() focusOutEvent() keyPressEvent() keyReleaseEvent() enabled

PySide2.QtWidgets.QWidget.setFocusProxy(arg__1)

Parameters:

arg__1 – PySide2.QtWidgets.QWidget

Sets the widget’s focus proxy to widget w . If w is None , the function resets this widget to have no focus proxy.

Some widgets can “have focus”, but create a child widget, such as QLineEdit , to actually handle the focus. In this case, the widget can set the line edit to be its focus proxy.

sets the widget which will actually get focus when “this widget” gets it. If there is a focus proxy, setFocus() and hasFocus() operate on the focus proxy. If “this widget” is the focus widget, then moves focus to the new focus proxy.

See also

focusProxy()

PySide2.QtWidgets.QWidget.setFont(arg__1)

Parameters:

arg__1 – PySide2.QtGui.QFont

This property holds the font currently set for the widget.

This property describes the widget’s requested font. The font is used by the widget’s style when rendering standard components, and is available as a means to ensure that custom widgets can maintain consistency with the native platform’s look and feel. It’s common that different platforms, or different styles, define different fonts for an application.

When you assign a new font to a widget, the properties from this font are combined with the widget’s default font to form the widget’s final font. You can call fontInfo() to get a copy of the widget’s final font. The final font is also used to initialize QPainter ‘s font.

The default depends on the system environment. QApplication maintains a system/theme font which serves as a default for all widgets. There may also be special font defaults for certain types of widgets. You can also define default fonts for widgets yourself by passing a custom font and the name of a widget to setFont() . Finally, the font is matched against Qt’s font database to find the best match.

QWidget propagates explicit font properties from parent to child. If you change a specific property on a font and assign that font to a widget, that property will propagate to all the widget’s children, overriding any system defaults for that property. Note that fonts by default don’t propagate to windows (see isWindow() ) unless the WA_WindowPropagation attribute is enabled.

QWidget ‘s font propagation is similar to its palette propagation.

The current style, which is used to render the content of all standard Qt widgets, is free to choose to use the widget font, or in some cases, to ignore it (partially, or completely). In particular, certain styles like GTK style, Mac style, and Windows Vista style, apply special modifications to the widget font to match the platform’s native look and feel. Because of this, assigning properties to a widget’s font is not guaranteed to change the appearance of the widget. Instead, you may choose to apply a styleSheet .

Note

If Qt Style Sheets are used on the same widget as , style sheets will take precedence if the settings conflict.

See also

fontInfo() fontMetrics()

PySide2.QtWidgets.QWidget.setForegroundRole(arg__1)

Parameters:

arg__1 – ColorRole

Sets the foreground role of the widget to role .

The foreground role defines the color from the widget’s palette that is used to draw the foreground.

If role is NoRole , the widget uses a foreground role that contrasts with the background role.

Note that styles are free to choose any color from the palette. You can modify the palette or set a style sheet if you don’t achieve the result you want with .

See also

foregroundRole() backgroundRole()

PySide2.QtWidgets.QWidget.setGeometry(arg__1)

Parameters:

arg__1 – PySide2.QtCore.QRect

This property holds the geometry of the widget relative to its parent and excluding the window frame.

When changing the geometry, the widget, if visible, receives a move event ( moveEvent() ) and/or a resize event ( resizeEvent() ) immediately. If the widget is not currently visible, it is guaranteed to receive appropriate events before it is shown.

The size component is adjusted if it lies outside the range defined by minimumSize() and maximumSize() .

Warning

Calling inside resizeEvent() or moveEvent() can lead to infinite recursion.

See the Window Geometry documentation for an overview of geometry issues with windows.

By default, this property contains a value that depends on the user’s platform and screen geometry.

See also

frameGeometry() rect() move() resize() moveEvent() resizeEvent() minimumSize() maximumSize()

PySide2.QtWidgets.QWidget.setGeometry(x, y, w, h)

Parameters:

• x – int

• y – int

• w – int

• h – int

This is an overloaded function.

This corresponds to setGeometry ( QRect (x , y , w , h )).

PySide2.QtWidgets.QWidget.setGraphicsEffect(effect)

Parameters:

effect – PySide2.QtWidgets.QGraphicsEffect

The function is for setting the widget’s graphics effect.

Sets effect as the widget’s effect. If there already is an effect installed on this widget, QWidget will delete the existing effect before installing the new effect .

If effect is the installed effect on a different widget, will remove the effect from the widget and install it on this widget.

QWidget takes ownership of effect .

Note

This function will apply the effect on itself and all its children.

Note

Graphics effects are not supported for OpenGL-based widgets, such as QGLWidget , QOpenGLWidget and QQuickWidget .

See also

graphicsEffect()

PySide2.QtWidgets.QWidget.setHidden(hidden)

Parameters:

hidden – bool

Convenience function, equivalent to setVisible (!``hidden`` ).

See also

isHidden()

PySide2.QtWidgets.QWidget.setInputMethodHints(hints)

Parameters:

hints – InputMethodHints

This property holds What input method specific hints the widget has..

This is only relevant for input widgets. It is used by the input method to retrieve hints as to how the input method should operate. For example, if the ImhFormattedNumbersOnly flag is set, the input method may change its visual components to reflect that only numbers can be entered.

Warning

Some widgets require certain flags in order to work as intended. To set a flag, do w->setInputMethodHints(w->inputMethodHints()|f) instead of w->setInputMethodHints(f) .

Note

The flags are only hints, so the particular input method implementation is free to ignore them. If you want to be sure that a certain type of characters are entered, you should also set a QValidator on the widget.

The default value is ImhNone .

See also

inputMethodQuery()

PySide2.QtWidgets.QWidget.setLayout(arg__1)

Parameters:

arg__1 – PySide2.QtWidgets.QLayout

Sets the layout manager for this widget to layout .

If there already is a layout manager installed on this widget, QWidget won’t let you install another. You must first delete the existing layout manager (returned by layout() ) before you can call with the new layout.

If layout is the layout manager on a different widget, will reparent the layout and make it the layout manager for this widget.

Example:

QVBoxLayout *layout = new QVBoxLayout;
layout->addWidget(formWidget);
setLayout(layout);

An alternative to calling this function is to pass this widget to the layout’s constructor.

The QWidget will take ownership of layout .

See also

layout() Layout Management

PySide2.QtWidgets.QWidget.setLayoutDirection(direction)

Parameters:

direction – LayoutDirection

This property holds the layout direction for this widget..

Note

This method no longer affects text layout direction since Qt 4.7.

By default, this property is set to LeftToRight .

When the layout direction is set on a widget, it will propagate to the widget’s children, but not to a child that is a window and not to a child for which has been explicitly called. Also, child widgets added after has been called for the parent do not inherit the parent’s layout direction.

See also

layoutDirection

PySide2.QtWidgets.QWidget.setLocale(locale)

Parameters:

locale – PySide2.QtCore.QLocale

This property holds the widget’s locale.

As long as no special locale has been set, this is either the parent’s locale or (if this widget is a top level widget), the default locale.

If the widget displays dates or numbers, these should be formatted using the widget’s locale.

See also

QLocale setDefault()

PySide2.QtWidgets.QWidget.setMask(arg__1)

Parameters:

arg__1 – PySide2.QtGui.QBitmap

PySide2.QtWidgets.QWidget.setMask(arg__1)

Parameters:

arg__1 – PySide2.QtGui.QRegion

PySide2.QtWidgets.QWidget.setMaximumHeight(maxh)

Parameters:

maxh – int

This property holds the widget’s maximum height in pixels.

This property corresponds to the height held by the maximumSize property.

By default, this property contains a value of 16777215.

Note

The definition of the QWIDGETSIZE_MAX macro limits the maximum size of widgets.

See also

maximumSize maximumWidth

PySide2.QtWidgets.QWidget.setMaximumSize(arg__1)

Parameters:

arg__1 – PySide2.QtCore.QSize

This property holds the widget’s maximum size in pixels.

The widget cannot be resized to a larger size than the maximum widget size.

By default, this property contains a size in which both width and height have values of 16777215.

Note

The definition of the QWIDGETSIZE_MAX macro limits the maximum size of widgets.

See also

maximumWidth maximumHeight minimumSize sizeIncrement

PySide2.QtWidgets.QWidget.setMaximumSize(maxw, maxh)

Parameters:

• maxw – int

• maxh – int

This is an overloaded function.

This function corresponds to setMaximumSize ( QSize (maxw , maxh )). Sets the maximum width to maxw and the maximum height to maxh .

PySide2.QtWidgets.QWidget.setMaximumWidth(maxw)

Parameters:

maxw – int

This property holds the widget’s maximum width in pixels.

This property corresponds to the width held by the maximumSize property.

By default, this property contains a value of 16777215.

Note

The definition of the QWIDGETSIZE_MAX macro limits the maximum size of widgets.

See also

maximumSize maximumHeight

PySide2.QtWidgets.QWidget.setMinimumHeight(minh)

Parameters:

minh – int

This property holds the widget’s minimum height in pixels.

This property corresponds to the height held by the minimumSize property.

By default, this property has a value of 0.

See also

minimumSize minimumWidth

PySide2.QtWidgets.QWidget.setMinimumSize(arg__1)

Parameters:

arg__1 – PySide2.QtCore.QSize

This property holds the widget’s minimum size.

The widget cannot be resized to a smaller size than the minimum widget size. The widget’s size is forced to the minimum size if the current size is smaller.

The minimum size set by this function will override the minimum size defined by QLayout . In order to unset the minimum size, use a value of QSize(0, 0) .

By default, this property contains a size with zero width and height.

See also

minimumWidth minimumHeight maximumSize sizeIncrement

PySide2.QtWidgets.QWidget.setMinimumSize(minw, minh)

Parameters:

• minw – int

• minh – int

This is an overloaded function.

This function corresponds to setMinimumSize ( QSize (minw, minh)). Sets the minimum width to minw and the minimum height to minh .

PySide2.QtWidgets.QWidget.setMinimumWidth(minw)

Parameters:

minw – int

This property holds the widget’s minimum width in pixels.

This property corresponds to the width held by the minimumSize property.

By default, this property has a value of 0.

See also

minimumSize minimumHeight

PySide2.QtWidgets.QWidget.setMouseTracking(enable)

Parameters:

enable – bool

This property holds whether mouse tracking is enabled for the widget.

If mouse tracking is disabled (the default), the widget only receives mouse move events when at least one mouse button is pressed while the mouse is being moved.

If mouse tracking is enabled, the widget receives mouse move events even if no buttons are pressed.

See also

mouseMoveEvent()

PySide2.QtWidgets.QWidget.setPalette(arg__1)

Parameters:

arg__1 – PySide2.QtGui.QPalette

This property holds the widget’s palette.

This property describes the widget’s palette. The palette is used by the widget’s style when rendering standard components, and is available as a means to ensure that custom widgets can maintain consistency with the native platform’s look and feel. It’s common that different platforms, or different styles, have different palettes.

When you assign a new palette to a widget, the color roles from this palette are combined with the widget’s default palette to form the widget’s final palette. The palette entry for the widget’s background role is used to fill the widget’s background (see autoFillBackground ), and the foreground role initializes QPainter ‘s pen.

The default depends on the system environment. QApplication maintains a system/theme palette which serves as a default for all widgets. There may also be special palette defaults for certain types of widgets (e.g., on Windows Vista, all classes that derive from QMenuBar have a special default palette). You can also define default palettes for widgets yourself by passing a custom palette and the name of a widget to setPalette() . Finally, the style always has the option of polishing the palette as it’s assigned (see polish() ).

QWidget propagates explicit palette roles from parent to child. If you assign a brush or color to a specific role on a palette and assign that palette to a widget, that role will propagate to all the widget’s children, overriding any system defaults for that role. Note that palettes by default don’t propagate to windows (see isWindow() ) unless the WA_WindowPropagation attribute is enabled.

QWidget ‘s palette propagation is similar to its font propagation.

The current style, which is used to render the content of all standard Qt widgets, is free to choose colors and brushes from the widget palette, or in some cases, to ignore the palette (partially, or completely). In particular, certain styles like GTK style, Mac style, and Windows Vista style, depend on third party APIs to render the content of widgets, and these styles typically do not follow the palette. Because of this, assigning roles to a widget’s palette is not guaranteed to change the appearance of the widget. Instead, you may choose to apply a styleSheet .

Warning

Do not use this function in conjunction with Qt Style Sheets . When using style sheets, the palette of a widget can be customized using the “color”, “background-color”, “selection-color”, “selection-background-color” and “alternate-background-color”.

See also

palette() font() Qt Style Sheets

PySide2.QtWidgets.QWidget.setParent(parent)

Parameters:

parent – PySide2.QtWidgets.QWidget

Sets the parent of the widget to parent , and resets the window flags. The widget is moved to position (0, 0) in its new parent.

If the new parent widget is in a different window, the reparented widget and its children are appended to the end of the tab chain of the new parent widget, in the same internal order as before. If one of the moved widgets had keyboard focus, calls clearFocus() for that widget.

If the new parent widget is in the same window as the old parent, setting the parent doesn’t change the tab order or keyboard focus.

If the “new” parent widget is the old parent widget, this function does nothing.

Note

The widget becomes invisible as part of changing its parent, even if it was previously visible. You must call show() to make the widget visible again.

Warning

It is very unlikely that you will ever need this function. If you have a widget that changes its content dynamically, it is far easier to use QStackedWidget .

See also

setWindowFlags()

PySide2.QtWidgets.QWidget.setParent(parent, f)

Parameters:

• parent – PySide2.QtWidgets.QWidget

• f – WindowFlags

This is an overloaded function.

This function also takes widget flags, f as an argument.

PySide2.QtWidgets.QWidget.setShortcutAutoRepeat(id[, enable=true])

Parameters:

• id – int

• enable – bool

If enable is true, auto repeat of the shortcut with the given id is enabled; otherwise it is disabled.

See also

grabShortcut() releaseShortcut()

PySide2.QtWidgets.QWidget.setShortcutEnabled(id[, enable=true])

Parameters:

• id – int

• enable – bool

If enable is true, the shortcut with the given id is enabled; otherwise the shortcut is disabled.

Warning

You should not normally need to use this function since Qt’s shortcut system enables/disables shortcuts automatically as widgets become hidden/visible and gain or lose focus. It is best to use QAction or QShortcut to handle shortcuts, since they are easier to use than this low-level function.

See also

grabShortcut() releaseShortcut()

PySide2.QtWidgets.QWidget.setSizeIncrement(arg__1)

Parameters:

arg__1 – PySide2.QtCore.QSize

This property holds the size increment of the widget.

When the user resizes the window, the size will move in steps of . width() pixels horizontally and . height() pixels vertically, with baseSize() as the basis. Preferred widget sizes are for non-negative integers i and j :

width = widget.baseSize().width() + i * widget.sizeIncrement().width()
height = widget.baseSize().height() + j * widget.sizeIncrement().height()

Note that while you can set the size increment for all widgets, it only affects windows.

By default, this property contains a size with zero width and height.

Warning

The size increment has no effect under Windows, and may be disregarded by the window manager on X11.

See also

size minimumSize maximumSize

PySide2.QtWidgets.QWidget.setSizeIncrement(w, h)

Parameters:

• w – int

• h – int

This is an overloaded function.

Sets the x (width) size increment to w and the y (height) size increment to h .

PySide2.QtWidgets.QWidget.setSizePolicy(arg__1)

Parameters:

arg__1 – PySide2.QtWidgets.QSizePolicy

This property holds the default layout behavior of the widget.

If there is a QLayout that manages this widget’s children, the size policy specified by that layout is used. If there is no such QLayout , the result of this function is used.

The default policy is Preferred/Preferred, which means that the widget can be freely resized, but prefers to be the size sizeHint() returns. Button-like widgets set the size policy to specify that they may stretch horizontally, but are fixed vertically. The same applies to lineedit controls (such as QLineEdit , QSpinBox or an editable QComboBox ) and other horizontally orientated widgets (such as QProgressBar ). QToolButton ‘s are normally square, so they allow growth in both directions. Widgets that support different directions (such as QSlider , QScrollBar or QHeader) specify stretching in the respective direction only. Widgets that can provide scroll bars (usually subclasses of QScrollArea ) tend to specify that they can use additional space, and that they can make do with less than sizeHint() .

See also

sizeHint() QLayout QSizePolicy updateGeometry()

PySide2.QtWidgets.QWidget.setSizePolicy(horizontal, vertical)

Parameters:

• horizontal – Policy

• vertical – Policy

This is an overloaded function.

Sets the size policy of the widget to horizontal and vertical , with standard stretch and no height-for-width.

See also

QSizePolicy()

PySide2.QtWidgets.QWidget.setStatusTip(arg__1)

Parameters:

arg__1 – str

This property holds the widget’s status tip.

By default, this property contains an empty string.

See also

toolTip whatsThis

PySide2.QtWidgets.QWidget.setStyle(arg__1)

Parameters:

arg__1 – PySide2.QtWidgets.QStyle

Sets the widget’s GUI style to style . The ownership of the style object is not transferred.

If no style is set, the widget uses the application’s style, style() instead.

Setting a widget’s style has no effect on existing or future child widgets.

Warning

This function is particularly useful for demonstration purposes, where you want to show Qt’s styling capabilities. Real applications should avoid it and use one consistent GUI style instead.

Warning

Qt style sheets are currently not supported for custom QStyle subclasses. We plan to address this in some future release.

See also

style() QStyle style() setStyle()

PySide2.QtWidgets.QWidget.setStyleSheet(styleSheet)

Parameters:

styleSheet – str

This property holds the widget’s style sheet.

The style sheet contains a textual description of customizations to the widget’s style, as described in the Qt Style Sheets document.

Since Qt 4.5, Qt style sheets fully supports macOS.

Warning

Qt style sheets are currently not supported for custom QStyle subclasses. We plan to address this in some future release.

See also

setStyle() styleSheet Qt Style Sheets

static PySide2.QtWidgets.QWidget.setTabOrder(arg__1, arg__2)

Parameters:

• arg__1 – PySide2.QtWidgets.QWidget

• arg__2 – PySide2.QtWidgets.QWidget

Puts the second widget after the first widget in the focus order.

It effectively removes the second widget from its focus chain and inserts it after the first widget.

Note that since the tab order of the second widget is changed, you should order a chain like this:

widget.setTabOrder(a, b) # a to b
widget.setTabOrder(b, c) # a to b to c
widge.tsetTabOrder(c, d) # a to b to c to d

not like this:

# WRONG
widget.setTabOrder(c, d) # c to d
widget.setTabOrder(a, b) # a to b AND c to d
widget.setTabOrder(b, c) # a to b to c, but not c to d

If first or second has a focus proxy, correctly substitutes the proxy.

Note

Since Qt 5.10: A widget that has a child as focus proxy is understood as a compound widget. When setting a tab order between one or two compound widgets, the local tab order inside each will be preserved. This means that if both widgets are compound widgets, the resulting tab order will be from the last child inside first , to the first child inside second .

See also

setFocusPolicy() setFocusProxy() Keyboard Focus in Widgets

PySide2.QtWidgets.QWidget.setTabletTracking(enable)

Parameters:

enable – bool

This property holds whether tablet tracking is enabled for the widget.

If tablet tracking is disabled (the default), the widget only receives tablet move events when the stylus is in contact with the tablet, or at least one stylus button is pressed, while the stylus is being moved.

If tablet tracking is enabled, the widget receives tablet move events even while hovering in proximity. This is useful for monitoring position as well as the auxiliary properties such as rotation and tilt, and providing feedback in the UI.

See also

tabletEvent()

PySide2.QtWidgets.QWidget.setToolTip(arg__1)

Parameters:

arg__1 – str

This property holds the widget’s tooltip.

Note that by default tooltips are only shown for widgets that are children of the active window. You can change this behavior by setting the attribute WA_AlwaysShowToolTips on the window , not on the widget with the tooltip.

If you want to control a tooltip’s behavior, you can intercept the event() function and catch the ToolTip event (e.g., if you want to customize the area for which the tooltip should be shown).

By default, this property contains an empty string.

See also

QToolTip statusTip whatsThis

PySide2.QtWidgets.QWidget.setToolTipDuration(msec)

Parameters:

msec – int

This property holds the widget’s tooltip duration.

Specifies how long time the tooltip will be displayed, in milliseconds. If the value is -1 (default) the duration is calculated depending on the length of the tooltip.

See also

toolTip

PySide2.QtWidgets.QWidget.setUpdatesEnabled(enable)

Parameters:

enable – bool

This property holds whether updates are enabled.

An updates enabled widget receives paint events and has a system background; a disabled widget does not. This also implies that calling update() and repaint() has no effect if updates are disabled.

By default, this property is true .

is normally used to disable updates for a short period of time, for instance to avoid screen flicker during large changes. In Qt, widgets normally do not generate screen flicker, but on X11 the server might erase regions on the screen when widgets get hidden before they can be replaced by other widgets. Disabling updates solves this.

Example:

widget.setUpdatesEnabled(False)
widget.bigVisualChanges()
widget.setUpdatesEnabled(True)

Disabling a widget implicitly disables all its children. Enabling a widget enables all child widgets except top-level widgets or those that have been explicitly disabled. Re-enabling updates implicitly calls update() on the widget.

See also

paintEvent()

PySide2.QtWidgets.QWidget.setVisible(visible)

Parameters:

visible – bool

This property holds whether the widget is visible.

Calling (true) or show() sets the widget to visible status if all its parent widgets up to the window are visible. If an ancestor is not visible, the widget won’t become visible until all its ancestors are shown. If its size or position has changed, Qt guarantees that a widget gets move and resize events just before it is shown. If the widget has not been resized yet, Qt will adjust the widget’s size to a useful default using adjustSize() .

Calling (false) or hide() hides a widget explicitly. An explicitly hidden widget will never become visible, even if all its ancestors become visible, unless you show it.

A widget receives show and hide events when its visibility status changes. Between a hide and a show event, there is no need to waste CPU cycles preparing or displaying information to the user. A video application, for example, might simply stop generating new frames.

A widget that happens to be obscured by other windows on the screen is considered to be visible. The same applies to iconified windows and windows that exist on another virtual desktop (on platforms that support this concept). A widget receives spontaneous show and hide events when its mapping status is changed by the window system, e.g. a spontaneous hide event when the user minimizes the window, and a spontaneous show event when the window is restored again.

You almost never have to reimplement the function. If you need to change some settings before a widget is shown, use showEvent() instead. If you need to do some delayed initialization use the Polish event delivered to the event() function.

See also

show() hide() isHidden() isVisibleTo() isMinimized() showEvent() hideEvent()

PySide2.QtWidgets.QWidget.setWhatsThis(arg__1)

Parameters:

arg__1 – str

This property holds the widget’s What’s This help text..

By default, this property contains an empty string.

See also

QWhatsThis toolTip statusTip

PySide2.QtWidgets.QWidget.setWindowFilePath(filePath)

Parameters:

filePath – str

This property holds the file path associated with a widget.

This property only makes sense for windows. It associates a file path with a window. If you set the file path, but have not set the window title, Qt sets the window title to the file name of the specified path, obtained using fileName() .

If the window title is set at any point, then the window title takes precedence and will be shown instead of the file path string.

Additionally, on macOS, this has an added benefit that it sets the proxy icon for the window, assuming that the file path exists.

If no file path is set, this property contains an empty string.

By default, this property contains an empty string.

See also

windowTitle windowIcon

PySide2.QtWidgets.QWidget.setWindowFlag(arg__1[, on=true])

Parameters:

• arg__1 – WindowType

• on – bool

Sets the window flag flag on this widget if on is true; otherwise clears the flag.

See also

setWindowFlags() windowFlags() windowType()

PySide2.QtWidgets.QWidget.setWindowFlags(type)

Parameters:

type – WindowFlags

See also

windowFlags()

PySide2.QtWidgets.QWidget.setWindowIcon(icon)

Parameters:

icon – PySide2.QtGui.QIcon

This property holds the widget’s icon.

This property only makes sense for windows. If no icon has been set, returns the application icon ( windowIcon() ).

Note

On macOS, window icons represent the active document, and will not be displayed unless a file path has also been set using setWindowFilePath .

See also

windowTitle setWindowFilePath

PySide2.QtWidgets.QWidget.setWindowIconText(arg__1)

Parameters:

arg__1 – str

This property holds the text to be displayed on the icon of a minimized window.

This property only makes sense for windows. If no icon text has been set, this accessor returns an empty string. It is only implemented on the X11 platform, and only certain window managers use this window property.

This property is deprecated.

See also

windowIcon windowTitle

PySide2.QtWidgets.QWidget.setWindowModality(windowModality)

Parameters:

windowModality – WindowModality

This property holds which windows are blocked by the modal widget.

This property only makes sense for windows. A modal widget prevents widgets in other windows from getting input. The value of this property controls which windows are blocked when the widget is visible. Changing this property while the window is visible has no effect; you must hide() the widget first, then show() it again.

By default, this property is NonModal .

See also

isWindow() modal QDialog

PySide2.QtWidgets.QWidget.setWindowModified(arg__1)

Parameters:

arg__1 – bool

This property holds whether the document shown in the window has unsaved changes.

A modified window is a window whose content has changed but has not been saved to disk. This flag will have different effects varied by the platform. On macOS the close button will have a modified look; on other platforms, the window title will have an ‘*’ (asterisk).

The window title must contain a “[*]” placeholder, which indicates where the ‘*’ should appear. Normally, it should appear right after the file name (e.g., “document1.txt[*] - Text Editor”). If the window isn’t modified, the placeholder is simply removed.

Note that if a widget is set as modified, all its ancestors will also be set as modified. However, if you call setWindowModified(false) on a widget, this will not propagate to its parent because other children of the parent might have been modified.

See also

windowTitle Application Example SDI Example MDI Example

PySide2.QtWidgets.QWidget.setWindowOpacity(level)

Parameters:

level – float

See also

windowOpacity()

PySide2.QtWidgets.QWidget.setWindowRole(arg__1)

Parameters:

arg__1 – str

Sets the window’s role to role . This only makes sense for windows on X11.

See also

windowRole()

PySide2.QtWidgets.QWidget.setWindowState(state)

Parameters:

state – WindowStates

Sets the window state to windowState . The window state is a OR’ed combination of WindowState : WindowMinimized , WindowMaximized , WindowFullScreen , and WindowActive .

If the window is not visible (i.e. isVisible() returns false ), the window state will take effect when show() is called. For visible windows, the change is immediate. For example, to toggle between full-screen and normal mode, use the following code:

w.setWindowState(w.windowState() ^ Qt.WindowFullScreen)

In order to restore and activate a minimized window (while preserving its maximized and/or full-screen state), use the following:

w.setWindowState(w.windowState() & ~Qt.WindowMinimized | Qt.WindowActive)

Calling this function will hide the widget. You must call show() to make the widget visible again.

Note

On some window systems WindowActive is not immediate, and may be ignored in certain cases.

When the window state changes, the widget receives a changeEvent() of type WindowStateChange .

See also

WindowState windowState()

PySide2.QtWidgets.QWidget.setWindowTitle(arg__1)

Parameters:

arg__1 – str

This property holds the window title (caption).

This property only makes sense for top-level widgets, such as windows and dialogs. If no caption has been set, the title is based of the windowFilePath . If neither of these is set, then the title is an empty string.

If you use the windowModified mechanism, the window title must contain a “[*]” placeholder, which indicates where the ‘*’ should appear. Normally, it should appear right after the file name (e.g., “document1.txt[*] - Text Editor”). If the windowModified property is false (the default), the placeholder is simply removed.

On some desktop platforms (including Windows and Unix), the application name (from applicationDisplayName ) is added at the end of the window title, if set. This is done by the QPA plugin, so it is shown to the user, but isn’t part of the string.

See also

windowIcon windowModified windowFilePath

PySide2.QtWidgets.QWidget.show()

Shows the widget and its child widgets.

This is equivalent to calling showFullScreen() , showMaximized() , or setVisible (true), depending on the platform’s default behavior for the window flags.

See also

raise() showEvent() hide() setVisible() showMinimized() showMaximized() showNormal() isVisible() windowFlags()

PySide2.QtWidgets.QWidget.showEvent(event)

Parameters:

event – PySide2.QtGui.QShowEvent

This event handler can be reimplemented in a subclass to receive widget show events which are passed in the event parameter.

Non-spontaneous show events are sent to widgets immediately before they are shown. The spontaneous show events of windows are delivered afterwards.

Note: A widget receives spontaneous show and hide events when its mapping status is changed by the window system, e.g. a spontaneous hide event when the user minimizes the window, and a spontaneous show event when the window is restored again. After receiving a spontaneous hide event, a widget is still considered visible in the sense of isVisible() .

See also

visible event() QShowEvent

PySide2.QtWidgets.QWidget.showFullScreen()

Shows the widget in full-screen mode.

Calling this function only affects windows .

To return from full-screen mode, call showNormal() or close() .

Note

Full-screen mode works fine under Windows, but has certain problems under X. These problems are due to limitations of the ICCCM protocol that specifies the communication between X11 clients and the window manager. ICCCM simply does not understand the concept of non-decorated full-screen windows. Therefore, the best we can do is to request a borderless window and place and resize it to fill the entire screen. Depending on the window manager, this may or may not work. The borderless window is requested using MOTIF hints, which are at least partially supported by virtually all modern window managers.

An alternative would be to bypass the window manager entirely and create a window with the X11BypassWindowManagerHint flag. This has other severe problems though, like totally broken keyboard focus and very strange effects on desktop changes or when the user raises other windows.

X11 window managers that follow modern post-ICCCM specifications support full-screen mode properly.

On macOS, showing a window full screen puts the entire application in full-screen mode, providing it with a dedicated desktop. Showing another window while the application runs in full-screen mode might automatically make that window full screen as well. To prevent that, exit full-screen mode by calling showNormal() or by close() on the full screen window before showing another window.

See also

showNormal() showMaximized() show() isVisible() close()

PySide2.QtWidgets.QWidget.showMaximized()

Shows the widget maximized.

Calling this function only affects windows .

On X11, this function may not work properly with certain window managers. See the Window Geometry documentation for an explanation.

See also

setWindowState() showNormal() showMinimized() show() hide() isVisible()

PySide2.QtWidgets.QWidget.showMinimized()

Shows the widget minimized, as an icon.

Calling this function only affects windows .

See also

showNormal() showMaximized() show() hide() isVisible() isMinimized()

PySide2.QtWidgets.QWidget.showNormal()

Restores the widget after it has been maximized or minimized.

Calling this function only affects windows .

See also

setWindowState() showMinimized() showMaximized() show() hide() isVisible()

PySide2.QtWidgets.QWidget.size()

Return type:

PySide2.QtCore.QSize

This property holds the size of the widget excluding any window frame.

If the widget is visible when it is being resized, it receives a resize event ( resizeEvent() ) immediately. If the widget is not currently visible, it is guaranteed to receive an event before it is shown.

The size is adjusted if it lies outside the range defined by minimumSize() and maximumSize() .

By default, this property contains a value that depends on the user’s platform and screen geometry.

Warning

Calling or setGeometry() inside resizeEvent() can lead to infinite recursion.

Note

Setting the size to QSize(0, 0) will cause the widget to not appear on screen. This also applies to windows.

See also

pos geometry minimumSize maximumSize resizeEvent() adjustSize()

PySide2.QtWidgets.QWidget.sizeHint()

Return type:

PySide2.QtCore.QSize

This property holds the recommended size for the widget.

If the value of this property is an invalid size, no size is recommended.

The default implementation of returns an invalid size if there is no layout for this widget, and returns the layout’s preferred size otherwise.

See also

isValid() minimumSizeHint() sizePolicy() setMinimumSize() updateGeometry()

PySide2.QtWidgets.QWidget.sizeIncrement()

Return type:

PySide2.QtCore.QSize

This property holds the size increment of the widget.

When the user resizes the window, the size will move in steps of . width() pixels horizontally and . height() pixels vertically, with baseSize() as the basis. Preferred widget sizes are for non-negative integers i and j :

width = widget.baseSize().width() + i * widget.sizeIncrement().width()
height = widget.baseSize().height() + j * widget.sizeIncrement().height()

Note that while you can set the size increment for all widgets, it only affects windows.

By default, this property contains a size with zero width and height.

Warning

The size increment has no effect under Windows, and may be disregarded by the window manager on X11.

See also

size minimumSize maximumSize

PySide2.QtWidgets.QWidget.sizePolicy()

Return type:

PySide2.QtWidgets.QSizePolicy

This property holds the default layout behavior of the widget.

If there is a QLayout that manages this widget’s children, the size policy specified by that layout is used. If there is no such QLayout , the result of this function is used.

The default policy is Preferred/Preferred, which means that the widget can be freely resized, but prefers to be the size sizeHint() returns. Button-like widgets set the size policy to specify that they may stretch horizontally, but are fixed vertically. The same applies to lineedit controls (such as QLineEdit , QSpinBox or an editable QComboBox ) and other horizontally orientated widgets (such as QProgressBar ). QToolButton ‘s are normally square, so they allow growth in both directions. Widgets that support different directions (such as QSlider , QScrollBar or QHeader) specify stretching in the respective direction only. Widgets that can provide scroll bars (usually subclasses of QScrollArea ) tend to specify that they can use additional space, and that they can make do with less than sizeHint() .

See also

sizeHint() QLayout QSizePolicy updateGeometry()

PySide2.QtWidgets.QWidget.stackUnder(arg__1)

Parameters:

arg__1 – PySide2.QtWidgets.QWidget

Places the widget under w in the parent widget’s stack.

To make this work, the widget itself and w must be siblings.

See also

raise() lower()

PySide2.QtWidgets.QWidget.statusTip()

Return type:

str

This property holds the widget’s status tip.

By default, this property contains an empty string.

See also

toolTip whatsThis

PySide2.QtWidgets.QWidget.style()

Return type:

PySide2.QtWidgets.QStyle

See also

setStyle() setStyle() style()

PySide2.QtWidgets.QWidget.styleSheet()

Return type:

str

This property holds the widget’s style sheet.

The style sheet contains a textual description of customizations to the widget’s style, as described in the Qt Style Sheets document.

Since Qt 4.5, Qt style sheets fully supports macOS.

Warning

Qt style sheets are currently not supported for custom QStyle subclasses. We plan to address this in some future release.

See also

setStyle() styleSheet Qt Style Sheets

PySide2.QtWidgets.QWidget.tabletEvent(event)

Parameters:

event – PySide2.QtGui.QTabletEvent

This event handler, for event event , can be reimplemented in a subclass to receive tablet events for the widget.

If you reimplement this handler, it is very important that you ignore() the event if you do not handle it, so that the widget’s parent can interpret it.

The default implementation ignores the event.

If tablet tracking is switched off, tablet move events only occur if the stylus is in contact with the tablet, or at least one stylus button is pressed, while the stylus is being moved. If tablet tracking is switched on, tablet move events occur even while the stylus is hovering in proximity of the tablet, with no buttons pressed.

See also

ignore() accept() event() setTabletTracking() QTabletEvent

PySide2.QtWidgets.QWidget.testAttribute(arg__1)

Parameters:

arg__1 – WidgetAttribute

Return type:

bool

Returns true if attribute attribute is set on this widget; otherwise returns false .

See also

setAttribute()

PySide2.QtWidgets.QWidget.toolTip()

Return type:

str

This property holds the widget’s tooltip.

Note that by default tooltips are only shown for widgets that are children of the active window. You can change this behavior by setting the attribute WA_AlwaysShowToolTips on the window , not on the widget with the tooltip.

If you want to control a tooltip’s behavior, you can intercept the event() function and catch the ToolTip event (e.g., if you want to customize the area for which the tooltip should be shown).

By default, this property contains an empty string.

See also

QToolTip statusTip whatsThis

PySide2.QtWidgets.QWidget.toolTipDuration()

Return type:

int

This property holds the widget’s tooltip duration.

Specifies how long time the tooltip will be displayed, in milliseconds. If the value is -1 (default) the duration is calculated depending on the length of the tooltip.

See also

toolTip

PySide2.QtWidgets.QWidget.topLevelWidget()

Return type:

PySide2.QtWidgets.QWidget

Use window() instead.

PySide2.QtWidgets.QWidget.underMouse()

Return type:

bool

Returns true if the widget is under the mouse cursor; otherwise returns false .

This value is not updated properly during drag and drop operations.

See also

enterEvent() leaveEvent()

PySide2.QtWidgets.QWidget.ungrabGesture(type)

Parameters:

type – GestureType

Unsubscribes the widget from a given gesture type

See also

grabGesture() QGestureEvent

PySide2.QtWidgets.QWidget.unsetCursor()

This property holds the cursor shape for this widget.

The mouse cursor will assume this shape when it’s over this widget. See the list of predefined cursor objects for a range of useful shapes.

An editor widget might use an I-beam cursor:

widget.setCursor(Qt.IBeamCursor)

If no cursor has been set, or after a call to , the parent’s cursor is used.

By default, this property contains a cursor with the ArrowCursor shape.

Some underlying window implementations will reset the cursor if it leaves a widget even if the mouse is grabbed. If you want to have a cursor set for all widgets, even when outside the window, consider setOverrideCursor() .

See also

setOverrideCursor()

PySide2.QtWidgets.QWidget.unsetLayoutDirection()

This property holds the layout direction for this widget..

Note

This method no longer affects text layout direction since Qt 4.7.

By default, this property is set to LeftToRight .

When the layout direction is set on a widget, it will propagate to the widget’s children, but not to a child that is a window and not to a child for which has been explicitly called. Also, child widgets added after has been called for the parent do not inherit the parent’s layout direction.

See also

layoutDirection

PySide2.QtWidgets.QWidget.unsetLocale()

This property holds the widget’s locale.

As long as no special locale has been set, this is either the parent’s locale or (if this widget is a top level widget), the default locale.

If the widget displays dates or numbers, these should be formatted using the widget’s locale.

See also

QLocale setDefault()

PySide2.QtWidgets.QWidget.update()

Updates the widget unless updates are disabled or the widget is hidden.

This function does not cause an immediate repaint; instead it schedules a paint event for processing when Qt returns to the main event loop. This permits Qt to optimize for more speed and less flicker than a call to repaint() does.

Calling several times normally results in just one paintEvent() call.

Qt normally erases the widget’s area before the paintEvent() call. If the WA_OpaquePaintEvent widget attribute is set, the widget is responsible for painting all its pixels with an opaque color.

See also

repaint() paintEvent() setUpdatesEnabled() Analog Clock Example

PySide2.QtWidgets.QWidget.update(arg__1)

Parameters:

arg__1 – PySide2.QtCore.QRect

PySide2.QtWidgets.QWidget.update(arg__1)

Parameters:

arg__1 – PySide2.QtGui.QRegion

PySide2.QtWidgets.QWidget.update(x, y, w, h)

Parameters:

• x – int

• y – int

• w – int

• h – int

This is an overloaded function.

This version updates a rectangle (x , y , w , h ) inside the widget.

PySide2.QtWidgets.QWidget.updateGeometry()

Notifies the layout system that this widget has changed and may need to change geometry.

Call this function if the sizeHint() or sizePolicy() have changed.

For explicitly hidden widgets, is a no-op. The layout system will be notified as soon as the widget is shown.

PySide2.QtWidgets.QWidget.updateMicroFocus()

Updates the widget’s micro focus.

PySide2.QtWidgets.QWidget.updatesEnabled()

Return type:

bool

This property holds whether updates are enabled.

An updates enabled widget receives paint events and has a system background; a disabled widget does not. This also implies that calling update() and repaint() has no effect if updates are disabled.

By default, this property is true .

is normally used to disable updates for a short period of time, for instance to avoid screen flicker during large changes. In Qt, widgets normally do not generate screen flicker, but on X11 the server might erase regions on the screen when widgets get hidden before they can be replaced by other widgets. Disabling updates solves this.

Example:

widget.setUpdatesEnabled(False)
widget.bigVisualChanges()
widget.setUpdatesEnabled(True)

Disabling a widget implicitly disables all its children. Enabling a widget enables all child widgets except top-level widgets or those that have been explicitly disabled. Re-enabling updates implicitly calls update() on the widget.

See also

paintEvent()

PySide2.QtWidgets.QWidget.visibleRegion()

Return type:

PySide2.QtGui.QRegion

Returns the unobscured region where paint events can occur.

For visible widgets, this is an approximation of the area not covered by other widgets; otherwise, this is an empty region.

The repaint() function calls this function if necessary, so in general you do not need to call it.

PySide2.QtWidgets.QWidget.whatsThis()

Return type:

str

This property holds the widget’s What’s This help text..

By default, this property contains an empty string.

See also

QWhatsThis toolTip statusTip

PySide2.QtWidgets.QWidget.wheelEvent(event)

Parameters:

event – PySide2.QtGui.QWheelEvent

This event handler, for event event , can be reimplemented in a subclass to receive wheel events for the widget.

If you reimplement this handler, it is very important that you ignore() the event if you do not handle it, so that the widget’s parent can interpret it.

The default implementation ignores the event.

See also

ignore() accept() event() QWheelEvent

PySide2.QtWidgets.QWidget.winId()

Return type:

WId

Returns the window system identifier of the widget.

Portable in principle, but if you use it you are probably about to do something non-portable. Be careful.

If a widget is non-native (alien) and is invoked on it, that widget will be provided a native handle.

This value may change at run-time. An event with type WinIdChange will be sent to the widget following a change in window system identifier.

See also

find()

PySide2.QtWidgets.QWidget.window()

Return type:

PySide2.QtWidgets.QWidget

Returns the window for this widget, i.e. the next ancestor widget that has (or could have) a window-system frame.

If the widget is a window, the widget itself is returned.

Typical usage is changing the window title:

aWidget.window().setWindowTitle("New Window Title")

See also

isWindow()

PySide2.QtWidgets.QWidget.windowFilePath()

Return type:

str

This property holds the file path associated with a widget.

This property only makes sense for windows. It associates a file path with a window. If you set the file path, but have not set the window title, Qt sets the window title to the file name of the specified path, obtained using fileName() .

If the window title is set at any point, then the window title takes precedence and will be shown instead of the file path string.

Additionally, on macOS, this has an added benefit that it sets the proxy icon for the window, assuming that the file path exists.

If no file path is set, this property contains an empty string.

By default, this property contains an empty string.

See also

windowTitle windowIcon

PySide2.QtWidgets.QWidget.windowFlags()

Return type:

WindowFlags

See also

setWindowFlags()

PySide2.QtWidgets.QWidget.windowHandle()

Return type:

PySide2.QtGui.QWindow

If this is a native widget, return the associated QWindow . Otherwise return null.

Native widgets include toplevel widgets, QGLWidget , and child widgets on which winId() was called.

See also

winId() screen()

PySide2.QtWidgets.QWidget.windowIcon()

Return type:

PySide2.QtGui.QIcon

This property holds the widget’s icon.

This property only makes sense for windows. If no icon has been set, returns the application icon ( windowIcon() ).

Note

On macOS, window icons represent the active document, and will not be displayed unless a file path has also been set using setWindowFilePath .

See also

windowTitle setWindowFilePath

PySide2.QtWidgets.QWidget.windowIconChanged(icon)

Parameters:

icon – PySide2.QtGui.QIcon

PySide2.QtWidgets.QWidget.windowIconText()

Return type:

str

This property holds the text to be displayed on the icon of a minimized window.

This property only makes sense for windows. If no icon text has been set, this accessor returns an empty string. It is only implemented on the X11 platform, and only certain window managers use this window property.

This property is deprecated.

See also

windowIcon windowTitle

PySide2.QtWidgets.QWidget.windowIconTextChanged(iconText)

Parameters:

iconText – str

PySide2.QtWidgets.QWidget.windowModality()

Return type:

WindowModality

This property holds which windows are blocked by the modal widget.

This property only makes sense for windows. A modal widget prevents widgets in other windows from getting input. The value of this property controls which windows are blocked when the widget is visible. Changing this property while the window is visible has no effect; you must hide() the widget first, then show() it again.

By default, this property is NonModal .

See also

isWindow() modal QDialog

PySide2.QtWidgets.QWidget.windowOpacity()

Return type:

float

See also

setWindowOpacity()

PySide2.QtWidgets.QWidget.windowRole()

Return type:

str

Returns the window’s role, or an empty string.

See also

setWindowRole() windowIcon windowTitle

PySide2.QtWidgets.QWidget.windowState()

Return type:

WindowStates

Returns the current window state. The window state is a OR’ed combination of WindowState : WindowMinimized , WindowMaximized , WindowFullScreen , and WindowActive .

See also

WindowState setWindowState()

PySide2.QtWidgets.QWidget.windowTitle()

Return type:

str

This property holds the window title (caption).

This property only makes sense for top-level widgets, such as windows and dialogs. If no caption has been set, the title is based of the windowFilePath . If neither of these is set, then the title is an empty string.

If you use the windowModified mechanism, the window title must contain a “[*]” placeholder, which indicates where the ‘*’ should appear. Normally, it should appear right after the file name (e.g., “document1.txt[*] - Text Editor”). If the windowModified property is false (the default), the placeholder is simply removed.

On some desktop platforms (including Windows and Unix), the application name (from applicationDisplayName ) is added at the end of the window title, if set. This is done by the QPA plugin, so it is shown to the user, but isn’t part of the string.

See also

windowIcon windowModified windowFilePath

PySide2.QtWidgets.QWidget.windowTitleChanged(title)

Parameters:

title – str

PySide2.QtWidgets.QWidget.windowType()

Return type:

WindowType

Returns the window type of this widget. This is identical to windowFlags() & WindowType_Mask .

See also

windowFlags

PySide2.QtWidgets.QWidget.x()

Return type:

int

This property holds the x coordinate of the widget relative to its parent including any window frame.

See the Window Geometry documentation for an overview of geometry issues with windows.

By default, this property has a value of 0.

See also

frameGeometry y pos

PySide2.QtWidgets.QWidget.y()

Return type:

int

This property holds the y coordinate of the widget relative to its parent and including any window frame.

See the Window Geometry documentation for an overview of geometry issues with windows.

By default, this property has a value of 0.

See also

frameGeometry x pos