MapNotesDialog: Refactor and improved (#2272)

Moved out of MapEditorController.
Improved window size calculation using available space
while maintaining a readable max width.
Use standard buttons and layout for map notes dialog.

Co-authored-by: Kai Pastor <[email protected]>

Author: dl3sdo

code-check-wrapper.sh

@@ -73,6 +73,7 @@ for I in \
   map_find_feature.cpp \
   map_information.cpp \
   map_information_dialog.cpp \
+  map_notes.cpp \
   map_printer \
   map_widget.cpp \
   mapper_proxystyle.cpp \

src/CMakeLists.txt

@@ -165,6 +165,7 @@ set(Mapper_Common_SRCS
   gui/map/map_editor_activity.cpp
   gui/map/map_find_feature.cpp
   gui/map/map_information_dialog.cpp
+  gui/map/map_notes.cpp
   gui/map/map_widget.cpp
   gui/map/rotate_map_dialog.cpp
   gui/map/stretch_map_dialog.cpp

src/gui/map/map_editor.cpp

@@ -35,7 +35,6 @@
 #include <Qt>
 #include <QtGlobal>
 #include <QtMath>
-#include <QAbstractButton>
 #include <QAction>
 #include <QActionGroup>
 #include <QApplication>
@@ -75,7 +74,6 @@
 #include <QPoint>
 #include <QPointer>
 #include <QPointF>
-#include <QPushButton>
 #include <QRect>
 #include <QRectF>
 #include <QSettings>
@@ -87,7 +85,6 @@
 #include <QSplitter>
 #include <QStatusBar>
 #include <QStringList>
-#include <QTextEdit>
 #include <QToolBar>
 #include <QToolButton>
 #include <QVariant>
@@ -125,6 +122,7 @@
 #include "gui/map/map_editor_activity.h"
 #include "gui/map/map_find_feature.h"
 #include "gui/map/map_information_dialog.h"
+#include "gui/map/map_notes.h"
 #include "gui/map/map_widget.h"
 #include "gui/map/rotate_map_dialog.h"
 #include "gui/symbols/symbol_replacement.h"
@@ -2254,36 +2252,11 @@ void MapEditorController::rotateMapClicked()
 
 void MapEditorController::mapNotesClicked()
 {
-	QDialog dialog(window, Qt::WindowSystemMenuHint | Qt::WindowTitleHint);
-	dialog.setWindowTitle(tr("Map notes"));
-	dialog.setWindowModality(Qt::WindowModal);
-	
-	auto* text_edit = new QTextEdit();
-	text_edit->setPlainText(map->getMapNotes());
-	QPushButton* cancel_button = new QPushButton(tr("Cancel"));
-	QPushButton* ok_button = new QPushButton(QIcon(QString::fromLatin1(":/images/arrow-right.png")), tr("OK"));
-	ok_button->setDefault(true);
-	
-	auto* buttons_layout = new QHBoxLayout();
-	buttons_layout->addWidget(cancel_button);
-	buttons_layout->addStretch(1);
-	buttons_layout->addWidget(ok_button);
-	
-	auto* layout = new QVBoxLayout();
-	layout->addWidget(text_edit);
-	layout->addLayout(buttons_layout);
-	dialog.setLayout(layout);
-	
-	connect(cancel_button, &QAbstractButton::clicked, &dialog, &QDialog::reject);
-	connect(ok_button, &QAbstractButton::clicked, &dialog, &QDialog::accept);
-	
-	if (dialog.exec() == QDialog::Accepted)
+	if (map)
 	{
-		if (text_edit->toPlainText() != map->getMapNotes())
-		{
-			map->setMapNotes(text_edit->toPlainText());
-			map->setHasUnsavedChanges(true);
-		}
+		MapNotesDialog dialog(window, *map);
+		dialog.setWindowModality(Qt::WindowModal);
+		dialog.exec();
 	}
 }
 

src/gui/map/map_notes.cpp

@@ -0,0 +1,83 @@
+/*
+ *    Copyright 2012 Thomas Schöps
+ *    Copyright 2024 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 "map_notes.h"
+
+#include <Qt>
+#include <QtGlobal>
+#include <QDialogButtonBox>
+#include <QFlags>
+#include <QFontMetrics>
+#include <QLatin1Char>
+#include <QRect>
+#include <QSize>
+#include <QTextEdit>
+#include <QVBoxLayout>
+#include <QWidget>
+
+#include "core/map.h"
+
+
+namespace OpenOrienteering {
+
+MapNotesDialog::MapNotesDialog(QWidget* parent, Map& map)
+: QDialog(parent, Qt::WindowSystemMenuHint | Qt::WindowTitleHint | Qt::WindowCloseButtonHint)
+, map { map }
+{
+	setWindowTitle(tr("Map notes"));
+	
+	text_edit = new QTextEdit();
+	text_edit->setPlainText(map.getMapNotes());
+	auto* button_box = new QDialogButtonBox(QDialogButtonBox::Ok | QDialogButtonBox::Cancel);
+	
+	auto* layout = new QVBoxLayout();
+	layout->addWidget(text_edit);
+	layout->addWidget(button_box);
+	setLayout(layout);
+	
+	const auto max_size = parent ? parent->window()->size() : QSize{800, 600};
+	const QFontMetrics text_font_metrics(text_edit->currentFont());
+	auto preferred_width = text_font_metrics.boundingRect(QString(60, QLatin1Char('m'))).width();
+	const auto bounding_rect = text_font_metrics.boundingRect(0, 0, preferred_width, max_size.height(), Qt::TextWordWrap, map.getMapNotes());
+	auto width = qBound(300, bounding_rect.width() + 60, max_size.width());
+	auto height = qBound(200, bounding_rect.height() + 80, max_size.height());
+	resize(width, height);
+	
+	connect(button_box, &QDialogButtonBox::rejected, this, &QDialog::reject);
+	connect(button_box, &QDialogButtonBox::accepted, this, &MapNotesDialog::okClicked);	
+}
+
+MapNotesDialog::~MapNotesDialog() = default;
+
+// slot
+void MapNotesDialog::okClicked()
+{
+	auto text = text_edit->toPlainText();
+	if (text != map.getMapNotes())
+	{
+		map.setMapNotes(text);
+		map.setHasUnsavedChanges(true);
+	}
+	
+	accept();
+}
+
+}  // namespace OpenOrienteering

src/gui/map/map_notes.h

@@ -0,0 +1,58 @@
+/*
+ *    Copyright 2024 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_MAP_NOTES_H
+#define OPENORIENTEERING_MAP_NOTES_H
+
+#include <QDialog>
+#include <QObject>
+
+// IWYU pragma: no_include <QString>
+class QTextEdit;
+class QWidget;
+
+
+namespace OpenOrienteering {
+
+class Map;
+
+class MapNotesDialog : public QDialog
+{
+Q_OBJECT
+public:
+	/**
+	 * Creates a new MapNotesDialog object.
+	 */
+	MapNotesDialog(QWidget* parent, Map& map);
+	
+	~MapNotesDialog() override;
+	
+private slots:
+	void okClicked();
+	
+private:
+	QTextEdit* text_edit;
+	
+	Map& map;
+};
+
+
+}  // namespace OpenOrienteering
+
+#endif // OPENORIENTEERING_MAP_NOTES_H