PySide6.QtWidgets.QScrollArea¶
- class QScrollArea¶
The
QScrollArea
class provides a scrolling view onto another widget. More…Synopsis¶
Properties¶
alignmentᅟ
- The alignment of the scroll area’s widgetwidgetResizableᅟ
- Whether the scroll area should resize the view widget
Methods¶
def
__init__()
def
alignment()
def
ensureVisible()
def
setAlignment()
def
setWidget()
def
takeWidget()
def
widget()
Note
This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE
Detailed Description¶
Warning
This section contains snippets that were automatically translated from C++ to Python and may contain errors.
A scroll area is used to display the contents of a child widget within a frame. If the widget exceeds the size of the frame, the view can provide scroll bars so that the entire area of the child widget can be viewed. The child widget must be specified with
setWidget()
. For example:imageLabel = QLabel() image = QImage("happyguy.png") imageLabel.setPixmap(QPixmap.fromImage(image)) scrollArea = QScrollArea() scrollArea.setBackgroundRole(QPalette.Dark) scrollArea.setWidget(imageLabel)
The code above creates a scroll area (shown in the images below) containing an image label. When scaling the image, the scroll area can provide the necessary scroll bars:
The scroll bars appearance depends on the currently set scroll bar policies. You can control the appearance of the scroll bars using the inherited functionality from
QAbstractScrollArea
.For example, you can set the
horizontalScrollBarPolicy
andverticalScrollBarPolicy
properties. Or if you want the scroll bars to adjust dynamically when the contents of the scroll area changes, you can use thehorizontalScrollBar()
andverticalScrollBar()
functions (which enable you to access the scroll bars) and set the scroll bars’ values whenever the scroll area’s contents change, using thesetValue()
function.You can retrieve the child widget using the
widget()
function. The view can be made to be resizable with thesetWidgetResizable()
function. The alignment of the widget can be specified withsetAlignment()
.Two convenience functions
ensureVisible()
andensureWidgetVisible()
ensure a certain region of the contents is visible inside the viewport, by scrolling the contents if necessary.Size Hints and Layouts¶
When using a scroll area to display the contents of a custom widget, it is important to ensure that the
size hint
of the child widget is set to a suitable value. If a standardQWidget
is used for the child widget, it may be necessary to callsetMinimumSize()
to ensure that the contents of the widget are shown correctly within the scroll area.If a scroll area is used to display the contents of a widget that contains child widgets arranged in a layout, it is important to realize that the size policy of the layout will also determine the size of the widget. This is especially useful to know if you intend to dynamically change the contents of the layout. In such cases, setting the layout’s
size constraint
property to one which provides constraints on the minimum and/or maximum size of the layout (e.g.,SetMinAndMaxSize
) will cause the size of the scroll area to be updated whenever the contents of the layout changes.See also
Note
Properties can be used directly when
from __feature__ import true_property
is used or via accessor functions otherwise.- property alignmentᅟ: Combination of Qt.AlignmentFlag¶
This property holds the alignment of the scroll area’s widget.
A valid alignment is a combination of the following flags:
Qt::AlignLeft
Qt::AlignHCenter
Qt::AlignRight
Qt::AlignTop
Qt::AlignVCenter
Qt::AlignBottom
By default, the widget stays rooted to the top-left corner of the scroll area.
- Access functions:
- property widgetResizableᅟ: bool¶
This property holds whether the scroll area should resize the view widget.
If this property is set to false (the default), the scroll area honors the size of its widget. Regardless of this property, you can programmatically resize the widget using
widget()
->resize()
, and the scroll area will automatically adjust itself to the new size.If this property is set to true, the scroll area will automatically resize the widget in order to avoid scroll bars where they can be avoided, or to take advantage of extra space.
- Access functions:
Constructs an empty scroll area with the given
parent
.See also
- alignment()¶
- Return type:
Combination of
AlignmentFlag
See also
Getter of property
alignmentᅟ
.- ensureVisible(x, y[, xmargin=50[, ymargin=50]])¶
- Parameters:
x – int
y – int
xmargin – int
ymargin – int
Scrolls the contents of the scroll area so that the point (
x
,y
) is visible inside the region of the viewport with margins specified in pixels byxmargin
andymargin
. If the specified point cannot be reached, the contents are scrolled to the nearest valid position. The default value for both margins is 50 pixels.- ensureWidgetVisible(childWidget[, xmargin=50[, ymargin=50]])¶
- Parameters:
childWidget –
QWidget
xmargin – int
ymargin – int
Scrolls the contents of the scroll area so that the
childWidget
ofwidget()
is visible inside the viewport with margins specified in pixels byxmargin
andymargin
. If the specified point cannot be reached, the contents are scrolled to the nearest valid position. The default value for both margins is 50 pixels.- setAlignment(arg__1)¶
- Parameters:
arg__1 – Combination of
AlignmentFlag
See also
Setter of property
alignmentᅟ
.Sets the scroll area’s
widget
.The
widget
becomes a child of the scroll area, and will be destroyed when the scroll area is deleted or when a new widget is set.The widget’s
autoFillBackground
property will be set totrue
.If the scroll area is visible when the
widget
is added, you mustshow()
it explicitly.Note that You must add the layout of
widget
before you call this function; if you add it later, thewidget
will not be visible - regardless of when youshow()
the scroll area. In this case, you can also notshow()
thewidget
later.See also
- setWidgetResizable(resizable)¶
- Parameters:
resizable – bool
See also
Setter of property
widgetResizableᅟ
.Removes the scroll area’s widget, and passes ownership of the widget to the caller.
See also
Returns the scroll area’s widget, or
None
if there is none.See also
- widgetResizable()¶
- Return type:
bool
See also
Getter of property
widgetResizableᅟ
.