]> SALOME platform Git repositories - modules/gui.git/commitdiff
Salome HOME
doxygen comments
authorasl <asl@opencascade.com>
Thu, 4 May 2006 07:17:28 +0000 (07:17 +0000)
committerasl <asl@opencascade.com>
Thu, 4 May 2006 07:17:28 +0000 (07:17 +0000)
24 files changed:
src/LightApp/LightApp_AboutDlg.h
src/LightApp/LightApp_Displayer.h
src/LightApp/LightApp_GLSelector.h
src/LightApp/LightApp_ModuleDlg.h
src/LightApp/LightApp_OBFilter.h
src/LightApp/LightApp_OBSelector.h
src/LightApp/LightApp_OCCSelector.h
src/LightApp/LightApp_Preferences.h
src/LightApp/LightApp_PreferencesDlg.h
src/LightApp/LightApp_Selection.h
src/LightApp/LightApp_SelectionMgr.h
src/LightApp/LightApp_ShowHideOp.h
src/LightApp/LightApp_Study.h
src/LightApp/LightApp_VTKSelector.h
src/OBJECT/Handle_SALOME_AISObject.hxx
src/OBJECT/Handle_SALOME_AISShape.hxx
src/OBJECT/Handle_SALOME_Filter.hxx
src/OBJECT/Handle_SALOME_InteractiveObject.hxx
src/OBJECT/Handle_SALOME_ListNodeOfListIO.hxx
src/OBJECT/Handle_SALOME_TypeFilter.hxx
src/OBJECT/SALOME_ListIO.hxx
src/OBJECT/SALOME_ListNodeOfListIO.hxx
src/Session/InquireServersQThread.cxx
src/Session/SalomeApp_Engine_i.cxx

index c59cc938bd6e3d5f0915409c74fa71b5c3ff7bf4..8691515993b98e862a433445f5df711942f3ee2f 100644 (file)
 
 #include <QtxDialog.h>
 
-/*!
-  Descr: LightApp help about dialog
-*/
-
 class QLabel;
 
+/*!
+  \class LightApp_AboutDlg
+  LightApp help about dialog
+*/
 class LIGHTAPP_EXPORT LightApp_AboutDlg : public QtxDialog
 {
   Q_OBJECT
index f0896eb8f180d3440a4f26b8a5b5292f2128f29f..cc1eb89d191ebe5e2cfa719e9e469661fef6804b 100644 (file)
 
 class QString;
 
+/*!
+  \class LightApp_Displayer
+  Uniform mechanism of display/erase of objects in different views.
+  Objects are specified by string entry
+*/
 class LightApp_Displayer : public SALOME_Displayer
 {
 public:
index f58bb761a85e402e1f56d09030efc3e2d78e6d28..7447490ee38a1f762ad36e4bb1b13984c9d059bb 100644 (file)
 #include <string>
 #include <GLViewer_Object.h>
 
+/*!
+  \class LightApp_GLSelector
+  Custom selector to get/set selection from GL viewer
+*/
 class LIGHTAPP_EXPORT LightApp_GLSelector : public SUIT_Selector
 {
   Q_OBJECT
index 526f16f22f2167decc44119f477c4139d636d047..135e58c40aad967bd8a6df194e147c03bb78c36e 100644 (file)
@@ -19,6 +19,11 @@ class QFrame;
 class QLabel;
 class QPushButton;
 
+/*!
+  \class LightApp_ModuleDlg
+  Dialog allows to choose action on module activation when there is no document.
+  It is possible to create new document, to open existing or to cancel module activation
+*/
 class LIGHTAPP_EXPORT LightApp_ModuleDlg : public QDialog
 {
   Q_OBJECT
index 4ea2921324871a5085d677c699490aa790fe84fe..69db84c2ceb897f963bf39613d76e0f98d9b10ce 100644 (file)
 
 class LightApp_SelectionMgr;
 
+/*!
+  \class LightApp_OBFilter
+  Custom Object Browser filter, that checks correctness of object by all filters set in selection manager
+*/
 class LIGHTAPP_EXPORT LightApp_OBFilter: public OB_Filter
 {
 public:
index e8fc44371690890a5b4cdf2491e3c215cfb4102a..a3928ccd9e7507005e2b4263dcdfe296752c72af 100644 (file)
 class OB_Browser;
 class LightApp_DataObject;
 
+/*!
+  \class LightApp_OBSelector
+  Custom selector to get/set selection from object browser
+*/
 class LIGHTAPP_EXPORT LightApp_OBSelector : public SUIT_Selector
 {
   Q_OBJECT
index 5a53992e0e492748879ec8fddb8483ddd337329c..619a4739ee9d7949c44637ed00a65797d3e8d7ab 100644 (file)
 
 class Handle_AIS_InteractiveObject;
 
+/*!
+  \class LightApp_OCCSelector
+  Custom selector to get/set selection from OCC viewer
+*/
 class LIGHTAPP_EXPORT LightApp_OCCSelector : public SUIT_Selector
 {
   Q_OBJECT
index 2aa97f143ad1f27e1aabe1d0d3f92bf5d3cc9061..bcd39127b360e04f331418d9c19725799dee41e8 100644 (file)
 
 class QtxResourceMgr;
 
+/*!
+  \class LightApp_Preferences
+  Custom preference container. Assign each preference category with module.
+  Emits signal on preference changing
+*/
 class LIGHTAPP_EXPORT LightApp_Preferences : public QtxListResourceEdit
 {
   Q_OBJECT
index 91c9d3439692cc16601b640766d001f9c783b857..3a89ac82cb08a41ded5c5fa0dde7fff23da96afc 100644 (file)
 
 class LightApp_Preferences;
 
+/*!
+  \class LightApp_PreferencesDlg
+  Dialog for preferences edition
+*/
 class LIGHTAPP_EXPORT LightApp_PreferencesDlg : public QtxDialog
 {
   Q_OBJECT
index 79cc0fac6770e1f9f76641d90512f156a1281071..606f4c27ac0948ba56fbc51ca04d2ec837166c49 100644 (file)
@@ -37,7 +37,13 @@ class LightApp_DataOwner;
 class LightApp_Study;
 class SUIT_ViewWindow;
 
-
+/*!
+  \class LightApp_Selection 
+  Custom selection class, allowing to build popup with rules on the base
+  of owners selected in all selectors (popup client has more priority).
+  It is able to return values of standard object properties
+  (isVisible,isComponent,canBeDisplayed,isReference, etc)
+*/
 class LIGHTAPP_EXPORT LightApp_Selection : public QtxPopupMgr::Selection
 {
 public:
index 8546dadfe738a66882384653709c74f447251328..20d03efa617ccd5dcdd173a15eeac27e7e7dc31c 100644 (file)
 
 class LightApp_Application;
 
+/*!
+  Custom selection manager, allowing to work with object selection
+  (additionally to data owners) and to access to sub-selection of objects
+*/
 class LIGHTAPP_EXPORT LightApp_SelectionMgr : public SUIT_SelectionMgr
 {
   Q_OBJECT
index cac7b918d966887afbf45f64f8cce19299c887a8..d84ef52c8b8771b463d4dedb678f3a83146ba298 100644 (file)
 #include "LightApp_Operation.h"
 
 class LightApp_Displayer;
+
+/*!
+  \class LightApp_ShowHideOp
+  Standard operation allowing to show/hide selected objects
+  corresponding to any module with help of module displayer
+*/
 class LIGHTAPP_EXPORT LightApp_ShowHideOp : public LightApp_Operation
 {
   Q_OBJECT
index 2e0ac32260b04ab779b93fc8e28833fd673b62fe..2b8cf30c4ce1ac0cd5489fa12aa244bf50c81635 100644 (file)
 class SUIT_Application;
 class CAM_DataModel;
 
+/*!
+  Custom study, using for open/close of documents HDF format.
+  Data of each module can be saved to different files, those 
+  after that are combined into one HDF file
+*/
 class LIGHTAPP_EXPORT LightApp_Study : public CAM_Study
 {
   Q_OBJECT
index fd4247b7ff52b8ab4ee446dd6da9586005e9ef80..96582d555df09f96080553b9be24f51d6903f15b 100644 (file)
@@ -72,7 +72,8 @@ class LIGHTAPP_EXPORT LightApp_SVTKDataOwner : public LightApp_DataOwner
 
 
 /*!
-  Provide vtk selection of data owners.
+  \class LightApp_VTKSelector
+  Custom selector to get/set selection from object browser
 */
 class LIGHTAPP_EXPORT LightApp_VTKSelector : public SUIT_Selector
 {
index 98dede911c8370b7e48f5428ca98825d8467d253..1fd37e08bcb41b8baa4613c48d02a12495275b9a 100755 (executable)
 
 class Standard_Transient;
 class Handle_Standard_Type;
+/*!
+  \class Handle(AIS_InteractiveObject)
+  Smart pointer (handle) to AIS_InteractiveObject
+*/
 class Handle(AIS_InteractiveObject);
 class SALOME_AISObject;
 Standard_EXPORT Handle_Standard_Type& STANDARD_TYPE(SALOME_AISObject);
 
+/*!
+  \class Handle(SALOME_AISObject)
+  Smart pointer (handle) to SALOME_AISObject
+*/
 class Handle(SALOME_AISObject) : public Handle(AIS_InteractiveObject) {
   public:
     inline void* operator new(size_t,void* anAddress) 
index 65a1bc6d931bb2a838fe7df53870cb4d1be2d3e8..525fbada57a82d514b88291e7b90c7631e70f4f7 100755 (executable)
 
 class Standard_Transient;
 class Handle_Standard_Type;
+/*!
+  \class Handle(AIS_Shape)
+  Smart pointer (handle) to AIS_Shape
+*/
 class Handle(AIS_Shape);
 class SALOME_AISShape;
 Standard_EXPORT Handle_Standard_Type& STANDARD_TYPE(SALOME_AISShape);
 
+/*!
+  \class Handle(SALOME_AISShape)
+  Smart pointer (handle) to SALOME_AISShape
+*/
 class Handle(SALOME_AISShape) : public Handle(AIS_Shape) {
   public:
     inline void* operator new(size_t,void* anAddress) 
index 49eb7b877239f5fa57a8aed861f4f1493b1e3888..dc169db53750922974346e641036f2b079d6518f 100644 (file)
 
 class Standard_Transient;
 class Handle_Standard_Type;
+/*!
+  \class Handle(MMgt_TShared)
+  Smart pointer (handle) to MMgt_TShared
+*/
 class Handle(MMgt_TShared);
 class SALOME_Filter;
 Standard_EXPORT Handle_Standard_Type& STANDARD_TYPE(SALOME_Filter);
 
+/*!
+  \class Handle(SALOME_Filter)
+  Smart pointer (handle) to SALOME_Filter
+*/
 class Handle(SALOME_Filter) : public Handle(MMgt_TShared) {
   public:
     inline void* operator new(size_t,void* anAddress) 
index 767dfec3f5f51687e3ff952fd159e5e4ffe9ee4e..e4f3622fb1483758047881870992a064ed7005de 100755 (executable)
 
 class Standard_Transient;
 class Handle_Standard_Type;
+/*!
+  \class Handle(MMgt_TShared)
+  Smart pointer (handle) to MMgt_TShared
+*/
 class Handle(MMgt_TShared);
 class SALOME_InteractiveObject;
 Standard_EXPORT Handle_Standard_Type& STANDARD_TYPE(SALOME_InteractiveObject);
 
+/*!
+  \class Handle(SALOME_InteractiveObject)
+  Smart pointer (handle) to SALOME_InteractiveObject
+*/
 class Handle(SALOME_InteractiveObject) : public Handle(MMgt_TShared) {
   public:
     void* operator new(size_t,void* anAddress) 
index 0df5e98bee064b21ce6a649d977250103cc64f34..986a4da6e7094493756cf042e0551a4aa59704eb 100644 (file)
 
 class Standard_Transient;
 class Handle_Standard_Type;
+/*!
+  \class Handle(TCollection_MapNode)
+  Smart pointer (handle) to TCollection_MapNode
+*/
 class Handle(TCollection_MapNode);
 class SALOME_ListNodeOfListIO;
 Standard_EXPORT Handle_Standard_Type& STANDARD_TYPE(SALOME_ListNodeOfListIO);
 
+/*!
+  \class Handle(SALOME_ListNodeOfListIO)
+  Smart pointer (handle) to SALOME_ListNodeOfListIO
+*/
 class Handle(SALOME_ListNodeOfListIO) : public Handle(TCollection_MapNode) {
   public:
     void* operator new(size_t,void* anAddress) 
index 4fdd91368589352074ec12ab7d7b5d57c5c2ddbf..b41dc2bacc66ef7094125389ea55f833301790d6 100644 (file)
 
 class Standard_Transient;
 class Handle_Standard_Type;
+/*!
+  \class Handle(SALOME_Filter)
+  Smart pointer (handle) to SALOME_Filter
+*/
 class Handle(SALOME_Filter);
 class SALOME_TypeFilter;
 Standard_EXPORT Handle_Standard_Type& STANDARD_TYPE(SALOME_TypeFilter);
 
+/*!
+  \class Handle(SALOME_TypeFilter)
+  Smart pointer (handle) to SALOME_TypeFilter
+*/
 class Handle(SALOME_TypeFilter) : public Handle(SALOME_Filter) {
   public:
     inline void* operator new(size_t,void* anAddress) 
index e028e243ffa487872790ca787572baa45fcf72d1..43cc9f8ff29e08ec651ad0397475f347517fd9d4 100644 (file)
@@ -55,6 +55,10 @@ class SALOME_ListNodeOfListIO;
 #include <Standard_Macro.hxx>
 #endif
 
+/*!
+  \class SALOME_ListIO
+  List of SALOME interactive objects
+*/
 class SALOME_ListIO  {
 
 public:
index 9aed956f8060d55a13ebb5e25225b8419b82e35d..7734399e46bff4c35db9085139a8df855926bd92 100644 (file)
@@ -47,7 +47,10 @@ class SALOME_InteractiveObject;
 class SALOME_ListIO;
 class SALOME_ListIteratorOfListIO;
 
-
+/*!
+  \class SALOME_ListNodeOfListIO
+  Auxiliary class, represents list node for SALOME_ListIO
+*/
 class SALOME_ListNodeOfListIO : public TCollection_MapNode {
 
 public:
index 43bee4c5d6d3a74b524fdacb6c01c0e18ff692e4..b022744f72e82fbdbe25f142f03c7f9b87623ba5 100755 (executable)
@@ -140,6 +140,10 @@ InquireServersGUI::InquireServersGUI()
   myThread->start();
 }
 
+/*!
+  Sets pixmap of splash screen
+  \param pix - new pixmap
+*/
 void InquireServersGUI::setPixmap( QPixmap pix )
 {
   if ( !pix.isNull() ) 
@@ -159,6 +163,11 @@ InquireServersGUI::~InquireServersGUI()
   delete myThread;
 }
 
+/*!
+  Gets parameters from qApp
+  \param _argc - variable to return number of arguments
+  \param _argv - variable to return array of arguments
+*/
 void InquireServersGUI::getArgs( int& _argc, char *** _argv)
 {
   _argc = qApp->argc();
@@ -175,6 +184,9 @@ void InquireServersGUI::ClickOnCancel()
   qApp->exit( 1 );
 }
 
+/*!
+  Custom event filter
+*/
 void InquireServersGUI::customEvent( QCustomEvent* pe )
 {
   switch( pe->type() )
@@ -209,6 +221,9 @@ void InquireServersGUI::customEvent( QCustomEvent* pe )
     }
 }
 
+/*!
+  \return status of thread exit
+*/
 int InquireServersGUI::getExitStatus()
 {
   return myThread->getExitStatus();
@@ -266,6 +281,9 @@ InquireServersQThread::InquireServersQThread( InquireServersGUI* r )
   }
 }
 
+/*!
+  The main loop of this thread
+*/
 void InquireServersQThread::run()
 {
   while ( IsChecking && receiver )
@@ -313,6 +331,9 @@ void InquireServersQThread::run()
   qApp->exit( myExitStatus );
 }
 
+/*!
+  Stops this thread
+*/
 void InquireServersQThread::stop()
 {
   IsChecking = false;
index 4fc9bbac8a8916b5e4e53bf9f41126803dcde7c8..d23e815df15bc6a5e1ea3f3c777292441c0b59f2 100644 (file)
@@ -169,6 +169,9 @@ void SalomeApp_Engine_i::SetListOfFiles (const ListOfFiles theListOfFiles,
   mapOfListOfFiles[componentName] = theListOfFiles;
 }
 
+/*!
+  \return shared instance of engine
+*/
 SalomeApp_Engine_i* SalomeApp_Engine_i::GetInstance()
 {
   return myInstance;