forked from qt-creator/qt-creator
2c6adc1e74
Change VcsBaseEditorParameterWidget to add actions/widgets to an existing toolbar, instead of being a widget itself. The class is renamed in a follow-up commit. Task-number: QTCREATORBUG-14934 Change-Id: I473a439d12a096f4cbb64f06faa0598ee72000de Reviewed-by: Tobias Hunger <tobias.hunger@qt.io> Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>
301 lines
9.5 KiB
C++
301 lines
9.5 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 <QAction>
|
|
#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(QToolBar *toolBar) : m_toolBar(toolBar)
|
|
{
|
|
if (!toolBar)
|
|
return;
|
|
toolBar->setContentsMargins(3, 0, 3, 0);
|
|
toolBar->setToolButtonStyle(Qt::ToolButtonIconOnly);
|
|
}
|
|
|
|
QStringList m_baseArguments;
|
|
QList<VcsBaseEditorParameterWidget::OptionMapping> m_optionMappings;
|
|
QHash<QObject *, SettingMappingData> m_settingMapping;
|
|
QToolBar *m_toolBar;
|
|
};
|
|
|
|
} // namespace Internal
|
|
|
|
/*!
|
|
\class VcsBase::VcsBaseEditorParameterWidget
|
|
|
|
\brief The VcsBaseEditorParameterWidget is a widget/action aggregator for use
|
|
with VcsBase::VcsBaseEditor, influencing for example the generation of VCS diff output.
|
|
|
|
The class 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(QToolBar *toolBar) :
|
|
QObject(toolBar), d(new Internal::VcsBaseEditorParameterWidgetPrivate(toolBar))
|
|
{
|
|
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;
|
|
}
|
|
|
|
QAction *VcsBaseEditorParameterWidget::addToggleButton(const QString &option,
|
|
const QString &label,
|
|
const QString &tooltip)
|
|
{
|
|
return addToggleButton(option.isEmpty() ? QStringList() : QStringList(option), label, tooltip);
|
|
}
|
|
|
|
QAction *VcsBaseEditorParameterWidget::addToggleButton(const QStringList &options,
|
|
const QString &label,
|
|
const QString &tooltip)
|
|
{
|
|
auto action = new QAction(label, d->m_toolBar);
|
|
action->setToolTip(tooltip);
|
|
action->setCheckable(true);
|
|
connect(action, &QAction::toggled, this, &VcsBaseEditorParameterWidget::argumentsChanged);
|
|
const QList<QAction *> actions = d->m_toolBar->actions();
|
|
// Insert the action before line/column and split actions.
|
|
d->m_toolBar->insertAction(actions.at(qMax(actions.count() - 2, 0)), action);
|
|
d->m_optionMappings.append(OptionMapping(options, action));
|
|
return action;
|
|
}
|
|
|
|
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_toolBar->addWidget(cb);
|
|
d->m_optionMappings.append(OptionMapping(options, cb));
|
|
return cb;
|
|
}
|
|
|
|
void VcsBaseEditorParameterWidget::mapSetting(QAction *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, QObject *obj) :
|
|
object(obj)
|
|
{
|
|
if (!option.isEmpty())
|
|
options << option;
|
|
}
|
|
|
|
VcsBaseEditorParameterWidget::OptionMapping::OptionMapping(const QStringList &optionList, QObject *obj) :
|
|
options(optionList),
|
|
object(obj)
|
|
{
|
|
}
|
|
|
|
const QList<VcsBaseEditorParameterWidget::OptionMapping> &VcsBaseEditorParameterWidget::optionMappings() const
|
|
{
|
|
return d->m_optionMappings;
|
|
}
|
|
|
|
QStringList VcsBaseEditorParameterWidget::argumentsForOption(const OptionMapping &mapping) const
|
|
{
|
|
const QAction *action = qobject_cast<const QAction *>(mapping.object);
|
|
if (action && action->isChecked())
|
|
return mapping.options;
|
|
|
|
const QComboBox *cb = qobject_cast<const QComboBox *>(mapping.object);
|
|
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.object)) {
|
|
Internal::SettingMappingData& settingData = d->m_settingMapping[optMapping.object];
|
|
switch (settingData.type()) {
|
|
case Internal::SettingMappingData::Bool :
|
|
{
|
|
if (auto action = qobject_cast<const QAction *>(optMapping.object))
|
|
*settingData.boolSetting = action->isChecked();
|
|
break;
|
|
}
|
|
case Internal::SettingMappingData::String :
|
|
{
|
|
const QComboBox *cb = qobject_cast<const QComboBox *>(optMapping.object);
|
|
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.object);
|
|
if (cb && cb->currentIndex() != -1)
|
|
*settingData.intSetting = cb->currentIndex();
|
|
break;
|
|
}
|
|
case Internal::SettingMappingData::Invalid : break;
|
|
} // end switch ()
|
|
}
|
|
}
|
|
}
|
|
|
|
} // namespace VcsBase
|