QGroupBox Class | Qt Widgets | Qt 6.11.1
Description: The QGroupBox widget provides a group box frame with a title.

- Qt 6.11
- Qt Widgets
- C++ Classes
- QGroupBox
- Qt 6.11.1 Reference Documentation

# QGroupBox Class

The QGroupBox widget provides a group box frame with a title. More...

Header: | `#include <QGroupBox>`
CMake: | `find_package(Qt6 REQUIRED COMPONENTS Widgets)` `target_link_libraries(mytarget PRIVATE Qt6::Widgets)`
qmake: | `QT += widgets`
Inherits: | QWidget

- List of all members, including inherited members

## Properties

alignment : Qt::Alignment checkable : bool checked : bool | flat : bool title : QString

## Public Functions

| QGroupBox(QWidget *parent = nullptr)
| QGroupBox(const QString &title, QWidget *parent = nullptr)
virtual | ~QGroupBox()
Qt::Alignment | alignment() const
bool | isCheckable() const
bool | isChecked() const
bool | isFlat() const
void | setAlignment(int alignment)
void | setCheckable(bool checkable)
void | setFlat(bool flat)
void | setTitle(const QString &title)
QString | title() const

## Reimplemented Public Functions

virtual QSize | minimumSizeHint() const override

## Public Slots

void | setChecked(bool checked)

## Signals

void | clicked(bool checked = false)
void | toggled(bool on)

## Protected Functions

virtual void | initStyleOption(QStyleOptionGroupBox *option) const

## Reimplemented Protected Functions

virtual void | changeEvent(QEvent *ev) override
virtual void | childEvent(QChildEvent *c) override
virtual bool | event(QEvent *e) override
virtual void | focusInEvent(QFocusEvent *fe) override
virtual void | mouseMoveEvent(QMouseEvent *event) override
virtual void | mousePressEvent(QMouseEvent *event) override
virtual void | mouseReleaseEvent(QMouseEvent *event) override
virtual void | paintEvent(QPaintEvent *event) override
virtual void | resizeEvent(QResizeEvent *e) override

## Detailed Description

A group box provides a frame, a title on top, a keyboard shortcut, and displays various other widgets inside itself. The keyboard shortcut moves keyboard focus to one of the group box's child widgets.

QGroupBox also lets you set the title (normally set in the constructor) and the title's alignment. Group boxes can be checkable. Child widgets in checkable group boxes are enabled or disabled depending on whether or not the group box is checked.

You can minimize the space consumption of a group box by enabling the flat property. In most styles, enabling this property results in the removal of the left, right and bottom edges of the frame.

QGroupBox doesn't automatically lay out the child widgets (which are often QCheckBoxes or QRadioButtons but can be any widgets). The following example shows how we can set up a QGroupBox with a layout:

     QGroupBox *groupBox = new QGroupBox(tr("Group Box with Layout"));

     QRadioButton *radio1 = new QRadioButton(tr("&Radio button 1"));
     QRadioButton *radio2 = new QRadioButton(tr("R&adio button 2"));
     QRadioButton *radio3 = new QRadioButton(tr("Ra&dio button 3"));

     radio1->setChecked(true);

     QVBoxLayout *vbox = new QVBoxLayout;
     vbox->addWidget(radio1);
     vbox->addWidget(radio2);
     vbox->addWidget(radio3);
     vbox->addStretch(1);
     groupBox->setLayout(vbox);

See also QButtonGroup.

## Property Documentation

### alignment : Qt::Alignment

This property holds the alignment of the group box title.

Most styles place the title at the top of the frame. The horizontal alignment of the title can be specified using single values from the following list:

- Qt::AlignLeft aligns the title text with the left-hand side of the group box.
- Qt::AlignRight aligns the title text with the right-hand side of the group box.
- Qt::AlignHCenter aligns the title text with the horizontal center of the group box.

The default alignment is Qt::AlignLeft.

Access functions:

Qt::Alignment | alignment() const
void | setAlignment(int alignment)

See also Qt::Alignment.

### checkable : bool

This property holds whether the group box has a checkbox in its title

If this property is `true`, the group box displays its title using a checkbox in place of an ordinary label. If the checkbox is checked, the group box's children are enabled; otherwise, they are disabled and inaccessible.

By default, group boxes are not checkable.

If this property is enabled for a group box, it will also be initially checked to ensure that its contents are enabled.

Access functions:

bool | isCheckable() const
void | setCheckable(bool checkable)

See also checked.

### checked : bool

This property holds whether the group box is checked

If the group box is checkable, it is displayed with a check box. If the check box is checked, the group box's children are enabled; otherwise, the children are disabled and are inaccessible to the user.

By default, checkable group boxes are also checked.

Note: The group box itself will not be disabled when the box is unchecked, and you can explicitly enable individual children in a group box that is unchecked. This is however not recommended, as it could create a surprising experience for the end user.

Access functions:

bool | isChecked() const
void | setChecked(bool checked)

Notifier signal:

void | toggled(bool on)

See also checkable.

### flat : bool

This property holds whether the group box is painted flat or has a frame

A group box usually consists of a surrounding frame with a title at the top. If this property is enabled, only the top part of the frame is drawn in most styles; otherwise, the whole frame is drawn.

By default, this property is disabled, i.e., group boxes are not flat unless explicitly specified.

Note: In some styles, flat and non-flat group boxes have similar representations and may not be as distinguishable as they are in other styles.

Access functions:

bool | isFlat() const
void | setFlat(bool flat)

See also title.

### title : QString

This property holds the group box title text

The group box title text will have a keyboard shortcut if the title contains an ampersand ('&') followed by a letter.

     g->setTitle("&User information");

In the example above, Alt+U moves the keyboard focus to the group box. See the QShortcut documentation for details (to display an actual ampersand, use '&&').

There is no default title text.

Access functions:

QString | title() const
void | setTitle(const QString &title)

See also alignment.

## Member Function Documentation

### `[explicit]` QGroupBox::QGroupBox(QWidget *parent = nullptr)

Constructs a group box widget with the given parent but with no title.

### `[explicit]` QGroupBox::QGroupBox(const QString &title, QWidget *parent = nullptr)

Constructs a group box with the given title and parent.

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

Destroys the group box.

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

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

### `[override virtual protected]` void QGroupBox::childEvent(QChildEvent *c)

Reimplements: QObject::childEvent(QChildEvent *event).

### `[signal]` void QGroupBox::clicked(bool checked = false)

This signal is emitted when the check box is activated (i.e., pressed down then released while the mouse cursor is inside the button), or when the shortcut key is typed. Notably, this signal is not emitted if you call setChecked().

If the check box is checked, checked is true; it is false if the check box is unchecked.

See also checkable, toggled(), and checked.

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

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

### `[override virtual protected]` void QGroupBox::focusInEvent(QFocusEvent *fe)

Reimplements: QWidget::focusInEvent(QFocusEvent *event).

### `[virtual protected]` void QGroupBox::initStyleOption(QStyleOptionGroupBox *option) const

Initialize option with the values from this QGroupBox. This method is useful for subclasses when they need a QStyleOptionGroupBox, but don't want to fill in all the information themselves.

See also QStyleOption::initFrom().

### `[override virtual]` QSize QGroupBox::minimumSizeHint() const

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

### `[override virtual protected]` void QGroupBox::mouseMoveEvent(QMouseEvent *event)

Reimplements: QWidget::mouseMoveEvent(QMouseEvent *event).

### `[override virtual protected]` void QGroupBox::mousePressEvent(QMouseEvent *event)

Reimplements: QWidget::mousePressEvent(QMouseEvent *event).

### `[override virtual protected]` void QGroupBox::mouseReleaseEvent(QMouseEvent *event)

Reimplements: QWidget::mouseReleaseEvent(QMouseEvent *event).

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

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

### `[override virtual protected]` void QGroupBox::resizeEvent(QResizeEvent *e)

Reimplements: QWidget::resizeEvent(QResizeEvent *event).

### `[signal]` void QGroupBox::toggled(bool on)

If the group box is checkable, this signal is emitted when the check box is toggled. on is true if the check box is checked; otherwise, it is false.

Note: Notifier signal for property checked.

See also checkable.