tdf#125969 cui: add in-use area image to bitmap list

This fixes a five year old (non-)easyhack with 3 duplicates.
Note the nice-to-have dependencies in the bug report(s).

When the document has a unique background (area) image,
it is now added to the list of available images
IF/WHEN the user looks in the area tab.
This allows the user to switch back after changing,
or re-use it in other places in the document.

Most of this patch ended up being plumbing to ensure that
this added image is ONLY available to the current document,
because it MUST NOT be saved to the user profile.

This change affects all apps and all types of areas: NICE
-tested Writer pages, paragraphs, headers, textbox, sidebar(page)
-tested Calc page style
-tested Draw page, sidebar(page), textbox

Caveats:
-the bitmap list is NOT updated at the time of document import,
only when area property inspected.
(The bug requesting inclusion at the time of import is tdf#100832).

make -srj1 UITest_writer_tests8 \
UITEST_TEST_NAME=tdf125969.tdf125969.test_tdf125969 \
SAL_USE_VCLPLUGIN=gen

Change-Id: Ic9fea9b199602c4df1376e781d5df019526473d5
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/176253
Tested-by: Jenkins
Reviewed-by: Justin Luth <jluth@mail.com>

2 files changed, 81 insertions, 0 deletions

diff --git a/sw/qa/uitest/data/paragraphAreaFill.odt b/sw/qa/uitest/data/paragraphAreaFill.odt
new file mode 100644
index 000000000000..01baf1592621
--- /dev/null
+++ b/sw/qa/uitest/data/paragraphAreaFill.odt
diff --git a/sw/qa/uitest/writer_tests8/tdf125969.py b/sw/qa/uitest/writer_tests8/tdf125969.py
new file mode 100644
index 000000000000..2334bec06fc4
--- /dev/null
+++ b/sw/qa/uitest/writer_tests8/tdf125969.py
@@ -0,0 +1,81 @@
+# -*- tab-width: 4; indent-tabs-mode: nil; py-indent-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/.
+#
+from libreoffice.uno.propertyvalue import mkPropertyValues
+
+from uitest.framework import UITestCase
+from uitest.uihelper.common import get_url_for_data_file
+from uitest.uihelper.common import select_pos, get_state_as_dict
+import time
+
+# bug 125969: make in-use bitmap-area-fill available for re-use, but ONLY IN THE SAME DOCUMENT
+class tdf125969(UITestCase):
+
+    number_of_images = 0
+
+    def click_button(self, dialog, button):
+        xButton = dialog.getChild(button)
+        xButton.executeAction("CLICK", tuple())
+
+    def test_tdf125969(self):
+        with self.ui_test.load_file(get_url_for_data_file("paragraphAreaFill.odt")):
+            xWriterDoc = self.xUITest.getTopFocusWindow()
+            xWriterEdit = xWriterDoc.getChild("writer_edit")
+
+            self.xUITest.executeCommand(".uno:Sidebar") #turn on sidebar
+            xWriterEdit.executeAction("SIDEBAR", mkPropertyValues({"PANEL": "PageStylesPanel"}))
+
+            # Get baseline from sidebar: count number of initially available bitmaps by default
+            backgroundType = xWriterEdit.getChild('bgselect') #type of background: color, gradient, ...
+            self.ui_test.wait_until_property_is_updated(backgroundType, "SelectEntryText", "Bitmap")
+
+            imageCollection = xWriterEdit.getChild("lbbitmap") #listbox containing image names
+            number_of_images = get_state_as_dict(imageCollection)["EntryCount"]
+            # print (get_state_as_dict(imageCollection))
+            # time.sleep (10)
+
+            # The paragraph area has a custom background logo - which we want to become available
+            # for re-use everywhere as a background fill
+
+            # visit the paragraph background property - which now auto-adds it to the collection
+            with self.ui_test.execute_dialog_through_command(".uno:ParagraphDialog", close_button="cancel") as xDialog:
+                tabcontrol = xDialog.getChild("tabcontrol")
+                select_pos(tabcontrol, "8") # area tab
+                #time.sleep(1)
+
+            self.ui_test.wait_until_property_is_updated(imageCollection, "SelectEntryText", "Painted White")
+            # xToolkit = self.xContext.ServiceManager.createInstance('com.sun.star.awt.Toolkit')
+            # xToolkit.waitUntilAllIdlesDispatched()
+            time.sleep (1)
+            # test: the paragraph's wasta-offline logo was added and the list box was refreshed
+            self.assertEqual(int(number_of_images) + 1, int(get_state_as_dict(imageCollection)["EntryCount"]))
+
+        # A new document must not have access to the collected images from another document
+        with self.ui_test.create_doc_in_start_center("writer"):
+            xWriterDoc = self.xUITest.getTopFocusWindow()
+            xWriterEdit = xWriterDoc.getChild("writer_edit")
+
+            # because I don't know how to change the sidebar to bitmap mode, use the page dialog
+            with self.ui_test.execute_dialog_through_command(".uno:PageDialog", close_button="ok") as xDialog:
+                tabcontrol = xDialog.getChild("tabcontrol")
+                select_pos(tabcontrol, "2") # area tab
+                self.click_button(xDialog, 'btnbitmap')
+                #time.sleep (2)
+
+            backgroundType = xWriterEdit.getChild('bgselect')
+            imageCollection = xWriterEdit.getChild("lbbitmap")
+            self.ui_test.wait_until_property_is_updated(backgroundType, "SelectEntryText", "Bitmap")
+            # This number MUST NOT be higher than the initial state.
+            # We must not allow document images to leak into the user profile
+            self.assertEqual(number_of_images, get_state_as_dict(imageCollection)["EntryCount"])
+            #time.sleep (10)
+
+            # xWriterEdit.getChild("bogus for debugging")
+
+        self.xUITest.executeCommand(".uno:Sidebar") # good idea to turn off sidebar again
+# vim: set shiftwidth=4 softtabstop=4 expandtab: