]> SALOME platform Git repositories - modules/shaper.git/blob - src/ModuleBase/ModuleBase_IconFactory.h
Salome HOME
Issue #3086: Avoid crash when FeatureInfo is null.
[modules/shaper.git] / src / ModuleBase / ModuleBase_IconFactory.h
1 // Copyright (C) 2014-2019  CEA/DEN, EDF R&D
2 //
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
7 //
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11 // Lesser General Public License for more details.
12 //
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19
20 #ifndef ModuleBase_IconFactory_H
21 #define ModuleBase_IconFactory_H
22
23 #include "ModuleBase.h"
24 #include <ModelAPI_Object.h>
25
26 #include <QPixmap>
27 #include <QIcon>
28 #include <QImage>
29
30 /**\class ModuleBase_IconFactory
31  * \ingroup GUI
32  * \brief This is a class which provides icons of objects for object browser 
33  */
34 class MODULEBASE_EXPORT ModuleBase_IconFactory
35 {
36 public:
37   /// Returns icons factory instance
38   static ModuleBase_IconFactory* get();
39
40   /// Returns Icon for the given object
41   /// \param theObj an object
42   virtual QIcon getIcon(ObjectPtr theObj);
43
44   /// Finds an icon for the given value. The icon is loaded: firstly from qrc file,
45   /// then by the icon path. If the path contains ":" , it will be treated as absolute path to
46   /// the icon, or relative path from the plugin library
47   /// \param theValue an icon information
48   /// \return a loaded or empty icon
49   static QIcon loadIcon(const QString& theValue);
50
51   /// Finds a pixmap for the given value. It is loaded: firstly from qrc file,
52   /// then by the absolute path. If the pixmap is not loaded, it is searched in relative plugin path
53   /// \param theValue a pixmap information
54   /// \return a loaded or empty pixmap
55   static QPixmap loadPixmap(const QString& theValue);
56
57   /// Finds an image for the given value. It is loaded: firstly from qrc file,
58   /// then by the absolute path. If the image is not loaded, it is searched in relative plugin path
59   /// \param theValue a image information
60   /// \return a loaded or empty pixmap
61   static QImage loadImage(const QString& theValue);
62
63 protected:
64   ModuleBase_IconFactory();
65
66   /// Set the current icons factory instance
67   /// \param theFactory a new factory
68   static void setFactory(ModuleBase_IconFactory* theFactory);
69 };
70
71 #endif