1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
3 * This file is part of the LibreOffice project.
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
10 #ifndef INCLUDED_VCL_ICONTHEMESCANNER_HXX
11 #define INCLUDED_VCL_ICONTHEMESCANNER_HXX
13 #include <vcl/dllapi.h>
14 #include <tools/solar.h>
16 #include <rtl/ustring.hxx>
21 // forward declaration of unit test class. Required for friend relationship.
22 class IconThemeScannerTest
;
32 /** This class scans a folder for icon themes and provides the results.
34 class VCL_DLLPUBLIC IconThemeScanner
39 /** Factory method to create the object.
40 * Provide a path to search for IconThemes.
42 static std::shared_ptr
<IconThemeScanner
> Create(const OUString
&path
);
44 /** This method will return the standard path where icon themes are located.
47 GetStandardIconThemePath();
49 const std::vector
<IconThemeInfo
>&
50 GetFoundIconThemes() const {return mFoundIconThemes
;}
52 /** Get the IconThemeInfo for a theme.
53 * If the theme id is not among the found themes, a std::runtime_error will be thrown.
54 * Use IconThemeIsInstalled() to check whether it is available.
56 const IconThemeInfo
& GetIconThemeInfo(const OUString
& themeId
);
58 /** Checks whether the theme with the provided name has been found in the
62 IconThemeIsInstalled(const OUString
& themeId
) const;
67 /** Scan a directory for icon themes.
70 * This method will return true on success.
71 * There are several cases when this method will fail:
72 * - The directory does not exist
73 * - There are no files which which match the pattern images_xxx.zip
76 ScanDirectoryForIconThemes(const OUString
&path
);
78 /** Adds the provided icon theme by path.
81 AddIconThemeByPath(const OUString
&path
);
83 /** Scans the provided directory for icon themes.
84 * The returned strings will contain the URLs to the icon themes.
86 static std::vector
<OUString
>
87 ReadIconThemesFromPath(const OUString
& dir
);
89 /** Check whether a single file is valid */
91 FileIsValidIconTheme(const OUString
&);
93 std::vector
<IconThemeInfo
> mFoundIconThemes
;
95 friend class ::IconThemeScannerTest
;
98 } // end namespace vcl
100 #endif // INCLUDED_VCL_ICONTHEMESCANNER_HXX
102 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */