QWidget¶

PyQt6.QtWidgets.QWidget

Inherited by QAbstractButton, QAbstractSlider, QAbstractSpinBox, QAxBaseWidget, QCalendarWidget, QComboBox, QDesignerActionEditorInterface, QDesignerFormWindowInterface, QDesignerObjectInspectorInterface, QDesignerPropertyEditorInterface, QDesignerWidgetBoxInterface, QDialog, QDialogButtonBox, QDockWidget, QFocusFrame, QFrame, QGroupBox, QHelpFilterSettingsWidget, QHelpSearchQueryWidget, QHelpSearchResultWidget, QKeySequenceEdit, QLineEdit, QMainWindow, QMdiSubWindow, QMenu, QMenuBar, QOpenGLWidget, QPdfPageSelector, QPrintPreviewWidget, QProgressBar, QQuickWidget, QRubberBand, QSizeGrip, QSplashScreen, QSplitterHandle, QStatusBar, QSvgWidget, QTabBar, QTabWidget, QToolBar, QVideoWidget, QWebEngineView, QWizardPage.

Description¶

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

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:

QWidget \*parent = nullptr is the parent of the new widget. If it is nullptr (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).
Qt::WindowFlags f = { } (where available) sets the window flags; the default is suitable for most 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 that 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.

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 Widgets Tutorial.

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 because 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 that 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 don’t 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()

Transparency and Double Buffering¶

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

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 that have 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.

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, for example, 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.

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¶

You can 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¶

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, choose one of the following options:

Use the QT_USE_NATIVE_WINDOWS=1 in your environment.
Set the AA_NativeWindows attribute on your application. All widgets will be native widgets.
Set the WA_NativeWindow attribute on widgets: The widget itself and all its ancestors will become native (unless WA_DontCreateNativeAncestors is set).
Call winId() to enforce a native window (this implies 3).
Set the WA_PaintOnScreen attribute to enforce a native window (this implies 3).

Enums¶

RenderFlag

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

Member	Value	Description
DrawChildren	0x2	If you enable this option, the widget’s children are rendered recursively into the target. By default, this option is enabled.
DrawWindowBackground	0x1	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.
IgnoreMask	0x4	If you enable this option, the widget’s mask() is ignored when rendering into the target. By default, this option is disabled.

Methods¶

__init__(parent: QWidget = None, flags: WindowType = Qt.WindowFlags())

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

If parent is nullptr, 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 nullptr). 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().

acceptDrops() → bool: See also

setAcceptDrops().

accessibleDescription() → str: See also

setAccessibleDescription().

accessibleName() → str: See also

setAccessibleName().

actionEvent(QActionEvent): This event handler is called with the given event whenever the widget’s actions are changed.

See also

addAction(), insertAction(), removeAction(), actions(), QActionEvent.

actions() → list[QAction]: Returns the (possibly empty) list of this widget’s actions.

See also

contextMenuPolicy(), insertAction(), removeAction().

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().

addAction(Optional[str]) → QAction: TODO

addAction(QAction)

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

All QWidgets have a list of QActions, 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.

addAction(QIcon, Optional[str]) → QAction: TODO

addAction(Optional[str], Union[QKeySequence, StandardKey, Optional[str], int]) → QAction: TODO

addAction(QIcon, Optional[str], Union[QKeySequence, StandardKey, Optional[str], int]) → QAction: TODO

addAction(Optional[str], PYQT_SLOT, type: ConnectionType = AutoConnection) → QAction: TODO

addAction(QIcon, Optional[str], PYQT_SLOT, type: ConnectionType = AutoConnection) → QAction: TODO

addAction(Optional[str], Union[QKeySequence, StandardKey, Optional[str], int], PYQT_SLOT, type: ConnectionType = AutoConnection) → QAction: TODO

addAction(QIcon, Optional[str], Union[QKeySequence, StandardKey, Optional[str], int], PYQT_SLOT, type: ConnectionType = AutoConnection) → QAction: TODO

addActions(Iterable[QAction]): Appends the actions actions to this widget’s list of actions.

See also

removeAction(), QMenu, addAction().

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().

autoFillBackground() → bool: See also

setAutoFillBackground().

backgroundRole() → 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 inherits its parent widget’s background role.

See also

setBackgroundRole(), foregroundRole().

baseSize() → QSize: See also

setBaseSize().

changeEvent(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.

childAt(QPoint) → QWidget

This is an overloaded function.

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

childAt(QPointF) → QWidget

This is an overloaded function.

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

childAt(int, int) → 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 nullptr.

childrenRect() → QRect: TODO

childrenRegion() → QRegion: TODO

clearFocus()

Takes keyboard input focus from the widget.

If the widget has active focus, a focusOutEvent() is sent to this widget to tell it that it has lost the focus.

This widget must enable focus setting to get the keyboard input focus; that is, it must call setFocusPolicy().

clearMask(): Removes any mask set by setMask().

See also

setMask().

close() → bool

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

First it sends the widget a QCloseEvent. The widget is hide() if it accept() the close event. If it ignore() 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.

closeEvent(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.

See also

event(), hide(), close(), QCloseEvent.

contentsMargins() → QMargins: The contentsMargins function returns the widget’s contents margins.

See also

setContentsMargins(), contentsRect().

contentsRect() → QRect: Returns the area inside the widget’s margins.

See also

setContentsMargins(), contentsMargins().

contextMenuEvent(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.

contextMenuPolicy() → ContextMenuPolicy: See also

setContextMenuPolicy().

create(window: voidptr = None, initializeWindow: bool = True, destroyOldWindow: bool = True)

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().

@staticmethod createWindowContainer(QWindow, parent: QWidget = None, flags: WindowType = Qt.WindowFlags()) → 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 Widgets vs Alien Widgets 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.
Since 6.7, if window belongs to a widget (that is, window was received from calling windowHandle()), no container will be created. Instead, this function will return the widget itself, after being reparented to parent. Since no container will be created, flags will be ignored. In other words, if window belongs to a widget, consider just reparenting that widget to parent instead of using this function.

cursor() → QCursor: See also

setCursor().

destroy(destroyWindow: bool = True, destroySubWindows: bool = True)

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

destroy() 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.

devType() → int: TODO

dragEnterEvent(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 dragMoveEvent().

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

See also

QDrag, QDragEnterEvent.

dragLeaveEvent(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.

dragMoveEvent(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.

dropEvent(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.

effectiveWinId() → voidptr

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().

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().

enterEvent(QEnterEvent)

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.

event(QEvent) → bool: TODO

@staticmethod find(voidptr) → 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, nullptr is returned.

focusInEvent(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()).

focusNextChild() → 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().

focusNextPrevChild(bool) → 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 focusNextPrevChild() only when it reaches the last or first link on the “page”.

Child widgets call focusNextPrevChild() 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().

focusOutEvent(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()).

focusPolicy() → FocusPolicy: See also

setFocusPolicy().

focusPreviousChild() → 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().

focusProxy() → QWidget: Returns the focus proxy, or nullptr if there is no focus proxy.

See also

setFocusProxy().

focusWidget() → 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.

font() → QFont: See also

setFont().

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

See also

font(), fontMetrics(), setFont().

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

See also

font(), fontInfo(), setFont().

foregroundRole() → 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().

frameGeometry() → QRect: TODO

frameSize() → QSize: TODO

geometry() → QRect: See also

setGeometry().

grab(rectangle: QRect = QRect(QPoint(0,0),QSize(-1,-1))) → 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.

grabGesture(GestureType, flags: GestureFlag = Qt.GestureFlags()): Subscribes the widget to a given gesture with specific flags.

See also

ungrabGesture(), QGestureEvent.

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.

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 seldom 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 grabMouse().

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

grabMouse(Union[QCursor, CursorShape])

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().

grabShortcut(Union[QKeySequence, StandardKey, Optional[str], int], context: ShortcutContext = WindowShortcut) → 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 QActions with the shortcut key sequences you require (if you also want equivalent menu options and toolbar buttons), or create QShortcuts 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.

graphicsEffect() → QGraphicsEffect

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

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

See also

setGraphicsEffect().

graphicsProxyWidget() → QGraphicsProxyWidget: Returns the proxy widget for the corresponding embedded widget in a graphics view; otherwise returns nullptr.

See also

createProxyForChildWidget(), addWidget().

hasFocus() → bool: TODO

hasHeightForWidth() → bool: Returns true if the widget’s preferred height depends on its width; otherwise returns false.

hasMouseTracking() → bool: TODO

hasTabletTracking() → bool: TODO

height() → int: TODO

heightForWidth(int) → 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.

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.

hideEvent(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.

initPainter(QPainter): TODO

inputMethodEvent(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.

inputMethodHints() → InputMethodHint: See also

setInputMethodHints().

inputMethodQuery(InputMethodQuery) → Any

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.

insertAction(QAction, QAction)

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

A QWidget should only have one of each action.

insertActions(QAction, Iterable[QAction])

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

A QWidget can have at most one of each action.

isActiveWindow() → bool: TODO

isAncestorOf(QWidget) → 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.

isEnabled() → bool: TODO

isEnabledTo(QWidget) → 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.

isEnabledTo(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 isEnabledTo(0) stops at this widget’s window, unlike isEnabled() which also takes parent windows into considerations.

See also

setEnabled(), enabled.

isFullScreen() → bool: TODO

isHidden() → 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).

isHidden() 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.

isLeftToRight() → bool: TODO

isMaximized() → bool: TODO

isMinimized() → bool: TODO

isModal() → bool: TODO

isRightToLeft() → bool: TODO

isVisible() → bool: TODO

isVisibleTo(QWidget) → 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.

isVisibleTo(0) is identical to isVisible().

See also

show(), hide(), isVisible().

isWindow() → 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 setWindowTitle().

A window can have a parentWidget(). 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().

isWindowModified() → bool: TODO

@staticmethod keyboardGrabber() → QWidget

Returns the widget that is currently grabbing the keyboard input.

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

See also

grabMouse(), mouseGrabber().

keyPressEvent(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 QKeyEvent::accept() - just do not call the base class implementation if you act upon the key.

keyReleaseEvent(QKeyEvent)

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

A widget must setFocusPolicy() initially and hasFocus() 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 QKeyEvent::accept() - just do not call the base class implementation if you act upon the key.

layout() → QLayout

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

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

layoutDirection() → LayoutDirection: See also

setLayoutDirection().

leaveEvent(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.

locale() → QLocale: See also

setLocale().

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().

mapFrom(QWidget, QPoint) → QPoint: This is an overloaded function.

mapFrom(QWidget, QPointF) → QPointF: Translates the widget coordinate pos from the coordinate system of parent to this widget’s coordinate system. The parent must not be nullptr and must be a parent of the calling widget.

See also

mapTo(), mapFromParent(), mapFromGlobal(), underMouse().

mapFromGlobal(QPoint) → QPoint: This is an overloaded function.

mapFromGlobal(QPointF) → QPointF: Translates the global screen coordinate pos to widget coordinates.

See also

mapToGlobal(), mapFrom(), mapFromParent().

mapFromParent(QPoint) → QPoint: This is an overloaded function.

mapFromParent(QPointF) → QPointF

Translates the parent widget coordinate pos to widget coordinates.

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

mapTo(QWidget, QPoint) → QPoint: This is an overloaded function.

mapTo(QWidget, QPointF) → QPointF: Translates the widget coordinate pos to the coordinate system of parent. The parent must not be nullptr and must be a parent of the calling widget.

See also

mapFrom(), mapToParent(), mapToGlobal(), underMouse().

mapToGlobal(QPoint) → QPoint: This is an overloaded function.

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

See also

mapFromGlobal(), mapTo(), mapToParent().

mapToParent(QPoint) → QPoint: This is an overloaded function.

mapToParent(QPointF) → QPointF

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

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

mask() → 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().

maximumHeight() → int: See also

setMaximumHeight().

maximumSize() → QSize: See also

setMaximumSize().

maximumWidth() → int: See also

setMaximumWidth().

metric(PaintDeviceMetric) → int: TODO

minimumHeight() → int: See also

setMinimumHeight().

minimumSize() → QSize: See also

setMinimumSize().

minimumSizeHint() → QSize: TODO

minimumWidth() → int: See also

setMinimumWidth().

mouseDoubleClickEvent(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.

@staticmethod mouseGrabber() → QWidget

Returns the widget that is currently grabbing the mouse input.

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

See also

grabMouse(), keyboardGrabber().

mouseMoveEvent(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 mouseMoveEvent().

mousePressEvent(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 mousePressEvent() 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.

mouseReleaseEvent(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.

move(QPoint): TODO

move(int, int)

This is an overloaded function.

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

moveEvent(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().

nativeEvent(Union[QByteArray, bytes, bytearray, memoryview], voidptr) → (bool, voidptr)

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.

nativeParentWidget() → QWidget: Returns the native parent for this widget, i.e. the next ancestor widget that has a system identifier, or nullptr if it does not have any native parent.

See also

effectiveWinId().

nextInFocusChain() → QWidget: Returns the next widget in this widget’s focus chain.

See also

previousInFocusChain().

normalGeometry() → QRect: TODO

overrideWindowFlags(WindowType)

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().

overrideWindowState(WindowState): TODO

paintEngine() → QPaintEngine: TODO

paintEvent(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 paintEvent() to avoid flicker.

Note: Generally, you should refrain from calling update() or repaint() inside a paintEvent(). For example, calling update() or repaint() on children inside a paintEvent() 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.

palette() → QPalette: See also

setPalette().

parentWidget() → QWidget: Returns the parent of this widget, or nullptr if it does not have any parent widget.

pos() → QPoint: TODO

previousInFocusChain() → QWidget: The previousInFocusChain function returns the previous widget in this widget’s focus chain.

See also

nextInFocusChain().

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().

rect() → QRect: TODO

releaseKeyboard(): Releases the keyboard grab.

See also

grabKeyboard(), grabMouse(), releaseMouse().

releaseMouse(): Releases the mouse grab.

See also

grabMouse(), grabKeyboard(), releaseKeyboard().

releaseShortcut(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().

removeAction(QAction): Removes the action action from this widget’s list of actions.

See also

insertAction(), actions(), insertAction().

render(QPaintDevice, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: RenderFlag = QWidget.RenderFlags(QWidget.DrawWindowBackground|QWidget.DrawChildren))

Renders the sourceRegion of this widget into the target using renderFlags to determine how to render. Rendering starts at targetOffset in the target. For example:

# QPixmap pixmap(widget->size());
# widget->render(&pixmap);

If sourceRegion is a null region, this function will use rect() as the region, i.e. the entire widget.

Ensure that you call end() for the target device’s active painter (if any) before rendering. For example:

# QPainter painter(this);
# ...
# painter.end();
# myWidget->render(this);

Note: To obtain the contents of a QOpenGLWidget, use grabFramebuffer() instead.

render(QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: RenderFlag = QWidget.RenderFlags(QWidget.DrawWindowBackground|QWidget.DrawChildren))

This is an overloaded function.

Renders the widget into the painter’s device().

Transformations and settings applied to the painter will be used when rendering.

Note: The painter must be active. On macOS the widget will be rendered into a QPixmap and then drawn by the painter.

See also

device().

repaint()

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

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

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

repaint(QRect)

This is an overloaded function.

This version repaints a rectangle rect inside the widget.

repaint(QRegion)

This is an overloaded function.

This version repaints a region rgn inside the widget.

repaint(int, int, int, 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.

resize(QSize): TODO

resize(int, int)

This is an overloaded function.

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

resizeEvent(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.

restoreGeometry(Union[QByteArray, bytes, bytearray, memoryview]) → 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:

# QSettings settings("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.

saveGeometry() → 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:

# void MyWidget::closeEvent(QCloseEvent *event)
# {
#     QSettings settings("MyCompany", "MyApp");
#     settings.setValue("geometry", saveGeometry());
#     QWidget::closeEvent(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.

screen() → QScreen: Returns the screen the widget is on.

See also

setScreen(), windowHandle().

scroll(int, 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.

scroll(int, int, 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.

setAcceptDrops(bool): See also

acceptDrops().

setAccessibleDescription(Optional[str]): See also

accessibleDescription().

setAccessibleName(Optional[str]): See also

accessibleName().

setAttribute(WidgetAttribute, on: bool = True): Sets the attribute attribute on this widget if on is true; otherwise clears the attribute.

See also

testAttribute().

setAutoFillBackground(bool): See also

autoFillBackground().

setBackgroundRole(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 setBackgroundRole().

See also

backgroundRole(), foregroundRole().

setBaseSize(QSize): See also

baseSize().

setBaseSize(int, int)

This is an overloaded function.

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

setContentsMargins(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().

setContentsMargins(int, int, int, 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().

setContextMenuPolicy(ContextMenuPolicy): See also

contextMenuPolicy().

setCursor(Union[QCursor, CursorShape]): See also

cursor().

setDisabled(bool)

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

See the enabled documentation for more information.

setEnabled(bool): See also

isEnabled().

setFixedHeight(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().

setFixedSize(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().

setFixedSize(int, int)

This is an overloaded function.

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

setFixedWidth(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().

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 isActiveWindow().

setFocus(FocusReason)

Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the isActiveWindow(). 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.

setFocusPolicy(FocusPolicy): See also

focusPolicy().

setFocusProxy(QWidget)

Sets the widget’s focus proxy to widget w. If w is nullptr, 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.

setFocusProxy() 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 setFocusProxy() moves focus to the new focus proxy.

See also

focusProxy().

setFont(QFont): See also

font().

setForegroundRole(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 setForegroundRole().

See also

foregroundRole(), backgroundRole().

setGeometry(QRect): See also

geometry().

setGeometry(int, int, int, int)

This is an overloaded function.

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

setGraphicsEffect(QGraphicsEffect)

The setGraphicsEffect 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, setGraphicsEffect() 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().

setHidden(bool): Convenience function, equivalent to setVisible()(!hidden).

See also

isHidden().

setInputMethodHints(InputMethodHint): See also

inputMethodHints().

setLayout(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.

setLayoutDirection(LayoutDirection): See also

layoutDirection().

setLocale(QLocale): See also

locale().

setMask(QBitmap)

Causes only the pixels of the widget for which bitmap has a corresponding 1 bit to be visible. If the region includes pixels outside the rect() of the widget, window system controls in that area may or may not be visible, depending on the platform.

Note that this effect can be slow if the region is particularly complex.

The following code shows how an image with an alpha channel can be used to generate a mask for a widget:

#     QLabel topLevelLabel;
#     QPixmap pixmap(":/images/tux.png");
#     topLevelLabel.setPixmap(pixmap);
#     topLevelLabel.setMask(pixmap.mask());

The label shown by this code is masked using the image it contains, giving the appearance that an irregularly-shaped image is being drawn directly onto the screen.

Masked widgets receive mouse events only on their visible portions.

See also

mask(), clearMask(), windowOpacity().

setMask(QRegion)

This is an overloaded function.

Causes only the parts of the widget which overlap region to be visible. If the region includes pixels outside the rect() of the widget, window system controls in that area may or may not be visible, depending on the platform.

Since QRegion allows arbitrarily complex regions to be created, widget masks can be made to suit the most unconventionally-shaped windows, and even allow widgets to be displayed with holes in them. Note that this effect can be slow if the region is particularly complex.

Widget masks are used to hint to the window system that the application does not want mouse events for areas outside the mask. On most systems, they also result in coarse visual clipping. To get smooth window edges, use translucent background and anti-aliased painting instead, as shown in the Translucent Background example.

See also

windowOpacity().

setMaximumHeight(int): See also

maximumHeight().

setMaximumSize(QSize): See also

maximumSize().

setMaximumSize(int, 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.

setMaximumWidth(int): See also

maximumWidth().

setMinimumHeight(int): See also

minimumHeight().

setMinimumSize(QSize): See also

minimumSize().

setMinimumSize(int, 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.

setMinimumWidth(int): See also

minimumWidth().

setMouseTracking(bool): See also

hasMouseTracking().

setPalette(QPalette): See also

palette().

setParent(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 setFocusPolicy() 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().

setParent(QWidget, WindowType)

This is an overloaded function.

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

setScreen(QScreen)

Sets the screen on which the widget should be shown to screen.

Setting the screen only makes sense for windows. If necessary, the widget’s window will get recreated on screen.

Note: If the screen is part of a virtual desktop of multiple screens, the window will not move automatically to screen. To place the window relative to the screen, use the screen’s topLeft() position.

See also

screen(), setScreen().

setShortcutAutoRepeat(int, enabled: bool = True): If enable is true, auto repeat of the shortcut with the given id is enabled; otherwise it is disabled.

See also

grabShortcut(), releaseShortcut().

setShortcutEnabled(int, enabled: bool = True)

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().

setSizeIncrement(QSize): See also

sizeIncrement().

setSizeIncrement(int, int)

This is an overloaded function.

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

setSizePolicy(QSizePolicy): See also

sizePolicy().

setSizePolicy(Policy, 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

__init__().

setStatusTip(Optional[str]): See also

statusTip().

setStyle(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().

setStyleSheet(Optional[str]): See also

styleSheet().

setTabletTracking(bool): See also

hasTabletTracking().

@staticmethod setTabOrder(QWidget, 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:

# setTabOrder(a, b); // a to b
# setTabOrder(b, c); // a to b to c
# setTabOrder(c, d); // a to b to c to d

not like this:

# // WRONG
# setTabOrder(c, d); // c to d
# setTabOrder(a, b); // a to b AND c to d
# 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.

setToolTip(Optional[str]): See also

toolTip().

setToolTipDuration(int): See also

toolTipDuration().

setUpdatesEnabled(bool): See also

updatesEnabled().

setVisible(bool): See also

isVisible().

setWhatsThis(Optional[str]): See also

whatsThis().

setWindowFilePath(Optional[str]): See also

windowFilePath().

setWindowFlag(WindowType, on: bool = True): Sets the window flag flag on this widget if on is true; otherwise clears the flag.

See also

setWindowFlags(), windowFlags(), windowType().

setWindowFlags(WindowType): See also

windowFlags().

setWindowIcon(QIcon): See also

windowIcon().

setWindowIconText(Optional[str]): See also

windowIconText().

setWindowModality(WindowModality): See also

windowModality().

setWindowModified(bool): See also

isWindowModified().

setWindowOpacity(float): See also

windowOpacity().

setWindowRole(Optional[str]): Sets the window’s role to role. This only makes sense for windows on X11.

See also

windowRole().

setWindowState(WindowState)

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);

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().

setWindowTitle(Optional[str]): See also

windowTitle().

sharedPainter() → QPainter: TODO

show()

Shows the widget and its child widgets.

For child windows, this is equivalent to calling setVisible()(true). Otherwise, it is equivalent to calling showFullScreen(), showMaximized(), or setVisible()(true), depending on the platform’s default behavior for the window flags.

showEvent(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.

showFullScreen()

Shows the widget in full-screen mode.

Calling this function only affects isWindow().

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.

showMaximized()

Shows the widget maximized.

Calling this function only affects isWindow().

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

showMinimized()

Shows the widget minimized, as an icon.

Calling this function only affects isWindow().

showNormal()

Restores the widget after it has been maximized or minimized.

Calling this function only affects isWindow().

size() → QSize: TODO

sizeHint() → QSize: TODO

sizeIncrement() → QSize: See also

setSizeIncrement().

sizePolicy() → QSizePolicy: See also

setSizePolicy().

stackUnder(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().

statusTip() → str: See also

setStatusTip().

style() → QStyle: See also

setStyle(), setStyle(), style().

styleSheet() → str: See also

setStyleSheet().

tabletEvent(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 QEvent 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.

testAttribute(WidgetAttribute) → bool: Returns true if attribute attribute is set on this widget; otherwise returns false.

See also

setAttribute().

toolTip() → str: See also

setToolTip().

toolTipDuration() → int: See also

setToolTipDuration().

underMouse() → 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().

ungrabGesture(GestureType): Unsubscribes the widget from a given gesture type

See also

grabGesture(), QGestureEvent.

unsetCursor(): TODO

unsetLayoutDirection(): TODO

unsetLocale(): TODO

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 update() 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.

update(QRect)

This is an overloaded function.

This version updates a rectangle rect inside the widget.

update(QRegion)

This is an overloaded function.

This version repaints a region rgn inside the widget.

update(int, int, int, int)

This is an overloaded function.

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

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, updateGeometry() is a no-op. The layout system will be notified as soon as the widget is shown.

updateMicroFocus(query: InputMethodQuery = ImQueryAll): Updates the widget’s micro focus and informs input methods that the state specified by query has changed.

updatesEnabled() → bool: See also

setUpdatesEnabled().

visibleRegion() → 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.

whatsThis() → str: See also

setWhatsThis().

wheelEvent(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 QEvent the event if you do not handle it, so that the widget’s parent can interpret it.

The default implementation ignores the event.

width() → int: TODO

window() → 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().

windowFilePath() → str: See also

setWindowFilePath().

windowFlags() → WindowType: See also

setWindowFlags().

windowHandle() → 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().

windowIcon() → QIcon: See also

setWindowIcon().

windowIconText() → str: See also

setWindowIconText().

windowModality() → WindowModality: See also

setWindowModality().

windowOpacity() → float: See also

setWindowOpacity().

windowRole() → str: Returns the window’s role, or an empty string.

See also

setWindowRole(), windowIcon(), windowTitle().

windowState() → WindowState: Returns the current window state. The window state is a OR’ed combination of WindowState: WindowMinimized, WindowMaximized, WindowFullScreen, and WindowActive.

See also

WindowState, setWindowState().

windowTitle() → str: See also

setWindowTitle().

windowType() → WindowType: Returns the window type of this widget. This is identical to windowFlags() & WindowType_Mask.

See also

windowFlags().

winId() → voidptr

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 winId() 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().

x() → int: TODO

y() → int: TODO

Signals¶

customContextMenuRequested(QPoint): This signal is emitted when the widget’s contextMenuPolicy() is CustomContextMenu, and the user has requested a context menu on the widget. The position pos is the position of the context menu event that the widget receives. Normally this is in widget coordinates. The exception to this rule is QAbstractScrollArea and its subclasses that map the context menu event to coordinates of the viewport().

See also

mapToGlobal(), QMenu, contextMenuPolicy().

windowIconChanged(QIcon): This signal is emitted when the window’s icon has changed, with the new icon as an argument.

windowIconTextChanged(Optional[str])

This signal is emitted when the window’s icon text has changed, with the new iconText as an argument.

This signal is deprecated.

windowTitleChanged(Optional[str]): This signal is emitted when the window’s title has changed, with the new title as an argument.

QWidget¶

Description¶

Top-Level and Child Widgets¶

Composite Widgets¶

Custom Widgets and Painting¶

Size Hints and Size Policies¶

Events¶

Groups of Functions and Properties¶

Widget Style Sheets¶

Transparency and Double Buffering¶

Creating Translucent Windows¶

Native Widgets vs Alien Widgets¶

Enums¶

Methods¶

Signals¶

Table of Contents