diff options
Diffstat (limited to 'uui/qa')
| -rw-r--r-- | uui/qa/unit/data/uui-dialogs-test.txt | 44 | ||||
| -rw-r--r-- | uui/qa/unit/uui-dialogs-test.cxx | 150 |
2 files changed, 194 insertions, 0 deletions
diff --git a/uui/qa/unit/data/uui-dialogs-test.txt b/uui/qa/unit/data/uui-dialogs-test.txt new file mode 100644 index 000000000000..c33944c94082 --- /dev/null +++ b/uui/qa/unit/data/uui-dialogs-test.txt @@ -0,0 +1,44 @@ +# -*- 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/. +# + +# This file contains all dialogs that the unit tests in the module +# will work on if it is in script mode. It will read one-by-one, +# try to open it and create a screenshot that will be saved in +# workdir/screenshots using the pattern of the ui-file name. +# +# Syntax: +# - emty 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) + +# +# The 'known' dialogs which have a hard-coded representation +# in registerKnownDialogsByID/createDialogByID +# + +# No known dialogs in uui for now + +# +# Dialogs without a hard-coded representation. These will +# be visualized using a fallback based on VclBuilder +# + +# currently deactivated, leads to problems and the test to not work +# This is typically a hint that these should be hard-coded in the +# test case since they need some document and model data to work + +uui/ui/authfallback.ui +uui/ui/filterselect.ui +uui/ui/logindialog.ui +uui/ui/setmasterpassworddlg.ui +uui/ui/masterpassworddlg.ui +uui/ui/simplenameclash.ui +uui/ui/password.ui +uui/ui/macrowarnmedium.ui diff --git a/uui/qa/unit/uui-dialogs-test.cxx b/uui/qa/unit/uui-dialogs-test.cxx new file mode 100644 index 000000000000..f3a7d0c665ce --- /dev/null +++ b/uui/qa/unit/uui-dialogs-test.cxx @@ -0,0 +1,150 @@ +/* -*- 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 <sal/config.h> +#include <test/screenshot_test.hxx> +#include <rtl/strbuf.hxx> +#include <osl/file.hxx> +#include <sfx2/app.hxx> +#include <vcl/abstdlg.hxx> + +using namespace ::com::sun::star; + +/// Test opening a dialog in uui +class UuiDialogsTest : public ScreenshotTest +{ +private: + /// helper method to populate KnownDialogs, called in setUp(). Needs to be + /// written and has to add entries to KnownDialogs + virtual void registerKnownDialogsByID(mapType& rKnownDialogs) override; + + /// dialog creation for known dialogs by ID. Has to be implemented for + /// each registered known dialog + virtual VclAbstractDialog* createDialogByID(sal_uInt32 nID) override; + +public: + UuiDialogsTest(); + virtual ~UuiDialogsTest(); + + virtual void setUp() override; + + // try to open a dialog + void openAnyDialog(); + + CPPUNIT_TEST_SUITE(UuiDialogsTest); + CPPUNIT_TEST(openAnyDialog); + CPPUNIT_TEST_SUITE_END(); +}; + +UuiDialogsTest::UuiDialogsTest() +{ +} + +UuiDialogsTest::~UuiDialogsTest() +{ +} + +void UuiDialogsTest::setUp() +{ + ScreenshotTest::setUp(); +} + +void UuiDialogsTest::registerKnownDialogsByID(mapType& /*rKnownDialogs*/) +{ + // fill map of known dilogs +} + +VclAbstractDialog* UuiDialogsTest::createDialogByID(sal_uInt32 /*nID*/) +{ + return nullptr; +} + +void UuiDialogsTest::openAnyDialog() +{ + /// example how to process an input file containing the UXMLDescriptions of the dialogs + /// to dump + if (true) + { + test::Directories aDirectories; + OUString aURL = aDirectories.getURLFromSrc("uui/qa/unit/data/uui-dialogs-test.txt"); + SvFileStream aStream(aURL, StreamMode::READ); + OString aNextUIFile; + const OString aComment("#"); + + while (aStream.ReadLine(aNextUIFile)) + { + if (!aNextUIFile.isEmpty() && !aNextUIFile.startsWith(aComment)) + { + // first check if it's a known dialog + std::unique_ptr<VclAbstractDialog> pDlg(createDialogByName(aNextUIFile)); + + if (pDlg) + { + // known dialog, dump screenshot to path + dumpDialogToPath(*pDlg); + } + else + { + // unknown dialog, try fallback to generic created + // VclBuilder-generated instance. Keep in mind that Dialogs + // using this mechanism will probably not be layouted well + // since the setup/initialization part is missing. Thus, + // only use for fallback when only the UI file is available. + dumpDialogToPath(aNextUIFile); + } + } + } + } + + /// example how to dump all known dialogs + if (false) + { + // example for SfxTabDialog: 5 -> "modules/sdraw/ui/drawpagedialog.ui" + // example for TabDialog: 22 -> "modules/simpress/ui/headerfooterdialog.ui" + // example for self-adapted wizard: 0 -> "modules/simpress/ui/publishingdialog.ui" + for (mapType::const_iterator i = getKnownDialogs().begin(); i != getKnownDialogs().end(); i++) + { + std::unique_ptr<VclAbstractDialog> pDlg(createDialogByID((*i).second)); + + if (pDlg) + { + // known dialog, dump screenshot to path + dumpDialogToPath(*pDlg); + } + else + { + // unknown dialog, should not happen in this basic loop. + // You have probably forgotten to add a case and + // implementastion to createDialogByID, please do this + } + } + } + + /// example how to dump a dialog using fallback functionality + if (false) + { + // unknown dialog, try fallback to generic created + // VclBuilder-generated instance. Keep in mind that Dialogs + // using this mechanism will probably not be layouted well + // since the setup/initialization part is missing. Thus, + // only use for fallback when only the UI file is available. + // + // Take any example here, it's only for demonstration - using + // even a known one to demonstrate the fallback possibility + const OString aUIXMLDescription("uui/ui/authfallback.ui"); + + dumpDialogToPath(aUIXMLDescription); + } +} + +CPPUNIT_TEST_SUITE_REGISTRATION(UuiDialogsTest); + +CPPUNIT_PLUGIN_IMPLEMENT(); + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |