File indexing completed on 2025-01-05 03:35:25

 /*
     File                 : BarPlotDock.cpp
     Project              : LabPlot
     Description          : Dock widget for the bar plot
     --------------------------------------------------------------------
     SPDX-FileCopyrightText: 2022-2024 Alexander Semke <alexander.semke@web.de>
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 #include "BarPlotDock.h"
 #include "backend/core/AbstractColumn.h"
 #include "backend/lib/macros.h"
 #include "commonfrontend/widgets/TreeViewComboBox.h"
 #include "kdefrontend/GuiTools.h"
 #include "kdefrontend/TemplateHandler.h"
 #include "kdefrontend/widgets/BackgroundWidget.h"
 #include "kdefrontend/widgets/LineWidget.h"
 #include "kdefrontend/widgets/ValueWidget.h"
 
 #include <QPushButton>
 
 #include <KConfig>
 #include <KLocalizedString>
 
 BarPlotDock::BarPlotDock(QWidget* parent)
     : BaseDock(parent) {
     ui.setupUi(this);
     setPlotRangeCombobox(ui.cbPlotRanges);
     setBaseWidgets(ui.leName, ui.teComment);
     setVisibilityWidgets(ui.chkVisible, ui.chkLegendVisible);
 
     // Tab "General"
 
     // x-data
     cbXColumn = new TreeViewComboBox(ui.tabGeneral);
     QSizePolicy sizePolicy(QSizePolicy::Expanding, QSizePolicy::Fixed);
     cbXColumn->setSizePolicy(sizePolicy);
     static_cast<QVBoxLayout*>(ui.frameXColumn->layout())->insertWidget(0, cbXColumn);
     ui.bRemoveXColumn->setIcon(QIcon::fromTheme(QStringLiteral("edit-clear")));
 
     // y-data
     m_buttonNew = new QPushButton();
     m_buttonNew->setIcon(QIcon::fromTheme(QStringLiteral("list-add")));
 
     m_gridLayout = new QGridLayout(ui.frameDataColumns);
     m_gridLayout->setContentsMargins(0, 0, 0, 0);
     m_gridLayout->setHorizontalSpacing(2);
     m_gridLayout->setVerticalSpacing(2);
     ui.frameDataColumns->setLayout(m_gridLayout);
 
     ui.cbType->addItem(i18n("Grouped"));
     ui.cbType->addItem(i18n("Stacked"));
     ui.cbType->addItem(i18n("Stacked 100%"));
 
     ui.cbOrientation->addItem(i18n("Horizontal"));
     ui.cbOrientation->addItem(i18n("Vertical"));
 
     // Tab "Bars"
     QString msg = i18n("Select the data column for which the properties should be shown and edited");
     ui.lNumber->setToolTip(msg);
     ui.cbNumber->setToolTip(msg);
 
     msg = i18n("Specify the factor in percent to control the width of the bar relative to its default value, applying to all bars");
     ui.lWidthFactor->setToolTip(msg);
     ui.sbWidthFactor->setToolTip(msg);
 
     // filling
     auto* gridLayout = static_cast<QGridLayout*>(ui.tabBars->layout());
     backgroundWidget = new BackgroundWidget(ui.tabBars);
     gridLayout->addWidget(backgroundWidget, 5, 0, 1, 3);
     auto* spacer = new QSpacerItem(72, 18, QSizePolicy::Minimum, QSizePolicy::Fixed);
     gridLayout->addItem(spacer, 6, 0, 1, 1);
 
     // border lines
     gridLayout->addWidget(ui.lBorder, 7, 0, 1, 1);
     lineWidget = new LineWidget(ui.tabBars);
     gridLayout->addWidget(lineWidget, 8, 0, 1, 3);
     spacer = new QSpacerItem(18, 10, QSizePolicy::Minimum, QSizePolicy::Expanding);
     gridLayout->addItem(spacer, 9, 0, 1, 1);
 
     // Tab "Values"
     auto* hboxLayout = new QHBoxLayout(ui.tabValues);
     valueWidget = new ValueWidget(ui.tabValues);
     hboxLayout->addWidget(valueWidget);
     hboxLayout->setContentsMargins(2, 2, 2, 2);
     hboxLayout->setSpacing(2);
 
     // adjust layouts in the tabs
     for (int i = 0; i < ui.tabWidget->count(); ++i) {
         auto* layout = dynamic_cast<QGridLayout*>(ui.tabWidget->widget(i)->layout());
         if (!layout)
             continue;
 
         layout->setContentsMargins(2, 2, 2, 2);
         layout->setHorizontalSpacing(2);
         layout->setVerticalSpacing(2);
     }
 
     // SLOTS
     // Tab "General"
     connect(cbXColumn, &TreeViewComboBox::currentModelIndexChanged, this, &BarPlotDock::xColumnChanged);
     connect(ui.bRemoveXColumn, &QPushButton::clicked, this, &BarPlotDock::removeXColumn);
     connect(m_buttonNew, &QPushButton::clicked, this, &BarPlotDock::addDataColumn);
     connect(ui.cbType, QOverload<int>::of(&QComboBox::currentIndexChanged), this, &BarPlotDock::typeChanged);
     connect(ui.cbOrientation, QOverload<int>::of(&QComboBox::currentIndexChanged), this, &BarPlotDock::orientationChanged);
 
     // Tab "Bars"
     connect(ui.cbNumber, QOverload<int>::of(&QComboBox::currentIndexChanged), this, &BarPlotDock::currentBarChanged);
     connect(ui.sbWidthFactor, QOverload<int>::of(&QSpinBox::valueChanged), this, &BarPlotDock::widthFactorChanged);
 
     // template handler
     auto* frame = new QFrame(this);
     auto* layout = new QHBoxLayout(frame);
     layout->setContentsMargins(0, 11, 0, 11);
 
     auto* templateHandler = new TemplateHandler(this, QLatin1String("BarPlot"));
     layout->addWidget(templateHandler);
     connect(templateHandler, &TemplateHandler::loadConfigRequested, this, &BarPlotDock::loadConfigFromTemplate);
     connect(templateHandler, &TemplateHandler::saveConfigRequested, this, &BarPlotDock::saveConfigAsTemplate);
     connect(templateHandler, &TemplateHandler::info, this, &BarPlotDock::info);
 
     ui.verticalLayout->addWidget(frame);
 }
 
 void BarPlotDock::setBarPlots(QList<BarPlot*> list) {
     CONDITIONAL_LOCK_RETURN;
     m_barPlots = list;
     m_barPlot = list.first();
     setAspects(list);
 
     Q_ASSERT(m_barPlot);
     setModel();
 
     // backgrounds
     QList<Background*> backgrounds;
     QList<Line*> lines;
     QList<Value*> values;
     for (auto* plot : m_barPlots) {
         backgrounds << plot->backgroundAt(0);
         lines << plot->lineAt(0);
         values << plot->value();
     }
 
     backgroundWidget->setBackgrounds(backgrounds);
     lineWidget->setLines(lines);
     valueWidget->setValues(values);
 
     // show the properties of the first box plot
     ui.chkLegendVisible->setChecked(m_barPlot->legendVisible());
     ui.chkVisible->setChecked(m_barPlot->isVisible());
     load();
     cbXColumn->setColumn(m_barPlot->xColumn(), m_barPlot->xColumnPath());
     loadDataColumns();
 
     updatePlotRangeList();
 
     // set the current locale
     updateLocale();
 
     // SIGNALs/SLOTs
     // general
     connect(m_barPlot, &BarPlot::typeChanged, this, &BarPlotDock::plotTypeChanged);
     connect(m_barPlot, &BarPlot::xColumnChanged, this, &BarPlotDock::plotXColumnChanged);
     connect(m_barPlot, &BarPlot::dataColumnsChanged, this, &BarPlotDock::plotDataColumnsChanged);
 
     connect(m_barPlot, &BarPlot::widthFactorChanged, this, &BarPlotDock::plotWidthFactorChanged);
 }
 
 void BarPlotDock::setModel() {
     auto* model = aspectModel();
     model->enablePlottableColumnsOnly(true);
     model->enableShowPlotDesignation(true);
 
     QList<AspectType> list{AspectType::Column};
     model->setSelectableAspects(list);
 
     list = {AspectType::Folder,
             AspectType::Workbook,
             AspectType::Datapicker,
             AspectType::DatapickerCurve,
             AspectType::Spreadsheet,
             AspectType::LiveDataSource,
             AspectType::Column,
             AspectType::Worksheet,
             AspectType::CartesianPlot,
             AspectType::XYFitCurve,
             AspectType::XYSmoothCurve,
             AspectType::CantorWorksheet};
 
     cbXColumn->setTopLevelClasses(list);
     cbXColumn->setModel(model);
 }
 
 /*
  * updates the locale in the widgets. called when the application settins are changed.
  */
 void BarPlotDock::updateLocale() {
     lineWidget->updateLocale();
 }
 
 void BarPlotDock::loadDataColumns() {
     // add the combobox for the first column, is always present
     if (m_dataComboBoxes.count() == 0)
         addDataColumn();
 
     int count = m_barPlot->dataColumns().count();
     ui.cbNumber->clear();
 
     if (count != 0) {
         // box plot has already data columns, make sure we have the proper number of comboboxes
         int diff = count - m_dataComboBoxes.count();
         if (diff > 0) {
             for (int i = 0; i < diff; ++i)
                 addDataColumn();
         } else if (diff < 0) {
             for (int i = diff; i != 0; ++i)
                 removeDataColumn();
         }
 
         // show the columns in the comboboxes
         auto* model = aspectModel();
         for (int i = 0; i < count; ++i) {
             m_dataComboBoxes.at(i)->setModel(model); // the model might have changed in-between, reset the current model
             m_dataComboBoxes.at(i)->setAspect(m_barPlot->dataColumns().at(i));
         }
 
         // show columns names in the combobox for the selection of the bar to be modified
         for (int i = 0; i < count; ++i)
             if (m_barPlot->dataColumns().at(i))
                 ui.cbNumber->addItem(m_barPlot->dataColumns().at(i)->name());
     } else {
         // no data columns set in the box plot yet, we show the first combo box only
         m_dataComboBoxes.first()->setAspect(nullptr);
         for (int i = 0; i < m_dataComboBoxes.count(); ++i)
             removeDataColumn();
     }
 
     // disable data column widgets if we're modifying more than one box plot at the same time
     bool enabled = (m_barPlots.count() == 1);
     m_buttonNew->setVisible(enabled);
     for (auto* cb : m_dataComboBoxes)
         cb->setEnabled(enabled);
     for (auto* b : m_removeButtons)
         b->setVisible(enabled);
 
     // select the first column after all of them were added to the combobox
     ui.cbNumber->setCurrentIndex(0);
 }
 
 void BarPlotDock::setDataColumns() const {
     int newCount = m_dataComboBoxes.count();
     int oldCount = m_barPlot->dataColumns().count();
 
     if (newCount > oldCount)
         ui.cbNumber->addItem(QString::number(newCount));
     else {
         if (newCount != 0)
             ui.cbNumber->removeItem(ui.cbNumber->count() - 1);
     }
 
     QVector<const AbstractColumn*> columns;
 
     for (auto* cb : m_dataComboBoxes) {
         auto* aspect = cb->currentAspect();
         if (aspect && aspect->type() == AspectType::Column)
             columns << static_cast<AbstractColumn*>(aspect);
     }
 
     m_barPlot->setDataColumns(columns);
 }
 
 //**********************************************************
 //******* SLOTs for changes triggered in BarPlotDock *******
 //**********************************************************
 //"General"-tab
 void BarPlotDock::xColumnChanged(const QModelIndex& index) {
     auto aspect = static_cast<AbstractAspect*>(index.internalPointer());
     AbstractColumn* column(nullptr);
     if (aspect) {
         column = dynamic_cast<AbstractColumn*>(aspect);
         Q_ASSERT(column);
     }
 
     ui.bRemoveXColumn->setEnabled(column != nullptr);
 
     CONDITIONAL_LOCK_RETURN;
 
     for (auto* barPlot : m_barPlots)
         barPlot->setXColumn(column);
 }
 
 void BarPlotDock::removeXColumn() {
     cbXColumn->setAspect(nullptr);
     ui.bRemoveXColumn->setEnabled(false);
     for (auto* barPlot : m_barPlots)
         barPlot->setXColumn(nullptr);
 }
 
 void BarPlotDock::addDataColumn() {
     auto* cb = new TreeViewComboBox(this);
 
     static const QList<AspectType> list{AspectType::Folder,
                                         AspectType::Workbook,
                                         AspectType::Datapicker,
                                         AspectType::DatapickerCurve,
                                         AspectType::Spreadsheet,
                                         AspectType::LiveDataSource,
                                         AspectType::Column,
                                         AspectType::Worksheet,
                                         AspectType::CartesianPlot,
                                         AspectType::XYFitCurve,
                                         AspectType::XYSmoothCurve,
                                         AspectType::CantorWorksheet};
     cb->setTopLevelClasses(list);
     cb->setModel(aspectModel());
     connect(cb, &TreeViewComboBox::currentModelIndexChanged, this, &BarPlotDock::dataColumnChanged);
 
     int index = m_dataComboBoxes.size();
 
     if (index == 0) {
         QSizePolicy sizePolicy1(QSizePolicy::Expanding, QSizePolicy::Preferred);
         sizePolicy1.setHorizontalStretch(0);
         sizePolicy1.setVerticalStretch(0);
         sizePolicy1.setHeightForWidth(cb->sizePolicy().hasHeightForWidth());
         cb->setSizePolicy(sizePolicy1);
     } else {
         auto* button = new QPushButton();
         button->setIcon(QIcon::fromTheme(QStringLiteral("list-remove")));
         connect(button, &QPushButton::clicked, this, &BarPlotDock::removeDataColumn);
         m_gridLayout->addWidget(button, index, 1, 1, 1);
         m_removeButtons << button;
     }
 
     m_gridLayout->addWidget(cb, index, 0, 1, 1);
     m_gridLayout->addWidget(m_buttonNew, index + 1, 1, 1, 1);
 
     m_dataComboBoxes << cb;
     ui.lDataColumn->setText(i18n("Columns:"));
 }
 
 void BarPlotDock::removeDataColumn() {
     auto* sender = static_cast<QPushButton*>(QObject::sender());
     if (sender) {
         // remove button was clicked, determin which one and
         // delete it together with the corresponding combobox
         for (int i = 0; i < m_removeButtons.count(); ++i) {
             if (sender == m_removeButtons.at(i)) {
                 delete m_dataComboBoxes.takeAt(i + 1);
                 delete m_removeButtons.takeAt(i);
             }
         }
     } else {
         // no sender is available, the function is being called directly in loadDataColumns().
         // delete the last remove button together with the corresponding combobox
         int index = m_removeButtons.count() - 1;
         if (index >= 0) {
             delete m_dataComboBoxes.takeAt(index + 1);
             delete m_removeButtons.takeAt(index);
         }
     }
 
     // TODO
     if (!m_removeButtons.isEmpty()) {
         ui.lDataColumn->setText(i18n("Columns:"));
     } else {
         ui.lDataColumn->setText(i18n("Column:"));
     }
 
     if (!m_initializing)
         setDataColumns();
 }
 
 void BarPlotDock::dataColumnChanged(const QModelIndex&) {
     CONDITIONAL_LOCK_RETURN;
 
     setDataColumns();
 }
 
 void BarPlotDock::typeChanged(int index) {
     CONDITIONAL_LOCK_RETURN;
 
     auto type = static_cast<BarPlot::Type>(index);
     for (auto* barPlot : m_barPlots)
         barPlot->setType(type);
 }
 
 void BarPlotDock::orientationChanged(int index) {
     CONDITIONAL_LOCK_RETURN;
 
     auto orientation = BarPlot::Orientation(index);
     for (auto* barPlot : m_barPlots)
         barPlot->setOrientation(orientation);
 }
 
 //"Box"-tab
 /*!
  * called when the current bar number was changed, shows the bar properties for the selected bar.
  */
 void BarPlotDock::currentBarChanged(int index) {
     if (index == -1)
         return;
 
     CONDITIONAL_LOCK_RETURN;
 
     QList<Background*> backgrounds;
     QList<Line*> lines;
     for (auto* plot : m_barPlots) {
         auto* background = plot->backgroundAt(index);
         if (background)
             backgrounds << background;
 
         auto* line = plot->lineAt(index);
         if (line)
             lines << line;
     }
 
     backgroundWidget->setBackgrounds(backgrounds);
     lineWidget->setLines(lines);
 }
 
 void BarPlotDock::widthFactorChanged(int value) {
     CONDITIONAL_LOCK_RETURN;
 
     double factor = (double)value / 100.;
     for (auto* barPlot : m_barPlots)
         barPlot->setWidthFactor(factor);
 }
 
 //*************************************************************
 //******* SLOTs for changes triggered in BarPlot ********
 //*************************************************************
 // general
 void BarPlotDock::plotXColumnChanged(const AbstractColumn* column) {
     CONDITIONAL_LOCK_RETURN;
     cbXColumn->setColumn(column, m_barPlot->xColumnPath());
 }
 void BarPlotDock::plotDataColumnsChanged(const QVector<const AbstractColumn*>&) {
     CONDITIONAL_LOCK_RETURN;
     loadDataColumns();
 }
 void BarPlotDock::plotTypeChanged(BarPlot::Type type) {
     CONDITIONAL_LOCK_RETURN;
     ui.cbType->setCurrentIndex((int)type);
 }
 void BarPlotDock::plotOrientationChanged(BarPlot::Orientation orientation) {
     CONDITIONAL_LOCK_RETURN;
     ui.cbOrientation->setCurrentIndex((int)orientation);
 }
 
 // box
 void BarPlotDock::plotWidthFactorChanged(double factor) {
     CONDITIONAL_LOCK_RETURN;
     ui.sbWidthFactor->setValue(round(factor * 100));
 }
 
 //**********************************************************
 //******************** SETTINGS ****************************
 //**********************************************************
 void BarPlotDock::load() {
     // general
     ui.cbType->setCurrentIndex((int)m_barPlot->type());
     ui.cbOrientation->setCurrentIndex((int)m_barPlot->orientation());
 
     // box
     ui.sbWidthFactor->setValue(round(m_barPlot->widthFactor()) * 100);
 }
 
 void BarPlotDock::loadConfig(KConfig& config) {
     KConfigGroup group = config.group(QStringLiteral("BarPlot"));
 
     // general
     ui.cbType->setCurrentIndex(group.readEntry(QStringLiteral("Type"), (int)m_barPlot->type()));
     ui.cbOrientation->setCurrentIndex(group.readEntry(QStringLiteral("Orientation"), (int)m_barPlot->orientation()));
 
     // box
     ui.sbWidthFactor->setValue(round(group.readEntry(QStringLiteral("WidthFactor"), m_barPlot->widthFactor()) * 100));
     backgroundWidget->loadConfig(group);
     lineWidget->loadConfig(group);
 
     // values
     valueWidget->loadConfig(group);
 }
 
 void BarPlotDock::loadConfigFromTemplate(KConfig& config) {
     auto name = TemplateHandler::templateName(config);
     int size = m_barPlots.size();
     if (size > 1)
         m_barPlot->beginMacro(i18n("%1 bar plots: template \"%2\" loaded", size, name));
     else
         m_barPlot->beginMacro(i18n("%1: template \"%2\" loaded", m_barPlot->name(), name));
 
     this->loadConfig(config);
 
     m_barPlot->endMacro();
 }
 
 void BarPlotDock::saveConfigAsTemplate(KConfig& config) {
     KConfigGroup group = config.group(QStringLiteral("BarPlot"));
 
     // general
     group.writeEntry(QStringLiteral("Type"), ui.cbType->currentIndex());
     group.writeEntry(QStringLiteral("Orientation"), ui.cbOrientation->currentIndex());
 
     // box
     group.writeEntry(QStringLiteral("WidthFactor"), ui.sbWidthFactor->value() / 100.0);
     backgroundWidget->saveConfig(group);
     lineWidget->saveConfig(group);
 
     // values
     valueWidget->saveConfig(group);
 
     config.sync();
 }