1 files changed, 96 insertions, 0 deletions
diff --git a/include/test/screenshot_test.hxx b/include/test/screenshot_test.hxx
new file mode 100644
index 0000000000..801eb80c7b
--- /dev/null
+++ b/include/test/screenshot_test.hxx
@@ -0,0 +1,96 @@
+/* -*- 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/.
+ */
+
+#ifndef INCLUDED_TEST_SCREENSHOT_TEST_HXX
+#define INCLUDED_TEST_SCREENSHOT_TEST_HXX
+
+#include <sal/config.h>
+#include <test/bootstrapfixture.hxx>
+#include <unotest/macros_test.hxx>
+#include <com/sun/star/lang/XComponent.hpp>
+#include <osl/file.hxx>
+#include <vcl/vclptr.hxx>
+#include <vcl/weld.hxx>
+#include <map>
+#include <string_view>
+
+class VclAbstractDialog;
+typedef std::map<OString, sal_uInt32> mapType;
+
+class OOO_DLLPUBLIC_TEST ScreenshotTest : public test::BootstrapFixture, public unotest::MacrosTest
+{
+private:
+    /// The current UI language
+    OUString maCurrentLanguage;
+
+    /// the set of known dialogs and their ID for usage in createDialogByID
+    mapType maKnownDialogs;
+
+    /// parent for non-dialog buildables
+    weld::GenericDialogController maParent;
+    std::unique_ptr<weld::Container> mxParentWidget;
+
+private:
+    /// helpers
+    void implSaveScreenshot(const BitmapEx& rScreenshot, const OUString& rScreenshotId);
+    void saveScreenshot(VclAbstractDialog const& rDialog);
+    void saveScreenshot(weld::Window& rDialog);
+
+    /// helper method to create and dump a dialog based on Builder contents.
+    void dumpDialogToPath(weld::Builder& rDialog);
+
+    /// helper method to populate maKnownDialogs, called in setUp(). Needs to be
+    /// written and has to add entries to maKnownDialogs
+    virtual void registerKnownDialogsByID(mapType& rKnownDialogs) = 0;
+
+    /// dialog creation for known dialogs by ID. Has to be implemented for
+    /// each registered known dialog
+    virtual VclPtr<VclAbstractDialog> createDialogByID(sal_uInt32 nID) = 0;
+
+public:
+    ScreenshotTest();
+    virtual ~ScreenshotTest() override;
+
+    virtual void setUp() override;
+
+    /// Dialog creation for known dialogs by Name (path and UIXMLDescription, *.ui file).
+    /// This uses maKnownDialogs to check if known, and if so, calls createDialogByID
+    /// with the ID from the map
+    VclPtr<VclAbstractDialog> createDialogByName(const OString& rName);
+
+    /// version for AbstractDialogs, the ones created in AbstractDialogFactories
+    void dumpDialogToPath(VclAbstractDialog& rDialog);
+
+    /// fallback version for dialogs for which only the UXMLDescription is known.
+    /// This should be used with care - no active layouting will be done, only the
+    /// VclBuilder will be activated for layouting. Result can thus vary drastically
+    /// compared to the active dialog (can be compared with dialog previewer)
+    void dumpDialogToPath(std::string_view rUIXMLDescription);
+
+    /// helper to process all known dialogs
+    void processAllKnownDialogs();
+
+    /// helper to process an input file containing the UXMLDescriptions
+    /// of the dialogs to dump. It will internally try to detect and open
+    /// as known dialog first. If not successful, it will then use the
+    /// fallback version to dump the dialog.
+    /// The syntax of the input file is as follows:
+    /// - empty lines are allowed
+    /// - lines starting with '#' are treated as comment
+    /// - all other lines should contain a *.ui filename in the same
+    ///   notation as in the dialog constructors(see code)
+    void processDialogBatchFile(std::u16string_view rFile);
+
+    /// const access to known dialogs
+    const mapType& getKnownDialogs() const { return maKnownDialogs; }
+};
+
+#endif // INCLUDED_TEST_SCREENSHOT_TEST_HXX
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */