Home · All Classes · Modules

QFrame Class Reference
[QtGui module]

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

Inherits QWidget.

Inherited by QAbstractScrollArea, QLabel, QLCDNumber, QSplitter, QStackedWidget and QToolBox.

Types

Methods


Detailed Description

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

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.

 QLabel label(...);
 label.setFrameStyle(QFrame.Panel | QFrame.Raised);
 label.setLineWidth(2);

 QProgressBar pbar(...);
 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 margin between the frame and the contents of the frame can be customized with the QWidget.setContentsMargins() function.

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

Table of frame styles


Type Documentation

QFrame.Shadow

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

Constant Value Description
QFrame.Plain 0x0010 the frame and contents appear level with the surroundings; draws using the palette QPalette.WindowText color (without any 3D effect)
QFrame.Raised 0x0020 the frame and contents appear raised; draws a 3D raised line using the light and dark colors of the current color group
QFrame.Sunken 0x0030 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 QFrame.Shape, the lineWidth() and the midLineWidth(). See the picture of the frames in the main class documentation.

See also QFrame.Shape, lineWidth(), and midLineWidth().

QFrame.Shape

This enum type defines the shapes of frame available.

Constant Value Description
QFrame.NoFrame 0 QFrame draws nothing
QFrame.Box 0x0001 QFrame draws a box around its contents
QFrame.Panel 0x0002 QFrame draws a panel to make the contents appear raised or sunken
QFrame.StyledPanel 0x0006 draws a rectangular panel with a look that depends on the current GUI style. It can be raised or sunken.
QFrame.HLine 0x0004 QFrame draws a horizontal line that frames nothing (useful as separator)
QFrame.VLine 0x0005 QFrame draws a vertical line that frames nothing (useful as separator)
QFrame.WinPanel 0x0003 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 QFrame.Shadow, the lineWidth() and the midLineWidth() to create the total result. See the picture of the frames in the main class documentation.

See also QFrame.Shadow, QFrame.style(), and QStyle.drawPrimitive().

QFrame.StyleMask

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

Constant Value Description
QFrame.Shadow_Mask 0x00f0 The Shadow part of frameStyle()
QFrame.Shape_Mask 0x000f 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().

See also frameStyle() and setFrameStyle().


Method Documentation

QFrame.__init__ (self, QWidget parent = None, Qt.WindowFlags flags = 0)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

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.

QFrame.changeEvent (self, QEvent)

Reimplemented from QWidget.changeEvent().

QFrame.drawFrame (self, QPainter)

bool QFrame.event (self, QEvent e)

Reimplemented from QObject.event().

QRect QFrame.frameRect (self)

Shadow QFrame.frameShadow (self)

Shape QFrame.frameShape (self)

int QFrame.frameStyle (self)

Returns the frame style.

The default value is QFrame.Plain.

See also setFrameStyle(), frameShape(), and frameShadow().

int QFrame.frameWidth (self)

int QFrame.lineWidth (self)

int QFrame.midLineWidth (self)

QFrame.paintEvent (self, QPaintEvent)

Reimplemented from QWidget.paintEvent().

QFrame.setFrameRect (self, QRect)

QFrame.setFrameShadow (self, Shadow)

QFrame.setFrameShape (self, Shape)

QFrame.setFrameStyle (self, 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 QFrame.Shape and the shadow styles in QFrame.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().

QFrame.setLineWidth (self, int)

QFrame.setMidLineWidth (self, int)

QSize QFrame.sizeHint (self)

Reimplemented from QWidget.sizeHint().


PyQt 4.12 for X11Copyright © Riverbank Computing Ltd and The Qt Company 2015Qt 4.8.7