include/vcl/IconThemeScanner.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   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/.
   8  */
   9
  10 #ifndef INCLUDED_VCL_ICONTHEMESCANNER_HXX
  11 #define INCLUDED_VCL_ICONTHEMESCANNER_HXX
  12
  13 #include <vcl/dllapi.h>
  14
  15 #include <rtl/ustring.hxx>
  16 #include <vcl/IconThemeInfo.hxx>
  17
  18 #include <memory>
  19 #include <vector>
  20
  21 // forward declaration of unit test class. Required for friend relationship.
  22 class IconThemeScannerTest;
  23
  24 namespace vcl {
  25
  26 /** This class scans a folder for icon themes and provides the results.
  27  */
  28 class VCL_DLLPUBLIC IconThemeScanner
  29 {
  30 public:
  31     /** Factory method to create the object.
  32      * Provide a path to search for IconThemes.
  33      */
  34     static std::shared_ptr<IconThemeScanner> Create(const OUString &path);
  35
  36     /** This method will return the standard path where icon themes are located.
  37      */
  38     static OUString
  39     GetStandardIconThemePath();
  40
  41     const std::vector<IconThemeInfo>&
  42     GetFoundIconThemes() const {return mFoundIconThemes;}
  43
  44     /** Get the IconThemeInfo for a theme.
  45      * If the theme id is not among the found themes, a std::runtime_error will be thrown.
  46      * Use IconThemeIsInstalled() to check whether it is available.
  47      */
  48     const IconThemeInfo& GetIconThemeInfo(const OUString& themeId);
  49
  50     /** Checks whether the theme with the provided name has been found in the
  51      * scanned directory.
  52      */
  53     bool
  54     IconThemeIsInstalled(const OUString& themeId) const;
  55
  56 private:
  57     IconThemeScanner();
  58
  59     /** Scan a directory for icon themes.
  60      *
  61      * @return
  62      * There are several cases when this method will fail:
  63      * - The directory does not exist
  64      * - There are no files which match the pattern images_xxx.zip
  65      */
  66     void ScanDirectoryForIconThemes(const OUString &path);
  67
  68     /** Adds the provided icon theme by path.
  69      */
  70     bool
  71     AddIconThemeByPath(const OUString &path);
  72
  73     /** Scans the provided directory for icon themes.
  74      * The returned strings will contain the URLs to the icon themes.
  75      */
  76     static std::vector<OUString>
  77     ReadIconThemesFromPath(const OUString& dir);
  78
  79     /** Check whether a single file is valid */
  80     static bool
  81     FileIsValidIconTheme(const OUString&);
  82
  83     std::vector<IconThemeInfo> mFoundIconThemes;
  84
  85     friend class ::IconThemeScannerTest;
  86 };
  87
  88 } // end namespace vcl
  89
  90 #endif // INCLUDED_VCL_ICONTHEMESCANNER_HXX
  91
  92 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */