File indexing completed on 2024-04-14 15:13:53

 /*  This file is part of the Calligra project, made within the KDE community.
 
     Copyright 2012 Friedrich W. H. Kossebau <kossebau@kde.org>
 
     This library is free software; you can redistribute it and/or
     modify it under the terms of the GNU Library General Public
     License as published by the Free Software Foundation; either
     version 2 of the License, or (at your option) any later version.
 
     This library is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     Library General Public License for more details.
 
     You should have received a copy of the GNU Library General Public License
     along with this library; see the file COPYING.LIB.  If not, write to
     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
     Boston, MA 02110-1301, USA.
 */
 
 #ifndef KOICON_H
 #define KOICON_H
 
 // Qt
 #include <QIcon>
 
 /**
  * Macros to support collecting the icons in use.
  *
  * After any change to this list of macros the file /CheckIcons.sh needs to be
  * updated accordingly, to ensure that the icon names of the affected macros are
  * still considered in the extraction.
  *
  * The naming pattern of the macros is like this:
  * * koIcon* returns a QIcon object
  * * koIconName* returns a QLatin1String (aligned with usual API where "iconName" property is of type QString)
  * * koIconNameCStr* returns a const char*
  */
 
 /// Use these macros for icons without any issues
 #define koIcon(name) (QIcon::fromTheme(QStringLiteral(name)))
 #define koIconName(name) (QStringLiteral(name))
 #define koIconNameCStr(name) (name)
 /// Use these definitions in files where needed:
 // #define koSmallIcon(name) (SmallIcon(QStringLiteral(name)))
 // #define koDesktopIcon(name) (DesktopIcon(QStringLiteral(name)))
 // Also #include <kiconloader.h>
 
 /// Use these macros if there is a proper icon missing
 #define koIconNeeded(comment, neededName) (QIcon::fromTheme(QStringLiteral(neededName)))
 #define koIconNeededWithSubs(comment, neededName, substituteName) (QIcon::fromTheme(QStringLiteral(substituteName)))
 #define koIconNameNeeded(comment, neededName) (QStringLiteral(neededName))
 #define koIconNameNeededWithSubs(comment, neededName, substituteName) (QStringLiteral(substituteName))
 #define koIconNameCStrNeeded(comment, neededName) (neededName)
 #define koIconNameCStrNeededWithSubs(comment, neededName, substituteName) (substituteName)
 
 /// Use these macros if the UI is okay without any icon, but would be better with one.
 #define koIconWanted(comment, wantedName) (QIcon())
 #define koIconNameWanted(comment, wantedName) (QString())
 
 #endif