feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Utils: Factor out code related to optional checkboxes for strings

Browse Source 
We will need it twice when the FilePathAspect is fully separate.

Change-Id: Ief69af0e1167d5ca5c770c3cbd16fdafa16114f7
Reviewed-by: Marcus Tillmanns <marcus.tillmanns@qt.io>
This commit is contained in:
hjk
2023-07-21 15:47:13 +02:00
parent 370bd18dc6
commit d22df34e6c
4 changed files with 124 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files

189
src/libs/utils/aspects.cpp
View File

@@ -661,16 +661,102 @@ public:
QPointer<QListWidget> m_listView;
};
class CheckableAspectImplementation
{
public:
void fromMap(const QVariantMap &map)
{
if (m_checked)
m_checked->fromMap(map);
}
void toMap(QVariantMap &map)
{
if (m_checked)
m_checked->toMap(map);
}
template<class Widget>
void updateWidgetFromCheckStatus(BaseAspect *aspect, Widget *w)
{
const bool enabled = !m_checked || m_checked->value();
if (m_uncheckedSemantics == UncheckedSemantics::Disabled)
w->setEnabled(enabled && aspect->isEnabled());
else
w->setReadOnly(!enabled || aspect->isReadOnly());
}
void setUncheckedSemantics(UncheckedSemantics semantics)
{
m_uncheckedSemantics = semantics;
}
bool isChecked() const
{
QTC_ASSERT(m_checked, return false);
return m_checked->value();
}
void setChecked(bool checked)
{
QTC_ASSERT(m_checked, return);
m_checked->setValue(checked);
}
void makeCheckable(CheckBoxPlacement checkBoxPlacement, const QString &checkerLabel,
const QString &checkerKey, BaseAspect *aspect)
{
QTC_ASSERT(!m_checked, return);
m_checkBoxPlacement = checkBoxPlacement;
m_checked.reset(new BoolAspect);
m_checked->setLabel(checkerLabel, checkBoxPlacement == CheckBoxPlacement::Top
? BoolAspect::LabelPlacement::InExtraLabel
: BoolAspect::LabelPlacement::AtCheckBox);
m_checked->setSettingsKey(checkerKey);
QObject::connect(m_checked.get(), &BoolAspect::changed, aspect, [aspect] {
// FIXME: Check.
aspect->internalToBuffer();
aspect->bufferToGui();
emit aspect->changed();
aspect->checkedChanged();
});
QObject::connect(m_checked.get(), &BoolAspect::volatileValueChanged, aspect, [aspect] {
// FIXME: Check.
aspect->internalToBuffer();
aspect->bufferToGui();
aspect->checkedChanged();
});
aspect->internalToBuffer();
aspect->bufferToGui();
}
void addToLayoutFirst(LayoutItem &parent)
{
if (m_checked && m_checkBoxPlacement == CheckBoxPlacement::Top) {
m_checked->addToLayout(parent);
parent.addItem(br);
}
}
void addToLayoutLast(LayoutItem &parent)
{
if (m_checked && m_checkBoxPlacement == CheckBoxPlacement::Right)
m_checked->addToLayout(parent);
}
CheckBoxPlacement m_checkBoxPlacement = CheckBoxPlacement::Right;
UncheckedSemantics m_uncheckedSemantics = UncheckedSemantics::Disabled;
std::unique_ptr<BoolAspect> m_checked;
};
class StringAspectPrivate
{
public:
StringAspect::DisplayStyle m_displayStyle = StringAspect::LabelDisplay;
StringAspect::CheckBoxPlacement m_checkBoxPlacement
= StringAspect::CheckBoxPlacement::Right;
StringAspect::UncheckedSemantics m_uncheckedSemantics
= StringAspect::UncheckedSemantics::Disabled;
std::function<QString(const QString &)> m_displayFilter;
std::unique_ptr<BoolAspect> m_checker;
Qt::TextElideMode m_elideMode = Qt::ElideNone;
QString m_placeHolderText;
@@ -690,6 +776,8 @@ public:
std::optional<FancyLineEdit::ValidationFunction> m_validator;
std::function<void()> m_openTerminal;
CheckableAspectImplementation m_checkerImpl;
bool m_undoRedoEnabled = true;
bool m_acceptRichText = false;
bool m_showToolTipOnLabel = false;
@@ -701,15 +789,6 @@ public:
bool m_blockAutoApply = false;
bool m_allowPathFromDevice = true;
bool m_validatePlaceHolder = false;
template<class Widget> void updateWidgetFromCheckStatus(StringAspect *aspect, Widget *w)
{
const bool enabled = !m_checker || m_checker->value();
if (m_uncheckedSemantics == StringAspect::UncheckedSemantics::Disabled)
w->setEnabled(enabled && aspect->isEnabled());
else
w->setReadOnly(!enabled || aspect->isReadOnly());
}
};
class IntegerAspectPrivate
@@ -838,8 +917,7 @@ void StringAspect::fromMap(const QVariantMap &map)
{
if (!settingsKey().isEmpty())
setValueQuietly(map.value(settingsKey(), defaultValue()).toString());
if (d->m_checker)
d->m_checker->fromMap(map);
d->m_checkerImpl.fromMap(map);
}
/*!
@@ -848,8 +926,7 @@ void StringAspect::fromMap(const QVariantMap &map)
void StringAspect::toMap(QVariantMap &map) const
{
saveToMap(map, value(), defaultValue(), settingsKey());
if (d->m_checker)
d->m_checker->toMap(map);
d->m_checkerImpl.toMap(map);
}
/*!
@@ -887,27 +964,6 @@ void StringAspect::setDisplayFilter(const std::function<QString(const QString &)
d->m_displayFilter = displayFilter;
}
/*!
Returns the check box value.
\sa makeCheckable(), setChecked()
*/
bool StringAspect::isChecked() const
{
return !d->m_checker || d->m_checker->value();
}
/*!
Sets the check box of this aspect to \a checked.
\sa makeCheckable(), isChecked()
*/
void StringAspect::setChecked(bool checked)
{
QTC_ASSERT(d->m_checker, return);
d->m_checker->setValue(checked);
}
/*!
Selects the main display characteristics of the aspect according to
\a displayStyle.
@@ -1077,17 +1133,9 @@ void StringAspect::validateInput()
d->m_lineEditDisplay->validate();
}
void StringAspect::setUncheckedSemantics(StringAspect::UncheckedSemantics semantics)
{
d->m_uncheckedSemantics = semantics;
}
void StringAspect::addToLayout(LayoutItem &parent)
{
if (d->m_checker && d->m_checkBoxPlacement == CheckBoxPlacement::Top) {
d->m_checker->addToLayout(parent);
parent.addItem(br);
}
d->m_checkerImpl.addToLayoutFirst(parent);
const auto useMacroExpander = [this](QWidget *w) {
if (!d->m_expanderProvider)
@@ -1124,7 +1172,7 @@ void StringAspect::addToLayout(LayoutItem &parent)
// do not override default value with placeholder, but use placeholder if default is empty
if (d->m_pathChooserDisplay->lineEdit()->placeholderText().isEmpty())
d->m_pathChooserDisplay->lineEdit()->setPlaceholderText(d->m_placeHolderText);
d->updateWidgetFromCheckStatus(this, d->m_pathChooserDisplay.data());
d->m_checkerImpl.updateWidgetFromCheckStatus(this, d->m_pathChooserDisplay.data());
addLabeledItem(parent, d->m_pathChooserDisplay);
useMacroExpander(d->m_pathChooserDisplay->lineEdit());
connect(d->m_pathChooserDisplay, &PathChooser::validChanged, this, &StringAspect::validChanged);
@@ -1150,7 +1198,7 @@ void StringAspect::addToLayout(LayoutItem &parent)
d->m_lineEditDisplay->setTextKeepingActiveCursor(displayedString);
d->m_lineEditDisplay->setReadOnly(isReadOnly());
d->m_lineEditDisplay->setValidatePlaceHolder(d->m_validatePlaceHolder);
d->updateWidgetFromCheckStatus(this, d->m_lineEditDisplay.data());
d->m_checkerImpl.updateWidgetFromCheckStatus(this, d->m_lineEditDisplay.data());
addLabeledItem(parent, d->m_lineEditDisplay);
useMacroExpander(d->m_lineEditDisplay);
if (d->m_useResetButton) {
@@ -1182,7 +1230,7 @@ void StringAspect::addToLayout(LayoutItem &parent)
d->m_textEditDisplay->setTextInteractionFlags(Qt::TextEditorInteraction);
d->m_textEditDisplay->setText(displayedString);
d->m_textEditDisplay->setReadOnly(isReadOnly());
d->updateWidgetFromCheckStatus(this, d->m_textEditDisplay.data());
d->m_checkerImpl.updateWidgetFromCheckStatus(this, d->m_textEditDisplay.data());
addLabeledItem(parent, d->m_textEditDisplay);
useMacroExpander(d->m_textEditDisplay);
bufferToGui();
@@ -1199,8 +1247,7 @@ void StringAspect::addToLayout(LayoutItem &parent)
break;
}
if (d->m_checker && d->m_checkBoxPlacement == CheckBoxPlacement::Right)
d->m_checker->addToLayout(parent);
d->m_checkerImpl.addToLayoutLast(parent);
}
bool StringAspect::guiToBuffer()
@@ -1233,19 +1280,19 @@ void StringAspect::bufferToGui()
{
if (d->m_pathChooserDisplay) {
d->m_pathChooserDisplay->lineEdit()->setText(m_buffer);
d->updateWidgetFromCheckStatus(this, d->m_pathChooserDisplay.data());
d->m_checkerImpl.updateWidgetFromCheckStatus(this, d->m_pathChooserDisplay.data());
}
if (d->m_lineEditDisplay) {
d->m_lineEditDisplay->setTextKeepingActiveCursor(m_buffer);
d->updateWidgetFromCheckStatus(this, d->m_lineEditDisplay.data());
d->m_checkerImpl.updateWidgetFromCheckStatus(this, d->m_lineEditDisplay.data());
}
if (d->m_textEditDisplay) {
const QString old = d->m_textEditDisplay->document()->toPlainText();
if (m_buffer != old)
d->m_textEditDisplay->setText(m_buffer);
d->updateWidgetFromCheckStatus(this, d->m_textEditDisplay.data());
d->m_checkerImpl.updateWidgetFromCheckStatus(this, d->m_textEditDisplay.data());
}
if (d->m_labelDisplay) {
@@ -1266,29 +1313,17 @@ void StringAspect::bufferToGui()
void StringAspect::makeCheckable(CheckBoxPlacement checkBoxPlacement,
const QString &checkerLabel, const QString &checkerKey)
{
QTC_ASSERT(!d->m_checker, return);
d->m_checkBoxPlacement = checkBoxPlacement;
d->m_checker.reset(new BoolAspect);
d->m_checker->setLabel(checkerLabel, checkBoxPlacement == CheckBoxPlacement::Top
? BoolAspect::LabelPlacement::InExtraLabel
: BoolAspect::LabelPlacement::AtCheckBox);
d->m_checker->setSettingsKey(checkerKey);
d->m_checkerImpl.makeCheckable(checkBoxPlacement, checkerLabel, checkerKey, this);
}
connect(d->m_checker.get(), &BoolAspect::changed, this, [this] {
internalToBuffer();
bufferToGui();
emit changed();
checkedChanged();
});
bool StringAspect::isChecked() const
{
return d->m_checkerImpl.isChecked();
}
connect(d->m_checker.get(), &BoolAspect::volatileValueChanged, this, [this] {
internalToBuffer();
bufferToGui();
checkedChanged();
});
internalToBuffer();
bufferToGui();
void StringAspect::setChecked(bool checked)
{
return d->m_checkerImpl.setChecked(checked);
}

17
src/libs/utils/aspects.h
View File

@@ -38,6 +38,7 @@ class SelectionAspectPrivate;
class StringAspectPrivate;
class StringListAspectPrivate;
class TextDisplayPrivate;
class CheckableAspectImplementation;
} // Internal
class QTCREATOR_UTILS_EXPORT BaseAspect : public QObject
@@ -169,6 +170,7 @@ signals:
void volatileValueChanged();
void externalValueChanged();
void labelLinkActivated(const QString &link);
void checkedChanged();
protected:
virtual bool internalToBuffer();
@@ -226,6 +228,7 @@ protected:
private:
std::unique_ptr<Internal::BaseAspectPrivate> d;
friend class Internal::CheckableAspectImplementation;
};
QTCREATOR_UTILS_EXPORT void createItem(Layouting::LayoutItem *item, const BaseAspect &aspect);
@@ -467,6 +470,9 @@ private:
std::unique_ptr<Internal::MultiSelectionAspectPrivate> d;
};
enum class UncheckedSemantics { Disabled, ReadOnly };
enum class CheckBoxPlacement { Top, Right };
class QTCREATOR_UTILS_EXPORT StringAspect : public TypedAspect<QString>
{
Q_OBJECT
@@ -503,15 +509,11 @@ public:
void setAutoApplyOnEditingFinished(bool applyOnEditingFinished);
void setElideMode(Qt::TextElideMode elideMode);
void validateInput();
enum class UncheckedSemantics { Disabled, ReadOnly };
enum class CheckBoxPlacement { Top, Right };
void setUncheckedSemantics(UncheckedSemantics semantics);
void makeCheckable(CheckBoxPlacement checkBoxPlacement, const QString &optionalLabel, const QString &optionalBaseKey);
bool isChecked() const;
void setChecked(bool checked);
void makeCheckable(CheckBoxPlacement checkBoxPlacement, const QString &optionalLabel,
const QString &optionalBaseKey);
void validateInput();
enum DisplayStyle {
LabelDisplay,
@@ -527,7 +529,6 @@ public:
FilePath filePath() const;
signals:
void checkedChanged();
void validChanged(bool validState);
protected:

2
src/plugins/projectexplorer/runconfigurationaspects.cpp
View File

@@ -616,7 +616,7 @@ void ExecutableAspect::makeOverridable(const QString &overridingKey, const QStri
m_alternativeExecutable->setDisplayStyle(StringAspect::LineEditDisplay);
m_alternativeExecutable->setLabelText(Tr::tr("Alternate executable on device:"));
m_alternativeExecutable->setSettingsKey(overridingKey);
m_alternativeExecutable->makeCheckable(StringAspect::CheckBoxPlacement::Right,
m_alternativeExecutable->makeCheckable(CheckBoxPlacement::Right,
Tr::tr("Use this command instead"), useOverridableKey);
connect(m_alternativeExecutable, &StringAspect::changed,
this, &ExecutableAspect::changed);

2
src/plugins/remotelinux/makeinstallstep.cpp
View File

@@ -107,7 +107,7 @@ MakeInstallStep::MakeInstallStep(BuildStepList *parent, Id id) : MakeStep(parent
m_customCommand.setSettingsKey("RemoteLinux.MakeInstall.CustomCommandLine");
m_customCommand.setDisplayStyle(StringAspect::LineEditDisplay);
m_customCommand.setLabelText(Tr::tr("Custom command line:"));
m_customCommand.makeCheckable(StringAspect::CheckBoxPlacement::Top,
m_customCommand.makeCheckable(CheckBoxPlacement::Top,
Tr::tr("Use custom command line instead:"),
"RemoteLinux.MakeInstall.EnableCustomCommandLine");
const auto updateCommand = [this] {