Files
qt-creator/src/plugins/vcsbase/vcsbaseeditorparameterwidget.cpp
Tobias Hunger bb8270bab3 VcsBase: Modernize headers
* Use pragma once
* Use override
* Remove Q_DECLARE_PRIVATE as that makes no sense for QtCreator

Change-Id: Ic31d4868c172a0b8fcb50cc9a71a6e95639cf84c
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
2016-02-03 15:53:22 +00:00

299 lines
9.2 KiB
C++

/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/
#include "vcsbaseeditorparameterwidget.h"
#include <QComboBox>
#include <QToolButton>
#include <QHBoxLayout>
#include <QStringList>
#include <QDebug>
namespace VcsBase {
namespace Internal {
class SettingMappingData
{
public:
enum Type
{
Invalid,
Bool,
String,
Int
};
SettingMappingData() : boolSetting(0), m_type(Invalid)
{ }
SettingMappingData(bool *setting) : boolSetting(setting), m_type(Bool)
{ }
SettingMappingData(QString *setting) : stringSetting(setting), m_type(String)
{ }
SettingMappingData(int *setting) : intSetting(setting), m_type(Int)
{ }
Type type() const
{
return m_type;
}
union {
bool *boolSetting;
QString *stringSetting;
int *intSetting;
};
private:
Type m_type;
};
class VcsBaseEditorParameterWidgetPrivate
{
public:
VcsBaseEditorParameterWidgetPrivate() :
m_layout(0)
{ }
QStringList m_baseArguments;
QHBoxLayout *m_layout;
QList<VcsBaseEditorParameterWidget::OptionMapping> m_optionMappings;
QHash<QWidget*, SettingMappingData> m_settingMapping;
};
} // namespace Internal
/*!
\class VcsBase::VcsBaseEditorParameterWidget
\brief The VcsBaseEditorParameterWidget is a toolbar-like widget for use
with VcsBase::VcsBaseEditor::setConfigurationWidget()
influencing for example the generation of VCS diff output.
The widget maintains a list of command line arguments (starting from baseArguments())
which are set according to the state of the inside widgets. A change signal is provided
that should trigger the rerun of the VCS operation.
*/
VcsBaseEditorParameterWidget::ComboBoxItem::ComboBoxItem(const QString &text,
const QVariant &val) :
displayText(text),
value(val)
{
}
VcsBaseEditorParameterWidget::VcsBaseEditorParameterWidget(QWidget *parent) :
QWidget(parent), d(new Internal::VcsBaseEditorParameterWidgetPrivate)
{
d->m_layout = new QHBoxLayout(this);
d->m_layout->setContentsMargins(3, 0, 3, 0);
d->m_layout->setSpacing(2);
connect(this, &VcsBaseEditorParameterWidget::argumentsChanged,
this, &VcsBaseEditorParameterWidget::handleArgumentsChanged);
}
VcsBaseEditorParameterWidget::~VcsBaseEditorParameterWidget()
{
delete d;
}
QStringList VcsBaseEditorParameterWidget::baseArguments() const
{
return d->m_baseArguments;
}
void VcsBaseEditorParameterWidget::setBaseArguments(const QStringList &b)
{
d->m_baseArguments = b;
}
QStringList VcsBaseEditorParameterWidget::arguments() const
{
// Compile effective arguments
QStringList args = baseArguments();
foreach (const OptionMapping &mapping, optionMappings())
args += argumentsForOption(mapping);
return args;
}
QToolButton *VcsBaseEditorParameterWidget::addToggleButton(const QString &option,
const QString &label,
const QString &tooltip)
{
return addToggleButton(option.isEmpty() ? QStringList() : QStringList(option), label, tooltip);
}
QToolButton *VcsBaseEditorParameterWidget::addToggleButton(const QStringList &options, const QString &label, const QString &tooltip)
{
auto tb = new QToolButton;
tb->setText(label);
tb->setToolTip(tooltip);
tb->setCheckable(true);
connect(tb, &QToolButton::toggled, this, &VcsBaseEditorParameterWidget::argumentsChanged);
d->m_layout->addWidget(tb);
d->m_optionMappings.append(OptionMapping(options, tb));
return tb;
}
QComboBox *VcsBaseEditorParameterWidget::addComboBox(const QStringList &options,
const QList<ComboBoxItem> &items)
{
auto cb = new QComboBox;
foreach (const ComboBoxItem &item, items)
cb->addItem(item.displayText, item.value);
connect(cb, static_cast<void (QComboBox::*)(int)>(&QComboBox::currentIndexChanged),
this, &VcsBaseEditorParameterWidget::argumentsChanged);
d->m_layout->addWidget(cb);
d->m_optionMappings.append(OptionMapping(options, cb));
return cb;
}
void VcsBaseEditorParameterWidget::mapSetting(QToolButton *button, bool *setting)
{
if (!d->m_settingMapping.contains(button) && button) {
d->m_settingMapping.insert(button, Internal::SettingMappingData(setting));
if (setting) {
button->blockSignals(true);
button->setChecked(*setting);
button->blockSignals(false);
}
}
}
void VcsBaseEditorParameterWidget::mapSetting(QComboBox *comboBox, QString *setting)
{
if (!d->m_settingMapping.contains(comboBox) && comboBox) {
d->m_settingMapping.insert(comboBox, Internal::SettingMappingData(setting));
if (setting) {
comboBox->blockSignals(true);
const int itemIndex = setting ? comboBox->findData(*setting) : -1;
if (itemIndex != -1)
comboBox->setCurrentIndex(itemIndex);
comboBox->blockSignals(false);
}
}
}
void VcsBaseEditorParameterWidget::mapSetting(QComboBox *comboBox, int *setting)
{
if (d->m_settingMapping.contains(comboBox) || !comboBox)
return;
d->m_settingMapping.insert(comboBox, Internal::SettingMappingData(setting));
if (!setting || *setting < 0 || *setting >= comboBox->count())
return;
comboBox->blockSignals(true);
comboBox->setCurrentIndex(*setting);
comboBox->blockSignals(false);
}
void VcsBaseEditorParameterWidget::handleArgumentsChanged()
{
updateMappedSettings();
executeCommand();
}
void VcsBaseEditorParameterWidget::executeCommand()
{
emit commandExecutionRequested();
}
VcsBaseEditorParameterWidget::OptionMapping::OptionMapping(const QString &option, QWidget *w) :
widget(w)
{
if (!option.isEmpty())
options << option;
}
VcsBaseEditorParameterWidget::OptionMapping::OptionMapping(const QStringList &optionList, QWidget *w) :
options(optionList),
widget(w)
{
}
const QList<VcsBaseEditorParameterWidget::OptionMapping> &VcsBaseEditorParameterWidget::optionMappings() const
{
return d->m_optionMappings;
}
QStringList VcsBaseEditorParameterWidget::argumentsForOption(const OptionMapping &mapping) const
{
const QToolButton *tb = qobject_cast<const QToolButton *>(mapping.widget);
if (tb && tb->isChecked())
return mapping.options;
const QComboBox *cb = qobject_cast<const QComboBox *>(mapping.widget);
if (cb) {
const QString value = cb->itemData(cb->currentIndex()).toString();
QStringList args;
foreach (const QString &option, mapping.options)
args << option.arg(value);
return args;
}
return QStringList();
}
void VcsBaseEditorParameterWidget::updateMappedSettings()
{
foreach (const OptionMapping &optMapping, d->m_optionMappings) {
if (d->m_settingMapping.contains(optMapping.widget)) {
Internal::SettingMappingData& settingData = d->m_settingMapping[optMapping.widget];
switch (settingData.type()) {
case Internal::SettingMappingData::Bool :
{
const QToolButton *tb = qobject_cast<const QToolButton *>(optMapping.widget);
if (tb)
*settingData.boolSetting = tb->isChecked();
break;
}
case Internal::SettingMappingData::String :
{
const QComboBox *cb = qobject_cast<const QComboBox *>(optMapping.widget);
if (cb && cb->currentIndex() != -1)
*settingData.stringSetting = cb->itemData(cb->currentIndex()).toString();
break;
}
case Internal::SettingMappingData::Int:
{
const QComboBox *cb = qobject_cast<const QComboBox *>(optMapping.widget);
if (cb && cb->currentIndex() != -1)
*settingData.intSetting = cb->currentIndex();
break;
}
case Internal::SettingMappingData::Invalid : break;
} // end switch ()
}
}
}
} // namespace VcsBase