office-gobmx/include/test/screenshot_test.hxx
Noel Grandin 871035d72a loplugin:constparams in various
Change-Id: Id15f3562f42afa6c679cea3c839172557ead0395
Reviewed-on: https://gerrit.libreoffice.org/40624
Tested-by: Jenkins <ci@libreoffice.org>
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
2017-08-01 12:30:55 +02:00

93 lines
3.5 KiB
C++

/* -*- 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/dialog.hxx>
#include <map>
class VclAbstractDialog;
typedef std::map< OString, sal_uInt32 > mapType;
class OOO_DLLPUBLIC_TEST ScreenshotTest : public test::BootstrapFixture, public unotest::MacrosTest
{
private:
/// the target directory for screenshots
OUString m_aScreenshotDirectory;
/// The current UI language
OUString maCurrentLanguage;
/// the set of known dialogs and their ID for usage in createDialogByID
mapType maKnownDialogs;
private:
/// helpers
void implSaveScreenshot(const Bitmap& rScreenshot, const OString& rScreenshotId);
void saveScreenshot(VclAbstractDialog const & rDialog);
void saveScreenshot(Dialog& 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);
/// version for pure vcl-based dialogs
void dumpDialogToPath(Dialog& 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(const OString& 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:
/// - 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)
void processDialogBatchFile(const OUString& 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: */