office-gobmx/vcl/inc/IconThemeSelector.hxx
Caolán McNamara 3d826d780a make some headers private
as shown with ./bin/find-headers-to-move-inside-modules.py

Change-Id: I7662417e76fe00c0fc352957560e104b6c2a3d61
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/87850
Tested-by: Jenkins
Reviewed-by: Caolán McNamara <caolanm@redhat.com>
2020-02-03 20:24:00 +01:00

97 lines
2.8 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_VCL_ICONTHEMESELECTOR_HXX
#define INCLUDED_VCL_ICONTHEMESELECTOR_HXX
#include <rtl/ustring.hxx>
#include <vcl/dllapi.h>
#include <vector>
// forward declaration of unit test class. Required for friend relationship.
class IconThemeSelectorTest;
namespace vcl {
class IconThemeInfo;
/** This class helps to choose an icon theme from a list of installed themes.
*
* The following factors influence the selection:
* -# When high contrast mode is enabled, the high contrast icon theme is selected (if it is installed).
* -# When a preferred theme has been set (e.g., in the gnome desktop settings), that theme is selected.
*/
class VCL_DLLPUBLIC IconThemeSelector {
public:
IconThemeSelector();
/** Select an icon theme from the list of installed themes.
*
* If high contrast mode has been enabled, the highcontrast theme will be selected (if it is available).
*
* @pre
* @p installedThemes must not be empty
*/
OUString
SelectIconTheme(
const std::vector<IconThemeInfo>& installedThemes,
const OUString& theme
) const;
/** Select the standard icon theme for a desktop environment from a list of installed themes.
*
* If a preferred theme has been set, this one will take precedence.
*
* The same logic as in SelectIconTheme() will apply.
*
* @pre
* @p installedThemes must not be empty
*/
OUString
SelectIconThemeForDesktopEnvironment(
const std::vector<IconThemeInfo>& installedThemes,
const OUString& desktopEnvironment) const;
void
SetUseHighContrastTheme(bool);
void
SetPreferredIconTheme(const OUString&, bool bDarkIconTheme);
bool
operator==(const vcl::IconThemeSelector&) const;
bool
operator!=(const vcl::IconThemeSelector&) const;
private:
/** Return the first element of the themes, or the fallback if the vector is empty */
static OUString
ReturnFallback(const std::vector<IconThemeInfo>& installedThemes);
/** The name of the icon theme which is used as fallback */
static const OUStringLiteral FALLBACK_ICON_THEME_ID;
static OUString
GetIconThemeForDesktopEnvironment(const OUString& desktopEnvironment);
OUString mPreferredIconTheme;
bool mUseHighContrastTheme;
bool mPreferDarkIconTheme;
friend class ::IconThemeSelectorTest;
};
} /* namespace vcl */
#endif // INCLUDED_VCL_ICONTHEMESELECTOR_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */