Fix GitHub Issue #249: Option to include grid on export

- Grid will be exported if set visible

- Works for both PNG and SVG exports

Author: juzzlin

CHANGELOG

@@ -5,6 +5,10 @@ Release date:
 
 New features:
 
+* Fix GitHub Issue #249: Option to include grid on export
+    - Grid will be exported if set visible
+    - Works for both PNG and SVG exports
+
 * Fix GitHub Issue #251: Feature request: child has same colors as parent
   - Change "Copy on Drag" behavior so that only the style will be copied
 

src/application_service.cpp

@@ -27,6 +27,7 @@
 #include "single_instance_container.hpp"
 
 #include "core/progress_manager.hpp"
+#include "core/settings.hpp"
 #include "core/settings_proxy.hpp"
 #include "core/shadow_effect_params.hpp"
 
@@ -317,14 +318,36 @@ void ApplicationService::enableRedo(bool enable)
     m_mainWindow->enableRedo(enable);
 }
 
+ApplicationService::GridLineVector ApplicationService::addGridForExport()
+{
+    GridLineVector addedLineItems;
+    if (Settings::V1::loadGridVisibleState()) {
+        const auto gridLines = m_editorView->grid().calculateLines(m_editorScene->sceneRect());
+        const auto gridColor = SIC::instance().applicationService()->mindMapData()->gridColor();
+        for (auto && gridLine : gridLines) {
+            addedLineItems.push_back(m_editorScene->addLine(gridLine, gridColor));
+        }
+    }
+    return addedLineItems;
+}
+
+void ApplicationService::removeLineItems(const GridLineVector & lines)
+{
+    for (auto && line : lines) {
+        m_editorScene->removeItem(line);
+    }
+}
+
 void ApplicationService::exportToPng(const ExportParams & exportParams)
 {
     m_editorView->saveZoom();
     zoomForExport();
 
     L().info() << "Exporting a PNG image of size (" << exportParams.imageSize.width() << "x" << exportParams.imageSize.height() << ") to " << exportParams.fileName.toStdString();
+    const auto lines = addGridForExport();
     const auto image = m_editorScene->toImage(exportParams.imageSize, m_editorService->backgroundColor(), exportParams.transparentBackground);
     m_editorView->restoreZoom();
+    removeLineItems(lines);
 
     emit pngExportFinished(image.save(exportParams.fileName));
 }
@@ -335,8 +358,10 @@ void ApplicationService::exportToSvg(const ExportParams & exportParams)
     zoomForExport();
 
     L().info() << "Exporting an SVG image to " << exportParams.fileName.toStdString();
+    const auto lines = addGridForExport();
     m_editorScene->toSvg(exportParams.fileName, QFileInfo { exportParams.fileName }.fileName());
     m_editorView->restoreZoom();
+    removeLineItems(lines);
 
     emit svgExportFinished(true);
 }

src/application_service.hpp

@@ -225,6 +225,9 @@ private slots:
 private:
     void addExistingGraphToScene(bool zoomToFitAfterNodesLoaded = false);
 
+    using GridLineVector = std::vector<QGraphicsLineItem *>;
+    GridLineVector addGridForExport();
+
     double calculateNodeOverlapScore(NodeCR node1, NodeCR node2) const;
 
     void connectGraphToUndoMechanism();
@@ -237,6 +240,8 @@ private slots:
 
     void paste();
 
+    void removeLineItems(const GridLineVector & lines);
+
     void setupMindMapAfterUndoOrRedo();
 
     void updateNodeConnectionActions();

src/core/settings.cpp

@@ -199,9 +199,7 @@ Qt::CheckState loadGridVisibleState()
 {
     QSettings settings;
     settings.beginGroup(settingsGroupMainWindow);
-    const auto gridState = settings.value(gridVisibleStateKey, Qt::Unchecked).toInt();
-    settings.endGroup();
-    return static_cast<Qt::CheckState>(gridState);
+    return static_cast<Qt::CheckState>(settings.value(gridVisibleStateKey, Qt::Unchecked).toInt());
 }
 
 void saveGridVisibleState(int state)

src/core/settings_proxy.hpp

@@ -16,16 +16,21 @@
 #ifndef SETTINGS_PROXY_HPP
 #define SETTINGS_PROXY_HPP
 
-#include "../constants.hpp"
 #include "../scene_items/edge_model.hpp"
 #include "shadow_effect_params.hpp"
 
-#include <memory>
-
 #include <QFont>
 
 namespace Core {
 
+//! Some kind of a frond-end or facade for stateless Settings to enable faster value reads (QSettings can be quite slow)
+//! and to create more complex settings (e.g. setShadowEffect()) that use the Settings API. However, the situation is a
+//! bit of a mess right now as some features still use Settings directly and some features use SettingsProxy.
+//!
+//! The current policy for new settings is to use the Settings::Generic API and hide it behind SettingsProxy to
+//! expose a clean API without visible setting keys or low-level functions.
+//!
+//! SettingsProxy can be accessed via SingleInstanceContainer throughout the application.
 class SettingsProxy
 {
 public: