]> SALOME platform Git repositories - modules/shaper.git/blob - src/ModuleBase/ModuleBase_ActionInfo.h
Salome HOME
Issue #3086: Avoid crash when FeatureInfo is null.
[modules/shaper.git] / src / ModuleBase / ModuleBase_ActionInfo.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_ACTIONINFO_H_
21 #define MODULEBASE_ACTIONINFO_H_
22
23 #include <ModuleBase.h>
24 #include <Config_FeatureMessage.h>
25
26 #include <QAction>
27 #include <QIcon>
28 #include <QKeySequence>
29 #include <QFont>
30
31 #include <memory>
32
33 /*!
34  * Structure to pass info about QActions, AppElements_Commands, etc.
35  */
36 struct MODULEBASE_EXPORT ModuleBase_ActionInfo
37 {
38   QString id; //!< action's (command) id
39   bool checkable; //!< action's checkable state
40   bool checked; //!< action's checked state
41   bool enabled; //!< action's enabled state
42   bool visible; //!< action's visibility state
43
44   //! = true if the acton is a modal dialog box else property panel (==false by default)
45   bool modal;
46   QIcon icon; //!< action's icon
47   QString text; //!< action's text
48   QString iconText; //!< action's descriptive icon text
49   QString iconFile; //!< path to icon's file. Can not be initialized from QAction
50   QString toolTip; //!< action's tooltip
51   QString toolBar;  //!< A name of toolbar. By default = group of features name
52   // QString statusTip;
53   // QString whatsThis;
54   QKeySequence shortcut; //!< action's primary shortcut key
55   QFont font; //!< action's text font
56
57  public:
58   //! Default constructor, \sa initDefault
59   ModuleBase_ActionInfo();
60   //! Initializes structure with default values, except text
61   ModuleBase_ActionInfo(const QString &text);
62   //! Initializes structure with default values, except icon and text
63   ModuleBase_ActionInfo(const QIcon &icon, const QString &text);
64   virtual ~ModuleBase_ActionInfo();
65
66   //! Fills itself with info from given \param theAction
67   void initFrom(QAction* theAction);
68   //! Fills itself with info from given \param theFeatureMessage
69   void initFrom(std::shared_ptr<Config_FeatureMessage> theFeatureMessage);
70
71  protected:
72   //! Initializes structure with default values, like QAction()
73   void initDefault();
74 };
75
76 typedef ModuleBase_ActionInfo ActionInfo;
77
78 #endif /* XGUI_ACTIONINFO_H_ */