GroupBoxCollapser Class Reference

Description

Add-on to group boxes to make them collapsible.

Also adds the possibility to show toolbuttons or widgets in the group box's title. This add-on takes the layout (plus the contained widgets) of a given group box and moves it into a newly created content area widget. A title widget will be added, and the original group box title will be hidden.

To support style sheets, the custom bool property "collapsible" will be added to the group box an set to true.

Definition at line 34 of file GroupBoxCollapser.h.

Inheritance diagram for GroupBoxCollapser:

Collaboration diagram for GroupBoxCollapser:

Public Member Functions
void	addAction (QAction *action)
	Add a tool button to the title bar, connected to the given action. More...
void	addWidget (QWidget *widget)
	Add a widget to the title bar. More...
QWidget *	contentArea () const
	The content area, to which the found group box content has been moved when the add-on has been installed. More...
void	setExpanded (bool expanded=true)
	Expand/collapse the content area. More...
void	setTitle (const QString &title)
	Set the title of the group box. Do not use the method groupBox->setTitle() any more once the add-on is installed. More...

Static Public Member Functions
static GroupBoxCollapser *	findInstalledCollapser (QGroupBox *groupBox)
static GroupBoxCollapser *	installIntoGroupBox (QGroupBox *groupBox, bool expanded=true)

Private Member Functions
	GroupBoxCollapser (QGroupBox *groupBox)
void	toggle (bool checked)

Private Attributes
QWidget *	m_contentArea
	widget to where the original group box content has been moved More...
QHBoxLayout *	m_titleLayout
	layout in the title widget More...
QWidget *	m_titleWidget
	widget used to present the new groupbox title More...
QToolButton *	m_toggleButton
	button to toggle between collapsed/expanded More...

Constructor & Destructor Documentation

GroupBoxCollapser()

GroupBoxCollapser::GroupBoxCollapser ( QGroupBox *  groupBox )

private

Definition at line 78 of file GroupBoxCollapser.cpp.

    : QObject(groupBox)
{
    auto* mainLayout = new QVBoxLayout;
    mainLayout->setSpacing(0);
    mainLayout->setContentsMargins(0, 0, 0, 0);
 
    m_contentArea = new QWidget(groupBox);
    m_contentArea->setObjectName("ContentArea");
    m_contentArea->setLayout(groupBox->layout());
 
    mainLayout->addWidget(m_contentArea);
    groupBox->setLayout(mainLayout);
 
    m_toggleButton = new QToolButton(groupBox);
    m_toggleButton->setObjectName("GroupBoxToggler");
    if (appSettings->currentStyle() == ApplicationSettings::Style::native)
        m_toggleButton->setStyleSheet(
            "QToolButton { border: none; text-align: left; font: bold; padding: 5px}");
    m_toggleButton->setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
    m_toggleButton->setCheckable(true);
    m_toggleButton->setText(groupBox->title());
    m_toggleButton->setArrowType(Qt::ArrowType::DownArrow);
    m_toggleButton->setChecked(true);
    m_toggleButton->setSizePolicy(QSizePolicy::Minimum, QSizePolicy::MinimumExpanding);
 
    m_titleWidget = new QWidget(groupBox);
    m_titleWidget->setObjectName("GroupBoxTogglerTitleWidget");
    m_titleWidget->setAttribute(Qt::WA_StyledBackground, true);
 
    m_titleLayout = new QHBoxLayout;
    m_titleLayout->setContentsMargins(0, 0, 3, 0);
    m_titleLayout->setSpacing(3);
    m_titleLayout->setAlignment(Qt::AlignVCenter);
    m_titleWidget->setLayout(m_titleLayout);
    m_titleLayout->addWidget(m_toggleButton);
 
    groupBox->layout()->setMenuBar(m_titleWidget);
    groupBox->setTitle("");
    groupBox->setProperty("collapsible", true); // helps to distinguish GroupBoxes in stylesheets
 
    connect(m_toggleButton, &QAbstractButton::clicked, this, &GroupBoxCollapser::toggle);
}

References appSettings, ApplicationSettings::currentStyle(), m_contentArea, m_titleLayout, m_titleWidget, m_toggleButton, ApplicationSettings::native, and toggle().

Referenced by installIntoGroupBox().

Here is the call graph for this function:

Member Function Documentation

addAction()

void GroupBoxCollapser::addAction

(

QAction *

action

)

Add a tool button to the title bar, connected to the given action.

Definition at line 49 of file GroupBoxCollapser.cpp.

{
    auto* btn = new QToolButton(m_titleWidget);
    btn->setToolButtonStyle(Qt::ToolButtonIconOnly);
    btn->setDefaultAction(action);
    if (action->menu() != nullptr)
        btn->setPopupMode(QToolButton::InstantPopup);
 
    m_titleLayout->addWidget(btn);
 
    connect(action, &QAction::changed, [=]() { btn->setVisible(action->isVisible()); });
}

References m_titleLayout, and m_titleWidget.

Referenced by LayerForm::LayerForm(), ParticleCoreShellForm::ParticleCoreShellForm(), and ParticleLayoutForm::ParticleLayoutForm().

addWidget()

void GroupBoxCollapser::addWidget

(

QWidget *

widget

)

Add a widget to the title bar.

Definition at line 62 of file GroupBoxCollapser.cpp.

{
    m_titleLayout->addWidget(widget);
}

References m_titleLayout.

Referenced by LayerForm::LayerForm().

contentArea()

QWidget * GroupBoxCollapser::contentArea

(

)

const

The content area, to which the found group box content has been moved when the add-on has been installed.

Definition at line 67 of file GroupBoxCollapser.cpp.

{
    return m_contentArea;
}

References m_contentArea.

findInstalledCollapser()

GroupBoxCollapser * GroupBoxCollapser::findInstalledCollapser ( QGroupBox *  groupBox )

static

Definition at line 37 of file GroupBoxCollapser.cpp.

{
    if (groupBox == nullptr)
        return nullptr;
    return groupBox->findChild<GroupBoxCollapser*>();
}

Referenced by FormLayouter::FormLayouter().

installIntoGroupBox()

GroupBoxCollapser * GroupBoxCollapser::installIntoGroupBox ( QGroupBox *  groupBox, bool  expanded = true  )

static

Definition at line 23 of file GroupBoxCollapser.cpp.

{
    auto* p = new GroupBoxCollapser(groupBox);
 
    if (!expanded) {
        QSignalBlocker b(p->m_toggleButton);
        p->m_toggleButton->setChecked(false);
        p->m_toggleButton->setArrowType(Qt::ArrowType::RightArrow);
        p->m_contentArea->hide();
    }
 
    return p;
}

References GroupBoxCollapser().

Referenced by AxisPropertyEditor::AxisPropertyEditor(), DepthProbeInstrumentEditor::DepthProbeInstrumentEditor(), DetectorEditor::DetectorEditor(), DistributionEditor::DistributionEditor(), EnvironmentEditor::EnvironmentEditor(), FootprintCorrectionEditor::FootprintCorrectionEditor(), GISASBeamEditor::GISASBeamEditor(), InclinationAnglesEditor::InclinationAnglesEditor(), InterferenceForm::InterferenceForm(), LayerForm::LayerForm(), MaskEditorPropertyPanel::MaskEditorPropertyPanel(), MesoCrystalForm::MesoCrystalForm(), MultiLayerForm::MultiLayerForm(), OffspecBeamEditor::OffspecBeamEditor(), ParticleCompositionForm::ParticleCompositionForm(), ParticleCoreShellForm::ParticleCoreShellForm(), ParticleForm::ParticleForm(), ParticleLayoutForm::ParticleLayoutForm(), PolarizationAnalysisEditor::PolarizationAnalysisEditor(), ProjectSettingsView::ProjectSettingsView(), RectangularDetectorEditor::RectangularDetectorEditor(), ResolutionFunctionEditor::ResolutionFunctionEditor(), SimulationView::SimulationView(), SpecularBeamEditor::SpecularBeamEditor(), WelcomeView::WelcomeView(), InstrumentLibraryEditor::createWidgetsForCurrentInstrument(), and InstrumentView::createWidgetsForCurrentInstrument().

Here is the call graph for this function:

setExpanded()

void GroupBoxCollapser::setExpanded

(

bool

expanded = true

)

Expand/collapse the content area.

Definition at line 72 of file GroupBoxCollapser.cpp.

{
    if (m_toggleButton->isChecked() != expanded)
        m_toggleButton->click();
}

References m_toggleButton.

Referenced by LayerForm::expand().

setTitle()

void GroupBoxCollapser::setTitle

(

const QString &

title

)

Set the title of the group box. Do not use the method groupBox->setTitle() any more once the add-on is installed.

Definition at line 44 of file GroupBoxCollapser.cpp.

{
    m_toggleButton->setText(title);
}

References m_toggleButton.

Referenced by ParticleCoreShellForm::createCoreWidgets(), ParticleCoreShellForm::createShellWidgets(), InterferenceForm::updateTitle(), LayerForm::updateTitle(), and ParticleLayoutForm::updateTitle().

toggle()

void GroupBoxCollapser::toggle ( bool  checked )

private

Definition at line 122 of file GroupBoxCollapser.cpp.

{
    m_toggleButton->setArrowType(checked ? Qt::ArrowType::DownArrow : Qt::ArrowType::RightArrow);
 
    if (m_toggleButton->isChecked())
        m_contentArea->show();
    else
        m_contentArea->hide();
}

References m_contentArea, and m_toggleButton.

Referenced by GroupBoxCollapser().

Member Data Documentation

m_contentArea

QWidget* GroupBoxCollapser::m_contentArea

private

widget to where the original group box content has been moved

Definition at line 64 of file GroupBoxCollapser.h.

Referenced by GroupBoxCollapser(), contentArea(), and toggle().

m_titleLayout

QHBoxLayout* GroupBoxCollapser::m_titleLayout

private

layout in the title widget

Definition at line 62 of file GroupBoxCollapser.h.

Referenced by GroupBoxCollapser(), addAction(), and addWidget().

m_titleWidget

QWidget* GroupBoxCollapser::m_titleWidget

private

widget used to present the new groupbox title

Definition at line 61 of file GroupBoxCollapser.h.

Referenced by GroupBoxCollapser(), and addAction().

m_toggleButton

QToolButton* GroupBoxCollapser::m_toggleButton

private

button to toggle between collapsed/expanded

Definition at line 63 of file GroupBoxCollapser.h.

Referenced by GroupBoxCollapser(), setExpanded(), setTitle(), and toggle().

---

The documentation for this class was generated from the following files:

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Tool/GroupBoxCollapser.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Tool/GroupBoxCollapser.cpp