sc: add UI, undo/redo and test to change sparkline data range

This adds a "edit sparkline" action to the context menu and a
dialog to change the data range of a sparkline. To change a
sparkline using undo/redo, a new class UndoEditSparkline  was
added, which allows to change the attributes of a sparkline and
revert back the old attributes when undoing. This is then used in
the Dialog when setting the changed data range of a sparkline.

To make sure that undo/redo works correctly, a simple unit tests
was added.

Change-Id: I08af1813fa288278bc0d33b0540660b325b17235
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/132748
Tested-by: Jenkins
Reviewed-by: Tomaž Vajngerl <quikee@gmail.com>

12 files changed, 422 insertions, 1 deletions

diff --git a/sc/source/ui/app/scdll.cxx b/sc/source/ui/app/scdll.cxx
index a0bdf08b16c0..58efb29ecb9a 100644
--- a/sc/source/ui/app/scdll.cxx
+++ b/sc/source/ui/app/scdll.cxx
@@ -207,6 +207,7 @@ void ScDLL::Init()
     ScChiSquareTestDialogWrapper        ::RegisterChildWindow(false, pMod);
     ScFourierAnalysisDialogWrapper      ::RegisterChildWindow(false, pMod);
     sc::SparklineDialogWrapper          ::RegisterChildWindow(false, pMod);
+    sc::SparklineDataRangeDialogWrapper ::RegisterChildWindow(false, pMod);
 
     // Redlining Window
     ScAcceptChgDlgWrapper       ::RegisterChildWindow(false, pMod);
diff --git a/sc/source/ui/dialogs/SparklineDataRangeDialog.cxx b/sc/source/ui/dialogs/SparklineDataRangeDialog.cxx
new file mode 100644
index 000000000000..f085e737c77c
--- /dev/null
+++ b/sc/source/ui/dialogs/SparklineDataRangeDialog.cxx
@@ -0,0 +1,202 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+#include <SparklineDataRangeDialog.hxx>
+#include <Sparkline.hxx>
+#include <reffact.hxx>
+#include <docfunc.hxx>
+
+namespace sc
+{
+SparklineDataRangeDialog::SparklineDataRangeDialog(SfxBindings* pBindings,
+                                                   SfxChildWindow* pChildWindow,
+                                                   weld::Window* pWindow, ScViewData& rViewData)
+    : ScAnyRefDlgController(pBindings, pChildWindow, pWindow,
+                            u"modules/scalc/ui/sparklinedatarangedialog.ui",
+                            "SparklineDataRangeDialog")
+    , mrViewData(rViewData)
+    , mrDocument(rViewData.GetDocument())
+    , mpActiveEdit(nullptr)
+    , mbDialogLostFocus(false)
+    , mxButtonOk(m_xBuilder->weld_button("ok"))
+    , mxButtonCancel(m_xBuilder->weld_button("cancel"))
+    , mxDataRangeLabel(m_xBuilder->weld_label("cell-range-label"))
+    , mxDataRangeEdit(new formula::RefEdit(m_xBuilder->weld_entry("cell-range-edit")))
+    , mxDataRangeButton(new formula::RefButton(m_xBuilder->weld_button("cell-range-button")))
+
+{
+    mxDataRangeEdit->SetReferences(this, mxDataRangeLabel.get());
+    mxDataRangeButton->SetReferences(this, mxDataRangeEdit.get());
+
+    mxButtonCancel->connect_clicked(LINK(this, SparklineDataRangeDialog, ButtonClicked));
+    mxButtonOk->connect_clicked(LINK(this, SparklineDataRangeDialog, ButtonClicked));
+
+    mxButtonOk->set_sensitive(false);
+
+    Link<formula::RefEdit&, void> aEditLink
+        = LINK(this, SparklineDataRangeDialog, EditFocusHandler);
+    mxDataRangeEdit->SetGetFocusHdl(aEditLink);
+    aEditLink = LINK(this, SparklineDataRangeDialog, LoseEditFocusHandler);
+    mxDataRangeEdit->SetLoseFocusHdl(aEditLink);
+
+    Link<formula::RefButton&, void> aButtonLink
+        = LINK(this, SparklineDataRangeDialog, ButtonFocusHandler);
+    mxDataRangeButton->SetGetFocusHdl(aButtonLink);
+    aButtonLink = LINK(this, SparklineDataRangeDialog, LoseButtonFocusHandler);
+    mxDataRangeButton->SetLoseFocusHdl(aButtonLink);
+
+    Link<formula::RefEdit&, void> aModifyLink
+        = LINK(this, SparklineDataRangeDialog, RefInputModifyHandler);
+    mxDataRangeEdit->SetModifyHdl(aModifyLink);
+
+    setupValues();
+
+    mxDataRangeEdit->GrabFocus();
+}
+
+SparklineDataRangeDialog::~SparklineDataRangeDialog() = default;
+
+void SparklineDataRangeDialog::setupValues()
+{
+    ScAddress aCurrentAddress = mrViewData.GetCurPos();
+    mpSparkline = mrDocument.GetSparkline(aCurrentAddress);
+
+    if (mpSparkline)
+    {
+        ScRangeList aRangeList(mpSparkline->getInputRange());
+        if (!aRangeList.empty())
+        {
+            maDataRange = aRangeList[0];
+            OUString aString
+                = maDataRange.Format(mrDocument, ScRefFlags::VALID | ScRefFlags::TAB_3D,
+                                     mrDocument.GetAddressConvention());
+            mxDataRangeEdit->SetRefString(aString);
+            mxButtonOk->set_sensitive(true);
+        }
+    }
+}
+
+void SparklineDataRangeDialog::Close()
+{
+    DoClose(sc::SparklineDataRangeDialogWrapper::GetChildWindowId());
+}
+
+void SparklineDataRangeDialog::SetActive()
+{
+    if (mbDialogLostFocus)
+    {
+        mbDialogLostFocus = false;
+        if (mpActiveEdit)
+            mpActiveEdit->GrabFocus();
+    }
+    else
+    {
+        m_xDialog->grab_focus();
+    }
+    RefInputDone();
+}
+
+void SparklineDataRangeDialog::SetReference(const ScRange& rReferenceRange, ScDocument& rDocument)
+{
+    if (mpActiveEdit)
+    {
+        if (rReferenceRange.aStart != rReferenceRange.aEnd)
+            RefInputStart(mpActiveEdit);
+
+        OUString aString;
+        const ScRefFlags eFlags = ScRefFlags::VALID | ScRefFlags::TAB_3D;
+        auto eAddressConvention = rDocument.GetAddressConvention();
+
+        if (mpActiveEdit == mxDataRangeEdit.get())
+        {
+            maDataRange = rReferenceRange;
+            aString = maDataRange.Format(rDocument, eFlags, eAddressConvention);
+            mxDataRangeEdit->SetRefString(aString);
+        }
+    }
+}
+
+IMPL_LINK(SparklineDataRangeDialog, EditFocusHandler, formula::RefEdit&, rEdit, void)
+{
+    if (mxDataRangeEdit.get() == &rEdit)
+        mpActiveEdit = mxDataRangeEdit.get();
+    else
+        mpActiveEdit = nullptr;
+
+    if (mpActiveEdit)
+        mpActiveEdit->SelectAll();
+}
+
+IMPL_LINK(SparklineDataRangeDialog, ButtonFocusHandler, formula::RefButton&, rButton, void)
+{
+    if (mxDataRangeButton.get() == &rButton)
+        mpActiveEdit = mxDataRangeEdit.get();
+    else
+        mpActiveEdit = nullptr;
+
+    if (mpActiveEdit)
+        mpActiveEdit->SelectAll();
+}
+
+IMPL_LINK_NOARG(SparklineDataRangeDialog, LoseEditFocusHandler, formula::RefEdit&, void)
+{
+    mbDialogLostFocus = !m_xDialog->has_toplevel_focus();
+}
+
+IMPL_LINK_NOARG(SparklineDataRangeDialog, LoseButtonFocusHandler, formula::RefButton&, void)
+{
+    mbDialogLostFocus = !m_xDialog->has_toplevel_focus();
+}
+
+IMPL_LINK_NOARG(SparklineDataRangeDialog, RefInputModifyHandler, formula::RefEdit&, void)
+{
+    if (mpActiveEdit)
+    {
+        if (mpActiveEdit == mxDataRangeEdit.get())
+        {
+            ScRangeList aRangeList;
+            bool bValid = ParseWithNames(aRangeList, mxDataRangeEdit->GetText(), mrDocument);
+            const ScRange* pRange = (bValid && aRangeList.size() == 1) ? &aRangeList[0] : nullptr;
+            if (pRange)
+            {
+                maDataRange = *pRange;
+                mxDataRangeEdit->StartUpdateData();
+            }
+            else
+            {
+                maDataRange = ScRange(ScAddress::INITIALIZE_INVALID);
+            }
+        }
+    }
+}
+
+IMPL_LINK(SparklineDataRangeDialog, ButtonClicked, weld::Button&, rButton, void)
+{
+    if (mxButtonOk.get() == &rButton)
+    {
+        perform();
+        response(RET_OK);
+    }
+    else
+    {
+        response(RET_CANCEL);
+    }
+}
+
+void SparklineDataRangeDialog::perform()
+{
+    ScRangeList aList{ maDataRange };
+
+    auto& rDocFunc = mrViewData.GetDocShell()->GetDocFunc();
+    rDocFunc.ChangeSparkline(mpSparkline, mrViewData.GetTabNo(), aList);
+}
+
+} // end sc
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/sc/source/ui/docshell/docfunc.cxx b/sc/source/ui/docshell/docfunc.cxx
index 411658e1136a..eee39e0e81f5 100644
--- a/sc/source/ui/docshell/docfunc.cxx
+++ b/sc/source/ui/docshell/docfunc.cxx
@@ -104,6 +104,7 @@
 #include <undo/UndoEditSparklineGroup.hxx>
 #include <undo/UndoUngroupSparklines.hxx>
 #include <undo/UndoGroupSparklines.hxx>
+#include <undo/UndoEditSparkline.hxx>
 #include <config_features.h>
 
 #include <memory>
@@ -5893,7 +5894,7 @@ bool ScDocFunc::ChangeSparklineGroupAttributes(std::shared_ptr<sc::SparklineGrou
 bool ScDocFunc::GroupSparklines(ScRange const& rRange, std::shared_ptr<sc::SparklineGroup> const& rpGroup)
 {
     auto pUndo = std::make_unique<sc::UndoGroupSparklines>(rDocShell, rRange, rpGroup);
-    // ungroup sparklines by "redoing"
+    // group sparklines by "redoing"
     pUndo->Redo();
     rDocShell.GetUndoManager()->AddUndoAction(std::move(pUndo));
     return true;
@@ -5908,4 +5909,13 @@ bool ScDocFunc::UngroupSparklines(ScRange const& rRange)
     return true;
 }
 
+bool ScDocFunc::ChangeSparkline(std::shared_ptr<sc::Sparkline> const& rpSparkline, SCTAB nTab, ScRangeList const& rDataRange)
+{
+    auto pUndo = std::make_unique<sc::UndoEditSparkline>(rDocShell, rpSparkline, nTab, rDataRange);
+    // change sparkline by "redoing"
+    pUndo->Redo();
+    rDocShell.GetUndoManager()->AddUndoAction(std::move(pUndo));
+    return true;
+}
+
 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/sc/source/ui/inc/SparklineDataRangeDialog.hxx b/sc/source/ui/inc/SparklineDataRangeDialog.hxx
new file mode 100644
index 000000000000..41d882c8bc40
--- /dev/null
+++ b/sc/source/ui/inc/SparklineDataRangeDialog.hxx
@@ -0,0 +1,66 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+#pragma once
+
+#include <address.hxx>
+#include "anyrefdg.hxx"
+#include "viewdata.hxx"
+
+#include <SparklineGroup.hxx>
+#include <SparklineAttributes.hxx>
+
+class ColorListBox;
+
+namespace sc
+{
+class SparklineDataRangeDialog : public ScAnyRefDlgController
+{
+private:
+    ScViewData& mrViewData;
+    ScDocument& mrDocument;
+
+    std::shared_ptr<sc::Sparkline> mpSparkline;
+
+    ScRange maDataRange;
+
+    formula::RefEdit* mpActiveEdit;
+    bool mbDialogLostFocus;
+
+    std::unique_ptr<weld::Button> mxButtonOk;
+    std::unique_ptr<weld::Button> mxButtonCancel;
+
+    std::unique_ptr<weld::Label> mxDataRangeLabel;
+    std::unique_ptr<formula::RefEdit> mxDataRangeEdit;
+    std::unique_ptr<formula::RefButton> mxDataRangeButton;
+
+    DECL_LINK(ButtonClicked, weld::Button&, void);
+    DECL_LINK(EditFocusHandler, formula::RefEdit&, void);
+    DECL_LINK(ButtonFocusHandler, formula::RefButton&, void);
+    DECL_LINK(LoseEditFocusHandler, formula::RefEdit&, void);
+    DECL_LINK(LoseButtonFocusHandler, formula::RefButton&, void);
+    DECL_LINK(RefInputModifyHandler, formula::RefEdit&, void);
+
+    void setupValues();
+
+    void perform();
+    bool checkValidInputOutput();
+
+public:
+    SparklineDataRangeDialog(SfxBindings* pBindings, SfxChildWindow* pChildWindow,
+                             weld::Window* pWindow, ScViewData& rViewData);
+    virtual ~SparklineDataRangeDialog() override;
+
+    void SetReference(const ScRange& rRef, ScDocument& rDocument) override;
+    void SetActive() override;
+    void Close() override;
+};
+}
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/sc/source/ui/inc/docfunc.hxx b/sc/source/ui/inc/docfunc.hxx
index 938f96835b4d..f7ca3e422bc8 100644
--- a/sc/source/ui/inc/docfunc.hxx
+++ b/sc/source/ui/inc/docfunc.hxx
@@ -56,6 +56,7 @@ namespace sc
     struct ColRowSpan;
     class SparklineAttributes;
     class SparklineGroup;
+    class Sparkline;
 }
 
 class ScDocFunc
@@ -246,6 +247,7 @@ public:
                                                      sc::SparklineAttributes const& rNewAttributes);
     SC_DLLPUBLIC bool GroupSparklines(ScRange const& rRange, std::shared_ptr<sc::SparklineGroup> const& rpGroup);
     SC_DLLPUBLIC bool UngroupSparklines(ScRange const& rRange);
+    SC_DLLPUBLIC bool ChangeSparkline(std::shared_ptr<sc::Sparkline> const& rpSparkline, SCTAB nTab, ScRangeList const& rDataRange);
 
 private:
     void ProtectDocument(const ScDocProtection& rProtect);
diff --git a/sc/source/ui/inc/reffact.hxx b/sc/source/ui/inc/reffact.hxx
index 4bf1254b4556..1394418ffa85 100644
--- a/sc/source/ui/inc/reffact.hxx
+++ b/sc/source/ui/inc/reffact.hxx
@@ -157,6 +157,13 @@ private:
     SparklineDialogWrapper() = delete;
 };
 
+class SparklineDataRangeDialogWrapper :
+    public ChildControllerWrapper<SID_SPARKLINE_DATA_RANGE_DIALOG>
+{
+private:
+    SparklineDataRangeDialogWrapper() = delete;
+};
+
 }
 
 class ScAcceptChgDlgWrapper : public SfxChildWindow
diff --git a/sc/source/ui/inc/undo/UndoEditSparkline.hxx b/sc/source/ui/inc/undo/UndoEditSparkline.hxx
new file mode 100644
index 000000000000..4e33eaa1f5df
--- /dev/null
+++ b/sc/source/ui/inc/undo/UndoEditSparkline.hxx
@@ -0,0 +1,47 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ */
+
+#pragma once
+
+#include <undobase.hxx>
+#include <address.hxx>
+#include <rangelst.hxx>
+#include <memory>
+
+namespace sc
+{
+class Sparkline;
+struct SparklineData;
+
+/** Undo action for editing a Sparkline */
+class UndoEditSparkline : public ScSimpleUndo
+{
+private:
+    std::shared_ptr<sc::Sparkline> mpSparkline;
+    SCTAB mnTab;
+    ScRangeList maOldDataRange;
+    ScRangeList maNewDataRange;
+
+public:
+    UndoEditSparkline(ScDocShell& rDocShell, std::shared_ptr<sc::Sparkline> const& rpSparkline,
+                      SCTAB nTab, ScRangeList const& rDataRange);
+
+    virtual ~UndoEditSparkline() override;
+
+    void Undo() override;
+    void Redo() override;
+    bool CanRepeat(SfxRepeatTarget& rTarget) const override;
+    void Repeat(SfxRepeatTarget& rTarget) override;
+    OUString GetComment() const override;
+};
+
+} // namespace sc
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/sc/source/ui/undo/UndoEditSparkline.cxx b/sc/source/ui/undo/UndoEditSparkline.cxx
new file mode 100644
index 000000000000..b1f6f38f5dc4
--- /dev/null
+++ b/sc/source/ui/undo/UndoEditSparkline.cxx
@@ -0,0 +1,63 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ */
+
+#include <undo/UndoEditSparkline.hxx>
+#include <globstr.hrc>
+#include <scresid.hxx>
+
+#include <Sparkline.hxx>
+#include <SparklineGroup.hxx>
+
+namespace sc
+{
+UndoEditSparkline::UndoEditSparkline(ScDocShell& rDocShell,
+                                     std::shared_ptr<sc::Sparkline> const& rpSparkline, SCTAB nTab,
+                                     ScRangeList const& rDataRange)
+    : ScSimpleUndo(&rDocShell)
+    , mpSparkline(rpSparkline)
+    , mnTab(nTab)
+    , maOldDataRange(mpSparkline->getInputRange())
+    , maNewDataRange(rDataRange)
+{
+}
+
+UndoEditSparkline::~UndoEditSparkline() = default;
+
+void UndoEditSparkline::Undo()
+{
+    BeginUndo();
+
+    mpSparkline->setInputRange(maOldDataRange);
+
+    pDocShell->PostPaintCell(ScAddress(mpSparkline->getColumn(), mpSparkline->getRow(), mnTab));
+
+    EndUndo();
+}
+
+void UndoEditSparkline::Redo()
+{
+    BeginRedo();
+
+    mpSparkline->setInputRange(maNewDataRange);
+
+    pDocShell->PostPaintCell(ScAddress(mpSparkline->getColumn(), mpSparkline->getRow(), mnTab));
+
+    EndRedo();
+}
+
+void UndoEditSparkline::Repeat(SfxRepeatTarget& /*rTarget*/) {}
+
+bool UndoEditSparkline::CanRepeat(SfxRepeatTarget& /*rTarget*/) const { return false; }
+
+OUString UndoEditSparkline::GetComment() const { return ScResId(STR_UNDO_EDIT_SPARKLINE); }
+
+} // end sc namespace
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/sc/source/ui/view/cellsh.cxx b/sc/source/ui/view/cellsh.cxx
index 0824054c676b..215587cfa0e5 100644
--- a/sc/source/ui/view/cellsh.cxx
+++ b/sc/source/ui/view/cellsh.cxx
@@ -194,6 +194,12 @@ void ScCellShell::GetBlockState( SfxItemSet& rSet )
             }
             break;
 
+            case SID_EDIT_SPARKLINE:
+            {
+                bDisable = !rDoc.HasSparkline(GetViewData().GetCurPos());
+            }
+            break;
+
             case SID_DELETE_SPARKLINE:
             case SID_EDIT_SPARKLINE_GROUP:
             case SID_DELETE_SPARKLINE_GROUP:
diff --git a/sc/source/ui/view/cellsh1.cxx b/sc/source/ui/view/cellsh1.cxx
index fc221645a5d6..943df5b926ff 100644
--- a/sc/source/ui/view/cellsh1.cxx
+++ b/sc/source/ui/view/cellsh1.cxx
@@ -1063,6 +1063,16 @@ void ScCellShell::ExecuteEdit( SfxRequest& rReq )
         }
         break;
 
+        case SID_EDIT_SPARKLINE:
+        {
+            sal_uInt16 nId  = sc::SparklineDataRangeDialogWrapper::GetChildWindowId();
+            SfxViewFrame* pViewFrame = pTabViewShell->GetViewFrame();
+            SfxChildWindow* pWindow = pViewFrame->GetChildWindow(nId);
+            pScMod->SetRefDialog(nId, pWindow == nullptr);
+            rReq.Done();
+        }
+        break;
+
         case SID_DELETE_SPARKLINE:
         {
             pTabViewShell->DeleteContents(InsertDeleteFlags::SPARKLINES);
diff --git a/sc/source/ui/view/tabvwsh.cxx b/sc/source/ui/view/tabvwsh.cxx
index 7337b5cc2f0d..669c7554f3bd 100644
--- a/sc/source/ui/view/tabvwsh.cxx
+++ b/sc/source/ui/view/tabvwsh.cxx
@@ -98,6 +98,7 @@ void ScTabViewShell::InitInterface_Impl()
     GetStaticInterface()->RegisterChildWindow(ScFourierAnalysisDialogWrapper::GetChildWindowId());
     GetStaticInterface()->RegisterChildWindow(ScCondFormatDlgWrapper::GetChildWindowId());
     GetStaticInterface()->RegisterChildWindow(sc::SparklineDialogWrapper::GetChildWindowId());
+    GetStaticInterface()->RegisterChildWindow(sc::SparklineDataRangeDialogWrapper::GetChildWindowId());
 }
 
 SFX_IMPL_NAMED_VIEWFACTORY( ScTabViewShell, "Default" )
diff --git a/sc/source/ui/view/tabvwshc.cxx b/sc/source/ui/view/tabvwshc.cxx
index 667992e57da9..5ea8701a0dbe 100644
--- a/sc/source/ui/view/tabvwshc.cxx
+++ b/sc/source/ui/view/tabvwshc.cxx
@@ -70,6 +70,7 @@
 
 #include <PivotLayoutDialog.hxx>
 #include <SparklineDialog.hxx>
+#include <SparklineDataRangeDialog.hxx>
 
 #include <comphelper/lok.hxx>
 #include <o3tl/make_shared.hxx>
@@ -242,6 +243,11 @@ std::shared_ptr<SfxModelessDialogController> ScTabViewShell::CreateRefDialogCont
             xResult = std::make_shared<sc::SparklineDialog>(pB, pCW, pParent, GetViewData());
             break;
         }
+        case SID_SPARKLINE_DATA_RANGE_DIALOG:
+        {
+            xResult = std::make_shared<sc::SparklineDataRangeDialog>(pB, pCW, pParent, GetViewData());
+            break;
+        }
         case SID_DEFINE_DBNAME:
         {
             // when called for an existing range, then mark