blob: 825a0e14cafab548185f00e8c04cca48580178be (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
/* -*- 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_ICONTHEMEINFO_HXX
#define INCLUDED_VCL_ICONTHEMEINFO_HXX
#include <vcl/dllapi.h>
#include <tools/gen.hxx>
#include <rtl/ustring.hxx>
#include <vector>
// forward declaration of unit test classes. Required for friend relationship.
class IconThemeInfoTest;
class IconThemeSelectorTest;
class IconThemeScannerTest;
namespace vcl {
/** This class provides information about an icon theme.
*/
class VCL_DLLPUBLIC IconThemeInfo {
public:
/** The name of the icon theme to use for high contrast mode */
static const OUStringLiteral HIGH_CONTRAST_ID;
/** Construct an IconThemeInfo from the URL to a file.
* This method will throw a std::runtime_error if the URL cannot be properly parsed.
* Check the URL with UrlCanBeParsed() first.
*/
IconThemeInfo(const OUString& urlToFile);
const OUString& GetDisplayName() const {return mDisplayName;}
const OUString& GetThemeId() const { return mThemeId; }
const OUString& GetUrlToFile() const { return mUrlToFile; }
/** Obtain the icon size by theme name.
* @internal
* It is not clear where this information belongs to. The sizes were hard-coded before they moved here.
* Maybe there is a way to determine the sizes from the icon theme packages.
*/
static Size SizeByThemeName(const OUString&);
/** Check whether an IconThemeInfo can be constructed from a URL */
static bool UrlCanBeParsed(const OUString& url);
/** Find an icon theme by its id in a vector.
* Throws a runtime_error if the theme is not contained in the vector
*/
static const vcl::IconThemeInfo&
FindIconThemeById(const std::vector<vcl::IconThemeInfo>& themes, const OUString& themeId);
/** Check whether a theme with a specified id is in a vector of IconThemeInfo */
static bool
IconThemeIsInVector(const std::vector<vcl::IconThemeInfo>& themes, const OUString& themeId);
private:
/** private constructor for testing purposes only */
IconThemeInfo();
/** Determine the icon theme name from the filename
* If the name has an underscore, the name is taken from the first underscore to the last dot,
* e.g., images_oxygen.zip becomes oxygen
* If the name does not have an underscore in it, the whole name until the last dot is returned,
* e.g. default.zip becomes default
*/
static OUString FileNameToThemeId(const OUString&);
/** Creates the display name for the given id of a file.
* Currently, we only uppercase the id.
*/
static OUString ThemeIdToDisplayName(const OUString&);
/** The name which is presented to the user */
OUString mDisplayName;
/** The theme id. This id is used in ... to determine the file name */
OUString mThemeId;
/** The url to the icon theme package */
OUString mUrlToFile;
friend class ::IconThemeInfoTest;
friend class ::IconThemeScannerTest;
friend class ::IconThemeSelectorTest;
};
} // namespace vcl
#endif // INCLUDED_VCL_ICONTHEMEINFO_HXX
|
