Salome HOME
AIS presentation for result is created
[modules/shaper.git] / src / XGUI / XGUI_IPrefMgr.h
index 1a4f8481cf4053c20a6e1087ffab300af4c300d7..af0752d6f36d438409f18ee9af8a0408ac7206cd 100644 (file)
@@ -9,13 +9,28 @@
 #include <QString>
 #include <SUIT_PreferenceMgr.h>
 
+/** 
+* An interface class which provides incapsulation of SUIT_PreferenceMgr class instance 
+* It is used in order to make common interface to Preference manager in Salome 
+* and this application
+*/
 class XGUI_IPrefMgr
 {
 public:
+  /** 
+  * Add preference item into preference dialog box
+  * \param theLbl - label of the item
+  * \param pId - id of container item
+  * \param theType - type of the item
+  * \param theSection - resouce section name
+  * \param theName - name of the resource
+  * Returns Id of the ctreated item
+  */
   virtual int addPreference(const QString& theLbl, int pId, 
                             SUIT_PreferenceMgr::PrefItemType theType,
                             const QString& theSection, const QString& theName ) = 0;
 
+  /// Returns incapsulated preference manager
   virtual SUIT_PreferenceMgr* prefMgr() const = 0;
 };