- Qt 6.6
- Qt Widgets
- C++ Classes
- QFrame
- Qt 6.6.0 Reference Documentation

# QFrame Class

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

Header: | #include <QFrame>
CMake: | find_package(Qt6 REQUIRED COMPONENTS Widgets) target_link_libraries(mytarget PRIVATE Qt6::Widgets)
qmake: | QT += widgets
Inherits: | QWidget
Inherited By: | QAbstractScrollArea, QLabel, QLCDNumber, QSplitter, QStackedWidget, and QToolBox

- List of all members, including inherited members

## Public Types

enum | Shadow { Plain, Raised, Sunken }
enum | Shape { NoFrame, Box, Panel, StyledPanel, HLine, …, WinPanel }
enum | StyleMask { Shadow_Mask, Shape_Mask }

## Properties

frameRect : QRect frameShadow : Shadow frameShape : Shape | frameWidth : const int lineWidth : int midLineWidth : int

## Public Functions

| QFrame(QWidget *parent = nullptr, Qt::WindowFlags f = Qt::WindowFlags())
virtual | ~QFrame()
QRect | frameRect() const
QFrame::Shadow | frameShadow() const
QFrame::Shape | frameShape() const
int | frameStyle() const
int | frameWidth() const
int | lineWidth() const
int | midLineWidth() const
void | setFrameRect(const QRect &)
void | setFrameShadow(QFrame::Shadow)
void | setFrameShape(QFrame::Shape)
void | setFrameStyle(int style)
void | setLineWidth(int)
void | setMidLineWidth(int)

## Reimplemented Public Functions

virtual QSize | sizeHint() const override

## Protected Functions

virtual void | initStyleOption(QStyleOptionFrame *option) const

## Reimplemented Protected Functions

virtual void | changeEvent(QEvent *ev) override
virtual bool | event(QEvent *e) override
virtual void | paintEvent(QPaintEvent *) override

## Detailed Description

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.

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

## Member Type Documentation

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

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

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

## Property Documentation

### 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:

QRect | frameRect() const
void | setFrameRect(const QRect &)

### frameShadow : Shadow

This property holds the frame shadow value from the frame style

Access functions:

QFrame::Shadow | frameShadow() const
void | setFrameShadow(QFrame::Shadow)

See also frameStyle() and frameShape().

### frameShape : Shape

This property holds the frame shape value from the frame style

Access functions:

QFrame::Shape | frameShape() const
void | setFrameShape(QFrame::Shape)

See also frameStyle() and frameShadow().

### `[read-only]` frameWidth : const 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:

int | frameWidth() const

See also lineWidth(), midLineWidth(), and frameStyle().

### 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:

int | lineWidth() const
void | setLineWidth(int)

See also midLineWidth and frameWidth.

### midLineWidth : int

This property holds the width of the mid-line

The default value is 0.

Access functions:

int | midLineWidth() const
void | setMidLineWidth(int)

See also lineWidth and frameWidth.

## Member Function Documentation

### `[explicit]` QFrame::QFrame(QWidget *parent = nullptr, Qt::WindowFlags f = Qt::WindowFlags())

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.

### `[virtual noexcept]` QFrame::~QFrame()

Destroys the frame.

### `[override virtual protected]` void QFrame::changeEvent(QEvent *ev)

Reimplements: QWidget::changeEvent(QEvent *event).

### `[override virtual protected]` bool QFrame::event(QEvent *e)

Reimplements: QWidget::event(QEvent *event).

### int QFrame::frameStyle() const

Returns the frame style.

The default value is QFrame::Plain.

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

### `[virtual protected]` void QFrame::initStyleOption(QStyleOptionFrame *option) const

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 QStyleOption::initFrom().

### `[override virtual protected]` void QFrame::paintEvent(QPaintEvent *)

Reimplements: QWidget::paintEvent(QPaintEvent *event).

### void QFrame::setFrameStyle(int style)

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

### `[override virtual]` QSize QFrame::sizeHint() const

Reimplements an access function for property: QWidget::sizeHint.