src/uisupport/icon.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005-2018 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 "uisupport-export.h"
  24
  25 #include <vector>
  26
  27 #include <QIcon>
  28 #include <QString>
  29
  30 namespace icon {
  31
  32 /**
  33  * Gets an icon from the current icon theme.
  34  *
  35  * If the theme does not provide the icon, tries to load the icon from the
  36  * fallback path, if given.
  37  *
  38  * If no icon can be found, a warning is displayed and a null icon returned.
  39  *
  40  * @param iconName     Icon name
  41  * @param fallbackPath Full path to a fallback icon
  42  * @returns The requested icon, if available
  43  */
  44 UISUPPORT_EXPORT QIcon get(const QString &iconName, const QString &fallbackPath = {});
  45
  46 /**
  47  * Gets an icon from the current icon theme.
  48  *
  49  * If the theme does not provide any of the given icon names, tries to load the
  50  * icon from the fallback path, if given.
  51  *
  52  * If no icon can be found, a warning is displayed and a null icon returned.
  53  *
  54  * @param iconNames    List of icon names (first match wins)
  55  * @param fallbackPath Full path to a fallback icon
  56  * @returns The requested icon, if available
  57  */
  58 UISUPPORT_EXPORT QIcon get(const std::vector<QString> &iconNames, const QString &fallbackPath = {});
  59
  60 }