src/uisupport/icon.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2019 by the Quassel Project                        *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) version 3.                                           *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  19  ***************************************************************************/
  20
  21 #pragma once
  22
  23 #include <vector>
  24
  25 #include <QIcon>
  26 #include <QString>
  27
  28 namespace icon {
  29
  30 /**
  31  * Gets an icon from the current icon theme.
  32  *
  33  * If the theme does not provide the icon, tries to load the icon from the
  34  * fallback path, if given.
  35  *
  36  * If no icon can be found, a warning is displayed and a null icon returned.
  37  *
  38  * @param iconName     Icon name
  39  * @param fallbackPath Full path to a fallback icon
  40  * @returns The requested icon, if available
  41  */
  42 QIcon get(const QString &iconName, const QString &fallbackPath = {});
  43
  44 /**
  45  * Gets an icon from the current icon theme.
  46  *
  47  * If the theme does not provide any of the given icon names, tries to load the
  48  * icon from the fallback path, if given.
  49  *
  50  * If no icon can be found, a warning is displayed and a null icon returned.
  51  *
  52  * @param iconNames    List of icon names (first match wins)
  53  * @param fallbackPath Full path to a fallback icon
  54  * @returns The requested icon, if available
  55  */
  56 QIcon get(const std::vector<QString> &iconNames, const QString &fallbackPath = {});
  57
  58 }