src/ModuleBase/ModuleBase_IPrefMgr.h

   1 // Copyright (C) 2014-2023  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_IPrefMgr_H
  21 #define ModuleBase_IPrefMgr_H
  22
  23 #include "ModuleBase.h"
  24
  25 #include <QString>
  26 #include <SUIT_PreferenceMgr.h>
  27
  28 /**
  29 * \ingroup GUI
  30 * An interface class which provides incapsulation of SUIT_PreferenceMgr class instance
  31 * It is used in order to make common interface to Preference manager in Salome
  32 * and this application
  33 */
  34 class MODULEBASE_EXPORT ModuleBase_IPrefMgr
  35 {
  36 public:
  37   /// Default constructor
  38   ModuleBase_IPrefMgr();
  39   /// Virtual destructor
  40   virtual ~ModuleBase_IPrefMgr();
  41
  42   /**
  43   * Add preference item into preference dialog box
  44   * \param theLbl - label of the item
  45   * \param pId - id of container item
  46   * \param theType - type of the item
  47   * \param theSection - resouce section name
  48   * \param theName - name of the resource
  49   * Returns Id of the ctreated item
  50   */
  51   virtual int addPreference(const QString& theLbl, int pId,
  52                             SUIT_PreferenceMgr::PrefItemType theType,
  53                             const QString& theSection, const QString& theName ) = 0;
  54
  55   /**
  56   * \brief Set property of an item
  57   * \param thePropName the property name
  58   * \param theValue the value of the property
  59   * \param theId id of the property
  60   */
  61   virtual void setItemProperty(const QString& thePropName,
  62                                const QVariant& theValue,
  63                                const int theId = -1) = 0;
  64
  65   /// Returns incapsulated preference manager
  66   virtual SUIT_PreferenceMgr* prefMgr() const = 0;
  67 };
  68
  69 #endif