Feature: Remove object tags

Add dialog to remove object tags from selected objects that match
a configurable pattern.
Allow to create an undo step.

Closes GH-2354 (Remove objects tags).

Author: dl3sdo

code-check-wrapper.sh

@@ -1,6 +1,6 @@
 #!/bin/sh -e
 
-#    Copyright 2017, 2018, 2024 Kai Pastor
+#    Copyright 2017, 2018, 2024, 2025 Kai Pastor
 #
 #    This file is part of OpenOrienteering.
 #    
@@ -103,6 +103,7 @@ for I in \
   symbol_rule_set.cpp \
   symbol_t.cpp \
   symbol_tooltip.cpp \
+  tag_remove_widget.cpp \
   tag_select_widget.cpp \
   /template.cpp \
   template_image.cpp \

src/CMakeLists.txt

@@ -1,6 +1,6 @@
 #
 #    Copyright 2012-2014 Thomas Schöps
-#    Copyright 2012-2024 Kai Pastor
+#    Copyright 2012-2025 Kai Pastor
 #    
 #    This file is part of OpenOrienteering.
 # 
@@ -204,6 +204,7 @@ set(Mapper_Common_SRCS
   gui/widgets/symbol_render_widget.cpp
   gui/widgets/symbol_tooltip.cpp
   gui/widgets/symbol_widget.cpp
+  gui/widgets/tag_remove_widget.cpp
   gui/widgets/tag_select_widget.cpp
   gui/widgets/tags_widget.cpp
   gui/widgets/template_list_widget.cpp

src/gui/widgets/tag_remove_widget.cpp

@@ -0,0 +1,196 @@
+/*
+ *    Copyright 2025 Matthias Kühlewein
+ *
+ *    This file is part of OpenOrienteering.
+ *
+ *    OpenOrienteering is free software: you can redistribute it and/or modify
+ *    it under the terms of the GNU General Public License as published by
+ *    the Free Software Foundation, either version 3 of the License, or
+ *    (at your option) any later version.
+ *
+ *    OpenOrienteering is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *    GNU General Public License for more details.
+ *
+ *    You should have received a copy of the GNU General Public License
+ *    along with OpenOrienteering.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "tag_remove_widget.h"
+
+#include <algorithm>
+#include <functional>
+#include <set>
+#include <vector>
+
+#include <Qt>
+#include <QtGlobal>
+#include <QChar>
+#include <QCheckBox>
+#include <QCoreApplication>
+#include <QComboBox>
+#include <QDialogButtonBox>
+#include <QHBoxLayout>
+#include <QLabel>
+#include <QLatin1String>
+#include <QLineEdit>
+#include <QMessageBox>
+#include <QPushButton>
+#include <QVBoxLayout>
+#include <QWidget>
+
+#include "core/map.h"
+#include "core/objects/object.h"
+#include "gui/util_gui.h"
+#include "undo/object_undo.h"
+
+
+namespace {
+
+struct CompOpStruct {
+	const QString op;
+	const std::function<bool (const QString&, const QString&)> fn;
+};
+
+static const CompOpStruct compare_operations[4] = {
+	{ QCoreApplication::translate("OpenOrienteering::TagRemoveDialog", "equal to"), [](const QString& key, const QString& pattern) { return key == pattern; } },
+	{ QCoreApplication::translate("OpenOrienteering::TagRemoveDialog", "not equal to"), [](const QString& key, const QString& pattern) { return key != pattern; } },
+	{ QCoreApplication::translate("OpenOrienteering::TagRemoveDialog", "containing"), [](const QString& key, const QString& pattern) { return key.contains(pattern); } },
+	{ QCoreApplication::translate("OpenOrienteering::TagRemoveDialog", "not containing"), [](const QString& key, const QString& pattern) { return !key.contains(pattern); } }
+};
+
+}  // namespace
+
+
+namespace OpenOrienteering {
+
+TagRemoveDialog::TagRemoveDialog(QWidget* parent, Map* map)
+: QDialog(parent, Qt::WindowSystemMenuHint | Qt::WindowTitleHint | Qt::WindowCloseButtonHint)
+, map { map }
+{
+	setWindowTitle(tr("Remove Tags"));
+	
+	auto* h_layout = new QHBoxLayout();
+	h_layout->addWidget(new QLabel(tr("Remove all tags")));
+	
+	compare_op = new QComboBox();
+	for (auto& compare_operation : compare_operations)
+	{
+		compare_op->addItem(compare_operation.op);
+	}
+	h_layout->addWidget(compare_op);
+	
+	pattern_edit = new QLineEdit();
+	
+	undo_check = new QCheckBox(tr("Add undo step"));
+	
+	auto* button_box = new QDialogButtonBox(QDialogButtonBox::Ok | QDialogButtonBox::Cancel);
+	ok_button = button_box->button(QDialogButtonBox::Ok);
+	ok_button->setEnabled(false);
+	
+	auto* layout = new QVBoxLayout();
+	layout->addLayout(h_layout);
+	layout->addWidget(pattern_edit);
+	layout->addWidget(new QLabel(tr("from the selected objects.")));
+	layout->addWidget(undo_check);
+	layout->addItem(Util::SpacerItem::create(this));
+	layout->addStretch();
+	layout->addWidget(button_box);
+	setLayout(layout);
+	
+	connect(button_box, &QDialogButtonBox::rejected, this, &QDialog::reject);
+	connect(button_box, &QDialogButtonBox::accepted, this, &TagRemoveDialog::okClicked);
+	connect(pattern_edit, &QLineEdit::textChanged, this, &TagRemoveDialog::textChanged);
+}
+
+TagRemoveDialog::~TagRemoveDialog() = default;
+
+
+// slot
+void TagRemoveDialog::textChanged(const QString &text)
+{
+	ok_button->setEnabled(!text.trimmed().isEmpty());
+}
+
+// slot
+void TagRemoveDialog::okClicked()
+{
+	const auto pattern = pattern_edit->text();
+	auto op = compare_op->currentIndex();
+	
+	int objects_count = 0;
+	std::set<QString> matching_keys;
+	
+	for (const auto& object : map->selectedObjects())
+	{
+		bool object_matched = false;
+		for (const auto& tag : object->tags())
+		{
+			if ((compare_operations[op].fn)(tag.key, pattern))
+			{
+				matching_keys.insert(tag.key);
+				object_matched = true;
+			}
+		}
+		if (object_matched)
+			++objects_count;
+	}
+	if (matching_keys.empty())
+	{
+		QMessageBox::information(this, tr("Information"), tr("No matching object tags found."), QMessageBox::Ok);
+		return;
+	}
+	else
+	{
+		QString detailed_text = std::accumulate( begin(matching_keys), 
+												 end(matching_keys), 
+												 QString(tr("The following object tags will be removed:")),
+												 [](const QString& a, const QString& b) -> QString { return a + QChar::LineFeed + b; }
+												);
+		QMessageBox msgBox;
+		msgBox.setWindowTitle(tr("Confirmation"));
+		msgBox.setIcon(QMessageBox::Warning);
+		QString question = tr("Do you want to remove %n tag(s)", nullptr, matching_keys.size());
+		question += QChar::Space + tr("from %n object(s)?", nullptr, objects_count);
+		msgBox.setText(question);
+		msgBox.setDetailedText(detailed_text);
+		msgBox.setStandardButtons(QMessageBox::Yes | QMessageBox::No);
+		
+		if (msgBox.exec() == QMessageBox::Yes)
+		{
+			const auto add_undo = undo_check->isChecked();
+			CombinedUndoStep* combined_step;
+			if (add_undo)
+				combined_step = new CombinedUndoStep(map);
+			std::vector<QString> matching_keys;
+			for (const auto& object : map->selectedObjects())
+			{
+				matching_keys.clear();
+				for (const auto& tag : object->tags())
+				{
+					if ((compare_operations[op].fn)(tag.key, pattern))
+					{
+						matching_keys.push_back(tag.key);
+					}
+				}
+				if (add_undo && !matching_keys.empty())
+				{
+					auto undo_step = new ObjectTagsUndoStep(map);
+					undo_step->addObject(map->getCurrentPart()->findObjectIndex(object));
+					combined_step->push(undo_step);
+				}
+				for (const auto& key : matching_keys)
+				{
+					object->removeTag(key);
+				}
+			}
+			if (add_undo)
+				map->push(combined_step);
+		}
+	}
+	accept();
+}
+
+
+}  // namespace OpenOrienteering

src/gui/widgets/tag_remove_widget.h

@@ -0,0 +1,65 @@
+/*
+ *    Copyright 2025 Matthias Kühlewein
+ *
+ *    This file is part of OpenOrienteering.
+ *
+ *    OpenOrienteering is free software: you can redistribute it and/or modify
+ *    it under the terms of the GNU General Public License as published by
+ *    the Free Software Foundation, either version 3 of the License, or
+ *    (at your option) any later version.
+ *
+ *    OpenOrienteering is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *    GNU General Public License for more details.
+ *
+ *    You should have received a copy of the GNU General Public License
+ *    along with OpenOrienteering.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef OPENORIENTEERING_TAG_REMOVE_WIDGET_H
+#define OPENORIENTEERING_TAG_REMOVE_WIDGET_H
+
+#include <QDialog>
+#include <QObject>
+
+class QCheckBox;
+class QComboBox;
+class QLineEdit;
+class QPushButton;
+class QString;
+class QWidget;
+
+
+namespace OpenOrienteering {
+
+class Map;
+
+class TagRemoveDialog : public QDialog
+{
+Q_OBJECT
+public:
+	/**
+	 * Creates a new TagRemoveDialog object.
+	 */
+	TagRemoveDialog(QWidget* parent, Map* map);
+	
+	~TagRemoveDialog() override;
+	
+private slots:
+	void textChanged(const QString &text);
+	void okClicked();
+	
+private:
+	QPushButton* ok_button;
+	QCheckBox* undo_check;
+	QComboBox* compare_op;
+	QLineEdit* pattern_edit;
+	
+	Map *map;
+};
+
+
+}  // namespace OpenOrienteering
+
+#endif // OPENORIENTEERING_TAG_REMOVE_WIDGET_H

src/gui/widgets/tags_widget.cpp

@@ -32,6 +32,7 @@
 #include "gui/main_window.h"
 #include "gui/util_gui.h"
 #include "gui/map/map_editor.h"
+#include "gui/widgets/tag_remove_widget.h"
 #include "undo/object_undo.h"
 
 
@@ -65,6 +66,9 @@ TagsWidget::TagsWidget(Map* map, MapView* main_view, MapEditorController* contro
 	auto help_button = Util::ToolButton::create(QIcon(QString::fromLatin1(":/images/help.png")), tr("Help"));
 	help_button->setAutoRaise(true);
 
+	remove_button = Util::ToolButton::create(QIcon(QString::fromLatin1(":/images/delete.png")), tr("Remove tags"));
+	remove_button->setAutoRaise(true);
+	
 	auto all_buttons_layout = new QHBoxLayout();
 	QStyleOption style_option(QStyleOption::Version, QStyleOption::SO_DockWidget);
 	all_buttons_layout->setContentsMargins(
@@ -74,6 +78,7 @@ TagsWidget::TagsWidget(Map* map, MapView* main_view, MapEditorController* contro
 		style()->pixelMetric(QStyle::PM_LayoutBottomMargin, &style_option) / 2
 	);
 	all_buttons_layout->addWidget(new QLabel(QString::fromLatin1("   ")), 1);
+	all_buttons_layout->addWidget(remove_button);
 	all_buttons_layout->addWidget(help_button);
 
 	layout->addLayout(all_buttons_layout);
@@ -83,6 +88,7 @@ TagsWidget::TagsWidget(Map* map, MapView* main_view, MapEditorController* contro
 	connect(tags_table, &QTableWidget::cellChanged, this, &TagsWidget::cellChange);
 
 	connect(help_button, &QAbstractButton::clicked, this, &TagsWidget::showHelp);
+	connect(remove_button, &QAbstractButton::clicked, this, &TagsWidget::removeTags);
 
 	connect(map, &Map::objectSelectionChanged, this, &TagsWidget::objectTagsChanged);
 	connect(map, &Map::selectedObjectEdited, this, &TagsWidget::objectTagsChanged);
@@ -100,6 +106,18 @@ void TagsWidget::showHelp()
 	Util::showHelp(controller->getWindow(), "object_tags.html");
 }
 
+// slot
+void TagsWidget::removeTags()
+{
+	if (map)
+	{
+		TagRemoveDialog dialog(controller->getWindow(), map);
+		dialog.setWindowModality(Qt::WindowModal);
+		dialog.exec();
+		objectTagsChanged();
+	}
+}
+
 void TagsWidget::setupLastRow()
 {
 	const int row = tags_table->rowCount() - 1;
@@ -121,6 +139,8 @@ void TagsWidget::createUndoStep(Object* object)
 // slot
 void TagsWidget::objectTagsChanged()
 {
+	remove_button->setEnabled(map->getNumSelectedObjects() > 0);
+	
 	if (!react_to_changes)
 		return;
 

src/gui/widgets/tags_widget.h

@@ -1,5 +1,5 @@
 /*
- *    Copyright 2013 Kai Pastor
+ *    Copyright 2013-2018, 2025 Kai Pastor
  *
  *    This file is part of OpenOrienteering.
  *
@@ -38,7 +38,7 @@ class Object;
 
 
 /**
- * This widget allows for display and editing of tags, i.e. key-value pairs.
+ * This widget allows to display and edit tags, i.e. key-value pairs.
  */
 class TagsWidget : public QWidget
 {
@@ -70,6 +70,11 @@ protected slots:
 	 */
 	void showHelp();
 
+	/**
+	 * Opens a dialog for removing tags.
+	 */
+	void removeTags();
+	
 protected:
 	/** 
 	 * Sets up the last row: blank cells, right one not editable.
@@ -89,10 +94,11 @@ protected slots:
 	MapEditorController* controller;
 	bool react_to_changes;
 
+	QToolButton* remove_button;
 	QTableWidget* tags_table;
 };
 
 
 }  // namespace OpenOrienteering
 
-#endif // TAGS_WIDGET_H
+#endif // OPENORIENTEERING_TAGS_WIDGET_H