class QFrame

The QFrame class is the base class of widgets that can have a frame. More…

Inheritance diagram of PySide6.QtWidgets.QFrame

Inherited by: QToolBox, QStackedWidget, QSplitter, QLabel, QLCDNumber, QAbstractScrollArea, QTextEdit, QTextBrowser, QScrollArea, QPlainTextEdit, QMdiArea, QGraphicsView, QAbstractItemView, QTreeView, QTreeWidget, QHelpContentWidget, QTableView, QTableWidget, QListView, QUndoView, QListWidget, QHelpIndexWidget, QHeaderView, QColumnView, QPdfView, QChartView

Synopsis

Properties

Methods

Virtual methods

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.

QMenu uses this to “raise” the menu above the surrounding screen. QProgressBar has a “sunken” look. QLabel has a flat look. The frames of widgets like these can be changed.

label = QLabel(...)
label.setFrameStyle(QFrame.Panel | QFrame.Raised)
label.setLineWidth(2)
pbar = QProgressBar(...)
label.setFrameStyle(QFrame.NoFrame)

The QFrame class can also be used directly for creating simple placeholder frames without any contents.

The frame style is specified by a frame shape and a shadow style that is used to visually separate the frame from surrounding widgets. These properties can be set together using the setFrameStyle() function and read with frameStyle() .

The frame shapes are NoFrame , Box , Panel , StyledPanel , HLine and VLine ; the shadow styles are Plain , Raised and Sunken .

A frame widget has three attributes that describe the thickness of the border: lineWidth , midLineWidth , and frameWidth .

  • The line width is the width of the frame border. It can be modified to customize the frame’s appearance.

  • The mid-line width specifies the width of an extra line in the middle of the frame, which uses a third color to obtain a special 3D effect. Notice that a mid-line is only drawn for Box , HLine and VLine frames that are raised or sunken.

  • The frame width is determined by the frame style, and the frameWidth() function is used to obtain the value defined for the style used.

The margin between the frame and the contents of the frame can be customized with the setContentsMargins() function.

This table shows some of the combinations of styles and line widths:

../../_images/frames.png
class Shape

(inherits enum.IntEnum) This enum type defines the shapes of frame available.

Constant

Description

QFrame.NoFrame

QFrame draws nothing

QFrame.Box

QFrame draws a box around its contents

QFrame.Panel

QFrame draws a panel to make the contents appear raised or sunken

QFrame.StyledPanel

draws a rectangular panel with a look that depends on the current GUI style. It can be raised or sunken.

QFrame.HLine

QFrame draws a horizontal line that frames nothing (useful as separator)

QFrame.VLine

QFrame draws a vertical line that frames nothing (useful as separator)

QFrame.WinPanel

draws a rectangular panel that can be raised or sunken like those in Windows 2000. Specifying this shape sets the line width to 2 pixels. WinPanel is provided for compatibility. For GUI style independence we recommend using StyledPanel instead.

When it does not call QStyle , Shape interacts with Shadow , the lineWidth() and the midLineWidth() to create the total result. See the picture of the frames in the main class documentation.

See also

Shadow style() drawPrimitive()

class Shadow

(inherits enum.IntEnum) This enum type defines the types of shadow that are used to give a 3D effect to frames.

Constant

Description

QFrame.Plain

the frame and contents appear level with the surroundings; draws using the palette QPalette::WindowText color (without any 3D effect)

QFrame.Raised

the frame and contents appear raised; draws a 3D raised line using the light and dark colors of the current color group

QFrame.Sunken

the frame and contents appear sunken; draws a 3D sunken line using the light and dark colors of the current color group

Shadow interacts with Shape , the lineWidth() and the midLineWidth() . See the picture of the frames in the main class documentation.

class StyleMask

This enum defines two constants that can be used to extract the two components of frameStyle() :

Constant

Description

QFrame.Shadow_Mask

The Shadow part of frameStyle()

QFrame.Shape_Mask

The Shape part of frameStyle()

Normally, you don’t need to use these, since frameShadow() and frameShape() already extract the Shadow and the Shape parts of frameStyle() .

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property frameRectᅟ: QRect

This property holds the frame’s rectangle.

The frame’s rectangle is the rectangle the frame is drawn in. By default, this is the entire widget. Setting the rectangle doesn’t cause a widget update. The frame rectangle is automatically adjusted when the widget changes size.

If you set the rectangle to a null rectangle (for example, QRect(0, 0, 0, 0)), then the resulting frame rectangle is equivalent to the widget rectangle .

Access functions:
property frameShadowᅟ: QFrame.Shadow

This property holds the frame shadow value from the frame style.

Access functions:
property frameShapeᅟ: QFrame.Shape

This property holds the frame shape value from the frame style.

Access functions:
property frameWidthᅟ: int

This property holds the width of the frame that is drawn..

Note that the frame width depends on the frame style , not only the line width and the mid-line width. For example, the style specified by NoFrame always has a frame width of 0, whereas the style Panel has a frame width equivalent to the line width.

Access functions:
property lineWidthᅟ: int

This property holds the line width.

Note that the total line width for frames used as separators ( HLine and VLine ) is specified by frameWidth .

The default value is 1.

Access functions:
property midLineWidthᅟ: int

This property holds the width of the mid-line.

The default value is 0.

Access functions:
__init__([parent=None[, f=Qt.WindowFlags()]])
Parameters:

Constructs a frame widget with frame style NoFrame and a 1-pixel frame width.

The parent and f arguments are passed to the QWidget constructor.

drawFrame(arg__1)
Parameters:

arg__1 – QPainter

frameRect()
Return type:

QRect

See also

setFrameRect()

Getter of property frameRectᅟ .

frameShadow()
Return type:

Shadow

See also

setFrameShadow()

Getter of property frameShadowᅟ .

frameShape()
Return type:

Shape

See also

setFrameShape()

Getter of property frameShapeᅟ .

frameStyle()
Return type:

int

Returns the frame style.

The default value is Plain .

frameWidth()
Return type:

int

Getter of property frameWidthᅟ .

initStyleOption(option)
Parameters:

option – QStyleOptionFrame

Initializes option with the values from this QFrame . This method is useful for subclasses when they need a QStyleOptionFrame but don’t want to fill in all the information themselves.

See also

initFrom()

lineWidth()
Return type:

int

See also

setLineWidth()

Getter of property lineWidthᅟ .

midLineWidth()
Return type:

int

See also

setMidLineWidth()

Getter of property midLineWidthᅟ .

setFrameRect(arg__1)
Parameters:

arg__1 – QRect

See also

frameRect()

Setter of property frameRectᅟ .

setFrameShadow(arg__1)
Parameters:

arg__1 – Shadow

See also

frameShadow()

Setter of property frameShadowᅟ .

setFrameShape(arg__1)
Parameters:

arg__1 – Shape

See also

frameShape()

Setter of property frameShapeᅟ .

setFrameStyle(arg__1)
Parameters:

arg__1 – int

Sets the frame style to style.

The style is the bitwise OR between a frame shape and a frame shadow style. See the picture of the frames in the main class documentation.

The frame shapes are given in Shape and the shadow styles in Shadow .

If a mid-line width greater than 0 is specified, an additional line is drawn for Raised or Sunken Box , HLine , and VLine frames. The mid-color of the current color group is used for drawing middle lines.

See also

frameStyle()

setLineWidth(arg__1)
Parameters:

arg__1 – int

See also

lineWidth()

Setter of property lineWidthᅟ .

setMidLineWidth(arg__1)
Parameters:

arg__1 – int

See also

midLineWidth()

Setter of property midLineWidthᅟ .