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

• enum Shadow { Plain, Raised, Sunken }
• enum Shape { NoFrame, Box, Panel, WinPanel, ..., StyledPanel }
• enum StyleMask { Shadow_Mask, Shape_Mask }

Methods

• __init__ (self, QWidget parent = None, Qt.WindowFlags flags = 0)
• changeEvent (self, QEvent)
• drawFrame (self, QPainter)
• bool event (self, QEvent e)
• QRect frameRect (self)
• Shadow frameShadow (self)
• Shape frameShape (self)
• int frameStyle (self)
• int frameWidth (self)
• int lineWidth (self)
• int midLineWidth (self)
• paintEvent (self, QPaintEvent)
• setFrameRect (self, QRect)
• setFrameShadow (self, Shadow)
• setFrameShape (self, Shape)
• setFrameStyle (self, int)
• setLineWidth (self, int)
• setMidLineWidth (self, int)
• QSize sizeHint (self)

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

QFrame.Shadow

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

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.

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

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