From: asl Date: Wed, 3 May 2006 10:48:55 +0000 (+0000) Subject: doxygen comments X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=892eb4d1becb4039998dd5abd6cb4e2dee0f4c16;p=modules%2Fgui.git doxygen comments --- diff --git a/src/CAF/CAF_Application.h b/src/CAF/CAF_Application.h index 1ec88331d..6777012ef 100755 --- a/src/CAF/CAF_Application.h +++ b/src/CAF/CAF_Application.h @@ -35,6 +35,12 @@ class CAF_Study; #pragma warning ( disable: 4251 ) #endif +/*! + \class CAF_Application + Defines application configuration and behaviour for application with + link to standard OCC OCAF data model. Allows to use OCC OCAF serives + (for example, undo/redo) +*/ class CAF_EXPORT CAF_Application : public STD_Application { Q_OBJECT diff --git a/src/CAF/CAF_Operation.h b/src/CAF/CAF_Operation.h index f49e315d7..bc1ff81e2 100755 --- a/src/CAF/CAF_Operation.h +++ b/src/CAF/CAF_Operation.h @@ -29,8 +29,14 @@ #include class CAF_Study; +//! OCC OCAF Std document class Handle(TDocStd_Document); +/*! + \class CAF_Operation + Base operation for all operations used in CAF package + Operation has link to OCC OCAF std document +*/ class CAF_EXPORT CAF_Operation : public SUIT_Operation { Q_OBJECT diff --git a/src/CAF/CAF_Study.h b/src/CAF/CAF_Study.h index fe47c5b0b..5fbc614e4 100755 --- a/src/CAF/CAF_Study.h +++ b/src/CAF/CAF_Study.h @@ -34,6 +34,12 @@ class CAF_Application; #pragma warning ( disable: 4251 ) #endif +/*! + \class CAF_Study + Represents study for using in CAF, contains reference + to OCAF std document and allows to use OCAF services. + Provides necessary functionality for OCC transactions management. +*/ class CAF_EXPORT CAF_Study : public SUIT_Study { Q_OBJECT diff --git a/src/CAF/CAF_Tools.h b/src/CAF/CAF_Tools.h index e04d1c9d8..d305e5b3d 100755 --- a/src/CAF/CAF_Tools.h +++ b/src/CAF/CAF_Tools.h @@ -33,6 +33,10 @@ #include #include +/*! + \class CAF_Tools + Prodives set of auxiliary static methods +*/ class CAF_EXPORT CAF_Tools : public SUIT_Tools { public: diff --git a/src/CAM/CAM_Application.h b/src/CAM/CAM_Application.h index d19bde645..b72dc3c39 100755 --- a/src/CAM/CAM_Application.h +++ b/src/CAM/CAM_Application.h @@ -31,6 +31,13 @@ class QPopupMenu; #pragma warning( disable:4251 ) #endif +/*! + \class CAM_Application + Defines application configuration and behaviour for application with modules. + Every module has own data model, necessary windows and viewers, etc. + Application provides all necessary functionality for module management + (loading of modules/activation/deactivation, etc) +*/ class CAM_EXPORT CAM_Application : public STD_Application { Q_OBJECT diff --git a/src/CAM/CAM_DataModel.h b/src/CAM/CAM_DataModel.h index 0724916cd..0c4686cbc 100755 --- a/src/CAM/CAM_DataModel.h +++ b/src/CAM/CAM_DataModel.h @@ -29,6 +29,11 @@ class CAM_DataObject; class CAM_Study; class SUIT_DataObject; +/*! + \class CAM_DataModel + Base class for all data models used in CAM-based applications. + Represents data model of CAM module. Provides necessary interface (default implementation is empty) +*/ class CAM_EXPORT CAM_DataModel : public QObject { Q_OBJECT diff --git a/src/CAM/CAM_DataObject.h b/src/CAM/CAM_DataObject.h index 1b89a8e60..70d09994f 100755 --- a/src/CAM/CAM_DataObject.h +++ b/src/CAM/CAM_DataObject.h @@ -26,6 +26,10 @@ class CAM_Module; class CAM_DataModel; +/*! + \class CAM_DataObject + Provides only additional link to CAM_DataModel +*/ class CAM_EXPORT CAM_DataObject : public SUIT_DataObject { public: diff --git a/src/CAM/CAM_Module.cxx b/src/CAM/CAM_Module.cxx index 264054bdf..85df558d0 100755 --- a/src/CAM/CAM_Module.cxx +++ b/src/CAM/CAM_Module.cxx @@ -254,9 +254,8 @@ int CAM_Module::createTool( QAction* a, const QString& tBar, const int id, const /*! Create tool. * Insert QAction with id \a id from action map(myActionMap) to tool manager. - *\param a - QAction - *\param tBar - integer *\param id - integer + *\param tBar - integer *\param idx - integer *\retval integer id of new action in tool manager. *\retval Return -1 if something wrong. @@ -272,9 +271,8 @@ int CAM_Module::createTool( const int id, const int tBar, const int idx ) /*! Create tool. * Insert QAction with id \a id from action map(myActionMap) to tool manager. - *\param a - QAction - *\param tBar - QString& *\param id - integer + *\param tBar - QString& *\param idx - integer *\retval integer id of new action in tool manager. *\retval Return -1 if something wrong. diff --git a/src/CAM/CAM_Study.h b/src/CAM/CAM_Study.h index 29106776b..06544269e 100755 --- a/src/CAM/CAM_Study.h +++ b/src/CAM/CAM_Study.h @@ -31,6 +31,12 @@ #pragma warning( disable:4251 ) #endif +/*! + \class CAM_Study + Represents study for using in CAM, contains list of + data model references from all modules. Provides + necessary functionality for data models management. +*/ class CAM_EXPORT CAM_Study : public SUIT_Study { Q_OBJECT diff --git a/src/Event/SALOME_Event.cxx b/src/Event/SALOME_Event.cxx index 84928f623..d34dfc01a 100755 --- a/src/Event/SALOME_Event.cxx +++ b/src/Event/SALOME_Event.cxx @@ -51,6 +51,9 @@ static DWORD myThread; static pthread_t myThread; #endif +/*! + \return thread id +*/ void SALOME_Event::GetSessionThread(){ #ifdef WIN32 myThread = ::GetCurrentThreadId(); @@ -59,6 +62,9 @@ void SALOME_Event::GetSessionThread(){ #endif } +/*! + \return true if it is session thread +*/ bool SALOME_Event::IsSessionThread(){ bool aResult = false; #ifdef WIN32 @@ -71,12 +77,9 @@ bool SALOME_Event::IsSessionThread(){ } -//=========================================================== /*! - * SALOME_Event::SALOME_Event - * Constructor - */ -//=========================================================== + Constructor +*/ SALOME_Event::SALOME_Event(){ // if(MYDEBUG) MESSAGE( "SALOME_Event::SALOME_Event(): this = "< 0 ) @@ -106,10 +103,12 @@ int GLViewer_AspectLine::setLineWidth( const float width ) return 1; } -//======================================================================= -// Function: getLineColors -// Purpose : -//======================================================================= +/*! + \return colors of line + \param nc - variable for normal color + \param hc - variable for hilighting color + \param sc - variable for selection color +*/ void GLViewer_AspectLine::getLineColors( QColor& nc, QColor& hc, QColor& sc ) const { nc = myNColor; @@ -117,10 +116,9 @@ void GLViewer_AspectLine::getLineColors( QColor& nc, QColor& hc, QColor& sc ) co sc = mySColor; } -//======================================================================= -// Function: getByteCopy -// Purpose : -//======================================================================= +/*! + \return binary representation of line aspect +*/ QByteArray GLViewer_AspectLine::getByteCopy() const { int anISize = sizeof( int ); @@ -174,10 +172,9 @@ QByteArray GLViewer_AspectLine::getByteCopy() const return aResult; } -//======================================================================= -// Function: fromByteCopy -// Purpose : -//======================================================================= +/*! + Sets line aspect from binary representation +*/ GLViewer_AspectLine* GLViewer_AspectLine::fromByteCopy( QByteArray theBytes ) { diff --git a/src/GLViewer/GLViewer_AspectLine.h b/src/GLViewer/GLViewer_AspectLine.h index 800b166bb..23320b46f 100644 --- a/src/GLViewer/GLViewer_AspectLine.h +++ b/src/GLViewer/GLViewer_AspectLine.h @@ -34,9 +34,9 @@ #endif /*! - * Class GLViewer_AspectLine - * Substitution of Prs2d_AspectLine for OpenGL - */ + \Class GLViewer_AspectLine + Substitution of Prs2d_AspectLine for OpenGL +*/ class GLVIEWER_API GLViewer_AspectLine { diff --git a/src/GLViewer/GLViewer_BaseDrawers.cxx b/src/GLViewer/GLViewer_BaseDrawers.cxx index a43a5930e..5a8b6030e 100644 --- a/src/GLViewer/GLViewer_BaseDrawers.cxx +++ b/src/GLViewer/GLViewer_BaseDrawers.cxx @@ -33,16 +33,12 @@ #include #endif -/*************************************************************************** -** Class: GLViewer_MarkerDrawer -** Descr: Drawer for GLViewer_MarkerSet -** Module: GLViewer -** Created: UI team, 03.10.01 -****************************************************************************/ - GLfloat sin_table[SEGMENTS]; GLfloat cos_table[SEGMENTS]; +/*! + Default constructor +*/ GLViewer_MarkerDrawer::GLViewer_MarkerDrawer() : GLViewer_Drawer() { @@ -56,10 +52,18 @@ GLViewer_MarkerDrawer::GLViewer_MarkerDrawer() myObjectType = "GLViewer_MarkerSet"; } +/*! + Destructor +*/ GLViewer_MarkerDrawer::~GLViewer_MarkerDrawer() { } +/*! Draws object in GLViewer + \param xScale - current scale along X-direction + \param yScale - current scale along Y-direction + \param onlyUpdate - = true if only update highlight-select information +*/ void GLViewer_MarkerDrawer::create( float xScale, float yScale, bool onlyUpdate ) { QValueList::Iterator it; @@ -134,6 +138,13 @@ void GLViewer_MarkerDrawer::create( float xScale, float yScale, bool onlyUpdate } } +/*! Draws marker + \param theXCoord - X position + \param theYCoord - Y position + \param theRadius - radius + \param theColor - color + \param theAspectLine - line aspect +*/ void GLViewer_MarkerDrawer::drawMarker( float& theXCoord, float& theYCoord, float& theRadius, QColor& theColor, GLViewer_AspectLine* theAspectLine ) { @@ -154,23 +165,28 @@ void GLViewer_MarkerDrawer::drawMarker( float& theXCoord, float& theYCoord, glEnd(); } -/*************************************************************************** -** Class: GLViewer_PolylineDrawer -** Descr: Drawer for GLViewer_Polyline -** Module: GLViewer -** Created: UI team, 03.10.01 -****************************************************************************/ +/*! + Default constructor +*/ GLViewer_PolylineDrawer::GLViewer_PolylineDrawer() :GLViewer_Drawer() { myObjectType = "GLViewer_Polyline"; } +/*! + Destructor +*/ GLViewer_PolylineDrawer::~GLViewer_PolylineDrawer() { } +/*! Draws object in GLViewer + \param xScale - current scale along X-direction + \param yScale - current scale along Y-direction + \param onlyUpdate - = true if only update highlight-select information +*/ void GLViewer_PolylineDrawer::create( float xScale, float yScale, bool onlyUpdate ) { QValueList::Iterator aObjectIt = myObjects.begin(); @@ -239,23 +255,27 @@ void GLViewer_PolylineDrawer::create( float xScale, float yScale, bool onlyUpdat } } -/*************************************************************************** -** Class: GLViewer_TextDrawer -** Descr: -** Module: GLViewer -** Created: UI team, 27.02.04 -****************************************************************************/ - +/*! + Default constructor +*/ GLViewer_TextDrawer::GLViewer_TextDrawer() : GLViewer_Drawer() { myObjectType = "GLViewer_TextObject"; } +/*! + Destructor +*/ GLViewer_TextDrawer::~GLViewer_TextDrawer() { } +/*! Draws object in GLViewer + \param xScale - current scale along X-direction + \param yScale - current scale along Y-direction + \param onlyUpdate - = true if only update highlight-select information +*/ void GLViewer_TextDrawer::create( float xScale, float yScale, bool onlyUpdate ) { QValueList::Iterator aObjectIt = myObjects.begin(); @@ -297,6 +317,9 @@ void GLViewer_TextDrawer::create( float xScale, float yScale, bool onlyUpdate ) } } +/*! + Updates objects after updating font +*/ void GLViewer_TextDrawer::updateObjects() { QValueList::Iterator aObjectIt = myObjects.begin(); diff --git a/src/GLViewer/GLViewer_BaseDrawers.h b/src/GLViewer/GLViewer_BaseDrawers.h index ce98aa867..2d475f47d 100644 --- a/src/GLViewer/GLViewer_BaseDrawers.h +++ b/src/GLViewer/GLViewer_BaseDrawers.h @@ -40,9 +40,10 @@ class GLViewer_AspectLine; #pragma warning( disable:4251 ) #endif -/*! Class GLViewer_MarkerDrawer -* Drawer for GLViewer_MarkerSet - */ +/*! + \class GLViewer_MarkerDrawer + Drawer for GLViewer_MarkerSet +*/ class GLVIEWER_API GLViewer_MarkerDrawer : public GLViewer_Drawer { @@ -58,8 +59,9 @@ private: void drawMarker( float& x, float& y, float& radius, QColor& color, GLViewer_AspectLine* aspect ); }; -/*! Class GLViewer_PolylineDrawer -* Drawer for GLViewer_Polyline +/*! + \class GLViewer_PolylineDrawer + Drawer for GLViewer_Polyline */ class GLVIEWER_API GLViewer_PolylineDrawer : public GLViewer_Drawer @@ -71,8 +73,9 @@ public: virtual void create( float, float, bool ); }; -/* Class GLViewer_TextDrawer -* Drawer for GLViewer_Text +/*! + \class GLViewer_TextDrawer + Drawer for GLViewer_Text */ class GLVIEWER_API GLViewer_TextDrawer: public GLViewer_Drawer diff --git a/src/GLViewer/GLViewer_BaseObjects.cxx b/src/GLViewer/GLViewer_BaseObjects.cxx index 79c32e3f8..c35c664db 100644 --- a/src/GLViewer/GLViewer_BaseObjects.cxx +++ b/src/GLViewer/GLViewer_BaseObjects.cxx @@ -19,13 +19,6 @@ // Author : OPEN CASCADE // -/*************************************************************************** -** Class: GLViewer_BaseObjects -** Descr: Internal OpenGL Objects -** Module: GLViewer -** Created: UI team, 02.09.02 -****************************************************************************/ - //#include #include "GLViewer_BaseObjects.h" #include "GLViewer_BaseDrawers.h" @@ -39,13 +32,9 @@ //#include //using namespace std; -/*************************************************************************** -** Class: GLViewer_MarkerSet -** Descr: OpenGL MarkerSet -** Module: GLViewer -** Created: UI team, 03.09.02 -****************************************************************************/ - +/*! + Constructor +*/ GLViewer_MarkerSet::GLViewer_MarkerSet( int number, float size, const QString& toolTip ) : GLViewer_Object(), myNumber( 0 ), @@ -67,6 +56,9 @@ GLViewer_MarkerSet::GLViewer_MarkerSet( int number, float size, const QString& t setNumMarkers( number ); } +/*! + Destructor +*/ GLViewer_MarkerSet::~GLViewer_MarkerSet() { if ( myXCoord ) @@ -75,6 +67,16 @@ GLViewer_MarkerSet::~GLViewer_MarkerSet() delete[] myYCoord; } +/*! + Adds coords to text buffer in HPGL format + \param buffer - text buffer + \param command - command to be added with coords + \param aViewerCS - viewer co-ordinates system + \param aPaperCS - paper co-ordinates system + \param x - x co-ordinate + \param y - y co-ordinate + \param NewLine - adds new line to buffer +*/ void AddCoordsToHPGL( QString& buffer, QString command, GLViewer_CoordSystem* aViewerCS, GLViewer_CoordSystem* aPaperCS, double x, double y, bool NewLine = true ) { @@ -87,6 +89,16 @@ void AddCoordsToHPGL( QString& buffer, QString command, GLViewer_CoordSystem* aV buffer += ";\n"; } +/*! + Adds coords to text buffer in PostScript format + \param buffer - text buffer + \param command - command to be added with coords + \param aViewerCS - viewer co-ordinates system + \param aPaperCS - paper co-ordinates system + \param x - x co-ordinate + \param y - y co-ordinate + \param NewLine - adds new line to buffer +*/ void AddCoordsToPS( QString& buffer, QString command, GLViewer_CoordSystem* aViewerCS, GLViewer_CoordSystem* aPaperCS, double x, double y, bool NewLine = true ) { @@ -99,6 +111,13 @@ void AddCoordsToPS( QString& buffer, QString command, GLViewer_CoordSystem* aVie buffer += "\n"; } +/*! + Adds line aspect description to text buffer in PostScript format + \param buffer - text buffer + \param anAspect - line aspect + \param aViewerCS - viewer co-ordinates system + \param aPaperCS - paper co-ordinates system +*/ void AddLineAspectToPS( QString& buffer, GLViewer_AspectLine* anAspect, GLViewer_CoordSystem* aViewerCS, GLViewer_CoordSystem* aPaperCS ) { @@ -129,6 +148,13 @@ void AddLineAspectToPS( QString& buffer, GLViewer_AspectLine* anAspect, } #ifdef WIN32 +/*! + Adds line aspect description EMF image + \param hDC - descriptor of EMF + \param anAspect - line aspect + \param aViewerCS - viewer co-ordinates system + \param aPaperCS - paper co-ordinates system +*/ HPEN AddLineAspectToEMF( HDC hDC, GLViewer_AspectLine* anAspect, GLViewer_CoordSystem* aViewerCS, GLViewer_CoordSystem* aPaperCS ) { @@ -150,6 +176,12 @@ HPEN AddLineAspectToEMF( HDC hDC, GLViewer_AspectLine* anAspect, } #endif +/*! + Saves to file PostScript set of markers + \param hFile - file instance + \param aViewerCS - viewer co-ordinates system + \param aPSCS - paper co-ordinates system +*/ bool GLViewer_MarkerSet::translateToPS( QFile& hFile, GLViewer_CoordSystem* aViewerCS, GLViewer_CoordSystem* aPSCS ) { int noPoints = 20; @@ -187,6 +219,12 @@ bool GLViewer_MarkerSet::translateToPS( QFile& hFile, GLViewer_CoordSystem* aVie return true; } +/*! + Saves to file HPGL set of markers + \param hFile - file instance + \param aViewerCS - viewer co-ordinates system + \param aHPGLCS - paper co-ordinates system +*/ bool GLViewer_MarkerSet::translateToHPGL( QFile& hFile, GLViewer_CoordSystem* aViewerCS, GLViewer_CoordSystem* aHPGLCS ) { @@ -221,6 +259,12 @@ bool GLViewer_MarkerSet::translateToHPGL( QFile& hFile, GLViewer_CoordSystem* aV } #ifdef WIN32 +/*! + Saves to EMF image set of markers + \param dc - EMF image descriptor + \param aViewerCS - viewer co-ordinates system + \param aEMFCS - paper co-ordinates system +*/ bool GLViewer_MarkerSet::translateToEMF( HDC dc, GLViewer_CoordSystem* aViewerCS, GLViewer_CoordSystem* aEMFCS ) { int noPoints = 20; @@ -256,7 +300,9 @@ bool GLViewer_MarkerSet::translateToEMF( HDC dc, GLViewer_CoordSystem* aViewerCS } #endif - +/*! + Computes all necessary information about object for presentation in drawer +*/ void GLViewer_MarkerSet::compute() { // cout << "GLViewer_MarkerSet::compute" << endl; @@ -282,13 +328,23 @@ void GLViewer_MarkerSet::compute() myRect->setBottom( ya - myYGap ); } +/*! + Creates corresponding drawer +*/ GLViewer_Drawer* GLViewer_MarkerSet::createDrawer() { // cout << "GLViewer_MarkerSet::createDrawer" << endl; return myDrawer = new GLViewer_MarkerDrawer(); } - +/*! + Computes highlight presentation + \param x - x coord + \param y - y coord + \param tol - tolerance of detecting + \param isCircle - true if sensitive area of detection is round + \return true if highlight status is changed +*/ GLboolean GLViewer_MarkerSet::highlight( GLfloat x, GLfloat y, GLfloat tol, GLboolean isCircle ) { if( !myIsVisible ) @@ -342,6 +398,9 @@ GLboolean GLViewer_MarkerSet::highlight( GLfloat x, GLfloat y, GLfloat tol, GLbo return update; } +/*! + Unhilights object +*/ GLboolean GLViewer_MarkerSet::unhighlight() { if( !myHNumbers.isEmpty() ) @@ -356,6 +415,15 @@ GLboolean GLViewer_MarkerSet::unhighlight() return GL_FALSE; } +/*! + Selects marker set + /param x, y - co-ordinates of mouse + /param tol - tolerance + /param rect - rectangle (in case of rectangular selection) + /param isFull - if it is true, then object may selected only if it lays whole in selection zone + \param isCircle - true if sensitive area of detection is round + \param isShift - true if selection exec with append option +*/ GLboolean GLViewer_MarkerSet::select( GLfloat x, GLfloat y, GLfloat tol, GLViewer_Rect rect, GLboolean isFull, GLboolean isCircle, GLboolean isShift ) { @@ -480,6 +548,9 @@ GLboolean GLViewer_MarkerSet::select( GLfloat x, GLfloat y, GLfloat tol, GLViewe return myIsSel; } +/*! + Unselects marker set +*/ GLboolean GLViewer_MarkerSet::unselect() { if( !mySelNumbers.isEmpty() ) @@ -493,6 +564,10 @@ GLboolean GLViewer_MarkerSet::unselect() return GL_FALSE; } +/*! + \return update object rectangle + Does not equal getRect() if object have a persistence to some viewer transformations +*/ GLViewer_Rect* GLViewer_MarkerSet::getUpdateRect() { GLViewer_Rect* rect = new GLViewer_Rect(); @@ -510,7 +585,11 @@ GLViewer_Rect* GLViewer_MarkerSet::getUpdateRect() return rect; } - +/*! + Sets array of x coords of points + \param xCoord - array of co-ordinates + \param size - array size +*/ void GLViewer_MarkerSet::setXCoord( GLfloat* xCoord, int size ) { myXCoord = new GLfloat[ size ]; @@ -518,6 +597,11 @@ void GLViewer_MarkerSet::setXCoord( GLfloat* xCoord, int size ) myXCoord[i] = xCoord[i]; } +/*! + Sets array of y coords of points + \param yCoord - array of co-ordinates + \param size - array size +*/ void GLViewer_MarkerSet::setYCoord( GLfloat* yCoord, int size ) { myYCoord = new GLfloat[ size ]; @@ -525,6 +609,10 @@ void GLViewer_MarkerSet::setYCoord( GLfloat* yCoord, int size ) myYCoord[i] = yCoord[i]; } +/*! + Sets number of markers + \param number - new number of markers +*/ void GLViewer_MarkerSet::setNumMarkers( GLint number ) { if ( myNumber == number ) @@ -540,22 +628,10 @@ void GLViewer_MarkerSet::setNumMarkers( GLint number ) myXCoord = new GLfloat[ myNumber ]; myYCoord = new GLfloat[ myNumber ]; } -/* -void GLViewer_MarkerSet::onSelectionDone( bool append) -{ - mySelectedIndexes.Clear(); - QValueList::Iterator it; - //for( it = myMarkers->mySelNumbers.begin(); it != myMarkers->mySelNumbers.end(); ++it ) - // mySelectedIndexes.Append( *it / 2 ); //!!! - emit dvMarkersSelected( mySelectedIndexes ); -} -void GLViewer_MarkerSet::onSelectionCancel() -{ - mySelectedIndexes.Clear(); - emit dvMarkersSelected( mySelectedIndexes ); -} +/*! + Export numbers of highlighted/selected lines */ void GLViewer_MarkerSet::exportNumbers( QValueList& highlight, QValueList& unhighlight, @@ -570,6 +646,10 @@ void GLViewer_MarkerSet::exportNumbers( QValueList& highlight, myUHNumbers = myHNumbers; } +/*! + Adds or remove selected number + \param index - selected index +*/ bool GLViewer_MarkerSet::addOrRemoveSelected( int index ) { if( index < 0 || index > myNumber ) @@ -588,6 +668,10 @@ bool GLViewer_MarkerSet::addOrRemoveSelected( int index ) return TRUE; } +/*! + Adds some selected numbers + \param seq - sequence of indices +*/ void GLViewer_MarkerSet::addSelected( const TColStd_SequenceOfInteger& seq ) { for ( int i = 1; i <= seq.Length(); i++ ) @@ -595,6 +679,10 @@ void GLViewer_MarkerSet::addSelected( const TColStd_SequenceOfInteger& seq ) mySelNumbers.append( seq.Value( i ) - 1 ); } +/*! + Sets some numbers as selected + \param seq - sequence of indices +*/ void GLViewer_MarkerSet::setSelected( const TColStd_SequenceOfInteger& seq ) { // for( QValueList::Iterator it = mySelNumbers.begin(); it != mySelNumbers.end(); ++it ) @@ -608,6 +696,11 @@ void GLViewer_MarkerSet::setSelected( const TColStd_SequenceOfInteger& seq ) mySelNumbers.append( seq.Value( i ) - 1 ); } +/*! Moves object by recomputing + \param dx - moving along X coord + \param dy - moving along Y coord + \param fromGroup - is true if this method called from group +*/ void GLViewer_MarkerSet::moveObject( float theX, float theY, bool fromGroup ) { if( !fromGroup && myGroup) @@ -623,6 +716,10 @@ void GLViewer_MarkerSet::moveObject( float theX, float theY, bool fromGroup ) compute(); } +/*! + Codes marker set as byte copy + \return byte array +*/ QByteArray GLViewer_MarkerSet::getByteCopy() { int i = 0; @@ -655,6 +752,10 @@ QByteArray GLViewer_MarkerSet::getByteCopy() return aResult; } +/*! + Initialize marker set by byte array + \param theArray - byte array +*/ bool GLViewer_MarkerSet::initializeFromByteCopy( QByteArray theArray ) { int i = 0; @@ -701,16 +802,20 @@ bool GLViewer_MarkerSet::initializeFromByteCopy( QByteArray theArray ) return true; } -/*************************************************************************** -** Class: GLViewer_Polyline -** Descr: OpenGL Polyline -** Module: GLViewer -** Created: UI team, 03.09.02 -****************************************************************************/ +/*! + \class GLViewer_Polyline + OpenGL Polyline +*/ #define SECTIONS 100 #define DISTANTION 5 +/*! + Constructor + \param number - number of segments + \param size - size of polyline + \param toolTip - tool tip of polyline +*/ GLViewer_Polyline::GLViewer_Polyline( int number, float size, const QString& toolTip ): GLViewer_Object(), myNumber( 0 ), @@ -732,6 +837,9 @@ GLViewer_Polyline::GLViewer_Polyline( int number, float size, const QString& too myToolTipText = toolTip; } +/*! + Destructor, destroys internal arrays of co-ordinates +*/ GLViewer_Polyline::~GLViewer_Polyline() { if ( myXCoord ) @@ -740,6 +848,12 @@ GLViewer_Polyline::~GLViewer_Polyline() delete[] myYCoord; } +/*! + Saves polyline to file PostScript + \param hFile - file instance + \param aViewerCS - viewer co-ordinates system + \param aPSCS - paper co-ordinates system +*/ bool GLViewer_Polyline::translateToPS( QFile& hFile, GLViewer_CoordSystem* aViewerCS, GLViewer_CoordSystem* aPSCS ) { QString aBuffer = "newpath\n"; @@ -762,6 +876,12 @@ bool GLViewer_Polyline::translateToPS( QFile& hFile, GLViewer_CoordSystem* aView return true; } +/*! + Saves polyline to file HPGL + \param hFile - file instance + \param aViewerCS - viewer co-ordinates system + \param aHPGLCS - paper co-ordinates system +*/ bool GLViewer_Polyline::translateToHPGL( QFile& hFile, GLViewer_CoordSystem* aViewerCS, GLViewer_CoordSystem* aHPGLCS ) { QString aBuffer = ""; @@ -783,6 +903,12 @@ bool GLViewer_Polyline::translateToHPGL( QFile& hFile, GLViewer_CoordSystem* aVi } #ifdef WIN32 +/*! + Saves polyline to EMF image + \param dc - EMF image descriptor + \param aViewerCS - viewer co-ordinates system + \param aEMFCS - paper co-ordinates system +*/ bool GLViewer_Polyline::translateToEMF( HDC dc, GLViewer_CoordSystem* aViewerCS, GLViewer_CoordSystem* aEMFCS ) { if( !aViewerCS || !aEMFCS ) @@ -819,6 +945,9 @@ bool GLViewer_Polyline::translateToEMF( HDC dc, GLViewer_CoordSystem* aViewerCS, } #endif +/*! + Computes all necessary information about object for presentation in drawer +*/ void GLViewer_Polyline::compute() { // cout << "GLViewer_MarkerSet::compute" << endl; @@ -844,6 +973,10 @@ void GLViewer_Polyline::compute() myRect->setBottom( ya - yGap ); } +/*! + \return update object rectangle + Does not equal getRect() if object have a persistence to some viewer transformations +*/ GLViewer_Rect* GLViewer_Polyline::getUpdateRect() { GLViewer_Rect* rect = new GLViewer_Rect(); @@ -856,12 +989,23 @@ GLViewer_Rect* GLViewer_Polyline::getUpdateRect() return rect; } +/*! + Creates corresponding drawer +*/ GLViewer_Drawer* GLViewer_Polyline::createDrawer() { // cout << "GLViewer_MarkerSet::createDrawer" << endl; return myDrawer = new GLViewer_PolylineDrawer(); } +/*! + Computes highlight presentation + \param x - x coord + \param y - y coord + \param tol - tolerance of detecting + \param isCircle - true if sensitive area of detection is round + \return true if highlight status is changed +*/ GLboolean GLViewer_Polyline::highlight( GLfloat x, GLfloat y, GLfloat tol, GLboolean isCircle ) { if( !myIsVisible ) @@ -916,6 +1060,9 @@ GLboolean GLViewer_Polyline::highlight( GLfloat x, GLfloat y, GLfloat tol, GLboo return update; } +/*! + Unhilights object +*/ GLboolean GLViewer_Polyline::unhighlight() { // if( !myHNumbers.isEmpty() ) @@ -934,6 +1081,15 @@ GLboolean GLViewer_Polyline::unhighlight() return GL_FALSE; } +/*! + Selects polyline + /param x, y - co-ordinates of mouse + /param tol - tolerance + /param rect - rectangle (in case of rectangular selection) + /param isFull - if it is true, then object may selected only if it lays whole in selection zone + \param isCircle - true if sensitive area of detection is round + \param isShift - true if selection exec with append option +*/ GLboolean GLViewer_Polyline::select( GLfloat x, GLfloat y, GLfloat tol, GLViewer_Rect rect, GLboolean isFull, GLboolean isCircle, GLboolean isShift ) { @@ -994,6 +1150,9 @@ GLboolean GLViewer_Polyline::select( GLfloat x, GLfloat y, GLfloat tol, GLViewer return myIsSel; } +/*! + Unselects polyline +*/ GLboolean GLViewer_Polyline::unselect() { // if( !mySelNumbers.isEmpty() ) @@ -1013,6 +1172,11 @@ GLboolean GLViewer_Polyline::unselect() return GL_FALSE; } +/*! + Sets array of abscisses for points of polyline + \param xCoord - array of of abscisses + \param size - size of array +*/ void GLViewer_Polyline::setXCoord( GLfloat* xCoord, int size ) { myXCoord = new GLfloat[ size ]; @@ -1020,6 +1184,11 @@ void GLViewer_Polyline::setXCoord( GLfloat* xCoord, int size ) myXCoord[i] = xCoord[i]; } +/*! + Sets array of ordinates for points of polyline + \param xCoord - array of of ordinates + \param size - size of array +*/ void GLViewer_Polyline::setYCoord( GLfloat* yCoord, int size ) { myYCoord = new GLfloat[ size ]; @@ -1027,6 +1196,10 @@ void GLViewer_Polyline::setYCoord( GLfloat* yCoord, int size ) myYCoord[i] = yCoord[i]; } +/*! + Sets number of points + \param number - new number of points +*/ void GLViewer_Polyline::setNumber( GLint number ) { if ( myNumber == number ) @@ -1042,19 +1215,9 @@ void GLViewer_Polyline::setNumber( GLint number ) myXCoord = new GLfloat[ myNumber ]; myYCoord = new GLfloat[ myNumber ]; } -/* -void GLViewer_Polyline::onSelectionDone( bool append) -{ - mySelectedIndexes.Clear(); - QValueList::Iterator it; - //for( it = myMarkers->mySelNumbers.begin(); it != myMarkers->mySelNumbers.end(); ++it ) - // mySelectedIndexes.Append( *it / 2 ); //!!! -} -void GLViewer_Polyline::onSelectionCancel() -{ - mySelectedIndexes.Clear(); -} +/*! + Export numbers of highlighted/selected lines */ void GLViewer_Polyline::exportNumbers( QValueList& highlight, QValueList& unhighlight, @@ -1067,6 +1230,12 @@ void GLViewer_Polyline::exportNumbers( QValueList& highlight, unselect = myUSelNumbers; } +/*! + Moves object by recomputing + \param dx - moving along X coord + \param dy - moving along Y coord + \param fromGroup - is true if this method called from group +*/ void GLViewer_Polyline::moveObject( float theX, float theY, bool fromGroup ) { if( !fromGroup && myGroup) @@ -1082,6 +1251,10 @@ void GLViewer_Polyline::moveObject( float theX, float theY, bool fromGroup ) compute(); } +/*! + Codes polyline as byte copy + \return byte array +*/ QByteArray GLViewer_Polyline::getByteCopy() { int i = 0; @@ -1118,6 +1291,10 @@ QByteArray GLViewer_Polyline::getByteCopy() } +/*! + Initialize polyline by byte array + \param theArray - byte array +*/ bool GLViewer_Polyline::initializeFromByteCopy( QByteArray theArray ) { int i = 0; @@ -1167,13 +1344,16 @@ bool GLViewer_Polyline::initializeFromByteCopy( QByteArray theArray ) return true; } -/*************************************************************************** -** Class: GLViewer_TextObject -** Descr: Text as Object for OpenGL -** Module: GLViewer -** Created: UI team, 12.02.04 -****************************************************************************/ + +/*! + Constructor + \param theStr - text string + \param xPos - x position + \param yPos - y position + \param color - color of text + \param toolTip - tooltip of text object +*/ GLViewer_TextObject::GLViewer_TextObject( const QString& theStr, float xPos, float yPos, const QColor& color, const QString& toolTip ) : GLViewer_Object() @@ -1186,12 +1366,22 @@ GLViewer_TextObject::GLViewer_TextObject( const QString& theStr, float xPos, flo myToolTipText = toolTip; } + +/*! + Destructor +*/ GLViewer_TextObject::~GLViewer_TextObject() { if ( myGLText ) delete myGLText; } +/*! + Saves text object to file PostScript + \param hFile - file instance + \param aViewerCS - viewer co-ordinates system + \param aPSCS - paper co-ordinates system +*/ bool GLViewer_TextObject::translateToPS( QFile& hFile, GLViewer_CoordSystem* aViewerCS, GLViewer_CoordSystem* aPSCS ) { QString aText = myGLText->getText(); @@ -1209,6 +1399,12 @@ bool GLViewer_TextObject::translateToPS( QFile& hFile, GLViewer_CoordSystem* aVi return true; } +/*! + Saves text object to file HPGL + \param hFile - file instance + \param aViewerCS - viewer co-ordinates system + \param aHPGLCS - paper co-ordinates system +*/ bool GLViewer_TextObject::translateToHPGL( QFile& hFile, GLViewer_CoordSystem* aViewerCS, GLViewer_CoordSystem* aHPGLCS ) { QString aText = myGLText->getText(); @@ -1226,6 +1422,12 @@ bool GLViewer_TextObject::translateToHPGL( QFile& hFile, GLViewer_CoordSystem* a } #ifdef WIN32 +/*! + Saves text object to EMF image + \param dc - EMF image descriptor + \param aViewerCS - viewer co-ordinates system + \param aEMFCS - paper co-ordinates system +*/ bool GLViewer_TextObject::translateToEMF( HDC dc, GLViewer_CoordSystem* aViewerCS, GLViewer_CoordSystem* aEMFCS ) { QString aText = myGLText->getText(); @@ -1276,6 +1478,9 @@ bool GLViewer_TextObject::translateToEMF( HDC dc, GLViewer_CoordSystem* aViewerC } #endif +/*! + Creates corresponding drawer +*/ GLViewer_Drawer* GLViewer_TextObject::createDrawer() { myDrawer = new GLViewer_TextDrawer(); @@ -1283,6 +1488,9 @@ GLViewer_Drawer* GLViewer_TextObject::createDrawer() return myDrawer; } +/*! + Computes all necessary information about object for presentation in drawer +*/ void GLViewer_TextObject::compute() { float xPos, yPos; @@ -1297,12 +1505,20 @@ void GLViewer_TextObject::compute() myRect->setBottom( yPos ); } +/*! + Installing already exist drawer with same type + \param theDrawer - new drawer +*/ void GLViewer_TextObject::setDrawer( GLViewer_Drawer* theDrawer ) { myDrawer = theDrawer; //compute(); } +/*! + \return update object rectangle + Does not equal getRect() if object have a persistence to some viewer transformations +*/ GLViewer_Rect* GLViewer_TextObject::getUpdateRect() { GLViewer_Rect* rect = new GLViewer_Rect(); @@ -1319,6 +1535,14 @@ GLViewer_Rect* GLViewer_TextObject::getUpdateRect() return rect; } +/*! + Computes highlight presentation + \param x - x coord + \param y - y coord + \param tol - tolerance of detecting + \param isCircle - true if sensitive area of detection is round + \return true if highlight status is changed +*/ GLboolean GLViewer_TextObject::highlight( GLfloat theX, GLfloat theY, GLfloat theTol, GLboolean isCircle ) { if( !myIsVisible ) @@ -1366,6 +1590,9 @@ GLboolean GLViewer_TextObject::highlight( GLfloat theX, GLfloat theY, GLfloat th return myIsHigh; } +/*! + Unhilights object +*/ GLboolean GLViewer_TextObject::unhighlight() { if( myIsHigh ) @@ -1377,6 +1604,15 @@ GLboolean GLViewer_TextObject::unhighlight() return GL_FALSE; } +/*! + Selects text object + /param x, y - co-ordinates of mouse + /param tol - tolerance + /param rect - rectangle (in case of rectangular selection) + /param isFull - if it is true, then object may selected only if it lays whole in selection zone + \param isCircle - true if sensitive area of detection is round + \param isShift - true if selection exec with append option +*/ GLboolean GLViewer_TextObject::select( GLfloat theX, GLfloat theY, GLfloat theTol, GLViewer_Rect rect, GLboolean isFull, GLboolean isCircle, GLboolean isShift ) { @@ -1415,6 +1651,9 @@ GLboolean GLViewer_TextObject::select( GLfloat theX, GLfloat theY, GLfloat theTo return myIsSel; } +/*! + Unselects text object +*/ GLboolean GLViewer_TextObject::unselect() { if( myIsSel ) @@ -1426,6 +1665,12 @@ GLboolean GLViewer_TextObject::unselect() return GL_FALSE; } +/*! + Moves object by recomputing + \param dx - moving along X coord + \param dy - moving along Y coord + \param fromGroup - is true if this method called from group +*/ void GLViewer_TextObject::moveObject( float theX, float theY, bool fromGroup ) { if( !fromGroup && myGroup) @@ -1441,6 +1686,10 @@ void GLViewer_TextObject::moveObject( float theX, float theY, bool fromGroup ) compute(); } +/*! + Codes text object as byte copy + \return byte array +*/ QByteArray GLViewer_TextObject::getByteCopy() { QByteArray aObject = GLViewer_Object::getByteCopy(); @@ -1448,6 +1697,10 @@ QByteArray GLViewer_TextObject::getByteCopy() return aObject; } +/*! + Initialize text object by byte array + \param theArray - byte array +*/ bool GLViewer_TextObject::initializeFromByteCopy( QByteArray theArray ) { if( !GLViewer_Object::initializeFromByteCopy( theArray ) || myType != "GLViewer_TextObject" ) diff --git a/src/GLViewer/GLViewer_BaseObjects.h b/src/GLViewer/GLViewer_BaseObjects.h index 6e464ef04..c5dea1285 100644 --- a/src/GLViewer/GLViewer_BaseObjects.h +++ b/src/GLViewer/GLViewer_BaseObjects.h @@ -38,10 +38,9 @@ #endif /*! - * Class GLViewer_MarkerSet - * OpenGL MarkerSet - */ - + \class GLViewer_MarkerSet + OpenGL MarkerSet +*/ class GLVIEWER_API GLViewer_MarkerSet : public GLViewer_Object { public: @@ -120,10 +119,9 @@ protected: }; /*! - * Class GLViewer_Polyline - * OpenGL Polyline - */ - + \class GLViewer_Polyline + OpenGL Polyline +*/ class GLVIEWER_API GLViewer_Polyline: public GLViewer_Object { public: @@ -178,7 +176,7 @@ public: //! Checks highlight as whole object status GLboolean isHighSelAll() const { return myHighSelAll; } - //! Export numbers of heghlighted/selected lines + //! Export numbers of highlighted/selected lines void exportNumbers( QValueList& high, QValueList& unhigh, QValueList& sel, QValueList& unsel ); @@ -203,9 +201,10 @@ protected: GLboolean myHighFlag; }; -// Class: GLViewer_TextObject -// Descr: Text as Object for OpenGL - +/*! + \class GLViewer_TextObject + Text as Object for OpenGL +*/ class GLVIEWER_API GLViewer_TextObject : public GLViewer_Object { public: diff --git a/src/GLViewer/GLViewer_Compass.cxx b/src/GLViewer/GLViewer_Compass.cxx index 919641e7c..99c3f463a 100644 --- a/src/GLViewer/GLViewer_Compass.cxx +++ b/src/GLViewer/GLViewer_Compass.cxx @@ -22,18 +22,19 @@ // File: GLViewer_Compass.cxx // Created: November, 2004 -//================================================================ -// Class : GLViewer_Compass -// Description : Class implement representatiof of compass in one of corner in GLViewer -//================================================================ - #include "GLViewer_Compass.h" #include "GLViewer_Drawer.h" -//======================================================================= -// Function: GLViewer_Compass -// Purpose : -//======================================================================= +/*! + Constructor + \param color - a color of compass + \param size - a diameter of compass + \param pos - a position + \param WidthTop - width of wide part of arrow + \param WidthBottom - width of base part of arrow + \param HeightTop - height of arrow header + \param HeightBottom - height of arrow cut on bottom +*/ GLViewer_Compass::GLViewer_Compass ( const QColor& color, const int size, const Position pos, const int WidthTop, const int WidthBottom, const int HeightTop, const int HeightBottom ) @@ -52,19 +53,20 @@ GLViewer_Compass::GLViewer_Compass ( const QColor& color, const int size, const //myFont->generateTexture(); } -//======================================================================= -// Function: ~GLViewer_Compass -// Purpose : -//======================================================================= +/*! + Destructor +*/ GLViewer_Compass::~GLViewer_Compass() { delete myFont; } -//======================================================================= -// Function: setCompass -// Purpose : -//======================================================================= +/*! + Sets parameters of compass + \param color - a color of compass + \param size - a diameter of compass + \param pos - a position +*/ void GLViewer_Compass::setCompass( const QColor& color, const int size, const Position pos ) { myCol = color; @@ -72,29 +74,29 @@ void GLViewer_Compass::setCompass( const QColor& color, const int size, const Po myPos = pos; } -//======================================================================= -// Function: setVisible -// Purpose : -//======================================================================= +/*! + Sets visibility of compass + \param vis - new visibility state +*/ void GLViewer_Compass::setVisible( const bool vis ) { myIsVisible = vis; } -//======================================================================= -// Function: setSize -// Purpose : -//======================================================================= +/*! + Sets size of compass + \param size - new size +*/ void GLViewer_Compass::setSize( const int size ) { if( size > 0 ) mySize=size; } -//======================================================================= -// Function: setArrowWidthTop -// Purpose : -//======================================================================= +/*! + Sets arrow width top + \param WidthTop - new arrow width top +*/ void GLViewer_Compass::setArrowWidthTop( const int WidthTop ) { if( WidthTop < myArrowWidthBottom || WidthTop > mySize ) @@ -102,10 +104,10 @@ void GLViewer_Compass::setArrowWidthTop( const int WidthTop ) myArrowWidthTop=WidthTop; } -//======================================================================= -// Function: setArrowWidthBottom -// Purpose : -//======================================================================= +/*! + Sets arrow width bottom + \param WidthBot - new arrow width bottom +*/ void GLViewer_Compass::setArrowWidthBottom( const int WidthBot ) { if( WidthBot > myArrowWidthTop || WidthBot < 1 ) @@ -113,10 +115,10 @@ void GLViewer_Compass::setArrowWidthBottom( const int WidthBot ) myArrowWidthBottom=WidthBot; } -//======================================================================= -// Function: setArrowHeightTop -// Purpose : -//======================================================================= +/*! + Sets arrow height top + \param HeightTop - new arrow height top +*/ void GLViewer_Compass::setArrowHeightTop( const int HeightTop ) { if( HeightTop > (2*mySize-myArrowHeightBottom ) || HeightTop < 1 ) @@ -124,10 +126,10 @@ void GLViewer_Compass::setArrowHeightTop( const int HeightTop ) myArrowHeightTop=HeightTop; } -//======================================================================= -// Function: setArrowHeightBottom -// Purpose : -//======================================================================= +/*! + Sets arrow height bottom + \param HeightBot - new arrow height bottom +*/ void GLViewer_Compass::setArrowHeightBottom( const int HeightBot ) { if( HeightBot > ( 2*mySize-myArrowHeightTop ) || HeightBot < 1) @@ -135,10 +137,9 @@ void GLViewer_Compass::setArrowHeightBottom( const int HeightBot ) myArrowHeightBottom=HeightBot; } -//======================================================================= -// Function: getFont -// Purpose : -//======================================================================= +/*! + \return font of compass +*/ GLViewer_TexFont* GLViewer_Compass::getFont() { if(!isGenereted) @@ -149,10 +150,10 @@ GLViewer_TexFont* GLViewer_Compass::getFont() return myFont; } -//======================================================================= -// Function: setFont -// Purpose : -//======================================================================= +/*! + Sets font of compass + \param theFont - new font +*/ void GLViewer_Compass::setFont( QFont theFont ) { delete myFont; diff --git a/src/GLViewer/GLViewer_Compass.h b/src/GLViewer/GLViewer_Compass.h index abdec0e01..bb3b98913 100644 --- a/src/GLViewer/GLViewer_Compass.h +++ b/src/GLViewer/GLViewer_Compass.h @@ -33,14 +33,13 @@ #pragma warning( disable:4251 ) #endif +class GLViewer_TexFont; + /*! Class GLViewer_Compass * Class implement representatiof of compass in one of corner in GLViewer. * Compass it's a some round visual pointer rotated with view window and * located in fixed place (in one fixed corner) */ - -class GLViewer_TexFont; - class GLVIEWER_API GLViewer_Compass { public: diff --git a/src/GLViewer/GLViewer_Context.cxx b/src/GLViewer/GLViewer_Context.cxx index 7fc5fcf20..9b3842a48 100644 --- a/src/GLViewer/GLViewer_Context.cxx +++ b/src/GLViewer/GLViewer_Context.cxx @@ -22,10 +22,10 @@ // File: GLViewer_Context.cxx // Created: November, 2004 -//================================================================ -// Class : GLViewer_AspectLine -// Description : Class for manage of presentations in GLViewer -//================================================================ +/*! + \class GLViewer_AspectLine + \brief Class for manage of presentations in GLViewer +*/ #include "GLViewer_Context.h" @@ -38,10 +38,9 @@ #define TOLERANCE 12 -//======================================================================= -// Function: GLViewer_Context -// Purpose : -//======================================================================= +/*! + Constructor +*/ GLViewer_Context::GLViewer_Context( GLViewer_Viewer2d* v ) : myGLViewer2d( v ), myHighlightColor( Quantity_NOC_CYAN1 ), @@ -59,10 +58,9 @@ GLViewer_Context::GLViewer_Context( GLViewer_Viewer2d* v ) : mySelCurIndex = 0; } -//======================================================================= -// Function: ~GLViewer_Context -// Purpose : -//======================================================================= +/*! + Destructor +*/ GLViewer_Context::~GLViewer_Context() { myActiveObjects.clear(); @@ -70,10 +68,13 @@ GLViewer_Context::~GLViewer_Context() mySelectedObjects.clear(); } -//======================================================================= -// Function: MoveTo -// Purpose : -//======================================================================= +/*! + Hiilights objects under cursor + \param x - X coord of mouse cursor + \param y - Y coord of mouse cursor + \param byCircle - true if needs round sensitive area around mouse cursor, else rectangle + function search object rectangle which intersect with sensitive area and call object highlight method +*/ int GLViewer_Context::MoveTo( int xi, int yi, bool byCircle ) { GLfloat x = (GLfloat)xi; @@ -180,10 +181,10 @@ int GLViewer_Context::MoveTo( int xi, int yi, bool byCircle ) return 0; } -//======================================================================= -// Function: Select -// Purpose : -//======================================================================= +/*! Selects already highlighting object by calling object method select + \param Append - true if new selection will be append to existing selection, false - another + \param byCircle - true if needs round selection area in complex object +*/ int GLViewer_Context::Select( bool Append, bool byCircle ) { ObjList::Iterator it, itEnd, oit, oitEnd; @@ -322,10 +323,11 @@ int GLViewer_Context::Select( bool Append, bool byCircle ) return SS_NoChanged; } -//======================================================================= -// Function: SelectByRect -// Purpose : -//======================================================================= +/*! Selects objects on scene by rectangle + \param theRect - rectangle of selection + \param Append - true if new selection will be append to existing selection, false - another + function search object rectangle which intersect with theRect and call object select method +*/ int GLViewer_Context::SelectByRect( const QRect& theRect, bool Append ) { GLfloat aXScale; @@ -384,10 +386,10 @@ int GLViewer_Context::SelectByRect( const QRect& theRect, bool Append ) return status; } -//======================================================================= -// Function: SetHighlightColor -// Purpose : -//======================================================================= +/*! + Sets color of hilighting + \param aCol - new color of highlighting +*/ void GLViewer_Context::SetHighlightColor( Quantity_NameOfColor aCol ) { myHighlightColor = aCol; @@ -407,10 +409,10 @@ void GLViewer_Context::SetHighlightColor( Quantity_NameOfColor aCol ) myGLViewer2d->updateColors( colH, colS); } -//======================================================================= -// Function: SetSelectionColor -// Purpose : -//======================================================================= +/*! + Sets color of selection + \param aCol - new color of selection +*/ void GLViewer_Context::SetSelectionColor( Quantity_NameOfColor aCol ) { mySelectionColor = aCol; @@ -430,37 +432,33 @@ void GLViewer_Context::SetSelectionColor( Quantity_NameOfColor aCol ) myGLViewer2d->updateColors( colH, colS); } -//======================================================================= -// Function: NbSelected -// Purpose : -//======================================================================= +/*! + \return number of selected objects +*/ int GLViewer_Context::NbSelected() { return mySelectedObjects.count(); } -//======================================================================= -// Function: InitSelected -// Purpose : -//======================================================================= +/*! + Inits iteration through selected objects +*/ void GLViewer_Context::InitSelected() { mySelCurIndex = 0; } -//======================================================================= -// Function: MoreSelected -// Purpose : -//======================================================================= +/*! + Checks if iteration through selected objects may be continued +*/ bool GLViewer_Context::MoreSelected() { return ( mySelCurIndex < NbSelected() ); } -//======================================================================= -// Function: NextSelected -// Purpose : -//======================================================================= +/*! + Iterates to next selected object +*/ bool GLViewer_Context::NextSelected() { if ( mySelCurIndex >= 0 && mySelCurIndex < NbSelected() ) @@ -472,28 +470,28 @@ bool GLViewer_Context::NextSelected() return FALSE; } -//======================================================================= -// Function: SelectedObject -// Purpose : -//======================================================================= +/*! + \return current selected object (must be used only in cycle as "for( InitSelected(); MoreSelected(); NextSelected() ) {...}" ) +*/ GLViewer_Object* GLViewer_Context::SelectedObject() { return mySelectedObjects[ mySelCurIndex ]; } -//======================================================================= -// Function: isSelected -// Purpose : -//======================================================================= +/*! + \return true if object is selected + \param theObj - object to be checked +*/ bool GLViewer_Context::isSelected( GLViewer_Object* theObj ) { return mySelectedObjects.contains( theObj ); } -//======================================================================= -// Function: insertObject -// Purpose : -//======================================================================= +/*! Inserts new object in context + \param theObject - object to be inserted + \param display - true if needs display object immediatly after inserting, else false + \param isActive - true if needs inserting object in active list +*/ int GLViewer_Context::insertObject( GLViewer_Object* object, bool display, bool isActive ) { // cout << "GLViewer_Context::insertObject" << endl; @@ -517,10 +515,11 @@ int GLViewer_Context::insertObject( GLViewer_Object* object, bool display, bool return myActiveObjects.count() + myInactiveObjects.count(); } -//======================================================================= -// Function: replaceObject -// Purpose : -//======================================================================= +/*! + Replaces object in context + \param oldObject - object to be replaced + \param newObject - object for replacing +*/ bool GLViewer_Context::replaceObject( GLViewer_Object* oldObject, GLViewer_Object* newObject ) { if( !oldObject || !newObject ) @@ -543,10 +542,9 @@ bool GLViewer_Context::replaceObject( GLViewer_Object* oldObject, GLViewer_Objec return false; } -//======================================================================= -// Function: updateScales -// Purpose : -//======================================================================= +/*! + Updates scales of all objects in context +*/ void GLViewer_Context::updateScales( GLfloat scX, GLfloat scY ) { if( scX <= 0 || scY <= 0 ) @@ -561,10 +559,10 @@ void GLViewer_Context::updateScales( GLfloat scX, GLfloat scY ) (*it)->setScale( scX, scY ); } -//======================================================================= -// Function: clearHighlighted -// Purpose : -//======================================================================= +/*! + Clears hilighting of objects + \param updateViewer - if it is true, viewer must be updated +*/ void GLViewer_Context::clearHighlighted( bool updateViewer ) { if( myHFlag && myLastPicked ) @@ -577,10 +575,10 @@ void GLViewer_Context::clearHighlighted( bool updateViewer ) } } -//======================================================================= -// Function: clearSelected -// Purpose : -//======================================================================= +/*! + Clears selection of objects + \param updateViewer - if it is true, viewer must be updated +*/ void GLViewer_Context::clearSelected( bool updateViewer ) { if( !mySFlag ) @@ -600,10 +598,10 @@ void GLViewer_Context::clearSelected( bool updateViewer ) mySelectedObjects.clear(); } -//======================================================================= -// Function: setSelected -// Purpose : -//======================================================================= +/*! + Selects object, other selected objects are left as selected + \param updateViewer - if it is true, viewer must be updated +*/ void GLViewer_Context::setSelected( GLViewer_Object* object, bool updateViewer ) { if( !object ) @@ -619,10 +617,10 @@ void GLViewer_Context::setSelected( GLViewer_Object* object, bool updateViewer ) myGLViewer2d->activateDrawer( object, TRUE, TRUE ); } -//======================================================================= -// Function: remSelected -// Purpose : -//======================================================================= +/*! + Unselects object, other selected objects are left as selected + \param updateViewer - if it is true, viewer must be updated +*/ void GLViewer_Context::remSelected( GLViewer_Object* object, bool updateViewer ) { if( !object || !mySelectedObjects.contains( object ) ) @@ -635,10 +633,10 @@ void GLViewer_Context::remSelected( GLViewer_Object* object, bool updateViewer ) myGLViewer2d->activateDrawer( object, TRUE, TRUE ); } -//======================================================================= -// Function: eraseObject -// Purpose : -//======================================================================= +/*! + Erases object in viewer + \param theUpdateViewer - if it is true, viewer must be updated +*/ void GLViewer_Context::eraseObject( GLViewer_Object* theObject, bool theUpdateViewer ) { if( !theObject || !myActiveObjects.contains( theObject ) ) @@ -652,10 +650,10 @@ void GLViewer_Context::eraseObject( GLViewer_Object* theObject, bool theUpdateVi myGLViewer2d->updateAll(); } -//======================================================================= -// Function: deleteObject -// Purpose : -//======================================================================= +/*! + Deletes object in + \param updateViewer - if it is true, viewer must be updated +*/ void GLViewer_Context::deleteObject( GLViewer_Object* theObject, bool updateViewer ) { if( !theObject || @@ -683,10 +681,10 @@ void GLViewer_Context::deleteObject( GLViewer_Object* theObject, bool updateView myGLViewer2d->updateAll(); } -//======================================================================= -// Function: setActive -// Purpose : -//======================================================================= +/*! + Installs active status to object + \param theObject +*/ bool GLViewer_Context::setActive( GLViewer_Object* theObject ) { if( !theObject || !myInactiveObjects.contains( theObject ) ) @@ -697,10 +695,10 @@ bool GLViewer_Context::setActive( GLViewer_Object* theObject ) return true; } -//======================================================================= -// Function: setInactive -// Purpose : -//======================================================================= +/*! + Installs inactive status to object + \param theObject +*/ bool GLViewer_Context::setInactive( GLViewer_Object* theObject ) { if( !theObject || !myActiveObjects.contains( theObject ) ) diff --git a/src/GLViewer/GLViewer_Context.h b/src/GLViewer/GLViewer_Context.h index f8c76eb50..d339782f6 100644 --- a/src/GLViewer/GLViewer_Context.h +++ b/src/GLViewer/GLViewer_Context.h @@ -23,10 +23,6 @@ // Created: November, 2004 -/*! Class GLViewer_Context - * Class for manage of presentations in GLViewer - */ - #ifndef GLVIEWER_CONTEXT_H #define GLVIEWER_CONTEXT_H @@ -52,6 +48,9 @@ class GLViewer_Viewer2d; #pragma warning( disable:4251 ) #endif +/*! \class GLViewer_Context + * Class for manage of presentations in GLViewer + */ class GLVIEWER_API GLViewer_Context { public: @@ -73,14 +72,12 @@ public: *function search object rectangle which intersect with sensitive area and call object highlight method */ int MoveTo( int x, int y, bool byCircle = FALSE ); - //! A function selecting already highlighting object by calling object method select - /*! + /*! A function selecting already highlighting object by calling object method select *\param Append - true if new selection will be append to existing selection, false - another *\param byCircle - true if needs round selection area in complex object */ int Select( bool Append = FALSE, bool byCircle = FALSE ); - //! A function selecting objects on scene by rectangle - /*! + /*! A function selecting objects on scene by rectangle *\param theRect - rectangle of selection *\param Append - true if new selection will be append to existing selection, false - another *function search object rectangle which intersect with theRect and call object select method @@ -119,7 +116,7 @@ public: int insertObject( GLViewer_Object* theObject, bool display = false, bool isActive = true ); //! Replacing objects in context /*! - * Function search activ and incative objects + * Function search active and incative objects */ bool replaceObject( GLViewer_Object* oldObject, GLViewer_Object* newObject ); //! A function updating scales of all objects in context @@ -129,7 +126,7 @@ public: //! Returns list of context objects /*! - * Returns active objects if isActive = true, else inactive objects + * \return active objects if isActive = true, else inactive objects */ const ObjList& getObjects( bool isActive = true ) { return isActive ? myActiveObjects : myInactiveObjects; } diff --git a/src/GLViewer/GLViewer_CoordSystem.cxx b/src/GLViewer/GLViewer_CoordSystem.cxx index 947ac6036..405c22b96 100644 --- a/src/GLViewer/GLViewer_CoordSystem.cxx +++ b/src/GLViewer/GLViewer_CoordSystem.cxx @@ -22,17 +22,18 @@ // File: GLViewer_Context.cxx // Created: November, 2004 -//================================================================ -// Class : GLViewer_CoordSystem -// Description : Class implementing mathematical model of 2D coordinate system -//================================================================ #include "GLViewer_CoordSystem.h" #include -//======================================================================= -// Function: GLViewer_CoordSystem -// Purpose : -//======================================================================= +/*! + Constructor + \param aType - type of CS + \param X0 - X of origin in reference CS + \param Y0 - Y of origin in reference CS + \param XUnit - X unit in reference CS + \param YUnit - Y unit in reference CS + \param Rotation - rotation relative reference CS +*/ GLViewer_CoordSystem::GLViewer_CoordSystem( CSType aType, double X0, double Y0, double XUnit, double YUnit, double Rotation ) { @@ -42,40 +43,36 @@ GLViewer_CoordSystem::GLViewer_CoordSystem( CSType aType, double X0, double Y0, setRotation( Rotation ); } -//======================================================================= -// Function: getOrigin -// Purpose : -//======================================================================= +/*! + \return origin in reference CS +*/ void GLViewer_CoordSystem::getOrigin( double& x, double& y ) const { x = myX0; y = myY0; } -//======================================================================= -// Function: setOrigin -// Purpose : -//======================================================================= +/*! + Sets origin in reference CS +*/ void GLViewer_CoordSystem::setOrigin( double x, double y ) { myX0 = x; myY0 = y; } -//======================================================================= -// Function: getUnits -// Purpose : -//======================================================================= +/*! + \return units +*/ void GLViewer_CoordSystem::getUnits( double& x, double& y ) const { x = myXUnit; y = myYUnit; } -//======================================================================= -// Function: setUnits -// Purpose : -//======================================================================= +/*! + Sets units +*/ void GLViewer_CoordSystem::setUnits( double x, double y ) { if( x>0 ) @@ -88,46 +85,43 @@ void GLViewer_CoordSystem::setUnits( double x, double y ) else myYUnit = 1.0; } -//======================================================================= -// Function: getRotation -// Purpose : -//======================================================================= + +/*! + \return rotation +*/ double GLViewer_CoordSystem::getRotation() const { return myRotation; } -//======================================================================= -// Function: setRotation -// Purpose : -//======================================================================= +/*! + Sets rotation +*/ void GLViewer_CoordSystem::setRotation( double rotation ) { myRotation = rotation; } -//======================================================================= -// Function: getType -// Purpose : -//======================================================================= +/*! + \return type +*/ GLViewer_CoordSystem::CSType GLViewer_CoordSystem::getType() const { return myType; } -//======================================================================= -// Function: setType -// Purpose : -//======================================================================= +/*! + Sets type +*/ void GLViewer_CoordSystem::setType( CSType type ) { myType = type; } -//======================================================================= -// Function: toReference -// Purpose : -//======================================================================= +/*! + Recalculate co-ordinates to reference co-ordinates + \param x, y - co-ordinates +*/ void GLViewer_CoordSystem::toReference( double& x, double& y ) { if( myType==Cartesian ) @@ -145,10 +139,10 @@ void GLViewer_CoordSystem::toReference( double& x, double& y ) } } -//======================================================================= -// Function: fromReference -// Purpose : -//======================================================================= +/*! + Recalculate co-ordinates from reference co-ordinates + \param x, y - co-ordinates +*/ void GLViewer_CoordSystem::fromReference( double& x, double& y ) { x = (x - myX0) / myXUnit; @@ -185,20 +179,20 @@ void GLViewer_CoordSystem::fromReference( double& x, double& y ) } } -//======================================================================= -// Function: transform -// Purpose : -//======================================================================= +/*! + Recalculate co-ordinates to co-ordinates of other CS + \param aSystem - other CS + \param x, y - co-ordinates +*/ void GLViewer_CoordSystem::transform( GLViewer_CoordSystem& aSystem, double& x, double& y ) { toReference( x, y ); aSystem.fromReference( x, y ); } -//======================================================================= -// Function: getStretching -// Purpose : -//======================================================================= +/*! + \return stretching of CS along X and Y axis +*/ void GLViewer_CoordSystem::getStretching( GLViewer_CoordSystem& aSystem, double& theX, double& theY ) { theX = myXUnit / aSystem.myXUnit; diff --git a/src/GLViewer/GLViewer_CoordSystem.h b/src/GLViewer/GLViewer_CoordSystem.h index ca571daab..4ea7795b1 100644 --- a/src/GLViewer/GLViewer_CoordSystem.h +++ b/src/GLViewer/GLViewer_CoordSystem.h @@ -35,6 +35,10 @@ #pragma warning( disable:4251 ) #endif +/*! + \class GLViewer_CoordSystem + \brief Class implementing mathematical model of 2D coordinate system +*/ class GLVIEWER_API GLViewer_CoordSystem { public: diff --git a/src/GLViewer/GLViewer_Drawer.cxx b/src/GLViewer/GLViewer_Drawer.cxx index b63cdda60..1b6912b81 100644 --- a/src/GLViewer/GLViewer_Drawer.cxx +++ b/src/GLViewer/GLViewer_Drawer.cxx @@ -48,10 +48,7 @@ GLfloat modelMatrix[16]; -//================================================================ -// Class : GLViewer_TexFont -// Description : -//================================================================ + //! code of first font symbol static int FirstSymbolNumber = 32; //! code of last font symbol @@ -60,10 +57,9 @@ static int LastSymbolNumber = 127; QMap GLViewer_TexFont::TexFontBase; QMap GLViewer_TexFont::BitmapFontCache; -//======================================================================= -// Function: clearTextBases -// Purpose : -//======================================================================= +/*! + Clears all generated fonts +*/ void GLViewer_TexFont::clearTextBases() { //cout << "Clear font map" << endl; @@ -71,10 +67,9 @@ void GLViewer_TexFont::clearTextBases() BitmapFontCache.clear(); } -//====================================================================== -// Function: GLViewer_TexFont -// Purpose : -//======================================================================= +/*! + Default constructor +*/ GLViewer_TexFont::GLViewer_TexFont() : myMaxRowWidth( 0 ), myFontHeight( 0 ) { @@ -86,10 +81,13 @@ GLViewer_TexFont::GLViewer_TexFont() init(); } -//====================================================================== -// Function: GLViewer_TexFont -// Purpose : -//======================================================================= +/*! + Constructor + \param theFont - a base font + \param theSeparator - separator between letters + \param theIsResizeable - specifies whether text drawn by this object can be scaled along with the scene + \param theMinMagFilter - min/mag filter, affects text sharpness +*/ GLViewer_TexFont::GLViewer_TexFont( QFont* theFont, int theSeparator, bool theIsResizeable, GLuint theMinMagFilter ) : myMaxRowWidth( 0 ), myFontHeight( 0 ) { @@ -101,20 +99,18 @@ GLViewer_TexFont::GLViewer_TexFont( QFont* theFont, int theSeparator, bool theIs init(); } -//====================================================================== -// Function: ~GLViewer_TexFont -// Purpose : -//======================================================================= +/*! + Destructor +*/ GLViewer_TexFont::~GLViewer_TexFont() { delete[] myWidths; delete[] myPositions; } -//====================================================================== -// Function: init -// Purpose : -//======================================================================= +/*! + Initializes font parameters +*/ void GLViewer_TexFont::init() { myNbSymbols = LastSymbolNumber - FirstSymbolNumber + 1; @@ -148,10 +144,9 @@ void GLViewer_TexFont::init() myTexFontHeight = 0; } -//====================================================================== -// Function: generateTexture -// Purpose : -//======================================================================= +/*! + Generating font texture +*/ bool GLViewer_TexFont::generateTexture() { GLViewer_TexFindId aFindFont; @@ -265,10 +260,13 @@ bool GLViewer_TexFont::generateTexture() return true; } -//====================================================================== -// Function: drawString -// Purpose : -//======================================================================= +/*! + Drawing string in viewer + \param theStr - string to be drawn + \param theX - X position + \param theY - Y position + \param theScale - scale coefficient +*/ void GLViewer_TexFont::drawString( QString theStr, GLdouble theX , GLdouble theY, GLfloat theScale ) { // Adding some pixels to have a gap between rows @@ -334,10 +332,9 @@ void GLViewer_TexFont::drawString( QString theStr, GLdouble theX , GLdouble theY glPopAttrib(); } -//====================================================================== -// Function: getStringWidth -// Purpose : -//======================================================================= +/*! + \return width of string in pixels +*/ int GLViewer_TexFont::getStringWidth( QString theStr ) { int aWidth = 0; @@ -351,17 +348,18 @@ int GLViewer_TexFont::getStringWidth( QString theStr ) return aWidth; } -//====================================================================== -// Function: getStringHeight -// Purpose : -//======================================================================= +/*! + \return height of string in pixels +*/ int GLViewer_TexFont::getStringHeight() { QFontMetrics aFM( myQFont ); return aFM.height(); } -//! function for generation list base for bitmap fonts +/*! + Generates list base for bitmap fonts +*/ static GLuint displayListBase( QFont* theFont ) { if ( !theFont ) @@ -473,16 +471,9 @@ static GLuint displayListBase( QFont* theFont ) return aList; } -/*************************************************************************** -** Class: GLViewer_Drawer -** Descr: Drawer for GLViewer_Object -** Module: GLViewer -** Created: UI team, 01.10.01 -****************************************************************************/ -//====================================================================== -// Function: GLViewer_Drawer -// Purpose : -//======================================================================= +/*! + Default constructor +*/ GLViewer_Drawer::GLViewer_Drawer() : myFont( "Helvetica", 10, QFont::Bold ) { @@ -495,20 +486,18 @@ GLViewer_Drawer::GLViewer_Drawer() myTextScale = 0.125; } -//====================================================================== -// Function: ~GLViewer_Drawer -// Purpose : -//======================================================================= +/*! + Destructor +*/ GLViewer_Drawer::~GLViewer_Drawer() { myObjects.clear(); glDeleteLists( myTextList, 1 ); } -//====================================================================== -// Function: destroyAllTextures -// Purpose : -//======================================================================= +/*! + Clears all generated textures +*/ void GLViewer_Drawer::destroyAllTextures() { QMap::Iterator anIt= GLViewer_TexFont::TexFontBase.begin(); @@ -518,10 +507,10 @@ void GLViewer_Drawer::destroyAllTextures() glDeleteTextures( 1, &(anIt.data().myTexFontId) ); } -//======================================================================= -// Function: setAntialiasing -// Purpose : The function enables and disables antialiasing in Open GL (for points, lines and polygons). -//======================================================================= +/*! + Enables and disables antialiasing in Open GL (for points, lines and polygons). + \param on - if it is true, antialiasing is enabled +*/ void GLViewer_Drawer::setAntialiasing(const bool on) { if (on) @@ -545,10 +534,12 @@ void GLViewer_Drawer::setAntialiasing(const bool on) } } -//====================================================================== -// Function: loadTexture -// Purpose : -//======================================================================= +/*! Loads texture from file + \param fileName - the name of texture file + \param x_size - the horizontal size of picture ( less or equal texture horizontal size ) + \param y_size - the vertical size of picture ( less or equal texture vertical size ) + \param t_size - the size of texture ( texture vertical size equals texture horizontal size ) +*/ GLuint GLViewer_Drawer::loadTexture( const QString& fileName, GLint* x_size, GLint* y_size, @@ -620,10 +611,12 @@ GLuint GLViewer_Drawer::loadTexture( const QString& fileName, return texture; } -//====================================================================== -// Function: drawTexture -// Purpose : -//======================================================================= +/*! Draw square texture + \param texture - the texture ID + \param size - the size of square texture + \param x - x coord + \param y - y coord +*/ void GLViewer_Drawer::drawTexture( GLuint texture, GLint size, GLfloat x, GLfloat y ) { /*float xScale = myXScale; @@ -660,10 +653,13 @@ void GLViewer_Drawer::drawTexture( GLuint texture, GLint size, GLfloat x, GLfloa drawTexture( texture, size, size, x, y ); } -//====================================================================== -// Function: drawTexture -// Purpose : -//======================================================================= +/*! Draw texture + \param texture - the texture ID + \param x_size - the horizontal size of texture + \param y_size - the vertical size of texture + \param x - x coord + \param y - y coord +*/ void GLViewer_Drawer::drawTexture( GLuint texture, GLint x_size, GLint y_size, GLfloat x, GLfloat y ) { /*float xScale = myXScale; @@ -699,10 +695,16 @@ void GLViewer_Drawer::drawTexture( GLuint texture, GLint x_size, GLint y_size, G drawTexturePart( texture, 1.0, 1.0, x_size, y_size, x, y ); } -//====================================================================== -// Function: drawTexture -// Purpose : -//======================================================================= +/*! Draw texture part + \param texture - the texture ID + \param x_ratio - the horizontal ratio of texture part + \param y_ratio - the vertical ratio of texture part + \param x_size - the horizontal size of texture + \param y_size - the vertical size of texture + \param x - x coord + \param y - y coord + \param scale - common scale factor ( if = 0, use drawer scales ) +*/ void GLViewer_Drawer::drawTexturePart( GLuint texture, GLfloat x_ratio, GLfloat y_ratio, @@ -750,10 +752,16 @@ void GLViewer_Drawer::drawTexturePart( GLuint texture, glDisable( GL_TEXTURE_2D ); } -//====================================================================== -// Function: drawText -// Purpose : -//======================================================================= +/*! + Draw text + \param text - text to be drawn + \param xPos - x position + \param yPos - y position + \param color - color of text + \param theFont - font of text + \param theSeparator - letter separator + \param theFormat - text format (by default DTF_BITMAP) +*/ void GLViewer_Drawer::drawText( const QString& text, GLfloat xPos, GLfloat yPos, const QColor& color, QFont* theFont, int theSeparator, DisplayTextFormat theFormat ) { @@ -781,10 +789,9 @@ void GLViewer_Drawer::drawText( const QString& text, GLfloat xPos, GLfloat yPos, } } -//====================================================================== -// Function: drawText -// Purpose : -//======================================================================= +/*! + Draws object-text +*/ void GLViewer_Drawer::drawText( GLViewer_Object* theObject ) { if( !theObject ) @@ -801,10 +808,15 @@ void GLViewer_Drawer::drawText( GLViewer_Object* theObject ) drawText( aText->getText(), aPosX, aPosY, aText->getColor(), &aTmpVarFont, aText->getSeparator(), aText->getDisplayTextFormat() ); } -//====================================================================== -// Function: drawGLText -// Purpose : -//======================================================================= +/*! Draw text + \param text - the text string + \param x - x coord + \param y - y coord + \param hPosition - horizontal alignment + \param vPosition - vertical alignment + \param color - text color + \param smallFont - font format +*/ void GLViewer_Drawer::drawGLText( QString text, float x, float y, int hPosition, int vPosition, QColor color, bool smallFont ) { @@ -838,10 +850,9 @@ void GLViewer_Drawer::drawGLText( QString text, float x, float y, drawText( text, x, y, color, &aFont, 2, myTextFormat ); } -//====================================================================== -// Function: textRect -// Purpose : -//======================================================================= +/*! + \return a rectangle of text (without viewer scale) +*/ GLViewer_Rect GLViewer_Drawer::textRect( const QString& text ) const { GLfloat scale = textScale() > 0. ? textScale() : 1.; @@ -853,10 +864,11 @@ GLViewer_Rect GLViewer_Drawer::textRect( const QString& text ) const return GLViewer_Rect( 0, width, height, 0 ); } -//====================================================================== -// Function: drawRectangle -// Purpose : -//======================================================================= +/*! + Draws rectangle + \param rect - instance of primitive + \param color - color of primitive +*/ void GLViewer_Drawer::drawRectangle( GLViewer_Rect* rect, QColor color ) { if( !rect ) @@ -880,10 +892,12 @@ void GLViewer_Drawer::drawRectangle( GLViewer_Rect* rect, QColor color ) glEnd(); } -//====================================================================== -// Function: translateToHPGL -// Purpose : -//======================================================================= +/*! + Saves object to file with format of HPGL + \param hFile - file + \param aViewerCS - viewer co-ordinate system + \param aHPGLCS - paper co-ordinate system +*/ bool GLViewer_Drawer::translateToHPGL( QFile& hFile, GLViewer_CoordSystem* aViewerCS, GLViewer_CoordSystem* aHPGLCS ) { bool result = true; @@ -892,10 +906,12 @@ bool GLViewer_Drawer::translateToHPGL( QFile& hFile, GLViewer_CoordSystem* aView return result; } -//====================================================================== -// Function: translateToPS -// Purpose : -//======================================================================= +/*! + Saves object to file with format of PostScript + \param hFile - file + \param aViewerCS - viewer co-ordinate system + \param aPSCS - paper co-ordinate system +*/ bool GLViewer_Drawer::translateToPS( QFile& hFile, GLViewer_CoordSystem* aViewerCS, GLViewer_CoordSystem* aPSCS ) { bool result = true; @@ -905,10 +921,12 @@ bool GLViewer_Drawer::translateToPS( QFile& hFile, GLViewer_CoordSystem* aViewer } #ifdef WIN32 -//====================================================================== -// Function: translateToEMF -// Purpose : -//======================================================================= +/*! + Saves object to file with format of EMF + \param hFile - file + \param aViewerCS - viewer co-ordinate system + \param aEMFCS - paper co-ordinate system +*/ bool GLViewer_Drawer::translateToEMF( HDC hDC, GLViewer_CoordSystem* aViewerCS, GLViewer_CoordSystem* aEMFCS ) { bool result = true; @@ -918,10 +936,15 @@ bool GLViewer_Drawer::translateToEMF( HDC hDC, GLViewer_CoordSystem* aViewerCS, } #endif -//====================================================================== -// Function: drawRectangle -// Purpose : -//======================================================================= +/*! + Draws rectangle + \param rect - instance of primitive + \param lineWidth - width of line + \param gap - gap of rectangle + \param color - color of primitive + \param filled - if it is true, then rectangle will be drawn filled with color "fillingColor" + \param fillingColor - color of filling +*/ void GLViewer_Drawer::drawRectangle( GLViewer_Rect* rect, GLfloat lineWidth, GLfloat gap, QColor color, bool filled, QColor fillingColor ) { @@ -959,10 +982,12 @@ void GLViewer_Drawer::drawRectangle( GLViewer_Rect* rect, GLfloat lineWidth, GLf glEnd(); } -//====================================================================== -// Function: drawContour -// Purpose : -//======================================================================= +/*! + Draws contour + \param pntList - list of points + \param color - color of contour + \param lineWidth - width of line +*/ void GLViewer_Drawer::drawContour( const GLViewer_PntList& pntList, QColor color, GLfloat lineWidth ) { glColor3f( ( GLfloat )color.red() / 255, @@ -977,10 +1002,14 @@ void GLViewer_Drawer::drawContour( const GLViewer_PntList& pntList, QColor color glEnd(); } -//====================================================================== -// Function: drawContour -// Purpose : -//======================================================================= +/*! + Draws rectangular contour + \param rect - instance of rectangle + \param color - color of primitive + \param lineWidth - width of line + \param pattern - pattern of line + \param isStripe - enables line stipple +*/ void GLViewer_Drawer::drawContour( GLViewer_Rect* rect, QColor color, GLfloat lineWidth, GLushort pattern, bool isStripe ) { @@ -1011,10 +1040,11 @@ void GLViewer_Drawer::drawContour( GLViewer_Rect* rect, QColor color, GLfloat li glDisable( GL_LINE_STIPPLE ); } -//====================================================================== -// Function: drawPolygon -// Purpose : -//======================================================================= +/*! + Draws polygon + \param pntList - list of points + \param color - color of polygon +*/ void GLViewer_Drawer::drawPolygon( const GLViewer_PntList& pntList, QColor color ) { glColor3f( ( GLfloat )color.red() / 255, @@ -1027,10 +1057,13 @@ void GLViewer_Drawer::drawPolygon( const GLViewer_PntList& pntList, QColor color glEnd(); } -//====================================================================== -// Function: drawPolygon -// Purpose : -//======================================================================= +/*! + Draws rectangle + \param rect - instance of rectangle + \param color - color of polygon + \param pattern - pattern of line + \param isStripe - enables line stipple +*/ void GLViewer_Drawer::drawPolygon( GLViewer_Rect* rect, QColor color, GLushort pattern, bool isStripe ) { @@ -1058,11 +1091,14 @@ void GLViewer_Drawer::drawPolygon( GLViewer_Rect* rect, QColor color, glDisable( GL_LINE_STIPPLE ); } -//====================================================================== -// Function: drawVertex -// Purpose : -//======================================================================= GLubyte rasterVertex[5] = { 0x70, 0xf8, 0xf8, 0xf8, 0x70 }; + +/*! + Draws vertex + \param x - x position + \param y - y position + \param color - color of vertex +*/ void GLViewer_Drawer::drawVertex( GLfloat x, GLfloat y, QColor color ) { glColor3f( ( GLfloat )color.red() / 255, ( GLfloat )color.green() / 255, ( GLfloat )color.blue() / 255 ); @@ -1070,11 +1106,14 @@ void GLViewer_Drawer::drawVertex( GLfloat x, GLfloat y, QColor color ) glBitmap( 5, 5, 2, 2, 0, 0, rasterVertex ); } -//====================================================================== -// Function: drawCross -// Purpose : -//======================================================================= GLubyte rasterCross[7] = { 0x82, 0x44, 0x28, 0x10, 0x28, 0x44, 0x82 }; + +/*! + Draws cross + \param x - x position + \param y - y position + \param color - color of cross +*/ void GLViewer_Drawer::drawCross( GLfloat x, GLfloat y, QColor color ) { glColor3f( ( GLfloat )color.red() / 255, ( GLfloat )color.green() / 255, ( GLfloat )color.blue() / 255 ); @@ -1082,10 +1121,18 @@ void GLViewer_Drawer::drawCross( GLfloat x, GLfloat y, QColor color ) glBitmap( 7, 7, 3, 3, 0, 0, rasterCross ); } -//====================================================================== -// Function: drawArrow -// Purpose : -//======================================================================= +/*! + Draws arrow + \param red, green, blue - components of color + \param lineWidth - width of line + \param staff - + \param length - length of arrow + \param width - width of arrow + \param x - x position + \param y - y position + \param angle - angle of arrow + \param filled - drawn as filled +*/ void GLViewer_Drawer::drawArrow( const GLfloat red, const GLfloat green, const GLfloat blue, GLfloat lineWidth, GLfloat staff, GLfloat length, GLfloat width, diff --git a/src/GLViewer/GLViewer_Drawer.h b/src/GLViewer/GLViewer_Drawer.h index 4b66e7b20..189560e0b 100644 --- a/src/GLViewer/GLViewer_Drawer.h +++ b/src/GLViewer/GLViewer_Drawer.h @@ -98,17 +98,11 @@ struct GLVIEWER_API GLViewer_TexFindId } }; -/*************************************************************************** -** Class: GLViewer_TexFont -** Descr: Font for GLViewer_Drawer -** Module: GLViewer -** Created: UI team, 03.10.01 -****************************************************************************/ +/*! + \class GLViewer_TexFont + Font for GLViewer_Drawer, Drawing bitmap and texture fonts in GLViewer +*/ -/*! - * Class GLViewer_TexFont - * Drawing bitmap and texture fonts in GLViewer - */ class GLVIEWER_API GLViewer_TexFont { public: @@ -185,17 +179,11 @@ private: int myMaxRowWidth; }; -/*************************************************************************** -** Class: GLViewer_Drawer -** Descr: Drawer for GLObject -** Module: GLViewer -** Created: UI team, 03.10.01 -****************************************************************************/ /*! - * Class GLViewer_Drawer - * Drawer for GLViewer_Objects. - * Drawer creates only one times per one type of object - */ + \class GLViewer_Drawer + Drawer for GLViewer_Objects. + Drawer creates only one times per one type of object +*/ class GLVIEWER_API GLViewer_Drawer { public: diff --git a/src/GLViewer/GLViewer_Geom.cxx b/src/GLViewer/GLViewer_Geom.cxx index cd0ef5cae..b5b1852cd 100644 --- a/src/GLViewer/GLViewer_Geom.cxx +++ b/src/GLViewer/GLViewer_Geom.cxx @@ -19,23 +19,15 @@ // Author : OPEN CASCADE // -/*************************************************************************** -** Class: GLViewer_Geom -** Descr: -** Module: GLViewer -** Created: UI team, 16.11.04 -****************************************************************************/ - //#include #include #define FAR_POINT 1e10 // Value used as a "very distant" co-ordinate #define TOLERANCE 1e-3 -//================================================================ -// Function : GLViewer_Segment -// Purpose : constructs a real segment bounded by two points -//================================================================ +/*! + constructs a real segment bounded by two points +*/ GLViewer_Segment::GLViewer_Segment( const GLViewer_Pnt& thePnt1, const GLViewer_Pnt& thePnt2 ) : myPnt1( thePnt1 ), @@ -46,11 +38,9 @@ GLViewer_Segment::GLViewer_Segment( const GLViewer_Pnt& thePnt1, myC = myPnt1.x() * myPnt2.y() - myPnt2.x() * myPnt1.y(); } -//================================================================ -// Function : GLViewer_Segment -// Purpose : constructs a ray starting at and directed -// along positive X axis direction (or Y axis if vertical ) -//================================================================ +/*! + constructs a ray starting at and directed along positive X axis direction (or Y axis if vertical ) +*/ GLViewer_Segment::GLViewer_Segment( const GLViewer_Pnt& thePnt, const GLfloat theA, const GLfloat theB, @@ -66,18 +56,16 @@ GLViewer_Segment::GLViewer_Segment( const GLViewer_Pnt& thePnt, myPnt2 = GLViewer_Pnt( FAR_POINT, - myA / myB * FAR_POINT - myC / myB ); } -//================================================================ -// Function : GLViewer_Segment -// Purpose : destructor, does nothing -//================================================================ +/*! + destructor, does nothing +*/ GLViewer_Segment::~GLViewer_Segment() { } -//================================================================ -// Function : HasIntersection -// Purpose : detects intersection with segment -//================================================================ +/*! + detects intersection with segment +*/ bool GLViewer_Segment::HasIntersection( const GLViewer_Segment& theOther ) const { bool aRes = false; @@ -113,27 +101,24 @@ bool GLViewer_Segment::HasIntersection( const GLViewer_Segment& theOther ) const return aRes; } -//================================================================ -// Function : GLViewer_Poly -// Purpose : constructs a closed polygon from the given ordered list of points -//================================================================ +/*! + constructs a closed polygon from the given ordered list of points +*/ GLViewer_Poly::GLViewer_Poly( const GLViewer_PntList* thePoints ) : myPoints( (GLViewer_PntList*)thePoints ) { } -//================================================================ -// Function : ~GLViewer_Poly -// Purpose : destructor, mustn't be deleted here! -//================================================================ +/*! + destructor, mustn't be deleted here! +*/ GLViewer_Poly::~GLViewer_Poly() { } -//================================================================ -// Function : IsIn -// Purpose : returns true if lies within this polygon -//================================================================ +/*! + \return true if lies within this polygon +*/ bool GLViewer_Poly::IsIn( const GLViewer_Pnt& thePnt ) const { if ( !myPoints ) @@ -159,11 +144,10 @@ bool GLViewer_Poly::IsIn( const GLViewer_Pnt& thePnt ) const return ( aNbInter % 2 == 1 ); } +/*! + \return true if lies within this polygon +*/ /* -//================================================================ -// Function : IsIn -// Purpose : returns true if lies within this polygon -//================================================================ bool GLViewer_Poly::IsIn( const GLViewer_Pnt& thePnt, const float tolerance ) const { if ( !myPoints ) @@ -184,10 +168,9 @@ bool GLViewer_Poly::IsIn( const GLViewer_Pnt& thePnt, const float tolerance ) co return res; } */ -//================================================================ -// Function : IsCovers -// Purpose : returns true if covers this polygon -//================================================================ +/*! + \return true if covers this polygon +*/ bool GLViewer_Poly::IsCovers( const GLViewer_Poly& thePoly ) const { if ( !myPoints || !thePoly.Count() ) @@ -204,10 +187,9 @@ bool GLViewer_Poly::IsCovers( const GLViewer_Poly& thePoly ) const return true; } -//================================================================ -// Function : IsCovers -// Purpose : returns true if covers this polygon -//================================================================ +/*! + \return true if covers this polygon +*/ bool GLViewer_Poly::IsCovers( const GLViewer_Rect& theRect ) const { if ( !myPoints ) //needs check for @@ -224,10 +206,10 @@ bool GLViewer_Poly::IsCovers( const GLViewer_Rect& theRect ) const return IsCovers( GLViewer_Poly( &aList ) ); } -//================================================================ -// Function : HasIntersection -// Purpose : looks for any -//================================================================ +/*! + \return true if polygon has intersection with segment or ray + \param theSegment - segment to check intersection +*/ bool GLViewer_Poly::HasIntersection( const GLViewer_Segment& theSegment ) const { if ( !myPoints ) diff --git a/src/GLViewer/GLViewer_Grid.cxx b/src/GLViewer/GLViewer_Grid.cxx index 85dfac4ba..cf483c965 100644 --- a/src/GLViewer/GLViewer_Grid.cxx +++ b/src/GLViewer/GLViewer_Grid.cxx @@ -29,6 +29,9 @@ #include #include +/*! + Default constructor +*/ GLViewer_Grid::GLViewer_Grid() : myGridList( 0 ), myGridHeight( (GLfloat)0.0 ), myGridWidth( (GLfloat)0.0 ), myWinW( (GLfloat)0.0 ), myWinH( (GLfloat)0.0 ), myXSize( (GLfloat)0.0 ), myYSize( (GLfloat)0.0 ), @@ -44,6 +47,14 @@ GLViewer_Grid::GLViewer_Grid() : myAxisColor[2] = 0.75; } +/*! + Constructor + \param width and \param height - width and height of grid + \param winW and \param winH - width and height of window + \param xSize and \param ySize - steps along x and y direction + \param xPan and \param yPan - offsets along x and y direction + \param xScale and \param yScal - scale factors along x and y direction +*/ GLViewer_Grid::GLViewer_Grid( GLfloat width, GLfloat height, GLfloat winW, GLfloat winH, GLfloat xSize, GLfloat ySize, @@ -63,10 +74,16 @@ GLViewer_Grid::GLViewer_Grid( GLfloat width, GLfloat height, myAxisColor[2] = 0.75; } +/*! + Destructor +*/ GLViewer_Grid::~GLViewer_Grid() { } +/*! + Performs OpenGL drawing +*/ void GLViewer_Grid::draw() { if ( myGridList == 0 || myIsUpdate ) @@ -75,6 +92,10 @@ void GLViewer_Grid::draw() glCallList( myGridList ); } +/*! + Changes color of grid + \param r, g, b - components of color +*/ void GLViewer_Grid::setGridColor( GLfloat r, GLfloat g, GLfloat b ) { if( myGridColor[0] == r && myGridColor[1] == g && myGridColor[2] == b ) @@ -86,6 +107,10 @@ void GLViewer_Grid::setGridColor( GLfloat r, GLfloat g, GLfloat b ) myIsUpdate = GL_TRUE; } +/*! + Changes color of axis + \param r, g, b - components of color +*/ void GLViewer_Grid::setAxisColor( GLfloat r, GLfloat g, GLfloat b ) { if( myAxisColor[0] == r && myAxisColor[1] == g && myAxisColor[2] == b ) @@ -97,6 +122,10 @@ void GLViewer_Grid::setAxisColor( GLfloat r, GLfloat g, GLfloat b ) myIsUpdate = GL_TRUE; } +/*! + Changes grid width + \param w - new grid width +*/ void GLViewer_Grid::setGridWidth( float w ) { if( myGridWidth == w ) @@ -106,6 +135,10 @@ void GLViewer_Grid::setGridWidth( float w ) myIsUpdate = GL_TRUE; } +/*! + Sets Radius of center point( begin coords ) + \param r - new radius +*/ void GLViewer_Grid::setCenterRadius( int r ) { if( myCenterRadius == r ) @@ -115,6 +148,11 @@ void GLViewer_Grid::setCenterRadius( int r ) myIsUpdate = GL_TRUE; } +/*! + Sets grid size along X and Y axis + \param xSize - size along X axis + \param ySize - size along Y axis +*/ void GLViewer_Grid::setSize( float xSize, float ySize ) { if( myXSize == xSize && myYSize == ySize ) @@ -125,6 +163,11 @@ void GLViewer_Grid::setSize( float xSize, float ySize ) myIsUpdate = GL_TRUE; } +/*! + Sets panning of grid + \param xPan - panning along X axis + \param yPan - panning along Y axis +*/ void GLViewer_Grid::setPan( float xPan, float yPan ) { if( myXPan == xPan && myYPan == yPan ) @@ -135,6 +178,10 @@ void GLViewer_Grid::setPan( float xPan, float yPan ) myIsUpdate = GL_TRUE; } +/*! + Sets zoom + \param zoom - new coefficient of zooming +*/ bool GLViewer_Grid::setZoom( float zoom ) { if( zoom == 1.0 ) @@ -160,6 +207,12 @@ bool GLViewer_Grid::setZoom( float zoom ) return true; } +/*! + Sets parameters of grid by zoom coefficient and window size + \param WinW - window width + \param WinH - window height + \param zoom - zoom coefficient +*/ void GLViewer_Grid::setResize( float WinW, float WinH, float zoom ) { if( myWinW == WinW && myWinH == WinH && zoom == 1.0 ) @@ -173,24 +226,42 @@ void GLViewer_Grid::setResize( float WinW, float WinH, float zoom ) myIsUpdate = GL_TRUE; } +/*! + \return grid size along x and y axis + \param xSize - for size along x axis + \param ySize - for size along y axis +*/ void GLViewer_Grid::getSize( float& xSize, float& ySize ) const { xSize = myXSize; ySize = myYSize; } +/*! + \return panning along x and y axis + \param xPan - for panning along x axis + \param yPan - for panning along y axis +*/ void GLViewer_Grid::getPan( float& xPan, float& yPan ) const { xPan = myXPan; yPan = myYPan; } +/*! + \return scaling along x and y axis + \param xScale - for scaling along x axis + \param yScale - for scaling along y axis +*/ void GLViewer_Grid::getScale( float& xScale, float& yScale ) const { xScale = myXScale; yScale = myYScale; } +/*! + Initialize grid display list +*/ bool GLViewer_Grid::initList() { myIsUpdate = GL_FALSE; diff --git a/src/GLViewer/GLViewer_Group.cxx b/src/GLViewer/GLViewer_Group.cxx index 6377e9ecd..ab32135c1 100644 --- a/src/GLViewer/GLViewer_Group.cxx +++ b/src/GLViewer/GLViewer_Group.cxx @@ -26,52 +26,40 @@ #include "GLViewer_Group.h" #include "GLViewer_Object.h" -/*************************************************************************** -** Class: GLViewer_Group -** Descr: Group of GLViewer_Objects -** Module: GLViewer -** Created: UI team, 25.03.05 -****************************************************************************/ - -//-------------------------------------------------------------------------- -//Function: GLViewer_Group() -//Description: constructor -//-------------------------------------------------------------------------- +/*! + constructor +*/ GLViewer_Group::GLViewer_Group() { mySelObjNum = 0; } -//-------------------------------------------------------------------------- -//Function: GLViewer_Group() -//Description: destructor -//-------------------------------------------------------------------------- +/*! + destructor +*/ GLViewer_Group::~GLViewer_Group() { } -//-------------------------------------------------------------------------- -//Function: isEmpty -//Description: detection of empty group -//-------------------------------------------------------------------------- +/*! + detection of empty group +*/ bool GLViewer_Group::isEmpty() { return myList.empty(); } -//-------------------------------------------------------------------------- -//Function: count -//Description: number of elements -//-------------------------------------------------------------------------- +/*! + \return number of elements +*/ int GLViewer_Group::count() { return myList.size(); } -//-------------------------------------------------------------------------- -//Function: contains -//Description: return the position of object, else -1 -//-------------------------------------------------------------------------- +/*! + \return the position of object if group contains it, else -1 +*/ int GLViewer_Group::contains( GLViewer_Object* theObject ) { if( !theObject ) @@ -86,10 +74,9 @@ int GLViewer_Group::contains( GLViewer_Object* theObject ) return -1; } -//-------------------------------------------------------------------------- -//Function: addObject -//Description: adding object to group -//-------------------------------------------------------------------------- +/*! + adding object to group +*/ int GLViewer_Group::addObject( GLViewer_Object* theObject ) { if( theObject && contains( theObject ) == -1 ) @@ -100,10 +87,9 @@ int GLViewer_Group::addObject( GLViewer_Object* theObject ) return count(); } -//-------------------------------------------------------------------------- -//Function: removeObject -//Description: removing object from group -//-------------------------------------------------------------------------- +/*! + removing object from group +*/ int GLViewer_Group::removeObject( GLViewer_Object* theObject ) { if( theObject ) @@ -122,10 +108,11 @@ int GLViewer_Group::removeObject( GLViewer_Object* theObject ) return count(); } -//-------------------------------------------------------------------------- -//Function: dragingObjects -//Description: -//-------------------------------------------------------------------------- +/*! + Dragging operation + \param Once is true, if this operation calls only one time for all object + \param x, y - dragging position +*/ void GLViewer_Group::dragingObjects( float x, float y, bool once ) { if( !once ) @@ -154,10 +141,11 @@ void GLViewer_Group::dragingObjects( float x, float y, bool once ) (*it)->moveObject( x, y, true ); } -//-------------------------------------------------------------------------- -//Function: updateZoom -//Description: -//-------------------------------------------------------------------------- +/*! + Updates zoom of object + \param sender - object to be updated + \param zoom - zoom coefficient +*/ void GLViewer_Group::updateZoom( GLViewer_Object* sender, float zoom ) { OGIterator it = myList.begin(); diff --git a/src/GLViewer/GLViewer_MimeSource.cxx b/src/GLViewer/GLViewer_MimeSource.cxx index e43ee5f51..5338ca7dd 100644 --- a/src/GLViewer/GLViewer_MimeSource.cxx +++ b/src/GLViewer/GLViewer_MimeSource.cxx @@ -19,13 +19,6 @@ // Author : OPEN CASCADE // -/*************************************************************************** -** Class: GLViewer_MimeSource -** Descr: Needs for a work with QClipboard -** Module: GLViewer -** Created: UI team, 22.03.04 -****************************************************************************/ - //#include #include "GLViewer_MimeSource.h" #include "GLViewer_BaseObjects.h" @@ -33,10 +26,17 @@ //#include //using namespace std; +/*! + Destructor +*/ GLViewer_MimeSource::~GLViewer_MimeSource() { } +/*! + Translate objects to byte array + \param theObjects - list of objects +*/ bool GLViewer_MimeSource::setObjects( QValueList theObjects ) { if( !theObjects.empty() ) @@ -109,9 +109,12 @@ bool GLViewer_MimeSource::setObjects( QValueList theObjects ) return false; } -//!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!NOTE!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -//If you want to use new class, following two method must be redefined -//!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!NOTE!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +/*! + Creates object by it's representation (byte array) + \param theArray - byte array + \param theType - type of object +*/ GLViewer_Object* GLViewer_MimeSource::getObject( QByteArray theArray, QString theType ) { if( !theArray.isEmpty() ) @@ -139,6 +142,11 @@ GLViewer_Object* GLViewer_MimeSource::getObject( QByteArray theArray, QString th return NULL; } +/*! + Creates list of objects by its representation (byte array) + \param theArray - byte array + \param theType - type of object +*/ QValueList GLViewer_MimeSource::getObjects( QByteArray theArray, QString theType ) { if( !theArray.isEmpty() ) @@ -210,6 +218,10 @@ QValueList GLViewer_MimeSource::getObjects( QByteArray theArra return QValueList(); } +/*! + \return format by index + \param theIndex - index +*/ const char* GLViewer_MimeSource::format( int theIndex ) const { switch( theIndex ) @@ -223,6 +235,9 @@ const char* GLViewer_MimeSource::format( int theIndex ) const } +/*! + \return internal byte array +*/ QByteArray GLViewer_MimeSource::encodedData( const char* theObjectType ) const { if( theObjectType == "GLViewer_Objects" ) diff --git a/src/GLViewer/GLViewer_MimeSource.h b/src/GLViewer/GLViewer_MimeSource.h index 4fca3c9d7..01e59b508 100644 --- a/src/GLViewer/GLViewer_MimeSource.h +++ b/src/GLViewer/GLViewer_MimeSource.h @@ -40,10 +40,10 @@ class GLViewer_Object; -/*! Class GLViewer_MimeSource -* Needs for a work with QClipboard +/*! + \class GLViewer_MimeSource + Needs for a work with QClipboard */ - class GLVIEWER_API GLViewer_MimeSource: public QMimeSource { public: diff --git a/src/GLViewer/GLViewer_Object.cxx b/src/GLViewer/GLViewer_Object.cxx index f5972674b..37fdca053 100644 --- a/src/GLViewer/GLViewer_Object.cxx +++ b/src/GLViewer/GLViewer_Object.cxx @@ -19,13 +19,6 @@ // Author : OPEN CASCADE // -/*************************************************************************** -** Class: GLViewer_Object -** Descr: OpenGL Object -** Module: GLViewer -** Created: UI team, 03.09.02 -****************************************************************************/ - //#include #include "GLViewer_Object.h" #include "GLViewer_Drawer.h" @@ -37,6 +30,9 @@ //#include //using namespace std; +/*! + Default constructor +*/ GLViewer_Object::GLViewer_Object() { myXScale = 1.0; @@ -65,6 +61,9 @@ GLViewer_Object::GLViewer_Object() myGroup = NULL; } +/*! + Destructor +*/ GLViewer_Object::~GLViewer_Object() { if( myRect ) @@ -80,16 +79,27 @@ GLViewer_Object::~GLViewer_Object() delete myAspectLine; } +/*! + \return priority of object +*/ int GLViewer_Object::getPriority() const { return myDrawer ? myDrawer->getPriority() : 0; } +/*! + \return true if object is inside rectangle + \param theRect - rectangle +*/ GLboolean GLViewer_Object::isInside( GLViewer_Rect theRect ) { return theRect.toQRect().contains( myRect->toQRect() ); } +/*! + Sets zoom factor + \param zoom - zoom factor +*/ GLboolean GLViewer_Object::setZoom( GLfloat zoom, bool, bool ) { if( myZoom == zoom ) @@ -99,6 +109,10 @@ GLboolean GLViewer_Object::setZoom( GLfloat zoom, bool, bool ) return GL_TRUE; } +/*! + Performs zoom change by step + \param zoomIn - to increase to decrease zoom +*/ GLboolean GLViewer_Object::updateZoom( bool zoomIn ) { float newZoom; @@ -118,6 +132,10 @@ GLboolean GLViewer_Object::updateZoom( bool zoomIn ) return setZoom( newZoom, true ); } +/*! + Codes object as byte copy + \return byte array +*/ QByteArray GLViewer_Object::getByteCopy() { int i = 0; @@ -185,6 +203,10 @@ QByteArray GLViewer_Object::getByteCopy() return aResult; } +/*! + Initialize object by byte array + \param theArray - byte array +*/ bool GLViewer_Object::initializeFromByteCopy( QByteArray theArray ) { int i = 0; @@ -281,6 +303,10 @@ bool GLViewer_Object::initializeFromByteCopy( QByteArray theArray ) return true; } +/*! + Sets object's group + \param theGroup - group +*/ void GLViewer_Object::setGroup( GLViewer_Group* theGroup ) { if ( myGroup == theGroup ) @@ -294,6 +320,9 @@ void GLViewer_Object::setGroup( GLViewer_Group* theGroup ) myGroup->addObject( this ); } +/*! + \return object's group +*/ GLViewer_Group* GLViewer_Object::getGroup() const { return myGroup; diff --git a/src/GLViewer/GLViewer_Object.h b/src/GLViewer/GLViewer_Object.h index 6cd21b294..d6abc6ea9 100644 --- a/src/GLViewer/GLViewer_Object.h +++ b/src/GLViewer/GLViewer_Object.h @@ -45,10 +45,6 @@ #pragma warning( disable:4251 ) #endif -/*! - * Class GLViewer_Object - * Base Object for GLViewer - */ class GLViewer_Drawer; class GLViewer_AspectLine; class GLViewer_Group; @@ -56,6 +52,10 @@ class GLViewer_CoordSystem; class GLViewer_Text; class GLViewer_Owner; +/*! + * Class GLViewer_Object + * Base Object for all GLViewer objects + */ class GLVIEWER_API GLViewer_Object { public: diff --git a/src/GLViewer/GLViewer_Selector.cxx b/src/GLViewer/GLViewer_Selector.cxx index 5df29eb89..2bf702e18 100644 --- a/src/GLViewer/GLViewer_Selector.cxx +++ b/src/GLViewer/GLViewer_Selector.cxx @@ -22,13 +22,6 @@ // File: GLViewer_Selector.cxx // Created: November, 2004 -/**************************************************************************** -** Class: GLViewer_Selector -** Descr: Base class for object selection in QAD-based application -** Module: GLViewer -** Created: UI team, 22.09.00 -*****************************************************************************/ - //#include #include "GLViewer_Selector.h" diff --git a/src/GLViewer/GLViewer_Selector.h b/src/GLViewer/GLViewer_Selector.h index ad40ab124..3458451f0 100644 --- a/src/GLViewer/GLViewer_Selector.h +++ b/src/GLViewer/GLViewer_Selector.h @@ -22,12 +22,6 @@ // File: GLViewer_Selector.h // Created: November, 2004 -/**************************************************************************** -** Class: GLViewer_Selector -** Descr: Base class for object selection in QAD-based application -** Module: GLViewer -** Created: UI team, 22.09.00 -*****************************************************************************/ #ifndef GLVIEWER_SELECTOR_H #define GLVIEWER_SELECTOR_H @@ -41,10 +35,10 @@ class GLViewer_Viewer; -/*! Class GLViewer_Selector -* Based select manager for GLViewer +/*! + \Class GLViewer_Selector + Base class for object selection in SUIT-based application */ - class GLVIEWER_API GLViewer_Selector : public QObject { Q_OBJECT diff --git a/src/GLViewer/GLViewer_Selector2d.cxx b/src/GLViewer/GLViewer_Selector2d.cxx index e8a414d46..d2037d272 100644 --- a/src/GLViewer/GLViewer_Selector2d.cxx +++ b/src/GLViewer/GLViewer_Selector2d.cxx @@ -22,19 +22,15 @@ // File: GLViewer_Selector2d.cxx // Created: November, 2004 -/**************************************************************************** -** Class: GLViewer_Selector2d -** Descr: OpenGL Selector 2D -** Module: GLViewer -** Created: UI team, 20.09.02 -*****************************************************************************/ - //#include #include "GLViewer_Selector2d.h" #include "GLViewer_Viewer2d.h" #include "GLViewer_Context.h" #include "GLViewer_ViewPort2d.h" +/*! + Constructor +*/ GLViewer_Selector2d::GLViewer_Selector2d( GLViewer_Viewer2d* v2d, GLViewer_Context* glc ) : GLViewer_Selector( v2d ), myGLContext( glc ) @@ -43,20 +39,35 @@ myGLContext( glc ) // myGLContext->SetSelectionColor( Quantity_NOC_RED ); } +/*! + Destructor +*/ GLViewer_Selector2d::~GLViewer_Selector2d() { } +/*! + Changes hilight color of context + \param color - new hilight color +*/ void GLViewer_Selector2d::setHilightColor( Quantity_NameOfColor color ) { myGLContext->SetHighlightColor( color ); } +/*! + Changes selection color of context + \param color - new selection color +*/ void GLViewer_Selector2d::setSelectColor( Quantity_NameOfColor color ) { myGLContext->SetSelectionColor( color ); } +/*! + Detects object at point + \param x, y - point co-ordinates +*/ void GLViewer_Selector2d::detect( int x, int y ) { //cout << "GLViewer_Selector2d : detect ( " << x << " , " << y << " )" << endl; @@ -71,6 +82,9 @@ void GLViewer_Selector2d::detect( int x, int y ) myGLContext->MoveTo( x, y ); } +/*! + Undetects all objects +*/ void GLViewer_Selector2d::undetectAll() { if ( myLocked || !myGLContext || !myViewer || !myViewer->getActiveView() || @@ -84,6 +98,10 @@ void GLViewer_Selector2d::undetectAll() myGLContext->clearHighlighted( true ); } +/*! + Selects previously hilighted objects + \param append - append objects to selection +*/ void GLViewer_Selector2d::select( bool append ) { //cout << "GLViewer_Selector2d : select ( " << (int)append << " )" << endl; @@ -104,6 +122,11 @@ void GLViewer_Selector2d::select( bool append ) checkSelection( selBefore, append, status ); } +/*! + Selects objects in rectangle + \param selRect - selection rectangle + \param append - append objects to selection +*/ void GLViewer_Selector2d::select( const QRect& selRect, bool append ) { GLViewer_Viewer::SelectionMode selMode = myViewer->getSelectionMode(); @@ -123,6 +146,9 @@ void GLViewer_Selector2d::select( const QRect& selRect, bool append ) checkSelection( selBefore, append, aStatus ); } +/*! + Unselects all objects +*/ void GLViewer_Selector2d::unselectAll() { if ( myLocked || !myViewer ) @@ -137,8 +163,10 @@ void GLViewer_Selector2d::unselectAll() if ( hadSelection ) emit selSelectionCancel(); } -/* Checks selection state and emits 'selSelectionDone' or 'selSelectionCancel' - Should be called by after non-interactive selection. */ +/*! + Checks selection state and emits 'selSelectionDone' or 'selSelectionCancel' + Should be called by after non-interactive selection. +*/ void GLViewer_Selector2d::checkSelection( int selBefore, bool append, int aStatus ) { int selAfter = numSelected(); @@ -158,6 +186,9 @@ void GLViewer_Selector2d::checkSelection( int selBefore, bool append, int aStatu } } +/*! + \return number of selected objects +*/ int GLViewer_Selector2d::numSelected() const { return myGLContext->NbSelected(); diff --git a/src/GLViewer/GLViewer_Selector2d.h b/src/GLViewer/GLViewer_Selector2d.h index cce3cc37e..2f21920ae 100644 --- a/src/GLViewer/GLViewer_Selector2d.h +++ b/src/GLViewer/GLViewer_Selector2d.h @@ -22,12 +22,6 @@ // File: GLViewer_Selector2d.h // Created: November, 2004 -/**************************************************************************** -** Class: GLViewer_Selector2d -** Descr: OpenGL Selector 2D -** Module: GLViewer -** Created: UI team, 20.09.02 -*****************************************************************************/ #ifndef GLVIEWER_SELECTOR2D_H #define GLVIEWER_SELECTOR2D_H @@ -42,8 +36,9 @@ class GLViewer_Viewer2d; class GLViewer_Context; -/*! Class GLViewer_Selector2d -* 2D select manager for GLViewer +/*! + \class GLViewer_Selector2d + 2D select manager for GLViewer */ class GLVIEWER_API GLViewer_Selector2d : public GLViewer_Selector { diff --git a/src/GLViewer/GLViewer_Text.cxx b/src/GLViewer/GLViewer_Text.cxx index bafa33ec1..63a00fd00 100644 --- a/src/GLViewer/GLViewer_Text.cxx +++ b/src/GLViewer/GLViewer_Text.cxx @@ -19,16 +19,12 @@ // Author : OPEN CASCADE // -/*************************************************************************** -** Class: GLViewer_Text -** Descr: Substitution of Prs3d_Text for OpenGL -** Module: GLViewer -** Created: UI team, 10.07.03 -****************************************************************************/ - //#include #include "GLViewer_Text.h" +/*! + Constructor +*/ GLViewer_Text::GLViewer_Text( const QString& text, float xPos, float yPos, const QColor& color ) { myText = text; @@ -40,6 +36,9 @@ GLViewer_Text::GLViewer_Text( const QString& text, float xPos, float yPos, const myDTF = DTF_BITMAP; } +/*! + Constructor +*/ GLViewer_Text::GLViewer_Text( const QString& text, float xPos, float yPos, const QColor& color, QFont theFont, int theSeparator ) { myText = text; @@ -51,10 +50,16 @@ GLViewer_Text::GLViewer_Text( const QString& text, float xPos, float yPos, const myDTF = DTF_BITMAP; } +/*! + Destructor +*/ GLViewer_Text::~GLViewer_Text() { } +/*! + \return width of text +*/ int GLViewer_Text::getWidth() { int aResult = 0; @@ -64,12 +69,19 @@ int GLViewer_Text::getWidth() return aResult; } +/*! + \return height of text +*/ int GLViewer_Text::getHeight() { QFontMetrics aFM( myQFont ); return aFM.height(); } +/*! + Codes object as byte copy + \return byte array +*/ QByteArray GLViewer_Text::getByteCopy() const { int i; @@ -121,6 +133,10 @@ QByteArray GLViewer_Text::getByteCopy() const return aResult; } +/*! + Initialize text from binary representation + \param theBuf - byte array +*/ GLViewer_Text* GLViewer_Text::fromByteCopy( QByteArray theBuf ) { int i = 0; diff --git a/src/GLViewer/GLViewer_Text.h b/src/GLViewer/GLViewer_Text.h index ef3512ca9..41f2869c8 100644 --- a/src/GLViewer/GLViewer_Text.h +++ b/src/GLViewer/GLViewer_Text.h @@ -43,9 +43,10 @@ #pragma warning( disable:4251 ) #endif -/* Class GLViewer_Text -* Substitution of Prs3d_Text for OpenGL */ - +/*! + \class GLViewer_Text + Substitution of Prs3d_Text for OpenGL +*/ class GLVIEWER_API GLViewer_Text { public: diff --git a/src/GLViewer/GLViewer_ToolTip.cxx b/src/GLViewer/GLViewer_ToolTip.cxx index 0521ff19f..e43eede36 100644 --- a/src/GLViewer/GLViewer_ToolTip.cxx +++ b/src/GLViewer/GLViewer_ToolTip.cxx @@ -34,17 +34,9 @@ #include #include -/*************************************************************************** -** Class: GLViewer_ToolTip -** Descr: ToolTip of GLViewer_Objects -** Module: GLViewer -** Created: UI team, 25.03.05 -****************************************************************************/ - -//-------------------------------------------------------------------------- -//Function: GLViewer_ToolTip() -//Description: constructor -//-------------------------------------------------------------------------- +/*! + constructor +*/ GLViewer_ObjectTip::GLViewer_ObjectTip( GLViewer_ViewPort2d* theParent ) :QObject(), myText(), @@ -69,10 +61,9 @@ GLViewer_ObjectTip::GLViewer_ObjectTip( GLViewer_ViewPort2d* theParent ) connect( mypTimer, SIGNAL( timeout() ), this, SLOT( showTip() ) ); } -//-------------------------------------------------------------------------- -//Function: GLViewer_ToolTip() -//Description: destructor -//-------------------------------------------------------------------------- +/*! + destructor +*/ GLViewer_ObjectTip::~GLViewer_ObjectTip() { // delete mypRect; @@ -87,10 +78,10 @@ GLViewer_ObjectTip::~GLViewer_ObjectTip() } -//-------------------------------------------------------------------------- -//Function: GLViewer_ToolTip() -//Description: destructor -//-------------------------------------------------------------------------- +/*! + It is called when there is a possibility that a tool tip should be shown + \param p - position of tooltip +*/ bool GLViewer_ObjectTip::maybeTip( const QPoint &p ) { @@ -138,6 +129,9 @@ bool GLViewer_ObjectTip::maybeTip( const QPoint &p ) */ } +/*! + Custom event filter +*/ bool GLViewer_ObjectTip::eventFilter( QObject* theObj, QEvent* e ) { hideTipAndSleep(); @@ -175,7 +169,9 @@ bool GLViewer_ObjectTip::eventFilter( QObject* theObj, QEvent* e ) return false; } - +/*! + Hides tooltip and stops timer +*/ void GLViewer_ObjectTip::hideTipAndSleep() { //if( mypPoint ) @@ -191,6 +187,9 @@ void GLViewer_ObjectTip::hideTipAndSleep() mypTimer->stop(); } +/*! + Shows tooltip +*/ void GLViewer_ObjectTip::showTip() { if( maybeTip( myPoint ) ) @@ -218,6 +217,9 @@ void GLViewer_ObjectTip::showTip() } } +/*! + Restarts timer +*/ void GLViewer_ObjectTip::wakeup( int theTime ) { if( mypTimer->isActive() ) diff --git a/src/GLViewer/GLViewer_ToolTip.h b/src/GLViewer/GLViewer_ToolTip.h index 9dcb71f68..7700b61b1 100644 --- a/src/GLViewer/GLViewer_ToolTip.h +++ b/src/GLViewer/GLViewer_ToolTip.h @@ -35,12 +35,10 @@ class GLViewer_ViewPort2d; class QLabel; -/*************************************************************************** -** Class: GLViewer_ObjectTip -** Descr: ToolTip of GLViewer_Objects -** Module: GLViewer -** Created: UI team, 28.03.05 -****************************************************************************/ +/*! + \class GLViewer_ObjectTip + ToolTip of GLViewer_Objects +*/ class GLVIEWER_API GLViewer_ObjectTip: public QObject//QToolTip//QtxToolTip { Q_OBJECT diff --git a/src/GLViewer/GLViewer_Tools.cxx b/src/GLViewer/GLViewer_Tools.cxx index a54ad837f..9d8739175 100644 --- a/src/GLViewer/GLViewer_Tools.cxx +++ b/src/GLViewer/GLViewer_Tools.cxx @@ -29,12 +29,10 @@ #include -/**************************************************************************** -** Class: GLViewer_LineList -** Descr: Tools for distinct line -** Module: GLViewer -** Created: UI team, 27.10.05 -*****************************************************************************/ +/*! + Constructor + \param size - size of internal array +*/ GLViewer_LineList::GLViewer_LineList( int size ) { myRealSize = 2*size; @@ -52,11 +50,18 @@ GLViewer_LineList::GLViewer_LineList( int size ) memset( myArray, 0, myRealSize*sizeof(double) ); } +/*! + Destructor +*/ GLViewer_LineList::~GLViewer_LineList() { delete myArray; } +/*! + Adds new line segment to list + \param coord1, coord2 - co-ordinates of points +*/ bool GLViewer_LineList::addSegment( double coord1, double coord2 ) { if( coord1 > coord2 ) @@ -158,6 +163,11 @@ bool GLViewer_LineList::addSegment( double coord1, double coord2 ) return true; } +/*! + Gets info about segment + \param theIndex - index of segment + \param coord1, coord2 - co-ordinates of points +*/ bool GLViewer_LineList::readSegment( int theIndex, double& coord1, double& coord2 ) { if( theIndex > mySegmentNumber || !myArray) @@ -169,6 +179,10 @@ bool GLViewer_LineList::readSegment( int theIndex, double& coord1, double& coord return true; } +/*! + \return true if line list covers point + \param thePoint - point co-ordinate +*/ int GLViewer_LineList::contains( double thePoint ) const { if( !myArray || mySegmentNumber == 0 ) @@ -182,6 +196,10 @@ int GLViewer_LineList::contains( double thePoint ) const } +/*! + Removes segment + \param theIndex - segment index +*/ bool GLViewer_LineList::removeSegment( int theIndex ) { if( theIndex > mySegmentNumber || !myArray) @@ -198,6 +216,10 @@ bool GLViewer_LineList::removeSegment( int theIndex ) return true; } +/*! + Removes segment from line list + \param coord1, coord2 - co-ordinates of points +*/ bool GLViewer_LineList::removeSegment( double coord1, double coord2 ) { if( coord1 > coord2 ) @@ -350,12 +372,18 @@ bool GLViewer_LineList::removeSegment( double coord1, double coord2 ) return true; } +/*! + Clears line list +*/ void GLViewer_LineList::clear() { if( myArray ) memset( myArray, 0, myRealSize*sizeof(double) ); } +/*! + Prints debug info about line list +*/ void GLViewer_LineList::print() { cout << "MainCoord: " << myMainCoord <<" SIZE: " << myRealSize << " ENum: " << mySegmentNumber << " :::"; @@ -365,6 +393,10 @@ void GLViewer_LineList::print() cout << endl; } +/*! + Draws line list with help of OpenGL + \param theDim - dimension +*/ void GLViewer_LineList::show( FieldDim theDim ) { if( !myArray ) @@ -393,12 +425,10 @@ void GLViewer_LineList::show( FieldDim theDim ) } } -/**************************************************************************** -** Class: GLViewer_LineField -** Descr: Tools for solving -** Module: GLViewer -** Created: UI team, 27.10.05 -*****************************************************************************/ + +/*! + Constructor +*/ GLViewer_LineField::GLViewer_LineField() { myCurArrayIndex = 0; @@ -412,6 +442,10 @@ GLViewer_LineField::GLViewer_LineField() myXLineArray = NULL; myYLineArray = NULL; } + +/*! + Constructor +*/ GLViewer_LineField::GLViewer_LineField( const int theMAXSize, const int theXN, const int theYN ) { myCurArrayIndex = 0; @@ -443,6 +477,9 @@ GLViewer_LineField::GLViewer_LineField( const int theMAXSize, const int theXN, c } } +/*! + Destructor +*/ GLViewer_LineField::~GLViewer_LineField() { if( myXLineArray ) @@ -468,11 +505,21 @@ GLViewer_LineField::~GLViewer_LineField() delete myGraphArray2; } +/*! + Adds line +*/ void GLViewer_LineField::addLine( FieldDim theDim, GLViewer_LineList* ) { //not implemented } +/*! + Adds line + \param theDim - dimension + \param theMC - main co-ordinate + \param theBegin - start co-ordinate + \param theEnd - end co-ordinate +*/ void GLViewer_LineField:: addLine( FieldDim theDim, double theMC, double theBegin, double theEnd ) { GLViewer_LineList* aLL = new GLViewer_LineList( 1 ); @@ -481,7 +528,12 @@ void GLViewer_LineField:: addLine( FieldDim theDim, double theMC, double theBegi addLine( theDim, aLL ); } - +/*! + Adds line + \param theDim - dimension + \param theLL - main co-ordinate + \param thePosition - index in list +*/ int GLViewer_LineField::insertLine( FieldDim theDim, GLViewer_LineList* theLL, int thePosition ) { if( !myXLineArray || !myYLineArray ) @@ -533,6 +585,14 @@ int GLViewer_LineField::insertLine( FieldDim theDim, GLViewer_LineList* theLL, i return -1; } +/*! + Adds line + \param theDim - dimension + \param theMainCoord - main co-ordinate + \param theBegin - start co-ordinate + \param theEnd - end co-ordinate + \param thePosition - index in list +*/ int GLViewer_LineField::insertLine( FieldDim theDim, double theMainCoord, double theBegin, double theEnd, int thePosition ) { GLViewer_LineList* aLL = new GLViewer_LineList( 1 ); @@ -541,7 +601,9 @@ int GLViewer_LineField::insertLine( FieldDim theDim, double theMainCoord, double return insertLine( theDim, aLL, thePosition ); } - +/*! + \return other dimension +*/ FieldDim GLViewer_LineField::invertDim( FieldDim theFD ) { if( theFD == FD_X ) @@ -550,6 +612,11 @@ FieldDim GLViewer_LineField::invertDim( FieldDim theFD ) return FD_X; } +/*! + \return line list + \param theIndex - index in list + \param tehFD - dimension +*/ GLViewer_LineList* GLViewer_LineField::getLine( int theIndex, FieldDim theFD ) { if( !myXLineArray || !myYLineArray ) @@ -573,6 +640,11 @@ GLViewer_LineList* GLViewer_LineField::getLine( int theIndex, FieldDim theFD ) return NULL; } +/*! + Sets borders of field + \param X1, X2 - minimal and maximal abscisses + \param Y1, Y2 - minimal and maximal ordinates +*/ void GLViewer_LineField::setBorders( double X1, double X2, double Y1, double Y2 ) { if( !myXLineArray || !myYLineArray ) @@ -593,6 +665,11 @@ void GLViewer_LineField::setBorders( double X1, double X2, double Y1, double Y2 } } +/*! + Adds rectangle + \param top, right - a corner of rectangle + \param bottom, left - other corner of rectangle +*/ void GLViewer_LineField::addRectangle( double top, double right, double bottom, double left ) { if( !myXLineArray || !myYLineArray ) @@ -612,6 +689,9 @@ void GLViewer_LineField::addRectangle( double top, double right, double bottom, } } +/*! + Prints debug info about line field +*/ void GLViewer_LineField::print() { cout << "My X matrix Number: " << myXSize << endl; @@ -623,6 +703,9 @@ void GLViewer_LineField::print() myYLineArray[j]->print(); } +/*! + Draws field with help of OpenGL +*/ void GLViewer_LineField::show() { for( int i = 0; i < myXSize; i++ ) @@ -644,6 +727,10 @@ void GLViewer_LineField::show() cout << "Show function" << endl; } +/*! + \return size + \param theDim - dimension +*/ int GLViewer_LineField::getDimSize( FieldDim theDim ) { if( theDim == FD_X ) @@ -654,6 +741,13 @@ int GLViewer_LineField::getDimSize( FieldDim theDim ) return -1; } +/*! + \return array of intersected indexes + \param theDim - dimension + \param theIndex - index + \param theLL - line with that intersection is checked + \param theSize - to return value of array size +*/ int* GLViewer_LineField::intersectIndexes( FieldDim theDim, int theIndex, const GLViewer_LineList* theLL, int& theSize ) { theSize = 0; @@ -678,7 +772,11 @@ int* GLViewer_LineField::intersectIndexes( FieldDim theDim, int theIndex, const return anArray; } - +/*! + Sets start/end search point + \param thePoint - type of point (start: FP_Start; end: FP_End ) + \param theX, theY - point co-ordinates +*/ bool GLViewer_LineField::setPoint( FieldPoint thePoint, double theX, double theY ) { if( !myXLineArray || !myYLineArray ) @@ -730,6 +828,9 @@ bool GLViewer_LineField::setPoint( FieldPoint thePoint, double theX, double theY return false; } +/*! + \return number of segments +*/ int GLViewer_LineField::segmentNumber() { if( !(myXLineArray || myYLineArray) ) @@ -743,6 +844,9 @@ int GLViewer_LineField::segmentNumber() return aNumber; } +/*! + Removes all multiple segments +*/ void GLViewer_LineField::optimize() { if( !myXLineArray || !myYLineArray ) @@ -790,6 +894,10 @@ void GLViewer_LineField::optimize() } } +/*! + Some prepare actions + Needs call setPoint before +*/ void GLViewer_LineField::initialize() { if( !myXLineArray || !myYLineArray ) @@ -843,6 +951,9 @@ void GLViewer_LineField::initialize() } } +/*! + One iteration of algorithm +*/ void GLViewer_LineField::iteration() { int aParam = myCurCount; @@ -874,6 +985,9 @@ void GLViewer_LineField::iteration() delete[] aNodes; } +/*! + Checks for complete status +*/ GLViewer_LineField::IterationStatus GLViewer_LineField::checkComplete() { if( !myXLineArray || !myYLineArray || !myGraphArray1 || !myGraphArray2 ) @@ -924,6 +1038,9 @@ GLViewer_LineField::IterationStatus GLViewer_LineField::checkComplete() return IS_NOT_SOLVED; } +/*! + Finds LineList by counts and returns indexes +*/ int* GLViewer_LineField::findByCount( int& theParam ) { if( !myXLineArray || !myYLineArray || !myGraphArray1 || !myGraphArray2 ) @@ -948,6 +1065,9 @@ int* GLViewer_LineField::findByCount( int& theParam ) return anArray; } +/*! + Finds LineList by segment and dimension +*/ int GLViewer_LineField::findBySegment( FieldDim theDim, int theLineIndex, int theSegment, bool inCurArray ) { if( !myXLineArray || !myYLineArray || !myGraphArray1 || !myGraphArray2 || getDimSize( theDim ) <= theLineIndex ) @@ -969,6 +1089,9 @@ int GLViewer_LineField::findBySegment( FieldDim theDim, int theLineIndex, int th return -1; } +/*! + Main method, performs algorithm execution +*/ GLViewer_LineField::EndStatus GLViewer_LineField::startAlgorithm() { if( !myXLineArray || !myYLineArray || !myGraphArray1 || !myGraphArray2 ) @@ -990,6 +1113,9 @@ GLViewer_LineField::EndStatus GLViewer_LineField::startAlgorithm() return ES_SOLVED; } +/*! + \return solution and size of solution +*/ double* GLViewer_LineField::solution( int& theSize ) { if( !myXLineArray || !myYLineArray || !myGraphArray1 || !myGraphArray2 ) @@ -1033,6 +1159,9 @@ double* GLViewer_LineField::solution( int& theSize ) return anArray; } +/*! + \return current solution array +*/ GraphNode* GLViewer_LineField::getCurArray() { if( !myGraphArray1 || !myGraphArray2 ) @@ -1044,6 +1173,9 @@ GraphNode* GLViewer_LineField::getCurArray() return myGraphArray2; } +/*! + \return other solution array +*/ GraphNode* GLViewer_LineField::getSecArray() { if( !myGraphArray1 || !myGraphArray2 ) @@ -1055,6 +1187,9 @@ GraphNode* GLViewer_LineField::getSecArray() return myGraphArray1; } +/*! + \return maximum segment number +*/ int GLViewer_LineField::maxSegmentNum() { if( !myXLineArray || !myYLineArray ) @@ -1074,6 +1209,10 @@ int GLViewer_LineField::maxSegmentNum() return max_num; } +/*! + \return list of LileList by dimension + \param theDim - dimension +*/ GLViewer_LineList** GLViewer_LineField::getLLArray( FieldDim theDim ) { if( theDim == FD_X ) diff --git a/src/GLViewer/GLViewer_Tools.h b/src/GLViewer/GLViewer_Tools.h index 3acdd879b..65a640f0e 100644 --- a/src/GLViewer/GLViewer_Tools.h +++ b/src/GLViewer/GLViewer_Tools.h @@ -34,12 +34,10 @@ class GLViewer_LineField; -/**************************************************************************** -** Class: GLViewer_Tools -** Descr: Tools for Viewer -** Module: GLViewer -** Created: UI team, 27.10.05 -*****************************************************************************/ +/*! + \class GLViewer_Tools + Tools for Viewer +*/ class GLVIEWER_API GLViewer_Tools { public: @@ -57,7 +55,7 @@ enum FieldDim }; /*! - Class GLViewer_LineList + \class GLViewer_LineList Tools for distinct line This class implmented interface for segment operations: add, cut, remove and etc. @@ -122,9 +120,10 @@ struct SearchPoint int mySolveIndex; }; -/*! Class GLViewer_LineField -* Tools for solving algorithm of finding shortest path on rare grid with minimum of -* line turns number +/*! + \class GLViewer_LineField + Tools for solving algorithm of finding shortest path on rare grid with minimum of + line turns number */ class GLViewer_LineField { @@ -212,9 +211,9 @@ protected: //! Checks for complete status IterationStatus checkComplete(); - //! Finds LileList by counts and returns indexes + //! Finds LineList by counts and returns indexes int* findByCount( int& theParam ); - //! Finds LileList by segment and dimension + //! Finds LineList by segment and dimension int findBySegment( FieldDim, int coord1, int coord2, bool inCurArray = true ); //! Returns current solution array diff --git a/src/GLViewer/GLViewer_ViewFrame.cxx b/src/GLViewer/GLViewer_ViewFrame.cxx index a466d7b2f..7cc29afba 100644 --- a/src/GLViewer/GLViewer_ViewFrame.cxx +++ b/src/GLViewer/GLViewer_ViewFrame.cxx @@ -22,13 +22,6 @@ // File: GLViewer_ViewFrame.cxx // Created: November, 2004 -/*************************************************************************** -** Class: GLViewer_ViewFrame -** Descr: Frame window for viewport in QAD-based application -** Module: QAD -** Created: UI team, 05.09.00 -****************************************************************************/ - //#include #include "GLViewer_ViewFrame.h" #include "GLViewer_Viewer.h" @@ -82,10 +75,9 @@ GLViewer_ViewFrame::~GLViewer_ViewFrame() { } -//================================================================ -// Function : createActions -// Purpose : -//================================================================ +/*! + Creates actions of GL view frame +*/ void GLViewer_ViewFrame::createActions() { if (!myActionsMap.isEmpty()) return; @@ -148,10 +140,9 @@ void GLViewer_ViewFrame::createActions() myActionsMap[ ResetId ] = aAction; } -//================================================================ -// Function : createToolBar -// Purpose : -//================================================================ +/*! + Creates toolbar of GL view frame +*/ void GLViewer_ViewFrame::createToolBar() { myActionsMap[DumpId]->addTo(myToolBar); @@ -248,7 +239,7 @@ QSize GLViewer_ViewFrame::sizeHint() const { QWidget* p = parentWidget(); if ( p && p->inherits( "QWorkspaceChild" ) ) - p = p->parentWidget(); /* QWorkspaceChild: internal impl class in QWorkspace */ + p = p->parentWidget(); if ( !p ) return QMainWindow::sizeHint(); return QSize( 9 * p->width() / 10 , 9 * p->height() / 10 ); @@ -263,6 +254,9 @@ void GLViewer_ViewFrame::onUpdate( int ) //#include +/*! + SLOT: called on dump view operation is activated, stores scene to raster file +*/ void GLViewer_ViewFrame::onViewDump() { GLViewer_Widget* aWidget = ((GLViewer_ViewPort2d*)myVP)->getGLWidget(); @@ -448,50 +442,73 @@ void GLViewer_ViewFrame::onViewDump() } } +/*! + Start panning +*/ void GLViewer_ViewFrame::onViewPan() { myViewer->activateTransform( GLViewer_Viewer::Pan ); } +/*! + Start zooming +*/ void GLViewer_ViewFrame::onViewZoom() { myViewer->activateTransform( GLViewer_Viewer::Zoom ); } +/*! + Start fit all +*/ void GLViewer_ViewFrame::onViewFitAll() { myViewer->activateTransform( GLViewer_Viewer::FitAll ); } +/*! + Start fit area +*/ void GLViewer_ViewFrame::onViewFitArea() { myViewer->activateTransform( GLViewer_Viewer::FitRect ); } +/*! + Start fit selected +*/ void GLViewer_ViewFrame::onViewFitSelect() { myViewer->activateTransform( GLViewer_Viewer::FitSelect ); } +/*! + Start global panning +*/ void GLViewer_ViewFrame::onViewGlobalPan() { myViewer->activateTransform( GLViewer_Viewer::PanGlobal ); } +/*! + Start rotating +*/ void GLViewer_ViewFrame::onViewRotate() { //myViewer->activateTransform( GLViewer_Viewer::Rotate ); } +/*! + Start reset default view aspects +*/ void GLViewer_ViewFrame::onViewReset() { myViewer->activateTransform( GLViewer_Viewer::Reset ); } - -//================================================================ -// Function : mouseEvent -// Purpose : dispatches mouse events -//================================================================ + +/*! + Dispatches mouse events +*/ void GLViewer_ViewFrame::mouseEvent( QMouseEvent* e ) { switch ( e->type() ) @@ -513,10 +530,9 @@ void GLViewer_ViewFrame::mouseEvent( QMouseEvent* e ) } } -//================================================================ -// Function : keyEvent -// Purpose : dispatches key events -//================================================================ +/*! + Dispatches key events +*/ void GLViewer_ViewFrame::keyEvent( QKeyEvent* e ) { switch ( e->type() ) @@ -532,10 +548,9 @@ void GLViewer_ViewFrame::keyEvent( QKeyEvent* e ) } } -//================================================================ -// Function : wheelEvent -// Purpose : dispatches wheel events -//================================================================ +/*! + Dispatches wheel events +*/ void GLViewer_ViewFrame::wheelEvent( QWheelEvent* e ) { switch ( e->type() ) @@ -548,8 +563,9 @@ void GLViewer_ViewFrame::wheelEvent( QWheelEvent* e ) } } -/*! The method returns the visual parameters of this view as a formated string - */ +/*! + \return the visual parameters of this view as a formated string +*/ QString GLViewer_ViewFrame::getVisualParameters() { QString retStr; @@ -563,8 +579,9 @@ QString GLViewer_ViewFrame::getVisualParameters() return retStr; } -/* The method restors visual parameters of this view from a formated string - */ +/*! + The method restores visual parameters of this view from a formated string +*/ void GLViewer_ViewFrame::setVisualParameters( const QString& parameters ) { QStringList paramsLst = QStringList::split( '*', parameters, true ); diff --git a/src/GLViewer/GLViewer_ViewFrame.h b/src/GLViewer/GLViewer_ViewFrame.h index 8b9267a42..d2686dfc6 100644 --- a/src/GLViewer/GLViewer_ViewFrame.h +++ b/src/GLViewer/GLViewer_ViewFrame.h @@ -22,12 +22,6 @@ // File: GLViewer_ViewFrame.h // Created: November, 2004 -/*************************************************************************** -** Class: GLViewer_ViewFrame -** Descr: Frame window for viewport in QAD-based application -** Module: QAD -** Created: UI team, 05.09.00 -****************************************************************************/ #ifndef GLVIEWER_VIEWFRAME_H #define GLVIEWER_VIEWFRAME_H @@ -47,8 +41,9 @@ class GLViewer_ViewPort; #pragma warning( disable:4251 ) #endif -/*! Class GLViewer_ViewFrame -* Frame window for viewport in GLViewer +/*! + \class GLViewer_ViewFrame + Frame window for viewport in QAD-based application */ class GLVIEWER_API GLViewer_ViewFrame: public SUIT_ViewWindow diff --git a/src/GLViewer/GLViewer_ViewManager.cxx b/src/GLViewer/GLViewer_ViewManager.cxx index 91150147a..2083ff4d5 100644 --- a/src/GLViewer/GLViewer_ViewManager.cxx +++ b/src/GLViewer/GLViewer_ViewManager.cxx @@ -30,7 +30,7 @@ int GLViewer_ViewManager::myMaxId = 0; -//*************************************************************** +/*!Constructor.*/ GLViewer_ViewManager::GLViewer_ViewManager( SUIT_Study* theStudy, SUIT_Desktop* theDesktop ) : SUIT_ViewManager( theStudy, theDesktop ) { @@ -38,19 +38,19 @@ GLViewer_ViewManager::GLViewer_ViewManager( SUIT_Study* theStudy, SUIT_Desktop* setViewModel( new GLViewer_Viewer2d( "GLViewer" ) ); } -//*************************************************************** +/*!Destructor.*/ GLViewer_ViewManager::~GLViewer_ViewManager() { } -//*************************************************************** +/*!Sets view name for view window \a theView.*/ void GLViewer_ViewManager::setViewName(SUIT_ViewWindow* theView) { int aPos = myViews.find(theView); theView->setCaption( QString( "GL scene:%1 - viewer:%2" ).arg(myId).arg(aPos+1)); } -//*************************************************************** +/*!Context menu popup for \a popup.*/ void GLViewer_ViewManager::contextMenuPopup( QPopupMenu* popup ) { SUIT_ViewManager::contextMenuPopup( popup ); diff --git a/src/GLViewer/GLViewer_ViewPort.cxx b/src/GLViewer/GLViewer_ViewPort.cxx index 78767afa1..b6416e9c6 100644 --- a/src/GLViewer/GLViewer_ViewPort.cxx +++ b/src/GLViewer/GLViewer_ViewPort.cxx @@ -22,13 +22,6 @@ // File: GLViewer_ViewPort.cxx // Created: November, 2004 -/*************************************************************************** -** Class: GLViewer_ViewPort -** Descr: Visualisation canvas of QAD-based application -** Module: QAD -** Created: UI team, 05.09.00 -****************************************************************************/ - //#include #if !(defined WNT) && !(defined QT_CLEAN_NAMESPACE) @@ -60,6 +53,11 @@ #include #include +/*! + \struct CMapEntry + Map of indexed colors + For internal purposes +*/ struct CMapEntry { CMapEntry(); @@ -69,6 +67,9 @@ struct CMapEntry XStandardColormap scmap; }; +/*! + Constructor +*/ CMapEntry::CMapEntry() { cmap = 0; @@ -76,6 +77,9 @@ CMapEntry::CMapEntry() scmap.colormap = 0; } +/*! + Destructor +*/ CMapEntry::~CMapEntry() { if ( alloc ) @@ -587,6 +591,9 @@ void GLViewer_ViewPort::onChangeBgColor() setBackgroundColor( selColor ); } +/*! + Custom context menu event handler +*/ void GLViewer_ViewPort::contextMenuEvent( QContextMenuEvent* e ) { //if ( e->reason() != QContextMenuEvent::Mouse ) diff --git a/src/GLViewer/GLViewer_ViewPort.h b/src/GLViewer/GLViewer_ViewPort.h index 02ef4edaf..3174121d1 100644 --- a/src/GLViewer/GLViewer_ViewPort.h +++ b/src/GLViewer/GLViewer_ViewPort.h @@ -22,11 +22,6 @@ // File: GLViewer_ViewPort.h // Created: November, 2004 -/*************************************************************************** -** Class: GLViewer_ViewPort -** Descr: Visualisation canvas of GLViewer -** Created: UI team, 05.09.04 -****************************************************************************/ #ifndef GLVIEWER_VIEWPORT_H #define GLVIEWER_VIEWPORT_H @@ -57,10 +52,10 @@ enum BlockStatus BS_Dragging = 0x0004 }; -/*! - * Class GLViewer_ViewPort - * Visualisation canvas of GLViewer - */ +/*! + \class GLViewer_ViewPort + Visualisation canvas of GLViewer +*/ class GLVIEWER_API GLViewer_ViewPort: public QWidget { Q_OBJECT diff --git a/src/GLViewer/GLViewer_ViewPort2d.cxx b/src/GLViewer/GLViewer_ViewPort2d.cxx index 17d9d68da..a81bc0763 100644 --- a/src/GLViewer/GLViewer_ViewPort2d.cxx +++ b/src/GLViewer/GLViewer_ViewPort2d.cxx @@ -63,6 +63,9 @@ void rotate_point( float& theX, float& theY, float theAngle ) theY = aTempY; } +/*! + Constructor +*/ GLViewer_ViewPort2d::GLViewer_ViewPort2d( QWidget* parent, GLViewer_ViewFrame* theViewFrame ) : GLViewer_ViewPort( parent ), myMargin( MARGIN ), myWidth( WIDTH ), myHeight( HEIGHT ), @@ -105,6 +108,9 @@ GLViewer_ViewPort2d::GLViewer_ViewPort2d( QWidget* parent, GLViewer_ViewFrame* t // myGLWidget->installEventFilter( myObjectTip ); } +/*! + Destructor +*/ GLViewer_ViewPort2d::~GLViewer_ViewPort2d() { if( myCompass ) @@ -117,6 +123,9 @@ GLViewer_ViewPort2d::~GLViewer_ViewPort2d() delete myGLWidget; } +/*! + SLOT: initializes drag process +*/ void GLViewer_ViewPort2d::onStartDragObject( ) { if( myIsDragProcess == noDrag ) @@ -132,6 +141,9 @@ void GLViewer_ViewPort2d::onStartDragObject( ) } } +/*! + SLOT: cuts object to clipboard +*/ void GLViewer_ViewPort2d::onCutObject() { /*GLViewer_Object* aMovingObject = ((GLViewer_Viewer2d*)getViewFrame()->getViewer())->getGLContext()->getCurrentObject(); @@ -167,6 +179,9 @@ void GLViewer_ViewPort2d::onCutObject() } } +/*! + SLOT: copies object to clipboard +*/ void GLViewer_ViewPort2d::onCopyObject() { /*GLViewer_Object* aMovingObject = ((GLViewer_Viewer2d*)getViewFrame()->getViewer())->getGLContext()->getCurrentObject(); @@ -198,6 +213,9 @@ void GLViewer_ViewPort2d::onCopyObject() } } +/*! + SLOT: pastes object from clipboard +*/ void GLViewer_ViewPort2d::onPasteObject() { /*QClipboard *aClipboard = QApplication::clipboard(); @@ -243,6 +261,9 @@ void GLViewer_ViewPort2d::onPasteObject() */ } +/*! + SLOT: called when object is being dragged +*/ void GLViewer_ViewPort2d::onDragObject( QMouseEvent* e ) { //cout << "---GLViewer_ViewPort2d::onDragObject()---" << endl; @@ -401,6 +422,9 @@ void GLViewer_ViewPort2d::mouseReleaseEvent( QMouseEvent* e ) } } +/*! + Custom mouse double click event handler +*/ void GLViewer_ViewPort2d::mouseDoubleClickEvent( QMouseEvent * e ) { //redefined to block mouse release after mouse double click @@ -409,6 +433,10 @@ void GLViewer_ViewPort2d::mouseDoubleClickEvent( QMouseEvent * e ) GLViewer_ViewPort::mouseDoubleClickEvent( e ); } +/*! + Creates or deletes compass + \param on - if it is true, then to create +*/ void GLViewer_ViewPort2d::turnCompass( GLboolean on ) { if( on ) @@ -417,6 +445,10 @@ void GLViewer_ViewPort2d::turnCompass( GLboolean on ) delete myCompass; } +/*! + Creates or deletes grid + \param on - if it is true, then to create +*/ void GLViewer_ViewPort2d::turnGrid( GLboolean on ) { if( on ) @@ -431,6 +463,11 @@ void GLViewer_ViewPort2d::turnGrid( GLboolean on ) delete myGrid; } +/*! + Changes grid color + \param gridColor - new grid color + \param axisColor - new axis color +*/ void GLViewer_ViewPort2d::setGridColor( const QColor gridColor, const QColor axisColor ) { if( myGrid ) @@ -444,6 +481,10 @@ void GLViewer_ViewPort2d::setGridColor( const QColor gridColor, const QColor axi } } +/*! + Changes background color + \param color - new background color +*/ void GLViewer_ViewPort2d::setBackgroundColor( const QColor& color ) { GLViewer_ViewPort::setBackgroundColor( color ); @@ -454,11 +495,17 @@ void GLViewer_ViewPort2d::setBackgroundColor( const QColor& color ) myGLWidget->repaint(); } +/*! + \return background color +*/ QColor GLViewer_ViewPort2d::backgroundColor() const { return GLViewer_ViewPort::backgroundColor(); } +/*! + Resize view +*/ void GLViewer_ViewPort2d::initResize( int x, int y ) { float xa, xb, ya, yb; @@ -509,6 +556,9 @@ void GLViewer_ViewPort2d::initResize( int x, int y ) myGLWidget->setScale( myXScale, myYScale, 1.0 ); } +/*! + Custom paint event handler +*/ void GLViewer_ViewPort2d::paintEvent( QPaintEvent* e ) { //cout << "GLViewer_ViewPort2d::paintEvent" << endl; @@ -516,12 +566,18 @@ void GLViewer_ViewPort2d::paintEvent( QPaintEvent* e ) GLViewer_ViewPort::paintEvent( e ); } +/*! + Custom resize event handler +*/ void GLViewer_ViewPort2d::resizeEvent( QResizeEvent* e ) { //cout << "GLViewer_ViewPort2d::resizeEvent" << endl; GLViewer_ViewPort::resizeEvent( e ); } +/*! + Resets view to start state +*/ void GLViewer_ViewPort2d::reset() { //cout << "GLViewer_ViewPort2d::reset" << endl; @@ -557,6 +613,11 @@ void GLViewer_ViewPort2d::reset() myGLWidget->updateGL(); } +/*! + Sets offset to view + \param dx - X offset + \param dy - Y offset +*/ void GLViewer_ViewPort2d::pan( int dx, int dy ) { //cout << "GLViewer_ViewPort2d::pan " << dx << " " << dy << endl; @@ -588,6 +649,10 @@ void GLViewer_ViewPort2d::pan( int dx, int dy ) myGLWidget->updateGL(); } +/*! + Sets view center in global coords + \param x, y - global co-ordinates of center +*/ void GLViewer_ViewPort2d::setCenter( int x, int y ) { //cout << "GLViewer_ViewPort2d::setCenter" << endl; @@ -617,6 +682,9 @@ void GLViewer_ViewPort2d::setCenter( int x, int y ) myGLWidget->updateGL(); } +/*! + Process zoming transformation with mouse tracking from ( x0, y0 ) to ( x1, y1 ) +*/ void GLViewer_ViewPort2d::zoom( int x0, int y0, int x, int y ) { //cout << "GLViewer_ViewPort2d::zoom" << endl; @@ -659,6 +727,10 @@ void GLViewer_ViewPort2d::zoom( int x0, int y0, int x, int y ) } } +/*! + Transforms view by rectangle + \param rect - rectangle +*/ void GLViewer_ViewPort2d::fitRect( const QRect& rect ) { float x0, x1, y0, y1; @@ -711,6 +783,9 @@ void GLViewer_ViewPort2d::fitRect( const QRect& rect ) myGLWidget->updateGL(); } +/*! + Transforms view by selection +*/ void GLViewer_ViewPort2d::fitSelect() { GLViewer_Viewer2d* aViewer = (GLViewer_Viewer2d*)getViewFrame()->getViewer(); @@ -732,6 +807,10 @@ void GLViewer_ViewPort2d::fitSelect() } } +/*! + Transform view by view borders + \param keepScale - if it is true, zoom does not change +*/ void GLViewer_ViewPort2d::fitAll( bool keepScale, bool withZ ) { //cout << "GLViewer_ViewPort2d::fitAll" << endl; @@ -820,11 +899,19 @@ void GLViewer_ViewPort2d::fitAll( bool keepScale, bool withZ ) emit vpUpdateValues(); } +/*! + Begins rotation + \param x, y - start point +*/ void GLViewer_ViewPort2d::startRotation( int x, int y ) { myGLWidget->setRotationStart( x, y, 1.0 ); } +/*! + Performs rotation + \param intX, intY - current point +*/ void GLViewer_ViewPort2d::rotate( int intX, int intY ) { GLint val[4]; @@ -871,6 +958,9 @@ void GLViewer_ViewPort2d::rotate( int intX, int intY ) myGLWidget->updateGL(); } +/*! + Finishes rotation +*/ void GLViewer_ViewPort2d::endRotation() { float ra, rx, ry, rz; @@ -878,6 +968,9 @@ void GLViewer_ViewPort2d::endRotation() myGLWidget->setRotationAngle( ra ); } +/*! + Draws compass +*/ void GLViewer_ViewPort2d::drawCompass() { if( !myCompass->getVisible() ) @@ -1038,6 +1131,9 @@ void GLViewer_ViewPort2d::drawCompass() glCallList( aTextList ); } +/*! + \return blocking status for current started operations +*/ BlockStatus GLViewer_ViewPort2d::currentBlock() { if( myIsDragProcess == inDrag && myCurDragPosX != NULL && myCurDragPosY != NULL) @@ -1049,6 +1145,10 @@ BlockStatus GLViewer_ViewPort2d::currentBlock() return BS_NoBlock; } +/*! + Initializes rectangle selection + \param x, y - start point +*/ void GLViewer_ViewPort2d::startSelectByRect( int x, int y ) { if( !mypFirstPoint && !mypLastPoint ) @@ -1057,6 +1157,11 @@ void GLViewer_ViewPort2d::startSelectByRect( int x, int y ) mypLastPoint = new QPoint( x, y ); } } + +/*! + Draws rectangle selection + \param x, y - current point +*/ void GLViewer_ViewPort2d::drawSelectByRect( int x, int y ) { if( mypFirstPoint && mypLastPoint ) @@ -1075,6 +1180,10 @@ void GLViewer_ViewPort2d::drawSelectByRect( int x, int y ) } } + +/*! + Finishes rectangle selection +*/ void GLViewer_ViewPort2d::finishSelectByRect() { if( mypFirstPoint && mypLastPoint ) @@ -1094,6 +1203,9 @@ void GLViewer_ViewPort2d::finishSelectByRect() } } +/*! + \return rectangle selection +*/ QRect GLViewer_ViewPort2d::selectionRect() { QRect aRect; @@ -1108,6 +1220,8 @@ QRect GLViewer_ViewPort2d::selectionRect() return aRect; } +/*! +*/ bool GLViewer_ViewPort2d::startPulling( GLViewer_Pnt point ) { GLViewer_Viewer2d* aViewer = (GLViewer_Viewer2d*)getViewFrame()->getViewer(); @@ -1131,6 +1245,8 @@ bool GLViewer_ViewPort2d::startPulling( GLViewer_Pnt point ) return false; } +/*! +*/ void GLViewer_ViewPort2d::drawPulling( GLViewer_Pnt point ) { GLViewer_Viewer2d* aViewer = (GLViewer_Viewer2d*)getViewFrame()->getViewer(); @@ -1156,6 +1272,8 @@ void GLViewer_ViewPort2d::drawPulling( GLViewer_Pnt point ) myPullingObject->pull( point, aLockedObject ); } +/*! +*/ void GLViewer_ViewPort2d::finishPulling() { myIsPulling = false; @@ -1163,6 +1281,10 @@ void GLViewer_ViewPort2d::finishPulling() setCursor( *getDefaultCursor() ); } +/*! + Convert rectangle in window co-ordinates to GL co-ordinates + \return converted rectangle +*/ GLViewer_Rect GLViewer_ViewPort2d::win2GLV( const QRect& theRect ) const { GLViewer_Rect aRect; @@ -1189,6 +1311,10 @@ GLViewer_Rect GLViewer_ViewPort2d::win2GLV( const QRect& theRect ) const return aRect; } +/*! + Convert rectangle in GL co-ordinates to window co-ordinates + \return converted rectangle +*/ QRect GLViewer_ViewPort2d::GLV2win( const GLViewer_Rect& theRect ) const { QRect aRect; @@ -1215,6 +1341,9 @@ QRect GLViewer_ViewPort2d::GLV2win( const GLViewer_Rect& theRect ) const return aRect; } +/*! + SLOT: called when tooltip should be shown +*/ void GLViewer_ViewPort2d::onMaybeTip( QPoint thePoint, QString& theText, QFont& theFont, QRect& theTextReg, QRect& theRegion ) { GLViewer_Context* aContext = ((GLViewer_Viewer2d*)getViewFrame()->getViewer())->getGLContext(); diff --git a/src/GLViewer/GLViewer_ViewPort2d.h b/src/GLViewer/GLViewer_ViewPort2d.h index 128cdbe06..4c39051ce 100644 --- a/src/GLViewer/GLViewer_ViewPort2d.h +++ b/src/GLViewer/GLViewer_ViewPort2d.h @@ -178,7 +178,7 @@ protected: virtual void setCenter( int x, int y ); //! Process zoming transformation with mouse tracking from ( x0, y0 ) to ( x1, y1 ) virtual void zoom( int x0, int y0, int x1, int y1 ); - //! Transforms view by certangle + //! Transforms view by rectangle virtual void fitRect( const QRect& ); //! Transforms view by selection virtual void fitSelect(); diff --git a/src/GLViewer/GLViewer_Viewer.cxx b/src/GLViewer/GLViewer_Viewer.cxx index 9ca9ed73e..78a16398f 100644 --- a/src/GLViewer/GLViewer_Viewer.cxx +++ b/src/GLViewer/GLViewer_Viewer.cxx @@ -22,13 +22,6 @@ // File: GLViewer_Viewer.cxx // Created: November, 2004 -/*************************************************************************** -** Class: GLViewer_Viewer -** Descr: Viewer for QAD-based application -** Module: QAD -** Created: UI team, 05.09.00 -****************************************************************************/ - //#include #include "GLViewer_Viewer.h" #include "GLViewer_Selector.h" @@ -66,10 +59,10 @@ GLViewer_Viewer::~GLViewer_Viewer() delete mySelector; } -//================================================================ -// Function : setViewManager -// Purpose : -//================================================================ +/*! + Sets new view manager + \param theViewManager - new view manager +*/ void GLViewer_Viewer::setViewManager(SUIT_ViewManager* theViewManager) { SUIT_ViewModel::setViewManager(theViewManager); @@ -89,10 +82,9 @@ void GLViewer_Viewer::setViewManager(SUIT_ViewManager* theViewManager) } } -//================================================================ -// Function : contextMenuPopup -// Purpose : -//================================================================ +/*! + Builds popup for GL viewer +*/ void GLViewer_Viewer::contextMenuPopup( QPopupMenu* thePopup ) { if( thePopup->count() > 0 ) @@ -530,10 +522,6 @@ void GLViewer_Viewer::handleWheel( QWheelEvent* e ) startOperations( e ); } -/**************************************************************** -** Class: GLViewer_ViewTransformer -** Level: Public -*****************************************************************/ int GLViewer_ViewTransformer::panBtn = Qt::MidButton; int GLViewer_ViewTransformer::zoomBtn = Qt::LeftButton; int GLViewer_ViewTransformer::fitRectBtn = Qt::LeftButton; @@ -758,10 +746,6 @@ int GLViewer_ViewTransformer::type() const } -/**************************************************************** -** Class: GLViewer_ViewSketcher -** Level: Public -*****************************************************************/ int GLViewer_ViewSketcher::sketchBtn = LeftButton; /*! diff --git a/src/GLViewer/GLViewer_Viewer.h b/src/GLViewer/GLViewer_Viewer.h index dfd16c2fa..fa6a36f35 100644 --- a/src/GLViewer/GLViewer_Viewer.h +++ b/src/GLViewer/GLViewer_Viewer.h @@ -46,9 +46,9 @@ class SUIT_ViewWindow; #endif /*! - * Class GLViewer_Object - * Base Viewer for GLViewer - */ + \class GLViewer_Object + Base Viewer for GLViewer +*/ class GLVIEWER_API GLViewer_Viewer: public SUIT_ViewModel { Q_OBJECT @@ -128,10 +128,6 @@ protected: GLViewer_ViewTransformer* myTransformer; /* transform manipulator */ }; -/**************************************************************** -** Class: GLViewer_ViewTransformer -** -*****************************************************************/ class GLVIEWER_API GLViewer_ViewTransformer : public QObject { public: @@ -188,10 +184,6 @@ protected: int myMajorBtn; }; -/**************************************************************** -** Class: GLViewer_ViewSketcher -** -*****************************************************************/ class GLVIEWER_API GLViewer_ViewSketcher : public QObject { public: diff --git a/src/GLViewer/GLViewer_Viewer2d.cxx b/src/GLViewer/GLViewer_Viewer2d.cxx index f98f5e2ae..77fdf4972 100644 --- a/src/GLViewer/GLViewer_Viewer2d.cxx +++ b/src/GLViewer/GLViewer_Viewer2d.cxx @@ -22,13 +22,6 @@ // File: GLViewer_Viewer2d.cxx // Created: November, 2004 -/*************************************************************************** -** Class: GLViewer_Viewer2d -** Descr: OpenGL Viewer 2D -** Module: GLViewer -** Created: UI team, 04.09.02 -****************************************************************************/ - //#include #include "GLViewer_Viewer2d.h" #include "GLViewer_Object.h" @@ -50,6 +43,10 @@ #include #include +/*! + Constructor + \param title - viewer title +*/ GLViewer_Viewer2d::GLViewer_Viewer2d( const QString& title) : GLViewer_Viewer( title ) { @@ -64,6 +61,9 @@ GLViewer_Viewer( title ) myDrawers.clear(); } +/*! + Destructor +*/ GLViewer_Viewer2d::~GLViewer_Viewer2d() { //myGLSketcher = 0; @@ -71,11 +71,18 @@ GLViewer_Viewer2d::~GLViewer_Viewer2d() GLViewer_TexFont::clearTextBases(); } +/*!Create new instance of view window on desktop \a theDesktop. + *\retval SUIT_ViewWindow* - created view window pointer. + */ SUIT_ViewWindow* GLViewer_Viewer2d::createView( SUIT_Desktop* theDesktop ) { return new GLViewer_ViewFrame( theDesktop, this ); } +/*! + Adds item for change background color + \param thePopup - menu +*/ void GLViewer_Viewer2d::addPopupItems( QPopupMenu* thePopup ) { // CTH8434. "Change background color" menu item is available if there are no selected objects @@ -87,6 +94,9 @@ void GLViewer_Viewer2d::addPopupItems( QPopupMenu* thePopup ) } } +/*! + Changes background color +*/ void GLViewer_Viewer2d::onChangeBgColor() { if( !getActiveView() ) @@ -99,6 +109,9 @@ void GLViewer_Viewer2d::onChangeBgColor() } } +/*! + Updates colors for all drawers (does not work) +*/ void GLViewer_Viewer2d::updateColors( QColor colorH, QColor colorS ) { // cout << "GLViewer_Viewer2d::updateColors" << endl; @@ -126,6 +139,10 @@ void GLViewer_Viewer2d::updateColors( QColor colorH, QColor colorS ) activateAllDrawers( TRUE ); } +/*! + Updates rect of global scene by adding new rectangle + \param theRect - rectangle +*/ void GLViewer_Viewer2d::updateBorders( GLViewer_Rect* theRect ) { QPtrVector views = getViewManager()->getViews(); @@ -140,6 +157,9 @@ void GLViewer_Viewer2d::updateBorders( GLViewer_Rect* theRect ) } } +/*! + Recomputes global scene rect +*/ void GLViewer_Viewer2d::updateBorders() { QPtrVector views = getViewManager()->getViews(); @@ -178,6 +198,9 @@ void GLViewer_Viewer2d::updateBorders() } } +/*! + Redraws all active objects by updating all drawers in all views +*/ void GLViewer_Viewer2d::updateAll() { if ( !getActiveView() ) @@ -188,6 +211,9 @@ void GLViewer_Viewer2d::updateAll() ( ( GLViewer_ViewPort2d* )( ( GLViewer_ViewFrame* )views[i] )->getViewPort() )->getGLWidget()->updateGL(); } +/*! + \param onlyUpdate is passed to method activateAllDrawers drawers +*/ void GLViewer_Viewer2d::updateDrawers( GLboolean update, GLfloat scX, GLfloat scY ) { // cout << "GLViewer_Viewer2d::updateDrawers" << endl; @@ -197,6 +223,9 @@ void GLViewer_Viewer2d::updateDrawers( GLboolean update, GLfloat scX, GLfloat sc activateAllDrawers( update ); } +/*! + Activates drawers for objects from list \param theObjects only +*/ void GLViewer_Viewer2d::activateDrawers( QValueList& theObjects, bool onlyUpdate, GLboolean swap ) { //cout << "GLViewer_Viewer2d::activateDrawers " << (int)onlyUpdate << " " << (int)swap << endl; @@ -282,6 +311,9 @@ void GLViewer_Viewer2d::activateDrawers( QValueList& theObject ( ( GLViewer_ViewPort2d* )getActiveView()->getViewPort() )->getGLWidget()->makeCurrent(); } +/*! + Activates drawer for \param theObject +*/ void GLViewer_Viewer2d::activateDrawer( GLViewer_Object* theObject, bool onlyUpdate, GLboolean swap ) { ObjList aList; @@ -289,6 +321,9 @@ void GLViewer_Viewer2d::activateDrawer( GLViewer_Object* theObject, bool onlyUpd activateDrawers( aList, onlyUpdate, swap ); } +/*! + \param onlyUpdate is passed to drawers +*/ void GLViewer_Viewer2d::activateAllDrawers( bool onlyUpdate, GLboolean swap ) { if ( !getActiveView() ) @@ -306,6 +341,11 @@ void GLViewer_Viewer2d::activateAllDrawers( bool onlyUpdate, GLboolean swap ) activateDrawers( anActiveObjs, onlyUpdate, swap ); } +/*! + Creates set of marker + \param theMarkersNum - number of markers + \param theMarkersRad - radius of markers +*/ void GLViewer_Viewer2d::onCreateGLMarkers( int theMarkersNum, int theMarkersRad ) { if ( !getActiveView() ) @@ -341,6 +381,12 @@ void GLViewer_Viewer2d::onCreateGLMarkers( int theMarkersNum, int theMarkersRad delete[] anYCoord; } +/*! + Creates GL polyline + \param theAnglesNum - number of angles + \param theRadius - radius + \param thePolylineNumber - number +*/ void GLViewer_Viewer2d::onCreateGLPolyline( int theAnglesNum, int theRadius, int thePolylineNumber ) { if ( !getActiveView() ) @@ -384,6 +430,11 @@ void GLViewer_Viewer2d::onCreateGLPolyline( int theAnglesNum, int theRadius, int delete[] anYCoord; } +/*! + Creates text + \param theStr - text string + \param theTextNumber - number +*/ void GLViewer_Viewer2d::onCreateGLText( QString theStr, int theTextNumber ) { if ( !getActiveView() ) @@ -414,6 +465,10 @@ void GLViewer_Viewer2d::onCreateGLText( QString theStr, int theTextNumber ) activateAllDrawers( false ); } +/*! + Translates point from global CS to curreent viewer CS + \param x, y - co-ordinates to be translated +*/ void GLViewer_Viewer2d::transPoint( GLfloat& x, GLfloat& y ) { if ( !getActiveView() ) @@ -442,6 +497,10 @@ void GLViewer_Viewer2d::transPoint( GLfloat& x, GLfloat& y ) y -= yPan; } +/*! + \return object rect in window CS + \param theObject - object +*/ QRect* GLViewer_Viewer2d::getWinObjectRect( GLViewer_Object* theObject ) { if ( !getActiveView() ) @@ -497,6 +556,11 @@ QRect* GLViewer_Viewer2d::getWinObjectRect( GLViewer_Object* theObject ) return newRect; } +/*! + Translates rect in window CS to rect in global CS + \param theRect - rectangle to be translated + \return transformed rect +*/ GLViewer_Rect GLViewer_Viewer2d::getGLVRect( const QRect& theRect ) const { if ( !getActiveView() ) @@ -510,6 +574,11 @@ GLViewer_Rect GLViewer_Viewer2d::getGLVRect( const QRect& theRect ) const return vp->win2GLV( theRect ); } +/*! + Translates rect in global CS to rect in window CS + \param theRect - rectangle to be translated + \return transformed rect +*/ QRect GLViewer_Viewer2d::getQRect( const GLViewer_Rect& theRect ) const { if ( !getActiveView() ) @@ -523,87 +592,25 @@ QRect GLViewer_Viewer2d::getQRect( const GLViewer_Rect& theRect ) const return vp->GLV2win( theRect ); } +/*! + \return new selector +*/ GLViewer_Selector* GLViewer_Viewer2d::createSelector() { return new GLViewer_Selector2d( this, getGLContext() ); } +/*! + \return new Transformer + \param type - type of new transformer +*/ GLViewer_ViewTransformer* GLViewer_Viewer2d::createTransformer( int type ) { return new GLViewer_View2dTransformer( this, type ); } -/* -GLViewer_Sketcher* GLViewer_Viewer2d::createGLSketcher( int type ) -{ - return new GLViewer_Sketcher( this, type ); -} -void GLViewer_Viewer2d::activateGLSketching( int type ) -{ - GLViewer_ViewPort2d* vp = 0; - if ( !getActiveView() || !( vp = ( GLViewer_ViewPort2d* )getActiveView()->getViewPort() ) ) - return; - - // Finish current sketching - if ( type == None ) - { - if ( myGLSketcher->getType() != None ) - { - myGLSketcher->setType( None ); - finishSketching(); - } - } - // Activate new sketching - else - { - activateGLSketching( None ); // concurrency not supported - myGLSketcher->setType( type ); - startSketching(); - } -} - -void GLViewer_Viewer2d::startSketching() -{ - GLViewer_ViewPort2d* avp = (GLViewer_ViewPort2d*)getActiveView()->getViewPort(); - avp->setCursor( *avp->getSketchCursor() ); - //avp->enablePopup( false ); - myGLSketcher->startSketching(); -} - -void GLViewer_Viewer2d::finishSketching() -{ - GLViewer_ViewPort2d* avp = (GLViewer_ViewPort2d*)getActiveView()->getViewPort(); - avp->setCursor( *avp->getDefaultCursor() ); - //avp->enablePopup( true ); - myGLSketcher->finishSketching(); -} - -bool GLViewer_Viewer2d::isSketchingActive() -{ - return myGLSketcher->getType() != None; -} - -int GLViewer_Viewer2d::getSketchingType() -{ - return myGLSketcher->getType(); -} - -void GLViewer_Viewer2d::onSketchDelObject() -{ - GLViewer_ViewPort2d* avp = (GLViewer_ViewPort2d*)getActiveView()->getViewPort(); - avp->setCursor( *avp->getDefaultCursor() ); - myGLSketcher->finishSketching( true ); -} - -void GLViewer_Viewer2d::onSketchUndoLast() -{ - -} - -void GLViewer_Viewer2d::onSketchFinish() -{ - finishSketching(); -} +/*! + Custom mouse event handler */ void GLViewer_Viewer2d::onMouseEvent( SUIT_ViewWindow*, QMouseEvent* e ) { @@ -626,6 +633,9 @@ void GLViewer_Viewer2d::onMouseEvent( SUIT_ViewWindow*, QMouseEvent* e ) GLViewer_Viewer::onMouseEvent( 0, e ); } +/*! + Rotation transformation +*/ bool GLViewer_Viewer2d::testRotation( QMouseEvent* e ) { if ( ( e->button() == GLViewer_View2dTransformer::rotateButton() ) && @@ -638,7 +648,11 @@ bool GLViewer_Viewer2d::testRotation( QMouseEvent* e ) return false; } - +/*! + Inserts text lines as header for file + \param aType - file type + \param hFile - file instance +*/ void GLViewer_Viewer2d::insertHeader( VectorFileType aType, QFile& hFile ) { if( aType == POST_SCRIPT ) @@ -671,6 +685,11 @@ void GLViewer_Viewer2d::insertHeader( VectorFileType aType, QFile& hFile ) } } +/*! + Inserts text lines as ending for file + \param aType - file type + \param hFile - file instance +*/ void GLViewer_Viewer2d::insertEnding( VectorFileType aType, QFile& hFile ) { if( aType == POST_SCRIPT ) @@ -698,6 +717,13 @@ inline void mm2custom( GLViewer_Viewer2d::VectorFileType aType, double& value ) #endif } +/*! + Translates current view content to vector file + \param aType - type of file + \param FileName - name of file, + \param aPType - paper size type + \param mmLeft, mmRight, mmTop, mmBottom - margins +*/ bool GLViewer_Viewer2d::translateTo( VectorFileType aType, QString FileName, PaperType aPType, double mmLeft, double mmRight, double mmTop, double mmBottom ) { @@ -821,7 +847,10 @@ bool GLViewer_Viewer2d::translateTo( VectorFileType aType, QString FileName, Pap return true; } - +/*! + Repaints view + \param theView - view to be repainted. If it is NULL then all views will be repainted +*/ void GLViewer_Viewer2d::repaintView( GLViewer_ViewFrame* theView, bool makeCurrent ) { GLViewer_ViewFrame* aCurView; @@ -897,6 +926,9 @@ void GLViewer_Viewer2d::repaintView( GLViewer_ViewFrame* theView, bool makeCurre // ( ( GLViewer_ViewPort2d* )getActiveView()->getViewPort() )->getGLWidget()->makeCurrent(); } +/*! + Starts some operation on mouse event +*/ void GLViewer_Viewer2d::startOperations( QMouseEvent* e ) { GLViewer_ViewPort2d* vp = ( GLViewer_ViewPort2d* )((GLViewer_ViewFrame*)getActiveView())->getViewPort(); @@ -913,6 +945,9 @@ void GLViewer_Viewer2d::startOperations( QMouseEvent* e ) vp->startSelectByRect( e->x(), e->y() ); } +/*! + Updates started operation on mouse event +*/ bool GLViewer_Viewer2d::updateOperations( QMouseEvent* e ) { GLViewer_ViewPort2d* vp = ( GLViewer_ViewPort2d* )((GLViewer_ViewFrame*)getActiveView())->getViewPort(); @@ -936,6 +971,9 @@ bool GLViewer_Viewer2d::updateOperations( QMouseEvent* e ) return false; } +/*! + Completes started operation on mouse event +*/ void GLViewer_Viewer2d::finishOperations( QMouseEvent* e ) { GLViewer_ViewPort2d* vp = ( GLViewer_ViewPort2d* )((GLViewer_ViewFrame*)getActiveView())->getViewPort(); @@ -959,6 +997,9 @@ void GLViewer_Viewer2d::finishOperations( QMouseEvent* e ) } } +/*! + Starts some operation on mouse wheel event +*/ void GLViewer_Viewer2d::startOperations( QWheelEvent* e ) { bool zoomIn = e->delta() > 0; @@ -976,13 +1017,11 @@ void GLViewer_Viewer2d::startOperations( QWheelEvent* e ) } -/**************************************************************** -** Class: GLViewer_View2dTransformer -** -*****************************************************************/ - int GLViewer_View2dTransformer::rotateBtn = RightButton; +/*! + Constructor +*/ GLViewer_View2dTransformer::GLViewer_View2dTransformer( GLViewer_Viewer* viewer, int typ ) : GLViewer_ViewTransformer( viewer, typ ) { @@ -990,6 +1029,9 @@ GLViewer_View2dTransformer::GLViewer_View2dTransformer( GLViewer_Viewer* viewer, initTransform( true ); } +/*! + Destructor +*/ GLViewer_View2dTransformer::~GLViewer_View2dTransformer() { if ( type() == GLViewer_Viewer::Rotate ) diff --git a/src/GLViewer/GLViewer_Viewer2d.h b/src/GLViewer/GLViewer_Viewer2d.h index 21840335f..3682633e1 100644 --- a/src/GLViewer/GLViewer_Viewer2d.h +++ b/src/GLViewer/GLViewer_Viewer2d.h @@ -22,12 +22,6 @@ // File: GLViewer_Viewer2d.h // Created: November, 2004 -/*************************************************************************** -** Class: GLViewer_Viewer2d -** Descr: OpenGL Viewer 2D -** Module: GLViewer -** Created: UI team, 04.09.04 -****************************************************************************/ #ifndef GLVIEWER_VIEWER2D_H #define GLVIEWER_VIEWER2D_H @@ -68,10 +62,11 @@ const double Sizes[2*5] = { #pragma warning( disable:4251 ) #endif -/*! - * Class GLViewer_Object - * 2D viewer for GLViewer - */ +/*! + \class GLViewer_Viewer2d + OpenGL Viewer 2D +*/ + class GLVIEWER_API GLViewer_Viewer2d : public GLViewer_Viewer { Q_OBJECT @@ -234,10 +229,6 @@ protected: //GLViewer_Sketcher* myGLSketcher; }; -/**************************************************************** -** Class: GLViewer_View2dTransformer -** -*****************************************************************/ class GLVIEWER_API GLViewer_View2dTransformer : public GLViewer_ViewTransformer { public: diff --git a/src/GLViewer/GLViewer_Widget.cxx b/src/GLViewer/GLViewer_Widget.cxx index b29a9fb52..616e57546 100644 --- a/src/GLViewer/GLViewer_Widget.cxx +++ b/src/GLViewer/GLViewer_Widget.cxx @@ -22,11 +22,6 @@ // File: GLViewer_Widget.cxx // Created: November, 2004 -//================================================================ -// Class : GLViewer_Widget -// Description : OpenGL QWidget for GLViewer -//================================================================ - #include "GLViewer_Widget.h" #include "GLViewer_ViewPort2d.h" #include "GLViewer_Viewer2d.h" @@ -49,10 +44,10 @@ using namespace std; #include #include -//======================================================================= -// Function: GLViewer_Widget -// Purpose : -//======================================================================= +/*! + A constructor + Parameters using for QOGLWidget as is +*/ GLViewer_Widget::GLViewer_Widget( QWidget* parent, const char* name ): QGLWidget( parent, 0/*, WRepaintNoErase | WResizeNoErase*/ ) { @@ -78,18 +73,16 @@ QGLWidget( parent, 0/*, WRepaintNoErase | WResizeNoErase*/ ) setMouseTracking( true ); } -//======================================================================= -// Function: GLViewer_Widget -// Purpose : -//======================================================================= +/*! + Destructor +*/ GLViewer_Widget::~GLViewer_Widget() { } -//======================================================================= -// Function: ~GLViewer_Widget -// Purpose : -//======================================================================= +/*! + \return offset parameters of Window in OpenGL global scene +*/ void GLViewer_Widget::getPan( GLfloat& xPan, GLfloat& yPan, GLfloat& zPan ) { xPan = myXPan; @@ -97,10 +90,9 @@ void GLViewer_Widget::getPan( GLfloat& xPan, GLfloat& yPan, GLfloat& zPan ) zPan = myZPan; } -//======================================================================= -// Function: setPan -// Purpose : -//======================================================================= +/*! + A function for installing the offset parameters of Window in OpenGL global scene +*/ void GLViewer_Widget::setPan( GLfloat xPan, GLfloat yPan, GLfloat zPan ) { myXPan = xPan; @@ -108,10 +100,9 @@ void GLViewer_Widget::setPan( GLfloat xPan, GLfloat yPan, GLfloat zPan ) myZPan = zPan; } -//======================================================================= -// Function: getScale -// Purpose : -//======================================================================= +/*! + \return scales on OpenGL scene along 3 directions in 2d scene zScale = 1.0 +*/ void GLViewer_Widget::getScale( GLfloat& xScale, GLfloat& yScale, GLfloat& zScale ) { xScale = myXScale; @@ -119,10 +110,9 @@ void GLViewer_Widget::getScale( GLfloat& xScale, GLfloat& yScale, GLfloat& zScal zScale = myZScale; } -//======================================================================= -// Function: setScale -// Purpose : -//======================================================================= +/*! + A function for installing the scales of OpenGL scene +*/ void GLViewer_Widget::setScale( GLfloat xScale, GLfloat yScale, GLfloat zScale ) { if ( xScale > 0 && yScale > 0 && zScale > 0 ) @@ -133,10 +123,9 @@ void GLViewer_Widget::setScale( GLfloat xScale, GLfloat yScale, GLfloat zScale ) } } -//======================================================================= -// Function: getRotationStart -// Purpose : -//======================================================================= +/*! + \return start point of curren rotation of Window in OpenGL global scene +*/ void GLViewer_Widget::getRotationStart( GLfloat& rotationStartX, GLfloat& rotationStartY, GLfloat& rotationStartZ ) @@ -146,10 +135,9 @@ void GLViewer_Widget::getRotationStart( GLfloat& rotationStartX, rotationStartZ = myRotationStartZ; } -//======================================================================= -// Function: setRotationStart -// Purpose : -//======================================================================= +/*! + A function for installing the rotation angle of Window in OpenGL global scene in degree (Only in 2D) +*/ void GLViewer_Widget::setRotationStart( GLfloat rotationStartX, GLfloat rotationStartY, GLfloat rotationStartZ ) @@ -159,10 +147,13 @@ void GLViewer_Widget::setRotationStart( GLfloat rotationStartX, myRotationStartZ = rotationStartZ; } -//======================================================================= -// Function: getRotation -// Purpose : -//======================================================================= +/*! + \return parameters of rotation + \param rotationAngle - angle + \param rotationCenterX - center x + \param rotationCenterY - center y + \param rotationCenterZ - center z +*/ void GLViewer_Widget::getRotation( GLfloat& rotationAngle, GLfloat& rotationCenterX, GLfloat& rotationCenterY, @@ -174,10 +165,13 @@ void GLViewer_Widget::getRotation( GLfloat& rotationAngle, rotationCenterZ = myRotationCenterZ; } -//======================================================================= -// Function: setRotation -// Purpose : -//======================================================================= +/*! + Sets parameters of rotation + \param rotationAngle - angle + \param rotationCenterX - center x + \param rotationCenterY - center y + \param rotationCenterZ - center z +*/ void GLViewer_Widget::setRotation( GLfloat rotationAngle, GLfloat rotationCenterX, GLfloat rotationCenterY, @@ -189,10 +183,11 @@ void GLViewer_Widget::setRotation( GLfloat rotationAngle, myRotationCenterZ = rotationCenterZ; } -//======================================================================= -// Function: setBackground -// Purpose : -//======================================================================= + +/*! + Sets image as background + \param filename - name of file +*/ void GLViewer_Widget::setBackground( QString filename ) { @@ -245,29 +240,28 @@ void GLViewer_Widget::setBackground( QString filename ) } } -//======================================================================= -// Function: addToolTip -// Purpose : -//======================================================================= +/*! + Adds tooltip + \param theString - tooltip text + \param theRect - tooltip rectangle +*/ void GLViewer_Widget::addToolTip( QString theString, QRect theRect ) { myToolTipRect = theRect; QToolTip::add( this, myToolTipRect, theString ); } -//======================================================================= -// Function: removeToolTip -// Purpose : -//======================================================================= +/*! + Removes tooltip +*/ void GLViewer_Widget::removeToolTip() { QToolTip::remove( this, myToolTipRect ); } -//======================================================================= -// Function: initializeGL -// Purpose : -//======================================================================= +/*! + Initialization (redefined virtual from QGLWidget) +*/ void GLViewer_Widget::initializeGL() { setAutoBufferSwap( true ); @@ -289,10 +283,9 @@ void GLViewer_Widget::initializeGL() isLoadBackground = false; } -//======================================================================= -// Function: paintGL -// Purpose : -//======================================================================= +/*! + Paints content +*/ void GLViewer_Widget::paintGL() { glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT); @@ -335,10 +328,11 @@ void GLViewer_Widget::paintGL() v->repaintView( getViewPort()->getViewFrame() ); } -//======================================================================= -// Function: resizeGL -// Purpose : -//======================================================================= +/*! + Resets OpenGl parameters after resize + \param w - new width + \param h - new height +*/ void GLViewer_Widget::resizeGL( int w, int h ) { @@ -365,10 +359,9 @@ void GLViewer_Widget::resizeGL( int w, int h ) glLoadIdentity(); } -//======================================================================= -// Function: exportRepaint -// Purpose : -//======================================================================= +/*! + Provides repaint in export mode +*/ void GLViewer_Widget::exportRepaint() { isExportMode = true; @@ -378,65 +371,59 @@ void GLViewer_Widget::exportRepaint() isExportMode = false; } -//======================================================================= -// Function: paintEvent -// Purpose : -//======================================================================= +/*! + Custom paint event handler +*/ void GLViewer_Widget::paintEvent( QPaintEvent* e ) { QApplication::sendEvent( myViewPort, e ); } -//======================================================================= -// Function: mouseMoveEvent -// Purpose : -//======================================================================= +/*! + Custom mouse move event handler +*/ void GLViewer_Widget::mouseMoveEvent( QMouseEvent* e ) { QApplication::sendEvent( myViewPort, e ); } -//======================================================================= -// Function: mousePressEvent -// Purpose : -//======================================================================= +/*! + Custom mouse press event handler +*/ void GLViewer_Widget::mousePressEvent( QMouseEvent* e ) { QApplication::sendEvent( myViewPort, e ); } -//======================================================================= -// Function: mouseReleaseEvent -// Purpose : -//======================================================================= +/*! + Custom mouse release event handler +*/ void GLViewer_Widget::mouseReleaseEvent( QMouseEvent* e ) { QApplication::sendEvent( myViewPort, e ); } -//======================================================================= -// Function: enterEvent -// Purpose : -//======================================================================= +/*! + Custom enter event handler +*/ void GLViewer_Widget::enterEvent( QEvent* e ) { updateGL(); } -//======================================================================= -// Function: leaveEvent -// Purpose : -//======================================================================= +/*! + Custom leave event handler +*/ void GLViewer_Widget::leaveEvent( QEvent* e ) { updateGL(); } -//======================================================================= -//! Function: hex -//! Purpose : Returns the hex code of digit < 16 -//======================================================================= +/*! + \return the hex code of digit < 16 + \param c - digit +*/ inline char hex( uchar c ) { if( c<=9 ) @@ -447,11 +434,23 @@ inline char hex( uchar c ) return ' '; } -//======================================================================= -//! Function: AddImagePart -//! Purpose : Translates path of image to PS format -/*! Image inside rectangle from w1 to w2 and from h2 to h1*/ -//======================================================================= +/*! + Translates part of image inside rectangle from w1 to w2 and from h2 to h1 to PS format + \param hFile - PostScript file + \param image - image to be tarnslated + \param w1 - x start position + \param w2 - x end position + \param h1 - y start position + \param h2 - y end position + \param aViewerCS - viewer co-ordinate system + \param aPSCS - paper co-ordinate system + \param a + \param b + \param c + \param d + \param dw + \param dh +*/ void AddImagePart( QFile& hFile, QImage& image, int w1, int w2, int h1, int h2, GLViewer_CoordSystem* aViewerCS, GLViewer_CoordSystem* aPSCS, double a, double b, double c, double d, double dw, double dh ) @@ -493,20 +492,21 @@ void AddImagePart( QFile& hFile, QImage& image, int w1, int w2, int h1, int h2, } } -//======================================================================= -// Function: getBackgroundRectInViewerCS -// Purpose : -//======================================================================= +/*! + \return background rectangle in viewer CS +*/ void GLViewer_Widget::getBackgroundRectInViewerCS( double& left, double& top, double& right, double& bottom ) { left = -myIW/2; right = myIW/2; top = myIH/2; bottom = -myIH/2; } -//======================================================================= -// Function: translateBackgroundToPS -// Purpose : -//======================================================================= +/*! + Translates background to PostScript + \param hFile - PostScript file + \param aViewerCS - viewer co-ordinate system + \param aPSCS - paper co-ordinate system +*/ void GLViewer_Widget::translateBackgroundToPS( QFile& hFile, GLViewer_CoordSystem* aViewerCS, GLViewer_CoordSystem* aPSCS ) { QImage buf; @@ -553,10 +553,9 @@ void GLViewer_Widget::translateBackgroundToPS( QFile& hFile, GLViewer_CoordSyste } } -//======================================================================= -//! Function: DecodeScanLine -//! Purpose : Translate image line with one color depth to line wiht other depth -//======================================================================= +/*! + Translates image line with one color depth to line with other depth +*/ void DecodeScanLine( int width, uchar* dest, int dest_depth, uchar* source, int source_depth ) { #ifndef WIN32 @@ -620,11 +619,13 @@ typedef unsigned int WORD; } } -//======================================================================= -// Function: translateBackgroundToEMF -// Purpose : -//======================================================================= #ifdef WIN32 +/*! + Translates background to EMF + \param dc - descriptor of EMF + \param aViewerCS - viewer co-ordinate system + \param aPSCS - paper co-ordinate system +*/ void GLViewer_Widget::translateBackgroundToEMF( HDC dc, GLViewer_CoordSystem* aViewerCS, GLViewer_CoordSystem* aEMFCS ) { QImage buf; diff --git a/src/GLViewer/GLViewer_Widget.h b/src/GLViewer/GLViewer_Widget.h index c580a9a84..3236c1867 100644 --- a/src/GLViewer/GLViewer_Widget.h +++ b/src/GLViewer/GLViewer_Widget.h @@ -22,9 +22,6 @@ // File: GLViewer_Widget.h // Created: November, 2004 -/*! Class GLViewer_Widget - * Class for visualization OpenGL scene (widget) for GLViewer - */ #ifndef GLVIEWER_WIDGET_H #define GLVIEWER_WIDGET_H @@ -36,6 +33,10 @@ class GLViewer_ViewPort2d; class GLViewer_CoordSystem; +/*! + \class GLViewer_Widget + Widget for visualization of OpenGL scene +*/ class GLVIEWER_API GLViewer_Widget : public QGLWidget { Q_OBJECT diff --git a/src/OBJECT/SALOME_AISShape.cxx b/src/OBJECT/SALOME_AISShape.cxx index dcd76be06..1bd77e3ba 100755 --- a/src/OBJECT/SALOME_AISShape.cxx +++ b/src/OBJECT/SALOME_AISShape.cxx @@ -29,6 +29,12 @@ //using namespace std; #include "SALOME_AISShape.ixx" -SALOME_AISShape::SALOME_AISShape(const TopoDS_Shape& shape): AIS_Shape(shape) { +/*! + Constructor + \param shape - TopoDS shape +*/ +SALOME_AISShape::SALOME_AISShape(const TopoDS_Shape& shape) +: AIS_Shape(shape) +{ } diff --git a/src/OBJECT/SALOME_DataMapNodeOfDataMapOfIOMapOfInteger_0.cxx b/src/OBJECT/SALOME_DataMapNodeOfDataMapOfIOMapOfInteger_0.cxx index 4cab4c88e..8af01576f 100644 --- a/src/OBJECT/SALOME_DataMapNodeOfDataMapOfIOMapOfInteger_0.cxx +++ b/src/OBJECT/SALOME_DataMapNodeOfDataMapOfIOMapOfInteger_0.cxx @@ -46,10 +46,17 @@ #include "SALOME_DataMapIteratorOfDataMapOfIOMapOfInteger.hxx" #endif using namespace std; + +/*! + Destructor +*/ SALOME_DataMapNodeOfDataMapOfIOMapOfInteger::~SALOME_DataMapNodeOfDataMapOfIOMapOfInteger() {} +/*! + \return OCC Handle Type +*/ Standard_EXPORT Handle_Standard_Type& SALOME_DataMapNodeOfDataMapOfIOMapOfInteger_Type_() { @@ -72,9 +79,9 @@ Standard_EXPORT Handle_Standard_Type& SALOME_DataMapNodeOfDataMapOfIOMapOfIntege } -// DownCast method -// allow safe downcasting -// +/*! + DownCast method: allows safe downcasting +*/ const Handle(SALOME_DataMapNodeOfDataMapOfIOMapOfInteger) Handle(SALOME_DataMapNodeOfDataMapOfIOMapOfInteger)::DownCast(const Handle(Standard_Transient)& AnObject) { Handle(SALOME_DataMapNodeOfDataMapOfIOMapOfInteger) _anOtherObject; @@ -87,14 +94,26 @@ const Handle(SALOME_DataMapNodeOfDataMapOfIOMapOfInteger) Handle(SALOME_DataMapN return _anOtherObject ; } + +/*! + \return OCC Handle dynamic Type +*/ const Handle(Standard_Type)& SALOME_DataMapNodeOfDataMapOfIOMapOfInteger::DynamicType() const { return STANDARD_TYPE(SALOME_DataMapNodeOfDataMapOfIOMapOfInteger) ; } + +/*! + \return true if other type is the same + \param AType - type to be checked +*/ Standard_Boolean SALOME_DataMapNodeOfDataMapOfIOMapOfInteger::IsKind(const Handle(Standard_Type)& AType) const { return (STANDARD_TYPE(SALOME_DataMapNodeOfDataMapOfIOMapOfInteger) == AType || TCollection_MapNode::IsKind(AType)); } +/*! + Destructor +*/ Handle_SALOME_DataMapNodeOfDataMapOfIOMapOfInteger::~Handle_SALOME_DataMapNodeOfDataMapOfIOMapOfInteger() {} #define TheKey Handle_SALOME_InteractiveObject #define TheKey_hxx "SALOME_InteractiveObject.hxx" diff --git a/src/OBJECT/SALOME_InteractiveObject.cxx b/src/OBJECT/SALOME_InteractiveObject.cxx index 7d60d59e6..bd7f5c4f8 100755 --- a/src/OBJECT/SALOME_InteractiveObject.cxx +++ b/src/OBJECT/SALOME_InteractiveObject.cxx @@ -34,6 +34,9 @@ #include "SALOME_InteractiveObject.ixx" +/*! + Default constructor +*/ SALOME_InteractiveObject::SALOME_InteractiveObject() { myEntry = ""; @@ -42,6 +45,12 @@ SALOME_InteractiveObject::SALOME_InteractiveObject() myReference = ""; } +/*! + Constructor + \param anEntry - entry of object + \param aComponentDataType - component data type name + \param aName - name of object +*/ SALOME_InteractiveObject::SALOME_InteractiveObject(const char* anEntry, const char* aComponentDataType, const char* aName): @@ -51,34 +60,62 @@ SALOME_InteractiveObject::SALOME_InteractiveObject(const char* anEntry, myReference("") {} +/*! + Sets entry + \param anEntry - new entry of object +*/ void SALOME_InteractiveObject::setEntry(const char* anEntry){ myEntry = anEntry; } +/*! + \return entry +*/ const char* SALOME_InteractiveObject::getEntry(){ return myEntry.c_str(); } +/*! + Sets component data type + \param aComponentDataType - component data type name +*/ void SALOME_InteractiveObject::setComponentDataType(const char* aComponentDataType){ myComponentDataType = aComponentDataType; } +/*! + \return component data type +*/ const char* SALOME_InteractiveObject::getComponentDataType(){ return myComponentDataType.c_str(); } +/*! + Sets name + \param aName - new name of object +*/ void SALOME_InteractiveObject::setName(const char* aName){ myName = aName; } +/*! + \return name +*/ const char* SALOME_InteractiveObject::getName(){ return myName.c_str(); } +/*! + \return true if entry isn't empty +*/ Standard_Boolean SALOME_InteractiveObject::hasEntry(){ return myEntry != ""; } +/*! + \return true if objects have same entries + \param anIO - other object +*/ Standard_Boolean SALOME_InteractiveObject::isSame(const Handle(SALOME_InteractiveObject)& anIO ){ if ( anIO->hasEntry() && this->hasEntry() ) { if ( myEntry == anIO->getEntry() ) @@ -88,6 +125,10 @@ Standard_Boolean SALOME_InteractiveObject::isSame(const Handle(SALOME_Interactiv return Standard_False; } +/*! + \return true if component data types are same + \param ComponentDataType - component data type to be checked +*/ Standard_Boolean SALOME_InteractiveObject::isComponentType(const char* ComponentDataType){ if ( myComponentDataType == ComponentDataType ) return Standard_True; @@ -95,16 +136,26 @@ Standard_Boolean SALOME_InteractiveObject::isComponentType(const char* Component return Standard_False; } +/*! + \return true if object has reference +*/ Standard_Boolean SALOME_InteractiveObject::hasReference() { return myReference != ""; } +/*! + \return reference +*/ const char* SALOME_InteractiveObject::getReference() { return myReference.c_str(); } +/*! + Sets reference + \param aReference - new reference +*/ void SALOME_InteractiveObject::setReference(const char* aReference) { myReference = aReference; diff --git a/src/OBJECT/SALOME_ListNodeOfListIO_0.cxx b/src/OBJECT/SALOME_ListNodeOfListIO_0.cxx index 35f04d576..ba678a212 100644 --- a/src/OBJECT/SALOME_ListNodeOfListIO_0.cxx +++ b/src/OBJECT/SALOME_ListNodeOfListIO_0.cxx @@ -40,10 +40,16 @@ #include "SALOME_ListIteratorOfListIO.hxx" #endif using namespace std; + +/*! + Destructor +*/ SALOME_ListNodeOfListIO::~SALOME_ListNodeOfListIO() {} - +/*! + \return OCC Handle Type +*/ Standard_EXPORT Handle_Standard_Type& SALOME_ListNodeOfListIO_Type_() { @@ -66,9 +72,9 @@ Standard_EXPORT Handle_Standard_Type& SALOME_ListNodeOfListIO_Type_() } -// DownCast method -// allow safe downcasting -// +/*! + DownCast method, allows safe downcasting +*/ const Handle(SALOME_ListNodeOfListIO) Handle(SALOME_ListNodeOfListIO)::DownCast(const Handle(Standard_Transient)& AnObject) { Handle(SALOME_ListNodeOfListIO) _anOtherObject; @@ -81,14 +87,26 @@ const Handle(SALOME_ListNodeOfListIO) Handle(SALOME_ListNodeOfListIO)::DownCast( return _anOtherObject ; } + +/*! + \return OCC Handle dynamic Type +*/ const Handle(Standard_Type)& SALOME_ListNodeOfListIO::DynamicType() const { return STANDARD_TYPE(SALOME_ListNodeOfListIO) ; } + +/*! + \return true if other type is the same + \param AType - type to be checked +*/ Standard_Boolean SALOME_ListNodeOfListIO::IsKind(const Handle(Standard_Type)& AType) const { return (STANDARD_TYPE(SALOME_ListNodeOfListIO) == AType || TCollection_MapNode::IsKind(AType)); } +/*! + Destructor +*/ Handle_SALOME_ListNodeOfListIO::~Handle_SALOME_ListNodeOfListIO() {} #define Item Handle_SALOME_InteractiveObject #define Item_hxx "SALOME_InteractiveObject.hxx" diff --git a/src/OBJECT/SALOME_TypeFilter.cxx b/src/OBJECT/SALOME_TypeFilter.cxx index 83f1d71ec..65b2cf9c6 100644 --- a/src/OBJECT/SALOME_TypeFilter.cxx +++ b/src/OBJECT/SALOME_TypeFilter.cxx @@ -30,9 +30,17 @@ #include "SALOME_InteractiveObject.hxx" using namespace std; +/*! + Constructor + \param TheKind - type of filter +*/ SALOME_TypeFilter::SALOME_TypeFilter(const Standard_CString TheKind): myKind(TheKind){} +/*! + \return true if object passes filter + \param anObj - object to be checked +*/ Standard_Boolean SALOME_TypeFilter::IsOk(const Handle(SALOME_InteractiveObject)& anObj) const { return anObj->isComponentType( myKind ); diff --git a/src/ObjBrowser/OB_Browser.h b/src/ObjBrowser/OB_Browser.h index 9ee6e6bce..b0c592830 100755 --- a/src/ObjBrowser/OB_Browser.h +++ b/src/ObjBrowser/OB_Browser.h @@ -39,6 +39,12 @@ class OB_Filter; class OB_ListView; class OB_ListItem; +/*! + \class OB_Browser + Represents object browser. Allows to get/set selection, + to drag-n-drop of objects, to determine item by SUIT object and + vice versa +*/ class OB_EXPORT OB_Browser : public QFrame, public SUIT_PopupClient { Q_OBJECT diff --git a/src/ObjBrowser/OB_Filter.h b/src/ObjBrowser/OB_Filter.h index 3570eb06d..60ceaadff 100644 --- a/src/ObjBrowser/OB_Filter.h +++ b/src/ObjBrowser/OB_Filter.h @@ -23,6 +23,11 @@ class SUIT_DataObject; +/*! + \class OB_Filter + Base class for ObjectBrowser filter. + Filters selected objects by some condition. +*/ class OB_EXPORT OB_Filter { public: diff --git a/src/ObjBrowser/OB_ListItem.cxx b/src/ObjBrowser/OB_ListItem.cxx index d86511985..1147ae5da 100755 --- a/src/ObjBrowser/OB_ListItem.cxx +++ b/src/ObjBrowser/OB_ListItem.cxx @@ -38,6 +38,9 @@ myObject( obj ) { } +/*! + Paints item +*/ template void ListItemF::paintC( QPainter* p, QColorGroup& cg, int c, int w, int align ) { @@ -65,6 +68,9 @@ void ListItemF::paintC( QPainter* p, QColorGroup& cg, int c, int w, int align //myT.paintCell( p, colorGrp, c, itemW, align ); } +/*! + Paints focused item +*/ template void ListItemF::paintFoc( QPainter* p, QColorGroup& cg, const QRect& r ) { @@ -73,6 +79,10 @@ void ListItemF::paintFoc( QPainter* p, QColorGroup& cg, const QRect& r ) //myT.paintFocus( p, cg, rect ); } +/*! + Set selection of item + \param s - selected state +*/ template void ListItemF::setSel( bool s ) { @@ -86,6 +96,9 @@ void ListItemF::setSel( bool s ) //myT.setSelected( s ); } +/*! + Updates name and pixmap of item +*/ template void ListItemF::update() { diff --git a/src/ObjBrowser/OB_ListItem.h b/src/ObjBrowser/OB_ListItem.h index 112c3c8c9..3960fc141 100755 --- a/src/ObjBrowser/OB_ListItem.h +++ b/src/ObjBrowser/OB_ListItem.h @@ -26,10 +26,10 @@ class SUIT_DataObject; -/* - base template class for ListViewItems and CheckListItems +/*! + \class ListItemF + Base template class for ListViewItems and CheckListItems */ - template class ListItemF { public: @@ -57,10 +57,10 @@ protected: T* myT; }; -/* - ListViewItem class +/*! + \class OB_ListItem + Provides custom list item for Object Browser tree */ - class OB_EXPORT OB_ListItem : public ListItemF, public QListViewItem { public: @@ -82,10 +82,10 @@ public: static int RTTI(); }; -/* - CheckListItem class +/*! + \class OB_CheckListItem + Provides custom list item with check box */ - class OB_EXPORT OB_CheckListItem : public ListItemF, public QCheckListItem { public: diff --git a/src/ObjBrowser/OB_ListView.h b/src/ObjBrowser/OB_ListView.h index 03a394c21..d35b3320b 100755 --- a/src/ObjBrowser/OB_ListView.h +++ b/src/ObjBrowser/OB_ListView.h @@ -34,6 +34,11 @@ class OB_Filter; class QListViewItem; class SUIT_DataObject; +/*! + \class OB_ListView + Special list view for ObjectBrowser. + Allows drag-n-drop, filtering of selected objects, column management. +*/ class OB_EXPORT OB_ListView : public QtxListView { Q_OBJECT diff --git a/src/Qtx/Qtx.h b/src/Qtx/Qtx.h index c16bd7b23..cbfc63b99 100755 --- a/src/Qtx/Qtx.h +++ b/src/Qtx/Qtx.h @@ -87,6 +87,10 @@ typedef QValueList QIntList; typedef QValueList QShortList; typedef QValueList QDoubleList; +/*! + \class Qtx + \brief Set of auxiliary static methods +*/ class QTX_EXPORT Qtx : public Qt { public: diff --git a/src/Qtx/QtxActionMenuMgr.cxx b/src/Qtx/QtxActionMenuMgr.cxx index 1b30f2d55..50c1147bb 100644 --- a/src/Qtx/QtxActionMenuMgr.cxx +++ b/src/Qtx/QtxActionMenuMgr.cxx @@ -108,6 +108,16 @@ private: QMap myIds; }; + +/*! + Constructor for menu action + \param text - description text + \param menutext - menu text + \param parent - parent object + \param id - integer identificator of action + \param allowEmpty - if it is true, it makes possible to add this action with empty popup to menu +*/ + QtxActionMenuMgr::MenuAction::MenuAction( const QString& text, const QString& menuText, QObject* parent, @@ -121,11 +131,17 @@ QtxActionMenuMgr::MenuAction::MenuAction( const QString& text, myPopup = new QPopupMenu(); } +/*! + Destructor: deletes internal popup +*/ QtxActionMenuMgr::MenuAction::~MenuAction() { delete myPopup; } +/*! + Adds action to widget, for example, to popup menu or menu bar +*/ bool QtxActionMenuMgr::MenuAction::addTo( QWidget* w ) { if ( !w ) @@ -171,6 +187,9 @@ bool QtxActionMenuMgr::MenuAction::addTo( QWidget* w ) return true; } +/*! + Removes action from widget, for example, from popup menu or menu bar +*/ bool QtxActionMenuMgr::MenuAction::removeFrom( QWidget* w ) { if ( !w ) @@ -204,6 +223,9 @@ bool QtxActionMenuMgr::MenuAction::removeFrom( QWidget* w ) return false; } +/*! + \return internal popup of action +*/ QPopupMenu* QtxActionMenuMgr::MenuAction::popup() const { return myPopup; @@ -213,8 +235,6 @@ QPopupMenu* QtxActionMenuMgr::MenuAction::popup() const Class: QtxActionMenuMgr Level: Public */ - - QtxActionMenuMgr::QtxActionMenuMgr( QMainWindow* p ) : QtxActionMgr( p ), myMenu( p ? p->menuBar() : 0 ) @@ -231,6 +251,9 @@ QtxActionMenuMgr::QtxActionMenuMgr( QMainWindow* p ) } } +/*! + Constructor +*/ QtxActionMenuMgr::QtxActionMenuMgr( QWidget* mw, QObject* p ) : QtxActionMgr( p ), myMenu( mw ) @@ -242,6 +265,9 @@ QtxActionMenuMgr::QtxActionMenuMgr( QWidget* mw, QObject* p ) connect( myMenu, SIGNAL( destroyed( QObject* ) ), this, SLOT( onDestroyed( QObject* ) ) ); } +/*! + Destructor +*/ QtxActionMenuMgr::~QtxActionMenuMgr() { for ( NodeListIterator it( myRoot.children ); it.current() && myMenu; ++it ) @@ -258,12 +284,23 @@ QtxActionMenuMgr::~QtxActionMenuMgr() delete itr.data(); } +/*! + \return whether menu item corresponding to action is visible + \param actId - identificator of action + \param place - identificator of some parent action +*/ bool QtxActionMenuMgr::isVisible( const int actId, const int place ) const { MenuNode* node = find( actId, place ); return node && node->visible; } +/*! + Sets visible state of action + \param actId - identificator of action + \param place - identificator of some parent action + \param v - visibility state +*/ void QtxActionMenuMgr::setVisible( const int actId, const int place, const bool v ) { MenuNode* node = find( actId, place ); @@ -271,16 +308,40 @@ void QtxActionMenuMgr::setVisible( const int actId, const int place, const bool node->visible = v; } +/*! + Insert action as children menu item + \param id - identificator of action + \param menus - few names of parent menu items, separated by '|'. It means sequence of menu items, + for example "File|Edit" means File->Edit submenu. If submenu doesn't exist, it will be created. + \param group - group identificator + \param idx - index inside Qt menu +*/ int QtxActionMenuMgr::insert( const int id, const QString& menus, const int group, const int idx ) { return insert( id, QStringList::split( "|", menus ), group, idx ); } +/*! + Insert action as children menu item + \param a - action + \param menus - few names of parent menu items, separated by '|'. It means sequence of menu items, + for example "File|Edit" means File->Edit submenu. If submenu doesn't exist, it will be created. + \param group - group identificator + \param idx - index inside Qt menu +*/ int QtxActionMenuMgr::insert( QAction* a, const QString& menus, const int group, const int idx ) { return insert( a, QStringList::split( "|", menus ), group, idx ); } +/*! + Insert action as children menu item + \param id - identificator of action + \param menus - list of names of parent menu items, separated by |. It means sequence of menu items, + for example "File|Edit" means File->Edit submenu. If submenu doesn't exist, it will be created. + \param group - group identificator + \param idx - index inside Qt menu +*/ int QtxActionMenuMgr::insert( const int id, const QStringList& menus, const int group, const int idx ) { int pId = createMenu( menus, -1 ); @@ -290,6 +351,14 @@ int QtxActionMenuMgr::insert( const int id, const QStringList& menus, const int return insert( id, pId, group, idx ); } +/*! + Insert action as children menu item + \param a - action + \param menus - list of names of parent menu items. It means sequence of menu items, + for example "File|Edit" means File->Edit submenu. If submenu doesn't exist, it will be created. + \param group - group identificator + \param idx - index inside Qt menu +*/ int QtxActionMenuMgr::insert( QAction* a, const QStringList& menus, const int group, const int idx ) { int pId = createMenu( menus, -1 ); @@ -299,6 +368,13 @@ int QtxActionMenuMgr::insert( QAction* a, const QStringList& menus, const int gr return insert( a, pId, group, idx ); } +/*! + Insert action as children menu item + \param id - identificator of action + \param pId - identificator of action corresponding to parent menu item + \param group - group identificator + \param idx - index inside Qt menu +*/ int QtxActionMenuMgr::insert( const int id, const int pId, const int group, const int idx ) { if ( id == -1 ) @@ -320,11 +396,28 @@ int QtxActionMenuMgr::insert( const int id, const int pId, const int group, cons return node->id; } +/*! + Insert action as children menu item + \param a - action + \param pId - identificator of action corresponding to parent menu item + \param group - group identificator + \param idx - index inside Qt menu +*/ int QtxActionMenuMgr::insert( QAction* a, const int pId, const int group, const int idx ) { return insert( registerAction( a ), pId, group, idx ); } +/*! + Create and insert action as children menu item + \return identificator of inserted action + \param title - menu text of action + \param pId - identificator of action corresponding to parent menu item + \param group - group identificator + \param id - identificator of new action + \param idx - index inside Qt menu + \param allowEmpty - indicates, that it is possible to add this action with empty popup menu to other menu +*/ int QtxActionMenuMgr::insert( const QString& title, const int pId, const int group, const int id, const int idx, const bool allowEmpty ) { MenuNode* pNode = pId == -1 ? &myRoot : find( pId ); @@ -363,53 +456,129 @@ int QtxActionMenuMgr::insert( const QString& title, const int pId, const int gro return node->id; } +/*! + Create and insert action as children menu item + \return identificator of inserted action + \param title - menu text of action + \param menus - string list of parents' menu texts, separated by | + \param group - group identificator + \param id - identificator of new action + \param idx - index inside Qt menu + \param allowEmpty - indicates, that it is possible to add this action with empty popup menu to other menu +*/ int QtxActionMenuMgr::insert( const QString& title, const QString& menus, const int group, const int id, const int idx, const bool allowEmpty ) { return insert( title, QStringList::split( "|", menus ), group, id, idx, allowEmpty ); } +/*! + Create and insert action as children menu item + \return identificator of inserted action + \param title - menu text of action + \param menus - list of parents menu items + \param group - group identificator + \param id - identificator of new action + \param idx - index inside Qt menu + \param allowEmpty - indicates, that it is possible to add this action with empty popup menu to other menu +*/ int QtxActionMenuMgr::insert( const QString& title, const QStringList& menus, const int group, const int id, const int idx, const bool allowEmpty ) { int pId = createMenu( menus, -1 ); return insert( title, pId, group, id, idx, allowEmpty ); } +/*! + Create and append action as last children + \return identificator of inserted action + \param title - menu text of action + \param pId - id of action corresponding to parent menu item + \param group - group identificator + \param id - identificator of new action + \param allowEmpty - indicates, that it is possible to add this action with empty popup menu to other menu +*/ int QtxActionMenuMgr::append( const QString& title, const int pId, const int group, const int id, const bool allowEmpty ) { return insert( title, pId, group, id, allowEmpty ); } +/*! + Create and append action as last children + \return identificator of inserted action + \param id - identificator of existing action + \param pId - id of action corresponding to parent menu item + \param group - group identificator +*/ int QtxActionMenuMgr::append( const int id, const int pId, const int group ) { return insert( id, pId, group ); } +/*! + Create and append action as last children + \return identificator of inserted action + \param a - action + \param pId - id of action corresponding to parent menu item + \param group - group identificator +*/ int QtxActionMenuMgr::append( QAction* a, const int pId, const int group ) { return insert( a, pId, group ); } +/*! + Create and insert action as first children + \return identificator of inserted action + \param title - menu text of action + \param pId - id of action corresponding to parent menu item + \param group - group identificator + \param id - identificator of new action + \param allowEmpty - indicates, that it is possible to add this action with empty popup menu to other menu +*/ int QtxActionMenuMgr::prepend( const QString& title, const int pId, const int group, const int id, const bool allowEmpty ) { return insert( title, pId, group, id, 0, allowEmpty ); } +/*! + Create and insert action as last children + \return identificator of inserted action + \param id - identificator of existing action + \param pId - id of action corresponding to parent menu item + \param group - group identificator +*/ int QtxActionMenuMgr::prepend( const int id, const int pId, const int group ) { return insert( id, pId, group, 0 ); } +/*! + Create and insert action as last children + \return identificator of inserted action + \param a - action + \param pId - id of action corresponding to parent menu item + \param group - group identificator +*/ int QtxActionMenuMgr::prepend( QAction* a, const int pId, const int group ) { return insert( a, pId, group, 0 ); } +/*! + Removes menu item corresponding to action + \param id - identificator of action +*/ void QtxActionMenuMgr::remove( const int id ) { removeMenu( id, 0 ); update(); } +/*! + Removes menu item + \param id - identificator of action + \param pId - identificator of action corresponding to parent menu item + \param group - group identificator +*/ void QtxActionMenuMgr::remove( const int id, const int pId, const int group ) { MenuNode* pNode = pId == -1 ? &myRoot : find( pId ); @@ -429,16 +598,28 @@ void QtxActionMenuMgr::remove( const int id, const int pId, const int group ) updateMenu( pNode, false ); } +/*! + Shows menu item corresponding to action + \param id - identificator of action +*/ void QtxActionMenuMgr::show( const int id ) { setShown( id, true ); } +/*! + Hides menu item corresponding to action + \param id - identificator of action +*/ void QtxActionMenuMgr::hide( const int id ) { setShown( id, false ); } +/*! + \return shown status of menu item corresponding to action + \param id - identificator of action +*/ bool QtxActionMenuMgr::isShown( const int id ) const { bool res = false; @@ -448,6 +629,11 @@ bool QtxActionMenuMgr::isShown( const int id ) const return res; } +/*! + Sets shown status of menu item corresponding to action + \param id - identificator of action + \param on - new shown status +*/ void QtxActionMenuMgr::setShown( const int id, const bool on ) { NodeList aNodes; @@ -467,12 +653,18 @@ void QtxActionMenuMgr::setShown( const int id, const bool on ) updateMenu( itr.key(), false ); } +/*! + SLOT: called when corresponding menu is destroyed, clears internal pointer to menu +*/ void QtxActionMenuMgr::onDestroyed( QObject* obj ) { if ( myMenu == obj ) myMenu = 0; } +/*! + SLOT: called when menu item is highlighted +*/ void QtxActionMenuMgr::onHighlighted( int id ) { const QObject* snd = sender(); @@ -497,6 +689,10 @@ void QtxActionMenuMgr::onHighlighted( int id ) } } +/*! + Assignes new menu with manager + \param mw - new menu +*/ void QtxActionMenuMgr::setWidget( QWidget* mw ) { if ( myMenu == mw ) @@ -511,11 +707,23 @@ void QtxActionMenuMgr::setWidget( QWidget* mw ) connect( myMenu, SIGNAL( destroyed( QObject* ) ), this, SLOT( onDestroyed( QObject* ) ) ); } +/*! + \return menu node by it's place description + \param actId - identificator of action + \param pId - identificator of action corresponding to start menu item + \param rec - recursive search +*/ QtxActionMenuMgr::MenuNode* QtxActionMenuMgr::find( const int actId, const int pId, const bool rec ) const { return find( actId, find( pId ), rec ); } +/*! + \return menu node by it's place description + \param actId - identificator of action + \param startNode - start menu item + \param rec - recursive search +*/ QtxActionMenuMgr::MenuNode* QtxActionMenuMgr::find( const int id, MenuNode* startNode, const bool rec ) const { MenuNode* node = 0; @@ -530,6 +738,13 @@ QtxActionMenuMgr::MenuNode* QtxActionMenuMgr::find( const int id, MenuNode* star return node; } +/*! + Finds menu node + \return true if at least one node is found + \param id - identificator of action + \param lst - list to be filled with found nodes + \param startNode - start menu item +*/ bool QtxActionMenuMgr::find( const int id, NodeList& lst, MenuNode* startNode ) const { MenuNode* start = startNode ? startNode : (MenuNode*)&myRoot; @@ -543,11 +758,25 @@ bool QtxActionMenuMgr::find( const int id, NodeList& lst, MenuNode* startNode ) return !lst.isEmpty(); } +/*! + Finds menu node + \return menu node + \param title - menu text of searched node + \param pId - id of action corresponding to start menu item + \param rec - recursive searching +*/ QtxActionMenuMgr::MenuNode* QtxActionMenuMgr::find( const QString& title, const int pId, const bool rec ) const { return find( title, find( pId ), rec ); } +/*! + Finds menu node + \return true if at least one node is found + \param title - menu text of node + \param lst - list to be filled with found nodes + \param startNode - start menu item +*/ bool QtxActionMenuMgr::find( const QString& title, NodeList& lst, MenuNode* startNode ) const { MenuNode* start = startNode ? startNode : (MenuNode*)&myRoot; @@ -564,6 +793,13 @@ bool QtxActionMenuMgr::find( const QString& title, NodeList& lst, MenuNode* star return !lst.isEmpty(); } +/*! + Finds menu node + \return menu node + \param title - menu text of searched node + \param startNode - start menu item + \param rec - recursive searching +*/ QtxActionMenuMgr::MenuNode* QtxActionMenuMgr::find( const QString& title, MenuNode* startNode, const bool rec ) const { MenuNode* node = 0; @@ -581,6 +817,12 @@ QtxActionMenuMgr::MenuNode* QtxActionMenuMgr::find( const QString& title, MenuNo return node; } +/*! + Find id among children + \return id (>0) if on success or -1 on fail + \param id - id to be searched + \param pid - id of parent, among children of that 'id' must be searched +*/ int QtxActionMenuMgr::findId( const int id, const int pid ) const { MenuNode* start = pid != -1 ? find( pid ) : (MenuNode*)&myRoot; @@ -592,6 +834,11 @@ int QtxActionMenuMgr::findId( const int id, const int pid ) const return -1; } +/*! + Removes child + \param id - id of child to be removed + \param startNode - parent menu item +*/ void QtxActionMenuMgr::removeMenu( const int id, MenuNode* startNode ) { MenuNode* start = startNode ? startNode : &myRoot; @@ -604,11 +851,19 @@ void QtxActionMenuMgr::removeMenu( const int id, MenuNode* startNode ) } } +/*! + \return menu item action by id + \param id - id of action +*/ QAction* QtxActionMenuMgr::itemAction( const int id ) const { return action( id ); } +/*! + \return menu action by id + \param id - id of action +*/ QtxActionMenuMgr::MenuAction* QtxActionMenuMgr::menuAction( const int id ) const { MenuAction* a = 0; @@ -619,6 +874,13 @@ QtxActionMenuMgr::MenuAction* QtxActionMenuMgr::menuAction( const int id ) const return a; } +/*! + Updates menu ( isUpdatesEnabled() must return true ) + \param startNode - first menu item to be updated + \param rec - recursive update + \param updParent - update also parent item (without recursion) + \sa isUpdatesEnabled() +*/ void QtxActionMenuMgr::updateMenu( MenuNode* startNode, const bool rec, const bool updParent ) { if ( !isUpdatesEnabled() ) @@ -693,12 +955,19 @@ void QtxActionMenuMgr::updateMenu( MenuNode* startNode, const bool rec, const bo updateMenu( node->parent, false ); } +/*! + Updates menu (virtual variant). To be redefined for custom activity on menu updating +*/ void QtxActionMenuMgr::internalUpdate() { if ( isUpdatesEnabled() ) updateMenu(); } +/*! + \return true if widget is non-empty menu + \param wid - widget to be checked +*/ bool QtxActionMenuMgr::checkWidget( QWidget* wid ) const { if ( !wid ) @@ -713,6 +982,10 @@ bool QtxActionMenuMgr::checkWidget( QWidget* wid ) const return md ? md->count() : false; } +/*! + \return popup of menu item + \param node - menu item +*/ QWidget* QtxActionMenuMgr::menuWidget( MenuNode* node) const { if ( !node || node == &myRoot ) @@ -724,12 +997,21 @@ QWidget* QtxActionMenuMgr::menuWidget( MenuNode* node) const return myMenus[node->id]->popup(); } +/*! + Removes excess separators of menu + \param wid - menu to be processed +*/ void QtxActionMenuMgr::simplifySeparators( QWidget* wid ) { if ( wid && wid->inherits( "QPopupMenu" ) ) Qtx::simplifySeparators( (QPopupMenu*)wid, false ); } +/*! + Removes special symbols (&) from string + \param txt - string to be processed + \return clear variant of string +*/ QString QtxActionMenuMgr::clearTitle( const QString& txt ) const { QString res = txt; @@ -743,6 +1025,11 @@ QString QtxActionMenuMgr::clearTitle( const QString& txt ) const return res; } +/*! + Creates and inserts many menu items + \param lst - list of menu texts + \param pId - id of action corresponding to parent menu item +*/ int QtxActionMenuMgr::createMenu( const QStringList& lst, const int pId ) { if ( lst.isEmpty() ) @@ -758,27 +1045,44 @@ int QtxActionMenuMgr::createMenu( const QStringList& lst, const int pId ) return insert( title, parentId, -1 ); } +/*! + Loads actions description from file + \param fname - name of file + \param r - reader of file + \return true on success +*/ bool QtxActionMenuMgr::load( const QString& fname, QtxActionMgr::Reader& r ) { MenuCreator cr( &r, this ); return r.read( fname, cr ); } +/*! + \return true if item has such child + \param title - menu text of child + \param pid - id of action corresponding to item +*/ bool QtxActionMenuMgr::containsMenu( const QString& title, const int pid ) const { return (bool)find( title, pid, false ); } +/*! + \return true if item has such child + \param id - id of action corresponding to child + \param pid - id of action corresponding to item +*/ bool QtxActionMenuMgr::containsMenu( const int id, const int pid ) const { return (bool)find( id, pid, false ); } + /*! - Class: QtxActionMenuMgr::MenuCreator - Level: Public + Constructor + \param r - menu reader + \param mgr - menu manager */ - QtxActionMenuMgr::MenuCreator::MenuCreator( QtxActionMgr::Reader* r, QtxActionMenuMgr* mgr ) : QtxActionMgr::Creator( r ), @@ -786,10 +1090,20 @@ QtxActionMenuMgr::MenuCreator::MenuCreator( QtxActionMgr::Reader* r, { } +/*! + Destructor +*/ QtxActionMenuMgr::MenuCreator::~MenuCreator() { } +/*! + Appends new menu items + \param tag - tag of item + \param subMenu - it has submenu + \param attr - list of attributes + \param pId - id of action corresponding to parent item +*/ int QtxActionMenuMgr::MenuCreator::append( const QString& tag, const bool subMenu, const ItemAttributes& attr, const int pId ) { diff --git a/src/Qtx/QtxActionMenuMgr.h b/src/Qtx/QtxActionMenuMgr.h index f06ff9d3b..252ef42ab 100644 --- a/src/Qtx/QtxActionMenuMgr.h +++ b/src/Qtx/QtxActionMenuMgr.h @@ -35,6 +35,18 @@ class QMainWindow; #pragma warning( disable:4251 ) #endif +/*! + \class QtxActionMenuMgr + Allows to use set of action to automatically build main menu. + With help of methods insert/append/remove it is possible to + describe whole structure of menu. Method hide allows + to temporary remove some items from menu, method show allows to + recreate them. + Actions can be grouped with help of group identifictor. + Inside popup or menu bar items have order by increasing group id. + This manager is able to attune menu: to remove excess separators, + to remove empty popup menu etc. +*/ class QTX_EXPORT QtxActionMenuMgr : public QtxActionMgr { Q_OBJECT @@ -44,6 +56,11 @@ class QTX_EXPORT QtxActionMenuMgr : public QtxActionMgr typedef QPtrList NodeList; typedef QPtrListIterator NodeListIterator; + /*! + \class MenuNode + Represents a menu item inside main menu structure. + For internal purposes only + */ class MenuNode { public: @@ -148,6 +165,10 @@ private: MenuMap myMenus; }; +/*! + \class QtxActionMenuMgr::MenuCreator + Allows to create automatically main menu by data read from file +*/ class QtxActionMenuMgr::MenuCreator : public QtxActionMgr::Creator { public: diff --git a/src/Qtx/QtxActionMgr.cxx b/src/Qtx/QtxActionMgr.cxx index 16ec7b5b1..40823f61a 100644 --- a/src/Qtx/QtxActionMgr.cxx +++ b/src/Qtx/QtxActionMgr.cxx @@ -58,15 +58,25 @@ private: QMap myTools; }; +/*! + Constructor +*/ QtxActionMgr::SeparatorAction::SeparatorAction( QObject* parent ) : QtxAction( parent ) { } +/*! + Destructor +*/ QtxActionMgr::SeparatorAction::~SeparatorAction() { } +/*! + Adds action to widget + \param wid - widget +*/ bool QtxActionMgr::SeparatorAction::addTo( QWidget* wid ) { if ( !wid ) @@ -90,6 +100,10 @@ bool QtxActionMgr::SeparatorAction::addTo( QWidget* wid ) return res; } +/*! + Removes action from widget + \param wid - widget +*/ bool QtxActionMgr::SeparatorAction::removeFrom( QWidget* wid ) { if ( !wid ) @@ -140,16 +154,28 @@ bool QtxActionMgr::SeparatorAction::removeFrom( QWidget* wid ) Level: Public */ +/*! + Constructor +*/ QtxActionMgr::QtxActionMgr( QObject* parent ) : QObject( parent ), myUpdate( true ) { } +/*! + Destructor +*/ QtxActionMgr::~QtxActionMgr() { } +/*! + Stores action in internal map + If action with such id is registered already, then it will be unregistered + \param a - action to be registered + \param userId - proposed id (if it is less than 0, then id will be generated automatically) +*/ int QtxActionMgr::registerAction( QAction* a, const int userId ) { if ( !a ) @@ -174,12 +200,20 @@ int QtxActionMgr::registerAction( QAction* a, const int userId ) return theId; } +/*! + Removes action from internal map + \param id - action id +*/ void QtxActionMgr::unRegisterAction( const int id ) { if( contains( id ) ) myActions.remove( id ); } +/*! + \return action by id + \param id - action id +*/ QAction* QtxActionMgr::action( const int id ) const { if ( contains( id ) ) @@ -188,6 +222,10 @@ QAction* QtxActionMgr::action( const int id ) const return 0; } +/*! + \return id by action + \param a - action +*/ int QtxActionMgr::actionId( const QAction* a ) const { if ( !a ) @@ -203,61 +241,101 @@ int QtxActionMgr::actionId( const QAction* a ) const return theId; } +/*! + \return true if internal map contains such id + \param id - action id +*/ bool QtxActionMgr::contains( const int id ) const { return myActions.contains( id ); } +/*! + \return count of actions in internal map +*/ int QtxActionMgr::count() const { return myActions.count(); } +/*! + \return true if internal map is empty +*/ bool QtxActionMgr::isEmpty() const { return myActions.isEmpty(); } +/*! + Fills list with ids of registered actions +*/ void QtxActionMgr::idList( QIntList& lst ) const { lst = myActions.keys(); } +/*! + \return true if updates are enabled +*/ bool QtxActionMgr::isUpdatesEnabled() const { return myUpdate; } +/*! + Enables/disables updates + \param upd - new state +*/ void QtxActionMgr::setUpdatesEnabled( const bool upd ) { myUpdate = upd; } +/*! + \return true if action is visible (by default \return always true) +*/ bool QtxActionMgr::isVisible( const int, const int ) const { return true; } +/*! + Sets visibility of action (by default, empty implementation) +*/ void QtxActionMgr::setVisible( const int, const int, const bool ) { } +/*! + Updates actions, check isUpdatesEnabled() and call internalUpdate() + \sa isUpdatesEnabled(), internalUpdate() +*/ void QtxActionMgr::update() { if ( isUpdatesEnabled() ) internalUpdate(); } +/*! + Real update (to be redefined in successors) +*/ void QtxActionMgr::internalUpdate() { } +/*! + \return global free id +*/ int QtxActionMgr::generateId() const { static int id = -1; return --id; } +/*! + \return true if action is enabled + \param id - action id +*/ bool QtxActionMgr::isEnabled( const int id ) const { QAction* a = action( id ); @@ -267,6 +345,11 @@ bool QtxActionMgr::isEnabled( const int id ) const return false; } +/*! + Enables/disables action + \param id - action id + \param en - new state +*/ void QtxActionMgr::setEnabled( const int id, const bool en ) { QAction* a = action( id ); @@ -274,6 +357,11 @@ void QtxActionMgr::setEnabled( const int id, const bool en ) a->setEnabled( en ); } +/*! + \return action for separator + If this action doesn't exist, then it will be created + \param individual - if it is false, then action will be shared, otherwise it will be created on every call +*/ QAction* QtxActionMgr::separator( const bool individual ) { if ( individual ) @@ -292,19 +380,33 @@ QAction* QtxActionMgr::separator( const bool individual ) Level: Public */ +/*! + Constructor +*/ QtxActionMgr::Reader::Reader() { } +/*! + Destructor +*/ QtxActionMgr::Reader::~Reader() { } +/*! + \return list of options +*/ QStringList QtxActionMgr::Reader::options() const { return myOptions.keys(); } +/*! + \return value of option + \param name - option name + \param def - default option value (is returned, if there is no such option) +*/ QString QtxActionMgr::Reader::option( const QString& name, const QString& def ) const { if( myOptions.contains( name ) ) @@ -313,6 +415,11 @@ QString QtxActionMgr::Reader::option( const QString& name, const QString& def ) return def; } +/*! + Sets value of option + \param name - option name + \param value - option value +*/ void QtxActionMgr::Reader::setOption( const QString& name, const QString& value ) { myOptions[ name ] = value; @@ -320,8 +427,7 @@ void QtxActionMgr::Reader::setOption( const QString& name, const QString& value /*! - Class: QtxActionMgr::XMLReader - Level: Public + Constructor */ QtxActionMgr::XMLReader::XMLReader( const QString& root, const QString& item, @@ -342,10 +448,18 @@ QtxActionMgr::XMLReader::XMLReader( const QString& root, setOption( QString( "toggle" ), QString( "toggle-id" ) ); } +/*! + Destructor +*/ QtxActionMgr::XMLReader::~XMLReader() { } +/*! + Reads file and fills action manager with help of creator + \param fname - file name + \param cr - creator +*/ bool QtxActionMgr::XMLReader::read( const QString& fname, Creator& cr ) const { bool res = false; @@ -386,6 +500,12 @@ bool QtxActionMgr::XMLReader::read( const QString& fname, Creator& cr ) const return res; } +/*! + Create item by xml node + \param parent_node - parent node + \param parent_id - parent id + \param cr - creator +*/ void QtxActionMgr::XMLReader::read( const QDomNode& parent_node, const int parent_id, Creator& cr ) const @@ -420,6 +540,9 @@ void QtxActionMgr::XMLReader::read( const QDomNode& parent_node, } } +/*! + \return true if node satisfies pattern +*/ bool QtxActionMgr::XMLReader::isNodeSimilar( const QDomNode& node, const QString& pattern ) const { @@ -445,8 +568,10 @@ bool QtxActionMgr::XMLReader::isNodeSimilar( const QDomNode& node, /*! - Class: QtxActionMgr::Creator - Level: Public + \return integer value by attributes + \param attrs - attributes + \param name - name of attribute + \param def - default value (is returned on fail) */ int QtxActionMgr::Creator::intValue( const ItemAttributes& attrs, const QString& name, int def ) @@ -461,6 +586,12 @@ int QtxActionMgr::Creator::intValue( const ItemAttributes& attrs, return def; } +/*! + \return string value by attributes + \param attrs - attributes + \param name - name of attribute + \param def - default value (is returned on fail) +*/ QString QtxActionMgr::Creator::strValue( const ItemAttributes& attrs, const QString& name, const QString& def ) @@ -471,24 +602,41 @@ QString QtxActionMgr::Creator::strValue( const ItemAttributes& attrs, return def; } +/*! + Constructor +*/ QtxActionMgr::Creator::Creator( QtxActionMgr::Reader* r ) : myReader( r ) { } +/*! + Destructor +*/ QtxActionMgr::Creator::~Creator() { } +/*! + \return corresponding reader +*/ QtxActionMgr::Reader* QtxActionMgr::Creator::reader() const { return myReader; } +/*! + Connects action to some slots (default implementation is empty) +*/ void QtxActionMgr::Creator::connect( QAction* ) const { } +/*! + Loads pixmap + \param fname - file name + \param pix - to return loaded pixmap +*/ bool QtxActionMgr::Creator::loadPixmap( const QString& fname, QPixmap& pix ) const { if( !reader() ) diff --git a/src/Qtx/QtxActionMgr.h b/src/Qtx/QtxActionMgr.h index 60fc342c0..8a82362f0 100644 --- a/src/Qtx/QtxActionMgr.h +++ b/src/Qtx/QtxActionMgr.h @@ -36,6 +36,12 @@ class QDomNode; #pragma warning( disable:4251 ) #endif + +/*! + \class QtxActionMgr + Contains set of actions accessible by id. + Base class for menu, popup creators and other action containers. +*/ class QTX_EXPORT QtxActionMgr : public QObject { Q_OBJECT @@ -93,6 +99,10 @@ private: QTX_EXPORT typedef QMap ItemAttributes; +/*! + \class QtxActionMgr::Creator + Allows to fill automatically action manager with actions created by data from file +*/ class QtxActionMgr::Creator { public: @@ -115,6 +125,11 @@ private: QtxActionMgr::Reader* myReader; }; +/*! + \class QtxActionMgr::Reader + This class is used to read files of some format + to create actions and to fill action manager automatically +*/ class QtxActionMgr::Reader { public: @@ -131,6 +146,11 @@ private: QMap< QString, QString > myOptions; }; +/*! + \class QtxActionMgr::Reader + This class is used to read files of XML format + to create actions and to fill action manager automatically +*/ class QtxActionMgr::XMLReader : public Reader { public: diff --git a/src/Qtx/QtxActionToolMgr.cxx b/src/Qtx/QtxActionToolMgr.cxx index 0856fa560..7529fe250 100644 --- a/src/Qtx/QtxActionToolMgr.cxx +++ b/src/Qtx/QtxActionToolMgr.cxx @@ -27,21 +27,36 @@ #include #include +/*! + Constructor +*/ QtxActionToolMgr::QtxActionToolMgr( QMainWindow* p ) : QtxActionMgr( p ), myMainWindow( p ) { } +/*! + Destructor +*/ QtxActionToolMgr::~QtxActionToolMgr() { } +/*! + \return desktop +*/ QMainWindow* QtxActionToolMgr::mainWindow() const { return myMainWindow; } +/*! + Creates toolbar + \return id of just created toolbar + \param name - name of toolbar + \param tid - proposed id (if such id is used already, then it will be returned without creation) +*/ int QtxActionToolMgr::createToolBar( const QString& name, const int tid ) { static int _toolBarId = -1; @@ -75,6 +90,11 @@ int QtxActionToolMgr::createToolBar( const QString& name, const int tid ) return tbId; } +/*! + \return toolbar by title + \param label - toolbar title + \param mw - desktop +*/ QToolBar* QtxActionToolMgr::find( const QString& label, QMainWindow* mw ) const { if ( !mw ) @@ -96,6 +116,10 @@ QToolBar* QtxActionToolMgr::find( const QString& label, QMainWindow* mw ) const return res; } +/*! + Removes toolbar + \param tid - toolbar id +*/ void QtxActionToolMgr::removeToolBar( const int tid ) { if ( !myToolBars.contains( tid ) ) @@ -105,11 +129,21 @@ void QtxActionToolMgr::removeToolBar( const int tid ) myToolBars.remove( tid ); } +/*! + Removes toolbar + \param tname - toolbar name +*/ void QtxActionToolMgr::removeToolBar( const QString& tname ) { removeToolBar( find( tname ) ); } +/*! + Insert action into toolbar + \param id - identificator of action + \param tId - identificator of toolbar + \param idx - position inside toolbar +*/ int QtxActionToolMgr::insert( const int id, const int tid, const int idx ) { if ( !contains( id ) || !hasToolBar( tid ) ) @@ -129,61 +163,124 @@ int QtxActionToolMgr::insert( const int id, const int tid, const int idx ) return id; } +/*! + Insert action into toolbar + \param act - action + \param tId - identificator of toolbar + \param pos - position inside toolbar +*/ int QtxActionToolMgr::insert( QAction* act, const int tid, const int pos ) { return insert( registerAction( act ), tid, pos ); } +/*! + Insert action into toolbar + \param id - identificator of action + \param tname - name of toolbar + \param pos - position inside toolbar +*/ int QtxActionToolMgr::insert( const int id, const QString& tname, const int pos ) { return insert( id, createToolBar( tname ), pos ); } +/*! + Insert action into toolbar + \param act - action + \param tname - name of toolbar + \param pos - position inside toolbar +*/ int QtxActionToolMgr::insert( QAction* act, const QString& tname, const int pos ) { return insert( registerAction( act ), createToolBar( tname ), pos ); } +/*! + Append action into toolbar as last toolbutton + \param id - identificator of action + \param tId - identificator of toolbar +*/ int QtxActionToolMgr::append( const int id, const int tid ) { return insert( id, tid ); } +/*! + Append action into toolbar as last toolbutton + \param act - action + \param tId - identificator of toolbar +*/ int QtxActionToolMgr::append( QAction* act, const int tid ) { return insert( act, tid ); } +/*! + Append action into toolbar as last toolbutton + \param id - identificator of action + \param tname - toolbar name +*/ int QtxActionToolMgr::append( const int id, const QString& tname ) { return insert( id, tname ); } +/*! + Append action into toolbar as last toolbutton + \param act - action + \param tname - toolbar name +*/ int QtxActionToolMgr::append( QAction* act, const QString& tname ) { return insert( act, tname ); } +/*! + Append action into toolbar as first toolbutton + \param id - identificator of action + \param tId - identificator of toolbar +*/ int QtxActionToolMgr::prepend( const int id, const int tid ) { return insert( id, tid, 0 ); } +/*! + Append action into toolbar as first toolbutton + \param act - action + \param tId - identificator of toolbar +*/ int QtxActionToolMgr::prepend( QAction* act, const int tid ) { return insert( act, tid, 0 ); } +/*! + Append action into toolbar as first toolbutton + \param id - identificator of action + \param tname - toolbar name +*/ int QtxActionToolMgr::prepend( const int id, const QString& tname ) { return insert( id, tname, 0 ); } +/*! + Append action into toolbar as first toolbutton + \param act - action + \param tname - toolbar name +*/ int QtxActionToolMgr::prepend( QAction* act, const QString& tname ) { return insert( act, tname, 0 ); } +/*! + Remove action from toolbar + \param id - identificator of action + \param tId - identificator of toolbar +*/ void QtxActionToolMgr::remove( const int id, const int tid ) { if ( !myToolBars.contains( tid ) ) @@ -202,11 +299,20 @@ void QtxActionToolMgr::remove( const int id, const int tid ) updateToolBar( tid ); } +/*! + Remove action from toolbar + \param id - identificator of action + \param tname - name of toolbar +*/ void QtxActionToolMgr::remove( const int id, const QString& tname ) { remove( id, find( tname ) ); } +/*! + \return toolbar by it's id + \param tId - identificator of toolbar +*/ QToolBar* QtxActionToolMgr::toolBar( const int tid ) const { QToolBar* tb = 0; @@ -215,21 +321,38 @@ QToolBar* QtxActionToolMgr::toolBar( const int tid ) const return tb; } +/*! + \return toolbar by it's name + \param tname - name of toolbar +*/ QToolBar* QtxActionToolMgr::toolBar( const QString& tname ) const { return toolBar( find( tname ) ); } +/*! + \return true if manager contains toolbar with such id + \param tId - identificator of toolbar +*/ bool QtxActionToolMgr::hasToolBar( const int tid ) const { return myToolBars.contains( tid ); } +/*! + \return true if manager contains toolbar with such name + \param tname - name of toolbar +*/ bool QtxActionToolMgr::hasToolBar( const QString& tname ) const { return find( tname ) != -1; } +/*! + \return true if toolbar contains action + \param id - identificator of action + \param tId - identificator of toolbar +*/ bool QtxActionToolMgr::containsAction( const int id, const int tid ) const { for ( ToolBarMap::ConstIterator it = myToolBars.begin(); it != myToolBars.end(); ++it ) @@ -244,11 +367,18 @@ bool QtxActionToolMgr::containsAction( const int id, const int tid ) const return false; } +/*! + SLOT: called when toolbar is destroyed, removes just destroyed toolbar from map +*/ void QtxActionToolMgr::onToolBarDestroyed() { myToolBars.remove( find( (QToolBar*)sender() ) ); } +/*! + \return id of toolbar by it's name + \param tname - name of toolbar +*/ int QtxActionToolMgr::find( const QString& tname ) const { int id = -1; @@ -260,6 +390,10 @@ int QtxActionToolMgr::find( const QString& tname ) const return id; } +/*! + \return id of toolbar + \param t - toolbar +*/ int QtxActionToolMgr::find( QToolBar* t ) const { int id = -1; @@ -271,6 +405,10 @@ int QtxActionToolMgr::find( QToolBar* t ) const return id; } +/*! + Updates toolbar + \param tId - toolbar id +*/ void QtxActionToolMgr::updateToolBar( const int tId ) { if ( !isUpdatesEnabled() ) @@ -304,34 +442,57 @@ void QtxActionToolMgr::updateToolBar( const int tId ) simplifySeparators( tb ); } +/*! + Updates all toolbars +*/ void QtxActionToolMgr::internalUpdate() { for ( ToolBarMap::ConstIterator it1 = myToolBars.begin(); it1 != myToolBars.end(); ++it1 ) updateToolBar( it1.key() ); } +/*! + Removes excess separators from toolbar +*/ void QtxActionToolMgr::simplifySeparators( QToolBar* t ) { if ( t ) Qtx::simplifySeparators( t ); } +/*! + Shows action in all toolbars + \param actId - action id +*/ void QtxActionToolMgr::show( const int actId ) { setShown( actId, true ); } +/*! + Hides action in all toolbars + \param actId - action id +*/ void QtxActionToolMgr::hide( const int actId ) { setShown( actId, false ); } +/*! + Changes shown status of action in all toolbars + \param id - action id + \param on - new shown status +*/ void QtxActionToolMgr::setShown( const int id, const bool on ) { for ( ToolBarMap::Iterator it = myToolBars.begin(); it != myToolBars.end(); ++it ) setVisible( id, it.key(), on ); } +/*! + \return true if action is shown in all toolbars + \param id - action id +*/ bool QtxActionToolMgr::isShown( const int id ) const { QPtrList nodes; @@ -356,6 +517,11 @@ bool QtxActionToolMgr::isShown( const int id ) const return vis; } +/*! + \return shown status of action in toolbar + \param id - action id + \param tId - toolbar id +*/ bool QtxActionToolMgr::isVisible( const int id, const int tId ) const { if ( !myToolBars.contains( tId ) ) @@ -372,6 +538,12 @@ bool QtxActionToolMgr::isVisible( const int id, const int tId ) const return vis; } +/*! + Changes action shown status in certain toolbar + \param id - action id + \param tId - toolbar id + \param on - new shown status +*/ void QtxActionToolMgr::setVisible( const int id, const int tId, const bool on ) { if ( !myToolBars.contains( tId ) ) @@ -393,6 +565,11 @@ void QtxActionToolMgr::setVisible( const int id, const int tId, const bool on ) updateToolBar( tId ); } +/*! + Loads toolbar content from file + \param fname - file name + \param r - reader +*/ bool QtxActionToolMgr::load( const QString& fname, QtxActionMgr::Reader& r ) { ToolCreator cr( &r, this ); @@ -401,8 +578,7 @@ bool QtxActionToolMgr::load( const QString& fname, QtxActionMgr::Reader& r ) /*! - Class: QtxActionToolMgr::ToolCreator - Level: Public + Constructor */ QtxActionToolMgr::ToolCreator::ToolCreator( QtxActionMgr::Reader* r, QtxActionToolMgr* mgr ) @@ -411,10 +587,20 @@ QtxActionToolMgr::ToolCreator::ToolCreator( QtxActionMgr::Reader* r, { } +/*! + Destructor +*/ QtxActionToolMgr::ToolCreator::~ToolCreator() { } +/*! + Appends new tool buttons + \param tag - tag of toolmenu + \param subMenu - it has submenu (not used here) + \param attr - list of attributes + \param pId - id of action corresponding to parent item +*/ int QtxActionToolMgr::ToolCreator::append( const QString& tag, const bool subMenu, const ItemAttributes& attr, const int tId ) { diff --git a/src/Qtx/QtxActionToolMgr.h b/src/Qtx/QtxActionToolMgr.h index 48a722785..b86c53f41 100644 --- a/src/Qtx/QtxActionToolMgr.h +++ b/src/Qtx/QtxActionToolMgr.h @@ -35,10 +35,22 @@ class QMainWindow; #pragma warning( disable:4251 ) #endif +/*! + \class QtxActionToolMgr + Allows to use set of action to automatically build set of toolbars. + With help of methods insert/append/remove it is possible to + describe toolbars and its internal structure. + This manager is able to attune toolbar by removing excess separators +*/ class QTX_EXPORT QtxActionToolMgr : public QtxActionMgr { Q_OBJECT + /*! + \class ToolNode + Represents a toolbutton inside toolbar + For internal purposes only + */ class ToolNode { public: @@ -122,6 +134,10 @@ private: QMainWindow* myMainWindow; }; +/*! + \class QtxActionToolMgr::ToolCreator + Allows to create automatically toolbar by data read from file +*/ class QtxActionToolMgr::ToolCreator : public QtxActionMgr::Creator { public: diff --git a/src/Qtx/QtxColorScale.cxx b/src/Qtx/QtxColorScale.cxx index 7be7ba48d..1c703dad0 100755 --- a/src/Qtx/QtxColorScale.cxx +++ b/src/Qtx/QtxColorScale.cxx @@ -34,12 +34,9 @@ #include -/********************************************************************* -** Class: QtxColorScale -** Descr: Color Scale widget. -** Level: Public -*********************************************************************/ - +/*! + Constructor +*/ QtxColorScale::QtxColorScale( QWidget* parent, const char* name, WFlags f ) : QFrame( parent, name, f | WResizeNoErase | WRepaintNoErase ), myDock( 0 ), @@ -59,6 +56,9 @@ myFlags( AtBorder | WrapTitle ) setCaption( tr ( "Color scale" ) ); } +/*! + Constructor +*/ QtxColorScale::QtxColorScale( const int num, QWidget* parent, const char* name, WFlags f ) : QFrame( parent, name, f | WResizeNoErase | WRepaintNoErase ), myDock( 0 ), @@ -80,6 +80,9 @@ myFlags( AtBorder | WrapTitle ) #if QT_VER == 3 +/*! + Constructor +*/ QtxColorScale::QtxColorScale( Dock* dock, const char* name, WFlags f ) : QFrame( dock, name, f | WResizeNoErase | WRepaintNoErase ), myMin( 0.0 ), @@ -101,107 +104,89 @@ myFlags( AtBorder | WrapTitle ) #endif +/*! + Destructor +*/ QtxColorScale::~QtxColorScale() { } -//================================================================ -// Function : minimum -// Purpose : Returns minimal limit of scale. -//================================================================ - +/*! + \returns minimal limit of scale. +*/ double QtxColorScale::minimum() const { return myMin; } -//================================================================ -// Function : maximum -// Purpose : Returns maximal limit of scale. -//================================================================ - +/*! + \return maximal limit of scale. +*/ double QtxColorScale::maximum() const { return myMax; } -//================================================================ -// Function : range -// Purpose : Returns range (minimal and maximal limits) of scale. -//================================================================ - +/*! + \return range (minimal and maximal limits) of scale. +*/ void QtxColorScale::range( double& min, double& max ) const { min = myMin; max = myMax; } -//================================================================ -// Function : title -// Purpose : Returns the current title string. -//================================================================ - +/*! + \return the current title string. +*/ QString QtxColorScale::title() const { return myTitle; } -//================================================================ -// Function : format -// Purpose : Returns the current format of number presentation in -// labels for Auto label mode (sprintf specification). -//================================================================ - +/*! + \returns the current format of number presentation in labels for Auto label mode (sprintf specification). +*/ QString QtxColorScale::format() const { return myFormat; } -//================================================================ -// Function : dumpMode -// Purpose : Returns dump mode. -//================================================================ - +/*! + \return dump mode. +*/ int QtxColorScale::dumpMode() const { return myDumpMode; } -//================================================================ -// Function : labelMode -// Purpose : Returns label mode. -//================================================================ - +/*! + \return label mode. +*/ int QtxColorScale::labelMode() const { return myLabelMode; } -//================================================================ -// Function : colorMode -// Purpose : Returns color mode. -//================================================================ - +/*! + \return color mode. +*/ int QtxColorScale::colorMode() const { return myColorMode; } -//================================================================ -// Function : intervalsNumber -// Purpose : Returns intervals number of color scale. -//================================================================ - +/*! + \return intervals number of color scale. +*/ int QtxColorScale::intervalsNumber() const { return myInterval; } -//================================================================ -// Function : label -// Purpose : Returns the user label of specified interval. -//================================================================ - +/*! + \return the user label of specified interval. +*/ QString QtxColorScale::label( const int idx ) const { QString res; @@ -210,11 +195,9 @@ QString QtxColorScale::label( const int idx ) const return res; } -//================================================================ -// Function : color -// Purpose : Returns the user color of specified interval. -//================================================================ - +/*! + \return the user color of specified interval. +*/ QColor QtxColorScale::color( const int idx ) const { QColor res; @@ -223,71 +206,57 @@ QColor QtxColorScale::color( const int idx ) const return res; } -//================================================================ -// Function : labels -// Purpose : Returns the user labels. -//================================================================ - +/*! + \return the user labels. +*/ void QtxColorScale::labels( QStringList& list ) const { list = myLabels; } -//================================================================ -// Function : colors -// Purpose : Returns the user color. -//================================================================ - +/*! + \return the user color. +*/ void QtxColorScale::colors( QValueList& list ) const { list = myColors; } -//================================================================ -// Function : labelPosition -// Purpose : Returns the label position. -//================================================================ - +/*! + \return the label position. +*/ int QtxColorScale::labelPosition() const { return myLabelPos; } -//================================================================ -// Function : titlePosition -// Purpose : Returns the title position. -//================================================================ - +/*! + \return the title position. +*/ int QtxColorScale::titlePosition() const { return myTitlePos; } -//================================================================ -// Function : setMinimum -// Purpose : Sets the minimum limit. -//================================================================ - +/*! + Sets the minimum limit. +*/ void QtxColorScale::setMinimum( const double val ) { setRange( val, maximum() ); } -//================================================================ -// Function : setMaximum -// Purpose : Sets the maximum limit. -//================================================================ - +/*! + Sets the maximum limit. +*/ void QtxColorScale::setMaximum( const double val ) { setRange( minimum(), val ); } -//================================================================ -// Function : setRange -// Purpose : Sets the minimum and maximum limits. -//================================================================ - +/*! + Sets the minimum and maximum limits. +*/ void QtxColorScale::setRange( const double min, const double max ) { if ( myMin == min && myMax == max ) @@ -302,11 +271,9 @@ void QtxColorScale::setRange( const double min, const double max ) updateScale(); } -//================================================================ -// Function : setTitle -// Purpose : Sets the title string. -//================================================================ - +/*! + Sets the title string. +*/ void QtxColorScale::setTitle( const QString& str ) { if ( myTitle == str ) @@ -316,12 +283,10 @@ void QtxColorScale::setTitle( const QString& str ) updateScale(); } -//================================================================ -// Function : setFormat -// Purpose : Sets the format of number presentation in labels for -// Auto label mode (sprintf specification). -//================================================================ - +/*! + Sets the format of number presentation in labels for + Auto label mode (sprintf specification). +*/ void QtxColorScale::setFormat( const QString& format ) { if ( myFormat == format ) @@ -333,11 +298,9 @@ void QtxColorScale::setFormat( const QString& format ) updateScale(); } -//================================================================ -// Function : setIntervalsNumber -// Purpose : Sets the number of intervals. -//================================================================ - +/*! + Sets the number of intervals. +*/ void QtxColorScale::setIntervalsNumber( const int num ) { if ( myInterval == num || num < 1 ) @@ -349,13 +312,11 @@ void QtxColorScale::setIntervalsNumber( const int num ) updateScale(); } -//================================================================ -// Function : setLabel -// Purpose : Sets the user label for specified interval. If number -// of interval is negative then user label will be added -// as new at the end of list. -//================================================================ - +/*! + Sets the user label for specified interval. If number + of interval is negative then user label will be added + as new at the end of list. +*/ void QtxColorScale::setLabel( const QString& txt, const int idx ) { bool changed = false; @@ -376,13 +337,11 @@ void QtxColorScale::setLabel( const QString& txt, const int idx ) updateScale(); } -//================================================================ -// Function : setColor -// Purpose : Sets the user color for specified interval. If number -// of interval is negative then user color will be added -// as new at the end of list. -//================================================================ - +/*! + Sets the user color for specified interval. If number + of interval is negative then user color will be added + as new at the end of list. +*/ void QtxColorScale::setColor( const QColor& clr, const int idx ) { bool changed = false; @@ -403,11 +362,9 @@ void QtxColorScale::setColor( const QColor& clr, const int idx ) updateScale(); } -//================================================================ -// Function : setLabels -// Purpose : Replace the all user label with specified list. -//================================================================ - +/*! + Replace the all user label with specified list. +*/ void QtxColorScale::setLabels( const QStringList& list ) { if ( list.isEmpty() ) @@ -417,11 +374,9 @@ void QtxColorScale::setLabels( const QStringList& list ) updateScale(); } -//================================================================ -// Function : setColors -// Purpose : Replace the all user colors with specified list. -//================================================================ - +/*! + Replace the all user colors with specified list. +*/ void QtxColorScale::setColors( const QValueList& list ) { if ( list.isEmpty() ) @@ -431,11 +386,9 @@ void QtxColorScale::setColors( const QValueList& list ) updateScale(); } -//================================================================ -// Function : setColorMode -// Purpose : Sets the color mode (Auto or User). -//================================================================ - +/*! + Sets the color mode (Auto or User). +*/ void QtxColorScale::setColorMode( const int mode ) { if ( myColorMode == mode ) @@ -445,21 +398,17 @@ void QtxColorScale::setColorMode( const int mode ) updateScale(); } -//================================================================ -// Function : setDumpMode -// Purpose : Sets the dump mode. -//================================================================ - +/*! + Sets the dump mode. +*/ void QtxColorScale::setDumpMode( const int mode ) { myDumpMode = mode; } -//================================================================ -// Function : setLabelMode -// Purpose : Sets the label mode (Auto or User). -//================================================================ - +/*! + Sets the label mode (Auto or User). +*/ void QtxColorScale::setLabelMode( const int mode ) { if ( myLabelMode != mode ) @@ -469,11 +418,9 @@ void QtxColorScale::setLabelMode( const int mode ) } } -//================================================================ -// Function : setLabelPosition -// Purpose : Sets the label position. -//================================================================ - +/*! + Sets the label position. +*/ void QtxColorScale::setLabelPosition( const int pos ) { if ( myLabelPos != pos && pos >= None && pos <= Center ) @@ -483,11 +430,9 @@ void QtxColorScale::setLabelPosition( const int pos ) } } -//================================================================ -// Function : setTitlePosition -// Purpose : Sets the title position. -//================================================================ - +/*! + Sets the title position. +*/ void QtxColorScale::setTitlePosition( const int pos ) { if ( myTitlePos != pos && pos >= None && pos <= Center ) @@ -497,11 +442,9 @@ void QtxColorScale::setTitlePosition( const int pos ) } } -//================================================================ -// Function : setFlags -// Purpose : Set the specified flags. -//================================================================ - +/*! + Set the specified flags. +*/ void QtxColorScale::setFlags( const int flags ) { int prev = myFlags; @@ -510,21 +453,17 @@ void QtxColorScale::setFlags( const int flags ) updateScale(); } -//================================================================ -// Function : testFlags -// Purpose : Returns true if specified flags are setted. -//================================================================ - +/*! + \return true if specified flags are setted. +*/ bool QtxColorScale::testFlags( const int flags ) const { return ( myFlags & flags ) == flags; } -//================================================================ -// Function : clearFlags -// Purpose : Clear (reset) the specified flags. -//================================================================ - +/*! + Clear (reset) the specified flags. +*/ void QtxColorScale::clearFlags( const int flags ) { int prev = myFlags; @@ -533,33 +472,27 @@ void QtxColorScale::clearFlags( const int flags ) updateScale(); } -//================================================================ -// Function : minimumSizeHint -// Purpose : -//================================================================ - +/*! + \return minimum size hint +*/ QSize QtxColorScale::minimumSizeHint() const { QSize sz = calculateSize( true, myFlags, titlePosition() != None, labelPosition() != None, true ); return sz + QSize( frameWidth(), frameWidth() ); } -//================================================================ -// Function : sizeHint -// Purpose : -//================================================================ - +/*! + \return size hint +*/ QSize QtxColorScale::sizeHint() const { QSize sz = calculateSize( false, myFlags, titlePosition() != None, labelPosition() != None, true ); return sz + QSize( frameWidth(), frameWidth() ); } -//================================================================ -// Function : calculateSize -// Purpose : Dump color scale into pixmap with current size. -//================================================================ - +/*! + Dump color scale into pixmap with current size. +*/ QSize QtxColorScale::calculateSize( const bool min, const int flags, const bool title, const bool labels, const bool colors ) const { @@ -631,11 +564,9 @@ QSize QtxColorScale::calculateSize( const bool min, const int flags, const bool return QSize( W, H ); } -//================================================================ -// Function : dump -// Purpose : Dump color scale into pixmap with current size. -//================================================================ - +/*! + Dump color scale into pixmap with current size. +*/ QPixmap QtxColorScale::dump() const { QPixmap aPix; @@ -667,11 +598,9 @@ QPixmap QtxColorScale::dump() const return aPix; } -//================================================================ -// Function : dump -// Purpose : Dump color scale into pixmap with specified size. -//================================================================ - +/*! + Dump color scale into pixmap with specified size. +*/ QPixmap QtxColorScale::dump( const int w, const int h ) const { #if QT_VER < 3 @@ -681,12 +610,9 @@ QPixmap QtxColorScale::dump( const int w, const int h ) const #endif } -//================================================================ -// Function : dump -// Purpose : Dump color scale into pixmap with specified size -// and background color. -//================================================================ - +/*! + Dump color scale into pixmap with specified size and background color. +*/ QPixmap QtxColorScale::dump( const QColor& bg, const int w, const int h ) const { QPixmap aPix; @@ -724,11 +650,9 @@ QPixmap QtxColorScale::dump( const QColor& bg, const int w, const int h ) const return aPix; } -//================================================================ -// Function : show -// Purpose : Show the color scale. [Reimplemented] -//================================================================ - +/*! + Show the color scale. [Reimplemented] +*/ void QtxColorScale::show() { #if QT_VER == 3 @@ -739,11 +663,9 @@ void QtxColorScale::show() QFrame::show(); } -//================================================================ -// Function : hide -// Purpose : Hides the color scale. [Reimplemented] -//================================================================ - +/*! + Hides the color scale. [Reimplemented] +*/ void QtxColorScale::hide() { #if QT_VER == 3 @@ -754,11 +676,9 @@ void QtxColorScale::hide() QFrame::hide(); } -//================================================================ -// Function : drawContents -// Purpose : Draw color scale contents. [Reimplemented] -//================================================================ - +/*! + Draw color scale contents. [Reimplemented] +*/ void QtxColorScale::drawContents( QPainter* p ) { if ( !isUpdatesEnabled() ) @@ -771,11 +691,9 @@ void QtxColorScale::drawContents( QPainter* p ) titlePosition() != None, labelPosition() != None, true ); } -//================================================================ -// Function : drawScale -// Purpose : Draw color scale contents. -//================================================================ - +/*! + Draw color scale contents. +*/ void QtxColorScale::drawScale( QPainter* p, const bool transp, const int X, const int Y, const int W, const int H, const bool title, const bool label, const bool scale ) const @@ -793,11 +711,9 @@ void QtxColorScale::drawScale( QPainter* p, const bool transp, const int X, cons p->drawPixmap( X, Y, cache ); } -//================================================================ -// Function : drawScale -// Purpose : Draw color scale contents. -//================================================================ - +/*! + Draw color scale contents. +*/ void QtxColorScale::drawScale( QPainter* p, const QColor& bg, const bool transp, const int X, const int Y, const int W, const int H, const bool drawTitle, const bool drawLabel, const bool drawColors ) const @@ -964,11 +880,9 @@ void QtxColorScale::drawScale( QPainter* p, const QColor& bg, const bool transp, } } -//================================================================ -// Function : getFormat -// Purpose : Returns the format for number labels. -//================================================================ - +/*! + \return the format for number labels. +*/ QString QtxColorScale::getFormat() const { QString aFormat = format(); @@ -1029,11 +943,9 @@ QString QtxColorScale::getFormat() const return aFormat; } -//================================================================ -// Function : getNumber -// Purpose : Returns the number for specified interval. -//================================================================ - +/*! + \return the number for specified interval. +*/ double QtxColorScale::getNumber( const int idx ) const { double val = 0; @@ -1042,12 +954,9 @@ double QtxColorScale::getNumber( const int idx ) const return val; } -//================================================================ -// Function : getLabel -// Purpose : Returns the label for specified interval according -// to the current label mode. -//================================================================ - +/*! + \return the label for specified interval according to the current label mode. +*/ QString QtxColorScale::getLabel( const int idx ) const { QString res; @@ -1061,12 +970,9 @@ QString QtxColorScale::getLabel( const int idx ) const return res; } -//================================================================ -// Function : getColor -// Purpose : Returns the color for specified interval according -// to the current color mode. -//================================================================ - +/*! + \return the color for specified interval according to the current color mode. +*/ QColor QtxColorScale::getColor( const int idx ) const { QColor res; @@ -1077,24 +983,20 @@ QColor QtxColorScale::getColor( const int idx ) const return res; } -//================================================================ -// Function : updateScale -// Purpose : Update color scale if it required. -//================================================================ - +/*! + Update color scale if it required. +*/ void QtxColorScale::updateScale() { update(); updateGeometry(); } -//================================================================ -// Function : simpleRichText -// Purpose : Return QSimpleRichText object for title. If title -// not defined (empty string) then return null pointer. -// Object should be deleted by caller function. -//================================================================ - +/*! + \return QSimpleRichText object for title. If title + not defined (empty string) then return null pointer. + Object should be deleted by caller function. +*/ QSimpleRichText* QtxColorScale::simpleRichText( const int flags ) const { QSimpleRichText* srt = 0; @@ -1141,17 +1043,14 @@ QSimpleRichText* QtxColorScale::simpleRichText( const int flags ) const #if QT_VER == 3 -/********************************************************************* -** Class: QtxColorScale::Dock -** Descr: Dockable window contains the color scale. -** Level: Public -*********************************************************************/ - -//================================================================ -// Function : Dock -// Purpose : Constructor. -//================================================================ +/*! + \class QtxColorScale::Dock + Dockable window contains the color scale. +*/ +/*! + Constructor +*/ QtxColorScale::Dock::Dock( Place p, QWidget* parent, const char* name, WFlags f ) : QDockWindow( p, parent, name, f ), myBlockShow( false ), @@ -1169,30 +1068,24 @@ myBlockResize( false ) setCaption( tr ( "Color scale" ) ); } -//================================================================ -// Function : ~Dock -// Purpose : Destructor. -//================================================================ - +/*! + Destructor. +*/ QtxColorScale::Dock::~Dock() { } -//================================================================ -// Function : colorScale -// Purpose : Returns color scale widget. -//================================================================ - +/*! + \return color scale widget. +*/ QtxColorScale* QtxColorScale::Dock::colorScale() const { return myScale; } -//================================================================ -// Function : activate -// Purpose : Set the dockable window is visible for main window. -//================================================================ - +/*! + Set the dockable window is visible for main window. +*/ void QtxColorScale::Dock::activate() { if ( myBlockShow ) @@ -1210,11 +1103,9 @@ void QtxColorScale::Dock::activate() mw->setAppropriate( this, true ); } -//================================================================ -// Function : deactivate -// Purpose : Set the dockable window is hidden for main window. -//================================================================ - +/*! + Set the dockable window is hidden for main window. +*/ void QtxColorScale::Dock::deactivate() { if ( myBlockShow ) @@ -1232,11 +1123,9 @@ void QtxColorScale::Dock::deactivate() mw->setAppropriate( this, false ); } -//================================================================ -// Function : isActive -// Purpose : Returns true if the dockable window is visible. -//================================================================ - +/*! + \return true if the dockable window is visible. +*/ bool QtxColorScale::Dock::isActive() const { QMainWindow* mw = 0; @@ -1253,11 +1142,9 @@ bool QtxColorScale::Dock::isActive() const return false; } -//================================================================ -// Function : show -// Purpose : Reimplemented for internal reasons. -//================================================================ - +/*! + Redefined show +*/ void QtxColorScale::Dock::show() { bool f = myBlockShow; @@ -1266,11 +1153,9 @@ void QtxColorScale::Dock::show() myBlockShow = f; } -//================================================================ -// Function : hide -// Purpose : Reimplemented for internal reasons. -//================================================================ - +/*! + Redefined hide +*/ void QtxColorScale::Dock::hide() { bool f = myBlockShow; @@ -1279,11 +1164,9 @@ void QtxColorScale::Dock::hide() myBlockShow = f; } -//================================================================ -// Function : resize -// Purpose : Make extent width as maximum value of widget width. -//================================================================ - +/*! + Make extent width as maximum value of widget width. +*/ void QtxColorScale::Dock::resize( int w, int h ) { QDockWindow::resize( w, h ); @@ -1297,11 +1180,10 @@ void QtxColorScale::Dock::resize( int w, int h ) setFixedExtentHeight( QMAX( fixedExtent().height(), h ) ); } -//================================================================ -// Function : setOrientation -// Purpose : -//================================================================ - +/*! + Set orientation + \param o - new orientation +*/ void QtxColorScale::Dock::setOrientation( Orientation o ) { bool b = myBlockResize; diff --git a/src/Qtx/QtxColorScale.h b/src/Qtx/QtxColorScale.h index fa81c0d1a..164ea91be 100755 --- a/src/Qtx/QtxColorScale.h +++ b/src/Qtx/QtxColorScale.h @@ -38,6 +38,10 @@ class QSimpleRichText; #pragma warning( disable:4251 ) #endif +/*! + \class QtxColorScale + Color Scale widget. +*/ class QTX_EXPORT QtxColorScale : public QFrame { Q_OBJECT diff --git a/src/Qtx/QtxComboBox.cxx b/src/Qtx/QtxComboBox.cxx index 4e7c3b5cb..1f4325efd 100755 --- a/src/Qtx/QtxComboBox.cxx +++ b/src/Qtx/QtxComboBox.cxx @@ -25,6 +25,9 @@ #include #include +/*! + Constructor +*/ QtxComboBox::QtxComboBox( QWidget* parent, const char* name ) : QComboBox( parent, name ), myCleared( false ) @@ -33,6 +36,9 @@ myCleared( false ) connect( this, SIGNAL( activated( const QString& ) ), this, SLOT( onActivated( const QString& ) ) ); } +/*! + Constructor +*/ QtxComboBox::QtxComboBox( bool rw, QWidget* parent, const char* name ) : QComboBox( rw, parent, name ), myCleared( false ) @@ -41,15 +47,25 @@ myCleared( false ) connect( this, SIGNAL( activated( const QString& ) ), this, SLOT( onActivated( const QString& ) ) ); } +/*! + Destructor +*/ QtxComboBox::~QtxComboBox() { } +/*! + \return true if combobox is cleared +*/ bool QtxComboBox::isCleared() const { return myCleared; } +/*! + Sets cleared status + \param isClear - new status +*/ void QtxComboBox::setCleared( const bool isClear ) { if ( myCleared == isClear ) @@ -68,6 +84,10 @@ void QtxComboBox::setCleared( const bool isClear ) update(); } +/*! + Sets currently selected item + \param idx - index of item +*/ void QtxComboBox::setCurrentItem( int idx ) { if ( idx < 0 || idx >= count() ) @@ -77,6 +97,10 @@ void QtxComboBox::setCurrentItem( int idx ) QComboBox::setCurrentItem( idx ); } +/*! + Sets current text + \param txt - new current text +*/ void QtxComboBox::setCurrentText( const QString& txt ) { myCleared = false; @@ -96,16 +120,25 @@ void QtxComboBox::setCurrentText( const QString& txt ) #endif } +/*! + \return current selected id +*/ int QtxComboBox::currentId() const { return id( currentItem() ); } +/*! + Sets current selected id +*/ void QtxComboBox::setCurrentId( int num ) { setCurrentItem( index( num ) ); } +/*! + Custom paint event handler +*/ void QtxComboBox::paintEvent( QPaintEvent* e ) { if ( !count() || !myCleared || editable() ) @@ -114,6 +147,10 @@ void QtxComboBox::paintEvent( QPaintEvent* e ) paintClear( e ); } +/*! + SLOT: called if some item is activated + \param idx - index of activated item +*/ void QtxComboBox::onActivated( int idx ) { resetClear(); @@ -122,11 +159,16 @@ void QtxComboBox::onActivated( int idx ) emit activatedId( myIndexId[idx] ); } -void QtxComboBox::onActivated( const QString& ) +/*! + SLOT: called if some item is activated +*/void QtxComboBox::onActivated( const QString& ) { resetClear(); } +/*! + Strips "cleared" state and updates +*/ void QtxComboBox::resetClear() { if ( !myCleared ) @@ -136,6 +178,9 @@ void QtxComboBox::resetClear() update(); } +/*! + Draws combobox when it is cleared or isn't editable +*/ void QtxComboBox::paintClear( QPaintEvent* e ) { int curIndex = currentItem(); @@ -159,6 +204,9 @@ void QtxComboBox::paintClear( QPaintEvent* e ) setUpdatesEnabled( upd ); } +/*! + \return id by index +*/ int QtxComboBox::id( const int idx ) const { int id = -1; @@ -167,6 +215,9 @@ int QtxComboBox::id( const int idx ) const return id; } +/*! + \return index by id +*/ int QtxComboBox::index( const int id ) const { int idx = -1; diff --git a/src/Qtx/QtxDblSpinBox.cxx b/src/Qtx/QtxDblSpinBox.cxx index b10c28bd6..6c3655240 100755 --- a/src/Qtx/QtxDblSpinBox.cxx +++ b/src/Qtx/QtxDblSpinBox.cxx @@ -27,11 +27,10 @@ #include -/* - Class: QtxDblSpinBox::Validator [internal] - Descr: Validator for QtxDblSpinBox (getted from Trolltech Qt - SpinBoxValidator) +/*! + \class QtxDblSpinBox::Validator [internal] + Validator for QtxDblSpinBox (getted from Trolltech Qt - SpinBoxValidator) */ - class QtxDblSpinBox::Validator : public QDoubleValidator { public: @@ -44,6 +43,10 @@ private: QtxDblSpinBox* spinBox; }; + +/*! + Checks string and \return QValidator::State +*/ QValidator::State QtxDblSpinBox::Validator::validate( QString& str, int& pos ) const { QString pref = spinBox->prefix(); @@ -84,11 +87,9 @@ QValidator::State QtxDblSpinBox::Validator::validate( QString& str, int& pos ) c return state; } -/* - Class: QtxDblSpinBox - Descr: Spin box for real numbers. +/*! + Constructor */ - QtxDblSpinBox::QtxDblSpinBox( QWidget* parent, const char* name ) : QSpinBox( parent, name ), myCleared( false ), @@ -106,6 +107,9 @@ myPrecision( 0 ) connect( editor(), SIGNAL( textChanged( const QString& ) ), this, SLOT( onTextChanged( const QString& ) ) ); } +/*! + Constructor +*/ QtxDblSpinBox::QtxDblSpinBox( double min, double max, double step, QWidget* parent, const char* name ) : QSpinBox( parent, name ), myMin( min ), @@ -123,25 +127,42 @@ myPrecision( 0 ) connect( editor(), SIGNAL( textChanged( const QString& ) ), this, SLOT( onTextChanged( const QString& ) ) ); } +/*! + Destructor +*/ QtxDblSpinBox::~QtxDblSpinBox() { } +/*! + \return min value of spin box +*/ double QtxDblSpinBox::minValue() const { return myMin; } +/*! + \return max value of spin box +*/ double QtxDblSpinBox::maxValue() const { return myMax; } +/*! + Changes min value of spin box + \param min - new min value +*/ void QtxDblSpinBox::setMinValue( int min ) { setMinValue( (double)min ); } +/*! + Changes min value of spin box + \param min - new min value +*/ void QtxDblSpinBox::setMinValue( double min ) { if ( myMin != min ) @@ -151,11 +172,19 @@ void QtxDblSpinBox::setMinValue( double min ) } } +/*! + Changes max value of spin box + \param max - new max value +*/ void QtxDblSpinBox::setMaxValue( int max ) { setMaxValue( (double)max ); } +/*! + Changes max value of spin box + \param max - new max value +*/ void QtxDblSpinBox::setMaxValue( double max ) { if ( myMax != max ) @@ -165,11 +194,21 @@ void QtxDblSpinBox::setMaxValue( double max ) } } +/*! + Changes min and max value of spin box + \param min - new min value + \param max - new max value +*/ void QtxDblSpinBox::setRange( int min, int max ) { setRange( (double)min, (double)max ); } +/*! + Changes min and max value of spin box + \param min - new min value + \param max - new max value +*/ void QtxDblSpinBox::setRange( double min, double max ) { if ( myMin != min || myMax != max ) @@ -180,21 +219,35 @@ void QtxDblSpinBox::setRange( double min, double max ) } } +/*! + \return step of spin box +*/ double QtxDblSpinBox::lineStep() const { return myStep; } +/*! + Changes step of spin box + \param step - new step +*/ void QtxDblSpinBox::setLineStep( int step ) { setLineStep( (double)step ); } +/*! + Changes step of spin box + \param step - new step +*/ void QtxDblSpinBox::setLineStep( double step ) { myStep = step; } +/*! + \return value of spin box +*/ double QtxDblSpinBox::value() const { QSpinBox::value(); @@ -202,11 +255,19 @@ double QtxDblSpinBox::value() const return myValue; } +/*! + Changes value of spin box + \param val - new value of spin box +*/ void QtxDblSpinBox::setValue( int val ) { setValue( (double)val ); } +/*! + Changes value of spin box + \param val - new value of spin box +*/ void QtxDblSpinBox::setValue( double val ) { myCleared = false; @@ -216,6 +277,9 @@ void QtxDblSpinBox::setValue( double val ) valueChange(); } +/*! + Adds step to value +*/ void QtxDblSpinBox::stepUp() { interpretText(); @@ -225,6 +289,9 @@ void QtxDblSpinBox::stepUp() setValue( myValue + myStep ); } +/*! + Subtracks step from value +*/ void QtxDblSpinBox::stepDown() { interpretText(); @@ -234,11 +301,18 @@ void QtxDblSpinBox::stepDown() setValue( myValue - myStep ); } +/*! + \return number of digit after comma +*/ int QtxDblSpinBox::precision() const { return myPrecision; } +/*! + Changes number of digit after comma + \param prec - new digit number +*/ void QtxDblSpinBox::setPrecision( const int prec ) { int newPrec = QMAX( prec, 0 ); @@ -248,11 +322,18 @@ void QtxDblSpinBox::setPrecision( const int prec ) updateDisplay(); } +/*! + \return true if spin box is cleared +*/ bool QtxDblSpinBox::isCleared() const { return myCleared; } +/*! + Changes cleared status of spin box + \param on - new status +*/ void QtxDblSpinBox::setCleared( const bool on ) { if ( myCleared == on ) @@ -262,6 +343,9 @@ void QtxDblSpinBox::setCleared( const bool on ) updateDisplay(); } +/*! + Selects all content of spin box editor +*/ void QtxDblSpinBox::selectAll() { #if QT_VER >= 3 @@ -271,6 +355,9 @@ void QtxDblSpinBox::selectAll() #endif } +/*! + Custom event filter, updates text of spin box editor +*/ bool QtxDblSpinBox::eventFilter( QObject* o, QEvent* e ) { if ( !myCleared || o != editor() || !editor()->text().stripWhiteSpace().isEmpty() ) @@ -294,6 +381,9 @@ bool QtxDblSpinBox::eventFilter( QObject* o, QEvent* e ) return QSpinBox::eventFilter( o, e ); } +/*! + Updates text of editor +*/ void QtxDblSpinBox::updateDisplay() { if ( myBlocked ) @@ -332,6 +422,9 @@ void QtxDblSpinBox::updateDisplay() myBlocked = isBlock; } +/*! + Sets double value by text in editor +*/ void QtxDblSpinBox::interpretText() { myCleared = false; @@ -356,6 +449,9 @@ void QtxDblSpinBox::interpretText() updateDisplay(); } +/*! + Emits signal "valueChanged" +*/ void QtxDblSpinBox::valueChange() { updateDisplay(); @@ -363,6 +459,9 @@ void QtxDblSpinBox::valueChange() emit valueChanged( currentValueText() ); } +/*! + Attune parameters on range changing +*/ void QtxDblSpinBox::rangeChange() { double min = QMIN( myMin, myMax ); @@ -382,6 +481,9 @@ void QtxDblSpinBox::rangeChange() updateDisplay(); } +/*! + \return text of editor +*/ QString QtxDblSpinBox::currentValueText() { QString s; @@ -396,6 +498,10 @@ QString QtxDblSpinBox::currentValueText() return s; } +/*! + Converts number to string + \param v - number to be converted +*/ QString QtxDblSpinBox::mapValueToText( double v ) { QString s; @@ -403,6 +509,9 @@ QString QtxDblSpinBox::mapValueToText( double v ) return removeTrailingZeroes( s ); } +/*! + Converts value to string +*/ QString QtxDblSpinBox::mapValueToText( int ) { QString s; @@ -410,6 +519,9 @@ QString QtxDblSpinBox::mapValueToText( int ) return removeTrailingZeroes( s ); } +/*! + Converts current text of editor to double +*/ double QtxDblSpinBox::mapTextToDoubleValue( bool* ok ) { QString s = text(); @@ -422,6 +534,10 @@ double QtxDblSpinBox::mapTextToDoubleValue( bool* ok ) return newVal; } +/*! + \return value corrected in accordance with borders + \param val - value to be corrected +*/ double QtxDblSpinBox::bound( double val ) { double newVal = val; @@ -432,12 +548,18 @@ double QtxDblSpinBox::bound( double val ) return newVal; } +/*! + Custom handler for leave event +*/ void QtxDblSpinBox::leaveEvent( QEvent* e ) { if ( !myCleared ) QSpinBox::leaveEvent( e ); } +/*! + Custom handler for wheel event +*/ void QtxDblSpinBox::wheelEvent( QWheelEvent* e ) { if ( !isEnabled() ) @@ -447,12 +569,18 @@ void QtxDblSpinBox::wheelEvent( QWheelEvent* e ) updateDisplay(); } +/*! + SLOT: called if text is changed +*/ void QtxDblSpinBox::onTextChanged( const QString& str ) { if ( !myBlocked ) myCleared = false; } +/*! + \return string without excess zeros in start and in end +*/ QString QtxDblSpinBox::removeTrailingZeroes( const QString& src ) const { QString delim( "." ); diff --git a/src/Qtx/QtxDblSpinBox.h b/src/Qtx/QtxDblSpinBox.h index e59fe4f3d..d145390e0 100755 --- a/src/Qtx/QtxDblSpinBox.h +++ b/src/Qtx/QtxDblSpinBox.h @@ -26,6 +26,10 @@ #include +/*! + \class QtxDblSpinBox + Spin box for real numbers. +*/ class QTX_EXPORT QtxDblSpinBox : public QSpinBox { Q_OBJECT diff --git a/src/Qtx/QtxDblValidator.cxx b/src/Qtx/QtxDblValidator.cxx index 2769fd406..4b204f8db 100644 --- a/src/Qtx/QtxDblValidator.cxx +++ b/src/Qtx/QtxDblValidator.cxx @@ -21,16 +21,31 @@ #include "QtxDblValidator.h" +/*! + Constructor + \param bot - minimal possible value + \param top - maximal possible value + \param dec - number of digits + \param o - parent object + \param name - name of validator +*/ QtxDblValidator::QtxDblValidator( const double bot, const double top, const int dec, QObject* o, const char* name ) : QDoubleValidator( bot, top, dec, o, name ) { } +/*! + Destructor +*/ QtxDblValidator::~QtxDblValidator() { } +/*! + Corrects string: if it represent double value less then bottom, it becomes equal to bottom, + if it is more then top, it becomes equal to top, if it isn't number is becomes '0' +*/ void QtxDblValidator::fixup( QString& str ) const { bool ok = false; diff --git a/src/Qtx/QtxDialog.cxx b/src/Qtx/QtxDialog.cxx index 347479e55..5bbc1f79b 100755 --- a/src/Qtx/QtxDialog.cxx +++ b/src/Qtx/QtxDialog.cxx @@ -33,7 +33,6 @@ Class: QtxDialog::Area Level: Internal */ - class QtxDialog::Area : public QFrame { public: @@ -68,6 +67,9 @@ private: Orientation myOrientation; }; +/*! + Contructor +*/ QtxDialog::Area::Area( Orientation o, QtxDialog* dlg, QWidget* parent ) : QFrame( parent ), myDlg( dlg ), @@ -84,10 +86,17 @@ myOrientation( o ) hide(); } +/*! + Destructor +*/ QtxDialog::Area::~Area() { } +/*! + Inserts button to area + \param b - button +*/ void QtxDialog::Area::insertButton( QButton* b ) { if ( !b || myButtons.findRef( b ) != -1 ) @@ -108,6 +117,10 @@ void QtxDialog::Area::insertButton( QButton* b ) updateBorder(); } +/*! + Removes button from area + \param b - button +*/ void QtxDialog::Area::removeButton( QButton* b ) { if ( !b ) @@ -126,16 +139,27 @@ void QtxDialog::Area::removeButton( QButton* b ) layoutButtons(); } +/*! + \return true if area contains button + \param b - button +*/ bool QtxDialog::Area::contains( QButton* b ) const { return myButtons.containsRef( b ); } +/*! + \return policy of button layouting. +*/ int QtxDialog::Area::policy() const { return myPolicy; } +/*! + Changes policy of button layouting. + \param p - new policy +*/ void QtxDialog::Area::setPolicy( const int p ) { if ( myPolicy == p ) @@ -145,11 +169,18 @@ void QtxDialog::Area::setPolicy( const int p ) layoutButtons(); } +/*! + \return true if border enabled +*/ bool QtxDialog::Area::isBorderEnabled() const { return myLine && myBorder; } +/*! + Enables/disable separator between main frame and button frame + \param on - new state +*/ void QtxDialog::Area::setBorderEnabled( const bool on ) { if ( !myLine || myBorder == on ) @@ -159,6 +190,10 @@ void QtxDialog::Area::setBorderEnabled( const bool on ) updateBorder(); } +/*! + Sets label as separator between main frame and button frame + \param line - new separator +*/ void QtxDialog::Area::setBorderWidget( QLabel* line ) { if ( myLine == line ) @@ -169,11 +204,17 @@ void QtxDialog::Area::setBorderWidget( QLabel* line ) updateBorder(); } +/*! + \return const reference to list of buttons +*/ const QPtrList& QtxDialog::Area::buttons() const { return myButtons; } +/*! + Updates visibility of border +*/ void QtxDialog::Area::updateBorder() { if ( !myLine ) @@ -192,6 +233,9 @@ void QtxDialog::Area::updateBorder() myLine->setLineWidth( myBorder ? 1 : 0 ); } +/*! + Installs buttons into layout +*/ void QtxDialog::Area::layoutButtons() { int aPolicy = policy(); @@ -285,11 +329,12 @@ void QtxDialog::Area::layoutButtons() Qtx::setTabOrder( wids ); } + /*! - Class: QtxDialog::Border - Level: Internal -*/ + \class QtxDialog::Border + Special label used as separator between main frame and button frame +*/ class QtxDialog::Border : public QLabel { public: @@ -302,16 +347,26 @@ public: virtual QSize minimumSizeHint() const; }; +/*! + Constructor +*/ QtxDialog::Border::Border( QWidget* parent ) : QLabel( parent ) { setAlignment( Qt::AlignCenter ); } +/*! + Destructor +*/ QtxDialog::Border::~Border() { } +/*! + Set line width of separator + \param lw - new line width +*/ void QtxDialog::Border::setLineWidth( int lw ) { bool isOn = lineWidth() > 0; @@ -322,6 +377,9 @@ void QtxDialog::Border::setLineWidth( int lw ) updateGeometry(); } +/*! + \return the recommended size for the widget +*/ QSize QtxDialog::Border::sizeHint() const { QSize sz( 5, 5 ); @@ -339,26 +397,22 @@ QSize QtxDialog::Border::sizeHint() const return sz; } +/*! + \return the recommended minimum size for the widget +*/ QSize QtxDialog::Border::minimumSizeHint() const { return sizeHint(); } /*! - Class: QtxDialog - Level: Public + Constructor + Construct a dialog with specified parent and name. + \param modal define modal status of dialog (default non modal dialog created). + \param allowResize - if it is true then dialog can be resize by user (default non resizable dialog created). + \param Button flags specified control buttons for dialog (default buttons is OK, Cancel and Help). + \param Widget flags used as in any widget. */ - -/*! - Name: QtxDialog [public] - Desc: Construct a dialog with specified parent and name. - Parameter 'modal' define modal status of dialog (default non modal - dialog created). If parameter 'allowResize' is true then dialog - can be resize by user (default non resizable dialog created). - Button flags specified control buttons for dialog (default buttons - is OK, Cancel and Help). Widget flags used as in any widget. -*/ - QtxDialog::QtxDialog( QWidget* parent, const char* name, bool modal, bool allowResize, const int f, WFlags wf ) : QDialog( parent, name, modal, diff --git a/src/Qtx/QtxDockAction.cxx b/src/Qtx/QtxDockAction.cxx index 0a0295559..a8b7ddf7c 100755 --- a/src/Qtx/QtxDockAction.cxx +++ b/src/Qtx/QtxDockAction.cxx @@ -255,6 +255,10 @@ bool QtxDockAction::removeFrom( QWidget* wid ) return QtxAction::removeFrom( wid ); } +/*! + Sets menu text of action + \param txt - new menu text +*/ void QtxDockAction::setMenuText( const QString& txt ) { if ( menuText() == txt ) @@ -721,6 +725,11 @@ void QtxDockAction::dockWindows( QPtrList& lst, QMainWindow* main ) delete objs; } +/*! + \return true if main window is parent of object + \param mw - main window + \param win - object +*/ bool QtxDockAction::dockMainWindow( QMainWindow* mw, QObject* win ) const { if ( !mw || !win ) @@ -1251,6 +1260,9 @@ void QtxDockAction::collectNames( const int place, QStringList& lst ) const } } +/*! + Updates menu of action +*/ void QtxDockAction::updateMenus() { for ( MenuMap::Iterator it = myMenu.begin(); it != myMenu.end(); ++it ) diff --git a/src/Qtx/QtxDockWindow.cxx b/src/Qtx/QtxDockWindow.cxx index 9872d8505..df05b42dc 100644 --- a/src/Qtx/QtxDockWindow.cxx +++ b/src/Qtx/QtxDockWindow.cxx @@ -28,10 +28,9 @@ #include /*! - Class: QtxDockWindow::Watcher [Internal] - Descr: Internal object with event filter. + \class QtxDockWindow::Watcher [Internal] + Internal object with event filter. */ - class QtxDockWindow::Watcher : public QObject { public: @@ -62,6 +61,9 @@ private: bool myVisible; }; +/*! + Constructor +*/ QtxDockWindow::Watcher::Watcher( QtxDockWindow* cont ) : QObject( cont ), myCont( cont ), myState( true ), @@ -76,6 +78,9 @@ myEmpty( true ) installFilters(); } +/*! + Custom event filter +*/ bool QtxDockWindow::Watcher::eventFilter( QObject* o, QEvent* e ) { if ( o == myCont && @@ -98,6 +103,9 @@ bool QtxDockWindow::Watcher::eventFilter( QObject* o, QEvent* e ) return false; } +/*! + Sets internal status to shown +*/ void QtxDockWindow::Watcher::shown( QtxDockWindow* dw ) { if ( dw != myCont ) @@ -106,6 +114,9 @@ void QtxDockWindow::Watcher::shown( QtxDockWindow* dw ) myVisible = true; } +/*! + Sets internal status to hidden +*/ void QtxDockWindow::Watcher::hided( QtxDockWindow* dw ) { if ( dw != myCont ) @@ -114,6 +125,9 @@ void QtxDockWindow::Watcher::hided( QtxDockWindow* dw ) myVisible = false; } +/*! + Shows corresponding dock window +*/ void QtxDockWindow::Watcher::showContainer() { if ( !myCont ) @@ -125,6 +139,9 @@ void QtxDockWindow::Watcher::showContainer() myCont = cont; } +/*! + Hides corresponding dock window +*/ void QtxDockWindow::Watcher::hideContainer() { if ( !myCont ) @@ -136,6 +153,9 @@ void QtxDockWindow::Watcher::hideContainer() myCont = cont; } +/*! + Event filter of custom events +*/ void QtxDockWindow::Watcher::customEvent( QCustomEvent* e ) { installFilters(); @@ -145,6 +165,9 @@ void QtxDockWindow::Watcher::customEvent( QCustomEvent* e ) updateVisibility(); } +/*! + Installs this object as event filter to all widgets inside corresponding main window +*/ void QtxDockWindow::Watcher::installFilters() { if ( !myCont ) @@ -161,6 +184,9 @@ void QtxDockWindow::Watcher::installFilters() } } +/*! + Updates visibility of all widgets inside corresponding main window +*/ void QtxDockWindow::Watcher::updateVisibility() { if ( !myCont ) @@ -192,6 +218,9 @@ void QtxDockWindow::Watcher::updateVisibility() vis ? showContainer() : hideContainer(); } +/*! + Updates icon of corresponding main window +*/ void QtxDockWindow::Watcher::updateIcon() { if ( !myCont || !myCont->widget() ) @@ -201,6 +230,9 @@ void QtxDockWindow::Watcher::updateIcon() myCont->setIcon( ico ? *ico : QPixmap() ); } +/*! + Updates caption of corresponding main window +*/ void QtxDockWindow::Watcher::updateCaption() { if ( myCont && myCont->widget() && !myCont->widget()->caption().isNull() ) @@ -208,10 +240,8 @@ void QtxDockWindow::Watcher::updateCaption() } /*! - Class: QtxDockWindow [Public] - Descr: + Constructor */ - QtxDockWindow::QtxDockWindow( Place p, QWidget* parent, const char* name, WFlags f ) : QDockWindow( p, parent, name, f ), myWatcher( 0 ), @@ -219,6 +249,9 @@ myStretch( false ) { } +/*! + Constructor +*/ QtxDockWindow::QtxDockWindow( const bool watch, QWidget* parent, const char* name, WFlags f ) : QDockWindow( InDock, parent, name, f ), myWatcher( 0 ), @@ -228,6 +261,9 @@ myStretch( false ) myWatcher = new Watcher( this ); } +/*! + Constructor +*/ QtxDockWindow::QtxDockWindow( QWidget* parent, const char* name, WFlags f ) : QDockWindow( InDock, parent, name, f ), myWatcher( 0 ), @@ -235,10 +271,17 @@ myStretch( false ) { } +/*! + Destructor +*/ QtxDockWindow::~QtxDockWindow() { } +/*! + Sets the dock window's main widget + \param wid - new main widget +*/ void QtxDockWindow::setWidget( QWidget* wid ) { if ( wid ) @@ -247,11 +290,18 @@ void QtxDockWindow::setWidget( QWidget* wid ) QDockWindow::setWidget( wid ); } +/*! + \return true if the dock window is stretchable +*/ bool QtxDockWindow::isStretchable() const { return myStretch; } +/*! + Sets the dock window "stretchable" state + \param on - new state +*/ void QtxDockWindow::setStretchable( const bool on ) { if ( myStretch == on ) @@ -271,6 +321,9 @@ void QtxDockWindow::setStretchable( const bool on ) } } +/*! + \return the recommended size for the widget +*/ QSize QtxDockWindow::sizeHint() const { QSize sz = QDockWindow::sizeHint(); @@ -286,6 +339,9 @@ QSize QtxDockWindow::sizeHint() const return sz; } +/*! + \return the recommended minimum size for the widget +*/ QSize QtxDockWindow::minimumSizeHint() const { QSize sz = QDockWindow::minimumSizeHint(); @@ -306,6 +362,9 @@ QSize QtxDockWindow::minimumSizeHint() const return sz; } +/*! + \return corresponding main window +*/ QMainWindow* QtxDockWindow::mainWindow() const { QMainWindow* mw = 0; @@ -321,6 +380,9 @@ QMainWindow* QtxDockWindow::mainWindow() const return mw; } +/*! + Shows window +*/ void QtxDockWindow::show() { if ( myWatcher ) @@ -329,6 +391,9 @@ void QtxDockWindow::show() QDockWindow::show(); } +/*! + Hides window +*/ void QtxDockWindow::hide() { if ( myWatcher ) diff --git a/src/Qtx/QtxGroupBox.cxx b/src/Qtx/QtxGroupBox.cxx index 51732dc75..801c3a599 100644 --- a/src/Qtx/QtxGroupBox.cxx +++ b/src/Qtx/QtxGroupBox.cxx @@ -27,12 +27,18 @@ #include #include +/*! + Constructor +*/ QtxGroupBox::QtxGroupBox( QWidget* parent, const char* name ) : QGroupBox( parent, name ), myContainer( 0 ) { } +/*! + Constructor +*/ QtxGroupBox::QtxGroupBox( const QString& title, QWidget* parent, const char* name ) : QGroupBox( title, parent, name ), myContainer( 0 ) @@ -40,6 +46,9 @@ myContainer( 0 ) initialize(); } +/*! + Constructor +*/ QtxGroupBox::QtxGroupBox( int strips, Orientation o, QWidget* parent, const char* name ) : QGroupBox( strips, o, parent, name ), myContainer( 0 ) @@ -47,6 +56,9 @@ myContainer( 0 ) initialize(); } +/*! + Constructor +*/ QtxGroupBox::QtxGroupBox( int strips, Orientation o, const QString& title, QWidget* parent, const char* name ) : QGroupBox( strips, o, title, parent, name ), @@ -55,11 +67,17 @@ myContainer( 0 ) initialize(); } +/*! + Destructor +*/ QtxGroupBox::~QtxGroupBox() { delete myContainer; } +/*! + Creates horizontal box as container +*/ void QtxGroupBox::initialize() { myContainer = new QHBox( this, 0, WStyle_Customize | WStyle_NoBorderEx | WStyle_Tool ); @@ -69,6 +87,9 @@ void QtxGroupBox::initialize() #if QT_VER < 3 +/*! + \return the width of the empty space between the items in the group and the frame of the group +*/ int QtxGroupBox::insideMargin() const { int m = 0; @@ -77,6 +98,9 @@ int QtxGroupBox::insideMargin() const return m; } +/*! + \return the width of the empty space between each of the items in the group +*/ int QtxGroupBox::insideSpacing() const { int s = 0; @@ -85,12 +109,18 @@ int QtxGroupBox::insideSpacing() const return s; } +/*! + Sets the width of the empty space between the items in the group and the frame of the group +*/ void QtxGroupBox::setInsideMargin( int m ) { if ( layout() ) layout()->setMargin( m ); } +/*! + Sets the width of the empty space between each of the items in the group +*/ void QtxGroupBox::setInsideSpacing( int s ) { if ( layout() ) @@ -99,6 +129,10 @@ void QtxGroupBox::setInsideSpacing( int s ) #endif +/*! + Inserts title widget + \param wid - new title widget +*/ void QtxGroupBox::insertTitleWidget( QWidget* wid ) { if ( !myContainer ) @@ -110,6 +144,10 @@ void QtxGroupBox::insertTitleWidget( QWidget* wid ) updateTitle(); } +/*! + Removes title widget + \param wid - title widget +*/ void QtxGroupBox::removeTitleWidget( QWidget* wid ) { if ( !myContainer || wid->parentWidget() != myContainer ) @@ -121,6 +159,9 @@ void QtxGroupBox::removeTitleWidget( QWidget* wid ) updateTitle(); } +/*! + Calculates margin +*/ void QtxGroupBox::adjustInsideMargin() { QApplication::sendPostedEvents( myContainer, QEvent::ChildInserted ); @@ -130,6 +171,9 @@ void QtxGroupBox::adjustInsideMargin() setInsideMargin( myContainer->height() ); } +/*! + Sets the alignment of the group box title +*/ void QtxGroupBox::setAlignment( int align ) { QGroupBox::setAlignment( align ); @@ -137,6 +181,9 @@ void QtxGroupBox::setAlignment( int align ) updateTitle(); } +/*! + Sets title of groop box +*/ void QtxGroupBox::setTitle( const QString& title ) { QGroupBox::setTitle( title ); @@ -144,6 +191,11 @@ void QtxGroupBox::setTitle( const QString& title ) updateTitle(); } +/*! + Changes the layout of the group box + \param strips - number of column/rows + \param o - orientation +*/ void QtxGroupBox::setColumnLayout( int strips, Orientation o ) { if ( myContainer ) @@ -157,6 +209,9 @@ void QtxGroupBox::setColumnLayout( int strips, Orientation o ) updateTitle(); } +/*! + Shows group box +*/ void QtxGroupBox::show() { QGroupBox::show(); @@ -164,6 +219,9 @@ void QtxGroupBox::show() updateTitle(); } +/*! + Updates group box +*/ void QtxGroupBox::update() { QGroupBox::update(); @@ -171,6 +229,9 @@ void QtxGroupBox::update() updateTitle(); } +/*! + \return the recommended size for the widget +*/ QSize QtxGroupBox::sizeHint() const { QSize sz = QGroupBox::sizeHint(); @@ -190,6 +251,9 @@ QSize QtxGroupBox::sizeHint() const return QSize( QMAX( sz.width(), sw ), sz.height() ); } +/*! + \return the recommended minimum size for the widget +*/ QSize QtxGroupBox::minimumSizeHint() const { QSize sz = QGroupBox::minimumSizeHint(); @@ -209,6 +273,9 @@ QSize QtxGroupBox::minimumSizeHint() const return QSize( QMAX( sz.width(), sw ), sz.height() ); } +/*! + Custom event filter +*/ bool QtxGroupBox::eventFilter( QObject* obj, QEvent* e ) { QEvent::Type type = e->type(); @@ -220,6 +287,9 @@ bool QtxGroupBox::eventFilter( QObject* obj, QEvent* e ) return QGroupBox::eventFilter( obj, e ); } +/*! + Custom resize event filter +*/ void QtxGroupBox::resizeEvent( QResizeEvent* e ) { QGroupBox::resizeEvent( e ); @@ -227,6 +297,9 @@ void QtxGroupBox::resizeEvent( QResizeEvent* e ) updateTitle(); } +/*! + Custom child event filter +*/ void QtxGroupBox::childEvent( QChildEvent* e ) { if ( e->type() == QEvent::ChildInserted && e->child() == myContainer ) @@ -235,16 +308,25 @@ void QtxGroupBox::childEvent( QChildEvent* e ) QGroupBox::childEvent( e ); } +/*! + Event filter of custom items +*/ void QtxGroupBox::customEvent( QCustomEvent* ) { updateTitle(); } +/*! + On frame changed +*/ void QtxGroupBox::frameChanged() { updateTitle(); } +/*! + \return size of title +*/ QSize QtxGroupBox::titleSize() const { QSize sz( 0, 0 ); @@ -264,6 +346,9 @@ QSize QtxGroupBox::titleSize() const return QSize( w, h ); } +/*! + Updates title +*/ void QtxGroupBox::updateTitle() { if ( !myContainer ) diff --git a/src/Qtx/QtxIntSpinBox.cxx b/src/Qtx/QtxIntSpinBox.cxx index 35672e5ee..2e694cd18 100755 --- a/src/Qtx/QtxIntSpinBox.cxx +++ b/src/Qtx/QtxIntSpinBox.cxx @@ -24,6 +24,9 @@ #include #include +/*! + Constructor +*/ QtxIntSpinBox::QtxIntSpinBox( QWidget* parent, const char* name ) : QSpinBox( parent, name ), myCleared( false ), @@ -32,6 +35,9 @@ myBlocked( false ) connect( editor(), SIGNAL( textChanged( const QString& ) ), this, SLOT( onTextChanged( const QString& ) ) ); } +/*! + Constructor +*/ QtxIntSpinBox::QtxIntSpinBox( int min, int max, int step, QWidget* parent, const char* name ) : QSpinBox( min, max, step, parent, name ), myCleared( false ), @@ -40,15 +46,25 @@ myBlocked( false ) connect( editor(), SIGNAL( textChanged( const QString& ) ), this, SLOT( onTextChanged( const QString& ) ) ); } +/*! + Destructor +*/ QtxIntSpinBox::~QtxIntSpinBox() { } +/*! + \return true if spin box is cleared +*/ bool QtxIntSpinBox::isCleared() const { return myCleared; } +/*! + Changes cleared status of spin box + \param on - new status +*/ void QtxIntSpinBox::setCleared( const bool on ) { if ( myCleared == on ) @@ -58,6 +74,10 @@ void QtxIntSpinBox::setCleared( const bool on ) updateDisplay(); } +/*! + Changes value of spin box + \param val - new value of spin box +*/ void QtxIntSpinBox::setValue( int value ) { myCleared = false; @@ -65,6 +85,9 @@ void QtxIntSpinBox::setValue( int value ) QSpinBox::setValue( value ); } +/*! + Custom event filter +*/ bool QtxIntSpinBox::eventFilter( QObject* o, QEvent* e ) { if ( !myCleared || o != editor() || !editor()->text().stripWhiteSpace().isEmpty() ) @@ -83,6 +106,9 @@ bool QtxIntSpinBox::eventFilter( QObject* o, QEvent* e ) return QSpinBox::eventFilter( o, e ); } +/*! + Sets integer value by text in editor +*/ void QtxIntSpinBox::interpretText() { myCleared = false; @@ -90,6 +116,9 @@ void QtxIntSpinBox::interpretText() QSpinBox::interpretText(); } +/*! + Updates text of editor +*/ void QtxIntSpinBox::updateDisplay() { if ( myBlocked ) @@ -113,12 +142,18 @@ void QtxIntSpinBox::updateDisplay() myBlocked = block; } +/*! + Custom handler for leave event +*/ void QtxIntSpinBox::leaveEvent( QEvent* e ) { if ( !myCleared ) QSpinBox::leaveEvent( e ); } +/*! + Custom handler for wheel event +*/ void QtxIntSpinBox::wheelEvent( QWheelEvent* e ) { if ( !isEnabled() ) @@ -128,6 +163,9 @@ void QtxIntSpinBox::wheelEvent( QWheelEvent* e ) updateDisplay(); } +/*! + SLOT: called if text is changed +*/ void QtxIntSpinBox::onTextChanged( const QString& ) { if ( !myBlocked ) diff --git a/src/Qtx/QtxListAction.cxx b/src/Qtx/QtxListAction.cxx index 725120238..84fbed93b 100755 --- a/src/Qtx/QtxListAction.cxx +++ b/src/Qtx/QtxListAction.cxx @@ -46,10 +46,9 @@ static const char* list_arrow_icon[] = { }; /*! - Class: QtxListAction::ToolButton - Level: Internal + \class QtxListAction::ToolButton + Custom tool button */ - class QtxListAction::ToolButton : public QToolButton { public: @@ -62,6 +61,9 @@ private: QtxListAction* myAction; }; +/*! + Constructor +*/ QtxListAction::ToolButton::ToolButton( QtxListAction* a, QWidget* parent, const char* name ) : QToolButton( parent, name ), myAction( a ) @@ -69,12 +71,18 @@ myAction( a ) setIconSet( QPixmap( list_arrow_icon ) ); } +/*! + Destructor +*/ QtxListAction::ToolButton::~ToolButton() { if ( myAction ) myAction->controlDeleted( this ); } +/*! + \return the recommended size for the widget +*/ QSize QtxListAction::ToolButton::sizeHint() const { QSize sz = iconSet().pixmap().size(); @@ -82,16 +90,9 @@ QSize QtxListAction::ToolButton::sizeHint() const } /*! - Class: QtxListAction - Level: Public + Constructs an list action with given parent and name. If toggle is true the + action will be a toggle action, otherwise it will be a command action. */ - -/*! - Name: QtxListAction [public] - Desc: Constructs an list action with given parent and name. If toggle is true the - action will be a toggle action, otherwise it will be a command action. -*/ - QtxListAction::QtxListAction( QObject* parent, const char* name, bool toggle ) : QtxAction( parent, name, toggle ), myFrame( 0 ), @@ -102,12 +103,11 @@ myRaise( false ) } /*! - Name: QtxListAction [public] - Desc: This constructor creates an action with the following properties: the - description text, the icon or iconset icon, the menu text and keyboard - accelerator. It is a child of given parent and named specified name. - If toggle is true the action will be a toggle action, otherwise it will - be a command action. + This constructor creates an action with the following properties: the + description text, the icon or iconset icon, the menu text and keyboard + accelerator. It is a child of given parent and named specified name. + If toggle is true the action will be a toggle action, otherwise it will + be a command action. */ QtxListAction::QtxListAction( const QString& text, const QIconSet& icon, @@ -122,11 +122,10 @@ myRaise( false ) } /*! - Name: QtxListAction [public] - Desc: This constructor creates an action with the following properties: the - description text, the menu text and keyboard accelerator. It is a child - of given parent and named specified name. If toggle is true the action - will be a toggle action, otherwise it will be a command action. + This constructor creates an action with the following properties: the + description text, the menu text and keyboard accelerator. It is a child + of given parent and named specified name. If toggle is true the action + will be a toggle action, otherwise it will be a command action. */ QtxListAction::QtxListAction( const QString& text, const QString& menuText, @@ -140,8 +139,7 @@ myRaise( false ) } /*! - Name: ~QtxListAction [virtual public] - Desc: Destructor. + Destructor. */ QtxListAction::~QtxListAction() @@ -173,6 +171,9 @@ void QtxListAction::setPopupMode( const int mode ) myMode = mode; } +/*! + \return list of names +*/ QStringList QtxListAction::names() const { QStringList lst; @@ -505,6 +506,9 @@ void QtxListAction::onExpand( bool on ) myFrame->hide(); } +/*! + SLOT: called when frame is hidden +*/ void QtxListAction::onHided() { for ( ButtonsMap::Iterator bit = myButtons.begin(); bit != myButtons.end(); ++bit ) @@ -624,12 +628,10 @@ void QtxListAction::controlDeleted( QWidget* wid ) } } -/********************************************************************** -** Class: QtxListFrame -** Descr: Frame for the list of actions -** Level: Internal -***********************************************************************/ - +/*! + \class QtxListFrame + Frame for the list of actions +*/ class QtxListFrame::ScrollEvent : public QCustomEvent { public: @@ -693,6 +695,9 @@ myScrollBlock( false ) setFrameStyle( Panel | Raised ); } +/*! + Destructor +*/ QtxListFrame::~QtxListFrame() { if ( myAction ) @@ -709,6 +714,11 @@ void QtxListFrame::clear() setNames( myNames ); } +/*! + Adds a names to the list. Truncates the name to fit to the frame width. + Use QtxListAction::setMaxLineChar( int ) to set the width in characters. [ public ] +*/ + void QtxListFrame::addNames( const QStringList& names ) { for ( QStringList::ConstIterator it = names.begin(); it != names.end(); ++it ) @@ -754,6 +764,9 @@ void QtxListFrame::setNames( const QStringList& names ) } } +/*! + \return list of names +*/ const QStringList QtxListFrame::names() const { return myNames; @@ -822,6 +835,10 @@ void QtxListFrame::updateComment() myComment->setText( com ); } +/*! + Sets owner + \param wo - new owner +*/ void QtxListFrame::setOwner( QWidget* wo ) { myOwner = wo; @@ -1005,6 +1022,9 @@ bool QtxListFrame::handleMouseEvent( QObject* o, QMouseEvent* e ) return true; } +/*! + Custom event filter +*/ bool QtxListFrame::event( QEvent* e ) { if ( e->type() != (int)ScrollEvent::Scroll ) @@ -1089,6 +1109,9 @@ void QtxListFrame::setSelected( const int lastSel ) updateComment(); } +/*! + return number of selected items +*/ int QtxListFrame::selected() const { uint sel = 0; diff --git a/src/Qtx/QtxListAction.h b/src/Qtx/QtxListAction.h index 30c85acc0..d285d7ab2 100755 --- a/src/Qtx/QtxListAction.h +++ b/src/Qtx/QtxListAction.h @@ -118,11 +118,9 @@ private: friend class QtxListFrame; }; -/************************************* -** Class: QtxListFrame -** Level: Internal -*************************************/ - +/*! + \class QtxListFrame +*/ class QtxListFrame : public QFrame { Q_OBJECT diff --git a/src/Qtx/QtxListBox.cxx b/src/Qtx/QtxListBox.cxx index 6d2ce0cd9..47cff9d1d 100755 --- a/src/Qtx/QtxListBox.cxx +++ b/src/Qtx/QtxListBox.cxx @@ -24,6 +24,9 @@ #include #include +/*! + Constructor +*/ QtxListBox::QtxListBox( QWidget* parent, const char* name, WFlags f ) : QListBox( parent, name, f ), myEditor( 0 ), @@ -36,15 +39,25 @@ myModifEnabled( true ) this, SLOT( onContentsMoving( int, int ) ) ); } +/*! + Destructor +*/ QtxListBox::~QtxListBox() { } +/*! + \return true if editing is enabled +*/ bool QtxListBox::isEditEnabled() const { return myEditState; } +/*! + Enables/disables editing + \param on - new state +*/ void QtxListBox::setEditEnabled( bool on ) { if ( isEditEnabled() == on ) @@ -56,36 +69,66 @@ void QtxListBox::setEditEnabled( bool on ) endEdition( defaultEditAction() ); } +/*! + \return default edit action + \sa setDefaultEditAction() +*/ bool QtxListBox::defaultEditAction() const { return myEditDefault; } +/*! + Changes default edit action. + Pressing of ENTER button always accepts new value of edited item. + But other ways, such as focus out or edition of other item accepts + new value of edited item only if "default edit action" is true + \param def - new value +*/ void QtxListBox::setDefaultEditAction( bool def ) { myEditDefault = def; } +/*! + \return modification enabled state + \sa setModificationEnabled() +*/ bool QtxListBox::isModificationEnabled() const { return myModifEnabled; } +/*! + Changes "modification enabled" state + If it is true, then pressing of CTRL + { Up, Down, Home, End } allows move items in list + \param on - new state +*/ void QtxListBox::setModificationEnabled( bool on ) { myModifEnabled = on; } +/*! + \return current edited item +*/ QListBoxItem* QtxListBox::editedItem() const { return item( editedIndex() ); } +/*! + \return current edited index +*/ int QtxListBox::editedIndex() const { return myEditIndex; } +/*! + Starts edition of item + \param idx - index of item +*/ void QtxListBox::startEdition( const int idx ) { if ( idx < 0 || editedIndex() == idx || !isEditEnabled() ) @@ -108,11 +151,19 @@ void QtxListBox::startEdition( const int idx ) ed->setFocus(); } +/*! + Starts edition of item + \param item - item to be edited +*/ void QtxListBox::startEdition( const QListBoxItem* item ) { startEdition( index( item ) ); } +/*! + Finishes edition of item + \param action - if it is true, then new values must be accepted +*/ void QtxListBox::endEdition( const bool action ) { int idx = editedIndex(); @@ -141,6 +192,10 @@ void QtxListBox::endEdition( const bool action ) } } +/*! + Ensures that the item is visible. + \param idx - index of item +*/ void QtxListBox::ensureItemVisible( const int idx ) { if ( idx < 0 ) @@ -152,11 +207,18 @@ void QtxListBox::ensureItemVisible( const int idx ) setTopItem( idx ); } +/*! + Ensures that the item is visible. + \param item - item to be made visible +*/ void QtxListBox::ensureItemVisible( const QListBoxItem* item ) { ensureItemVisible( index( item ) ); } +/*! + \return validator of item editor +*/ const QValidator* QtxListBox::validator() const { const QValidator* v = 0; @@ -165,28 +227,48 @@ const QValidator* QtxListBox::validator() const return v; } +/*! + Removes validator of item editor +*/ void QtxListBox::clearValidator() { if ( editor() ) editor()->clearValidator(); } +/*! + Changes validator of item editor + \param v - new validator +*/ void QtxListBox::setValidator( const QValidator* v ) { if ( editor() ) editor()->setValidator( v ); } +/*! + Moves item to top + \param idx - index of item +*/ void QtxListBox::moveItemToTop( const int idx ) { moveItem( idx, -idx ); } +/*! + Moves item to bottom + \param idx - index of item +*/ void QtxListBox::moveItemToBottom( const int idx ) { moveItem( idx, count() - idx ); } +/*! + Moves item + \param idx - index of item + \param step - changing of position +*/ void QtxListBox::moveItem( const int idx, const int step ) { QListBoxItem* i = item( idx ); @@ -210,6 +292,10 @@ void QtxListBox::moveItem( const int idx, const int step ) emit itemMoved( idx, pos ); } +/*! + Inserts empty item + \param i - position of item (if it is less than 0, then current position is used) +*/ void QtxListBox::createItem( const int i ) { if ( !isEditEnabled() ) @@ -224,6 +310,10 @@ void QtxListBox::createItem( const int i ) startEdition( idx ); } +/*! + Removes item + \param i - position of item (if it is less than 0, then current position is used) +*/ void QtxListBox::deleteItem( const int i ) { if ( !isEditEnabled() ) @@ -240,6 +330,10 @@ void QtxListBox::deleteItem( const int i ) updateEditor(); } +/*! + Scrolls the content so that the point is in the top-left corner. + \param x, y - point co-ordinates +*/ void QtxListBox::setContentsPos( int x, int y ) { QListBox::setContentsPos( x, y ); @@ -247,6 +341,9 @@ void QtxListBox::setContentsPos( int x, int y ) updateEditor(); } +/*! + Custom event filter, performs finish of edition on focus out, escape/return/enter pressing +*/ bool QtxListBox::eventFilter( QObject* o, QEvent* e ) { if ( editor() == o ) @@ -267,6 +364,10 @@ bool QtxListBox::eventFilter( QObject* o, QEvent* e ) return QListBox::eventFilter( o, e ); } +/*! + Custom key press event handler + Allows to move items by CTRL + { Up, Down, Home, End } +*/ void QtxListBox::keyPressEvent( QKeyEvent* e ) { if ( e->key() == Key_Up && e->state() & ControlButton && isModificationEnabled() ) @@ -285,6 +386,9 @@ void QtxListBox::keyPressEvent( QKeyEvent* e ) QListBox::keyPressEvent( e ); } +/*! + Custom resize event handler +*/ void QtxListBox::viewportResizeEvent( QResizeEvent* e ) { QListBox::viewportResizeEvent( e ); @@ -292,6 +396,9 @@ void QtxListBox::viewportResizeEvent( QResizeEvent* e ) updateEditor(); } +/*! + Custom mouse double click event handler +*/ void QtxListBox::mouseDoubleClickEvent( QMouseEvent* e ) { if ( isEditEnabled() ) @@ -300,11 +407,17 @@ void QtxListBox::mouseDoubleClickEvent( QMouseEvent* e ) QListBox::mouseDoubleClickEvent( e ); } +/*! + Updates editor on contents moving +*/ void QtxListBox::onContentsMoving( int, int ) { updateEditor(); } +/*! + \return item editor +*/ QLineEdit* QtxListBox::editor() const { if ( !myEditor ) @@ -315,6 +428,9 @@ QLineEdit* QtxListBox::editor() const return myEditor; } +/*! + Creates item editor +*/ void QtxListBox::createEditor() { if ( myEditor ) @@ -332,6 +448,9 @@ void QtxListBox::createEditor() addChild( myEditor ); } +/*! + Updates item editor +*/ void QtxListBox::updateEditor() { if ( !editedItem() || !editor() ) diff --git a/src/Qtx/QtxListOfOperations.cxx b/src/Qtx/QtxListOfOperations.cxx index 1be04a75d..39eb5f1a2 100644 --- a/src/Qtx/QtxListOfOperations.cxx +++ b/src/Qtx/QtxListOfOperations.cxx @@ -20,26 +20,25 @@ #include "QtxListOfOperations.h" #include -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Constructor +*/ QtxListOfOperations::QtxListOfOperations() { } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Destructor +*/ QtxListOfOperations::~QtxListOfOperations() { } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return fills list with brackets symbols + \param list - list to be filled + \param open - if it is true, it is necessary to fill with open brackets otherwise with close +*/ void QtxListOfOperations::bracketsList( QStringList& list, bool open ) const { OperationSetsIterator anIt = mySets.begin(), @@ -57,10 +56,9 @@ void QtxListOfOperations::bracketsList( QStringList& list, bool open ) const } } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Fills list with operation names +*/ void QtxListOfOperations::opersList( QStringList& list ) const { OperationSetsIterator anIt = mySets.begin(), @@ -78,10 +76,9 @@ void QtxListOfOperations::opersList( QStringList& list ) const } } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Create some value by it's string representation +*/ bool QtxListOfOperations::createValue( const QString& str, QtxValue& val ) const { bool ok; @@ -96,10 +93,9 @@ bool QtxListOfOperations::createValue( const QString& str, QtxValue& val ) const return ok; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return priority of operation +*/ int QtxListOfOperations::prior( const QString& op, bool isBin ) const { OperationSetsIterator anIt = mySets.begin(), @@ -117,10 +113,12 @@ int QtxListOfOperations::prior( const QString& op, bool isBin ) const return prior>0 ? prior : 0; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return whether values with passed types are valid for arguments of operation + \param op - name of operation + \param t1 - type of first argument + \param t2 - type of second argument +*/ QtxParser::Error QtxListOfOperations::isValid( const QString& op, const QVariant::Type t1, const QVariant::Type t2 ) const @@ -137,10 +135,13 @@ QtxParser::Error QtxListOfOperations::isValid( const QString& op, return err; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Calculates result of operation + \return one of error states + \param op - name of operation + \param v1 - first operation argument (must be used also to store result) + \param v2 - second operation argument +*/ QtxParser::Error QtxListOfOperations::calculate( const QString& op, QtxValue& v1, QtxValue& v2 ) const @@ -169,19 +170,18 @@ QtxParser::Error QtxListOfOperations::calculate( const QString& op, return QtxParser::InvalidOperation; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Clears list of operations +*/ void QtxListOfOperations::clear() { mySets.clear(); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return true if list contains operations + \param name - name of operation +*/ bool QtxListOfOperations::has( const QString& name ) const { OperationSetsIterator anIt = mySets.begin(), @@ -192,30 +192,37 @@ bool QtxListOfOperations::has( const QString& name ) const return false; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Appends operations to list + \param name - name of operations + \param oper - operations + \param prior - additional prior +*/ void QtxListOfOperations::append( const QString& name, QtxOperations* oper, int prior ) { insert( name, oper, prior ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Prepends operations to list + \param name - name of operations + \param oper - operations + \param prior - additional prior +*/ void QtxListOfOperations::prepend( const QString& name, QtxOperations* oper, int prior ) { insert( name, oper, prior, 0 ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Inserts operations to list + \param name - name of operations + \param oper - operations + \param prior - additional prior + \param pos - insert position +*/ void QtxListOfOperations::insert( const QString& name, QtxOperations* oper, int prior, int pos ) { @@ -232,10 +239,10 @@ void QtxListOfOperations::insert( const QString& name, QtxOperations* oper, mySets.insert( mySets.at( pos ), op ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Removes operations from list + \param name - name of operations +*/ void QtxListOfOperations::remove( const QString& name ) { OperationSets::iterator anIt = mySets.begin(), @@ -248,19 +255,18 @@ void QtxListOfOperations::remove( const QString& name ) } } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return count of operations in list +*/ int QtxListOfOperations::count() const { return mySets.count(); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return operations by name + \name - name of operations +*/ QtxOperations* QtxListOfOperations::operations( const QString& name ) const { OperationSetsIterator anIt = mySets.begin(), diff --git a/src/Qtx/QtxListOfOperations.h b/src/Qtx/QtxListOfOperations.h index 3e1a711f1..05a737389 100644 --- a/src/Qtx/QtxListOfOperations.h +++ b/src/Qtx/QtxListOfOperations.h @@ -30,10 +30,15 @@ #endif -//================================================================ -// Class : -// Purpose : -//================================================================ +/*! + Class: QtxListOfOperations + + This class provides special variant of QtxOperations. It contains list of QtxOperations* with + fixed order. When it is necessary to calculate operation or get it's priority, this operation is + being found starting from first item. It makes possible to create unions of operations. Every QtxOperations* + has priority, which is added to priority of operation, so that it makes possible to increase priority of + whole group of operations +*/ class QTX_EXPORT QtxListOfOperations : public QtxOperations { public: diff --git a/src/Qtx/QtxListResourceEdit.cxx b/src/Qtx/QtxListResourceEdit.cxx index 038e189b7..bc3bcccb6 100644 --- a/src/Qtx/QtxListResourceEdit.cxx +++ b/src/Qtx/QtxListResourceEdit.cxx @@ -46,11 +46,9 @@ #include "QtxComboBox.h" #include "QtxDirListEditor.h" -/* - Class: QtxListResourceEdit - Descr: GUI implementation of QtxResourceEdit - manager of resources +/*! + Constructor */ - QtxListResourceEdit::QtxListResourceEdit( QtxResourceMgr* mgr, QWidget* parent ) : QFrame( parent ), QtxResourceEdit( mgr ) @@ -76,10 +74,19 @@ QtxResourceEdit( mgr ) updateState(); } +/*! + Destructor +*/ QtxListResourceEdit::~QtxListResourceEdit() { } +/*! + Sets value to widget + \param id - id of widget + \param prop - name of resource + \param val - value of resource +*/ void QtxListResourceEdit::setItemProperty( const int id, const QString& prop, const QVariant& val ) { Item* i = item( id ); @@ -96,6 +103,9 @@ void QtxListResourceEdit::setItemProperty( const int id, const QString& prop, co updateVisible(); } +/*! + SLOT: called if main list selection changed, raises resource group widgets +*/ void QtxListResourceEdit::onSelectionChanged() { QString title = myList->text( myList->index( myList->selectedItem() ) ); @@ -115,6 +125,10 @@ void QtxListResourceEdit::onSelectionChanged() myStack->raiseWidget( i->id() ); } +/*! + Custom activity after item addition + \param i - added item +*/ void QtxListResourceEdit::itemAdded( QtxResourceEdit::Item* i ) { if ( !i ) @@ -127,6 +141,10 @@ void QtxListResourceEdit::itemAdded( QtxResourceEdit::Item* i ) updateVisible(); } +/*! + Creates and \return category + \param title - category title +*/ QtxResourceEdit::Item* QtxListResourceEdit::createItem( const QString& title, const int ) { Item* i = item( title, -1 ); @@ -146,6 +164,10 @@ QtxResourceEdit::Item* QtxListResourceEdit::createItem( const QString& title, co return category; } +/*! + Emits signal about resource changing + \param map - map of changed resources +*/ void QtxListResourceEdit::changedResources( const QMap& map ) { QMap idMap; @@ -163,6 +185,9 @@ void QtxListResourceEdit::changedResources( const QMap& map ) emit resourcesChanged( idMap ); } +/*! + Updates widgets with accordance with main list selection +*/ void QtxListResourceEdit::updateState() { if ( myList->selectedItem() && myStack->visibleWidget() ) @@ -173,6 +198,9 @@ void QtxListResourceEdit::updateState() myList->setShown( myList->count() > 1 ); } +/*! + Updates visibility state +*/ void QtxListResourceEdit::updateVisible() { QPtrList items; @@ -201,11 +229,9 @@ void QtxListResourceEdit::updateVisible() updateState(); } -/* - Class: QtxListResourceEdit::Category - Descr: GUI implementation of preferences category. +/*! + Constructor */ - QtxListResourceEdit::Category::Category( QtxListResourceEdit* edit, QWidget* parent ) : QFrame( parent ), Item( edit ) @@ -226,28 +252,47 @@ Item( edit ) updateState(); } +/*! + Destructor +*/ QtxListResourceEdit::Category::~Category() { } +/*! + \return true if it is empty +*/ bool QtxListResourceEdit::Category::isEmpty() const { return Item::isEmpty() && myInfo->text().isEmpty(); } +/*! + \return category type +*/ int QtxListResourceEdit::Category::type() const { return -1; } +/*! + Default empty implementation of resources storing +*/ void QtxListResourceEdit::Category::store() { } +/*! + Default empty implementation of resources retrieving +*/ void QtxListResourceEdit::Category::retrieve() { } +/*! + \return value of property + \param prop - property name +*/ QVariant QtxListResourceEdit::Category::property( const QString& prop ) const { QVariant var; @@ -256,6 +301,11 @@ QVariant QtxListResourceEdit::Category::property( const QString& prop ) const return var; } +/*! + Sets property value + \param name - name of property + \param var - value of property +*/ void QtxListResourceEdit::Category::setProperty( const QString& name, const QVariant& var ) { QVariant prop = var; @@ -268,6 +318,10 @@ void QtxListResourceEdit::Category::setProperty( const QString& name, const QVar updateState(); } +/*! + Creates new tab + \param title - name of tab +*/ QtxResourceEdit::Item* QtxListResourceEdit::Category::createItem( const QString& title, const int ) { Item* i = item( title, id() ); @@ -282,6 +336,9 @@ QtxResourceEdit::Item* QtxListResourceEdit::Category::createItem( const QString& return tab; } +/*! + Updates category +*/ void QtxListResourceEdit::Category::updateState() { if ( myTabs->count() ) @@ -295,11 +352,10 @@ void QtxListResourceEdit::Category::updateState() myInfo->hide(); } -/* - Class: QtxListResourceEdit::Tab - Descr: GUI implementation of resources tab. -*/ +/*! + Constructor +*/ QtxListResourceEdit::Tab::Tab( QtxResourceEdit* edit, Item* pItem, QWidget* parent ) : QFrame( parent ), Item( edit, pItem ) @@ -312,23 +368,38 @@ Item( edit, pItem ) main->addStretch( 1 ); } +/*! + Destructor +*/ QtxListResourceEdit::Tab::~Tab() { } +/*! + \return tab type +*/ int QtxListResourceEdit::Tab::type() const { return -1; } +/*! + Default empty implementation of resources storing +*/ void QtxListResourceEdit::Tab::store() { } +/*! + Default empty implementation of resources retrieving +*/ void QtxListResourceEdit::Tab::retrieve() { } +/*! + Delayed initialization of a widget +*/ void QtxListResourceEdit::Tab::polish() { QFrame::polish(); @@ -336,6 +407,10 @@ void QtxListResourceEdit::Tab::polish() adjustLabels(); } +/*! + Creates new group + \param title - name of group +*/ QtxResourceEdit::Item* QtxListResourceEdit::Tab::createItem( const QString& title, const int ) { Item* i = item( title, id() ); @@ -347,6 +422,9 @@ QtxResourceEdit::Item* QtxListResourceEdit::Tab::createItem( const QString& titl return group; } +/*! + Adjusts sizes of labels +*/ void QtxListResourceEdit::Tab::adjustLabels() { QObjectList* labels = queryList( "QLabel" ); @@ -373,34 +451,48 @@ void QtxListResourceEdit::Tab::adjustLabels() } } -/* - Class: QtxListResourceEdit::Group - Descr: GUI implementation of resources group. +/*! + Constructor */ - QtxListResourceEdit::Group::Group( const QString& title, QtxResourceEdit* edit, Item* pItem, QWidget* parent ) : QGroupBox( 2, Qt::Horizontal, title, parent ), Item( edit, pItem ) { } +/*! + Destructor +*/ QtxListResourceEdit::Group::~Group() { } +/*! + \return group type +*/ int QtxListResourceEdit::Group::type() const { return -1; } +/*! + Default empty implementation of resources storing +*/ void QtxListResourceEdit::Group::store() { } +/*! + Default empty implementation of resources retrieving +*/ void QtxListResourceEdit::Group::retrieve() { } +/*! + \return value of property + \param prop - property name +*/ QVariant QtxListResourceEdit::Group::property( const QString& prop ) const { QVariant var; @@ -413,6 +505,11 @@ QVariant QtxListResourceEdit::Group::property( const QString& prop ) const return var; } +/*! + Sets property value + \param name - name of property + \param var - value of property +*/ void QtxListResourceEdit::Group::setProperty( const QString& name, const QVariant& var ) { QVariant prop = var; @@ -435,12 +532,21 @@ void QtxListResourceEdit::Group::setProperty( const QString& name, const QVarian } } +/*! + Sets title of group + \param title - new title of group +*/ void QtxListResourceEdit::Group::setTitle( const QString& title ) { Item::setTitle( title ); QGroupBox::setTitle( title ); } +/*! + Creates new item + \param title - title of new item + \type - type of new item +*/ QtxResourceEdit::Item* QtxListResourceEdit::Group::createItem( const QString& title, const int type ) { Item* item = 0; @@ -491,11 +597,9 @@ QtxResourceEdit::Item* QtxListResourceEdit::Group::createItem( const QString& ti return item; } -/* - Class: QtxListResourceEdit::PrefItem - Descr: Base class for preferences items. +/*! + Constructor */ - QtxListResourceEdit::PrefItem::PrefItem( const int type, QtxResourceEdit* edit, Item* pi, QWidget* parent ) : QHBox( parent ), Item( edit, pi ), @@ -504,48 +608,62 @@ myType( type ) setSpacing( 5 ); } +/*! + Destructor +*/ QtxListResourceEdit::PrefItem::~PrefItem() { } +/*! + \return preference item type +*/ int QtxListResourceEdit::PrefItem::type() const { return myType; } +/*! + Doesn't create item, \return 0 by default +*/ QtxResourceEdit::Item* QtxListResourceEdit::PrefItem::createItem( const QString&, const int ) { return 0; } -/* - Class: QtxListResourceEdit::Spacer - Descr: GUI implementation of resources spacer. +/*! + Constructor */ - QtxListResourceEdit::Spacer::Spacer( QtxResourceEdit* edit, Item* pItem, QWidget* parent ) : PrefItem( Space, edit, pItem, parent ) { setSizePolicy( QSizePolicy( QSizePolicy::Expanding, QSizePolicy::Fixed ) ); } +/*! + Destructor +*/ QtxListResourceEdit::Spacer::~Spacer() { } +/*! + Default empty implementation of resources storing +*/ void QtxListResourceEdit::Spacer::store() { } +/*! + Default empty implementation of resources retrieving +*/ void QtxListResourceEdit::Spacer::retrieve() { } -/* - Class: QtxListResourceEdit::SelectItem - Descr: GUI implementation of resources list item. +/*! + Constructor */ - QtxListResourceEdit::SelectItem::SelectItem( const QString& title, QtxResourceEdit* edit, Item* pItem, QWidget* parent ) : PrefItem( Selector, edit, pItem, parent ) @@ -555,10 +673,16 @@ QtxListResourceEdit::SelectItem::SelectItem( const QString& title, QtxResourceEd myList->setSizePolicy( QSizePolicy( QSizePolicy::Expanding, QSizePolicy::Fixed ) ); } +/*! + Destructor +*/ QtxListResourceEdit::SelectItem::~SelectItem() { } +/*! + Stores value to resource manager +*/ void QtxListResourceEdit::SelectItem::store() { int idx = myList->currentItem(); @@ -566,6 +690,9 @@ void QtxListResourceEdit::SelectItem::store() setInteger( myIndex[idx] ); } +/*! + Retrieve value to resource manager +*/ void QtxListResourceEdit::SelectItem::retrieve() { int id = getInteger( -1 ); @@ -580,6 +707,10 @@ void QtxListResourceEdit::SelectItem::retrieve() myList->setCurrentItem( idx ); } +/*! + \return value of property + \param prop - property name +*/ QVariant QtxListResourceEdit::SelectItem::property( const QString& name ) const { QVariant val; @@ -600,6 +731,11 @@ QVariant QtxListResourceEdit::SelectItem::property( const QString& name ) const return val; } +/*! + Sets property value + \param name - name of property + \param var - value of property +*/ void QtxListResourceEdit::SelectItem::setProperty( const QString& name, const QVariant& val ) { if ( name == QString( "strings" ) ) @@ -608,6 +744,10 @@ void QtxListResourceEdit::SelectItem::setProperty( const QString& name, const QV setIndexes( val ); } +/*! + Sets property "strings" - items for selection in combo box + \param var - must be string list: list of items +*/ void QtxListResourceEdit::SelectItem::setStrings( const QVariant& var ) { if ( var.type() != QVariant::StringList ) @@ -616,6 +756,10 @@ void QtxListResourceEdit::SelectItem::setStrings( const QVariant& var ) setStrings( var.toStringList() ); } +/*! + Sets property "indexes" - corresponding indices of items in combo box + \param var - must be list of integer variants: list of indices +*/ void QtxListResourceEdit::SelectItem::setIndexes( const QVariant& var ) { if ( var.type() != QVariant::List ) @@ -631,12 +775,20 @@ void QtxListResourceEdit::SelectItem::setIndexes( const QVariant& var ) setIndexes( lst ); } +/*! + Sets property "strings" - items for selection in combo box + \param lst - list of items +*/ void QtxListResourceEdit::SelectItem::setStrings( const QStringList& lst ) { myList->clear(); myList->insertStringList( lst ); } +/*! + Sets property "indexes" - corresponding indices of items in combo box + \param var - list of indices +*/ void QtxListResourceEdit::SelectItem::setIndexes( const QValueList& lst ) { myIndex.clear(); @@ -646,11 +798,9 @@ void QtxListResourceEdit::SelectItem::setIndexes( const QValueList& lst ) myIndex.insert( idx, *it ); } -/* - Class: QtxListResourceEdit::StateItem - Descr: GUI implementation of resources bool item. +/*! + Constructor */ - QtxListResourceEdit::StateItem::StateItem( const QString& title, QtxResourceEdit* edit, Item* pItem, QWidget* parent ) : PrefItem( Bool, edit, pItem, parent ) @@ -659,25 +809,32 @@ QtxListResourceEdit::StateItem::StateItem( const QString& title, QtxResourceEdit myState->setSizePolicy( QSizePolicy( QSizePolicy::Expanding, QSizePolicy::Fixed ) ); } +/*! + Destructor +*/ QtxListResourceEdit::StateItem::~StateItem() { } +/*! + Stores value to resource manager +*/ void QtxListResourceEdit::StateItem::store() { setBoolean( myState->isChecked() ); } +/*! + Retrieve value to resource manager +*/ void QtxListResourceEdit::StateItem::retrieve() { myState->setChecked( getBoolean() ); } -/* - Class: QtxListResourceEdit::StringItem - Descr: GUI implementation of resources string item. +/*! + Constructor */ - QtxListResourceEdit::StringItem::StringItem( const QString& title, QtxResourceEdit* edit, Item* pItem, QWidget* parent ) : PrefItem( String, edit, pItem, parent ) @@ -687,25 +844,32 @@ QtxListResourceEdit::StringItem::StringItem( const QString& title, QtxResourceEd myString->setSizePolicy( QSizePolicy( QSizePolicy::Expanding, QSizePolicy::Fixed ) ); } +/*! + Destructor +*/ QtxListResourceEdit::StringItem::~StringItem() { } +/*! + Stores value to resource manager +*/ void QtxListResourceEdit::StringItem::store() { setString( myString->text() ); } +/*! + Retrieve value to resource manager +*/ void QtxListResourceEdit::StringItem::retrieve() { myString->setText( getString() ); } -/* - Class: QtxListResourceEdit::IntegerEditItem - Descr: GUI implementation of resources integer item. +/*! + Constructor */ - QtxListResourceEdit::IntegerEditItem::IntegerEditItem( const QString& title, QtxResourceEdit* edit, Item* pItem, QWidget* parent ) : PrefItem( Integer, edit, pItem, parent ) { @@ -715,25 +879,32 @@ QtxListResourceEdit::IntegerEditItem::IntegerEditItem( const QString& title, Qtx myInteger->setSizePolicy( QSizePolicy( QSizePolicy::Expanding, QSizePolicy::Fixed ) ); } +/*! + Destructor +*/ QtxListResourceEdit::IntegerEditItem::~IntegerEditItem() { } +/*! + Stores value to resource manager +*/ void QtxListResourceEdit::IntegerEditItem::store() { setString( myInteger->text() ); } +/*! + Retrieve value to resource manager +*/ void QtxListResourceEdit::IntegerEditItem::retrieve() { myInteger->setText( getString() ); } -/* - Class: QtxListResourceEdit::IntegerSpinItem - Descr: GUI implementation of resources integer item. +/*! + Constructor */ - QtxListResourceEdit::IntegerSpinItem::IntegerSpinItem( const QString& title, QtxResourceEdit* edit, Item* pItem, QWidget* parent ) : PrefItem( IntSpin, edit, pItem, parent ) { @@ -742,20 +913,33 @@ QtxListResourceEdit::IntegerSpinItem::IntegerSpinItem( const QString& title, Qtx myInteger->setSizePolicy( QSizePolicy( QSizePolicy::Expanding, QSizePolicy::Fixed ) ); } +/*! + Destructor +*/ QtxListResourceEdit::IntegerSpinItem::~IntegerSpinItem() { } +/*! + Stores value to resource manager +*/ void QtxListResourceEdit::IntegerSpinItem::store() { setInteger( myInteger->value() ); } +/*! + Retrieve value to resource manager +*/ void QtxListResourceEdit::IntegerSpinItem::retrieve() { myInteger->setValue( getInteger() ); } +/*! + \return value of property + \param prop - property name +*/ QVariant QtxListResourceEdit::IntegerSpinItem::property( const QString& name ) const { QVariant var; @@ -774,6 +958,11 @@ QVariant QtxListResourceEdit::IntegerSpinItem::property( const QString& name ) c return var; } +/*! + Sets property value + \param name - name of property + \param var - value of property +*/ void QtxListResourceEdit::IntegerSpinItem::setProperty( const QString& name, const QVariant& var ) { QVariant prop = var; @@ -792,11 +981,9 @@ void QtxListResourceEdit::IntegerSpinItem::setProperty( const QString& name, con myInteger->setSuffix( prop.toString() ); } -/* - Class: QtxListResourceEdit::DoubleEditItem - Descr: GUI implementation of resources string item. +/*! + Constructor */ - QtxListResourceEdit::DoubleEditItem::DoubleEditItem( const QString& title, QtxResourceEdit* edit, Item* pItem, QWidget* parent ) : PrefItem( Double, edit, pItem, parent ) @@ -807,25 +994,32 @@ QtxListResourceEdit::DoubleEditItem::DoubleEditItem( const QString& title, QtxRe myDouble->setSizePolicy( QSizePolicy( QSizePolicy::Expanding, QSizePolicy::Fixed ) ); } +/*! + Destructor +*/ QtxListResourceEdit::DoubleEditItem::~DoubleEditItem() { } +/*! + Stores value to resource manager +*/ void QtxListResourceEdit::DoubleEditItem::store() { setString( myDouble->text() ); } +/*! + Retrieve value to resource manager +*/ void QtxListResourceEdit::DoubleEditItem::retrieve() { myDouble->setText( getString() ); } -/* - Class: QtxListResourceEdit::DoubleSpinItem - Descr: GUI implementation of resources double item. +/*! + Constructor */ - QtxListResourceEdit::DoubleSpinItem::DoubleSpinItem( const QString& title, QtxResourceEdit* edit, Item* pItem, QWidget* parent ) : PrefItem( DblSpin, edit, pItem, parent ) @@ -835,20 +1029,33 @@ QtxListResourceEdit::DoubleSpinItem::DoubleSpinItem( const QString& title, QtxRe myDouble->setSizePolicy( QSizePolicy( QSizePolicy::Expanding, QSizePolicy::Fixed ) ); } +/*! + Destructor +*/ QtxListResourceEdit::DoubleSpinItem::~DoubleSpinItem() { } +/*! + Stores value to resource manager +*/ void QtxListResourceEdit::DoubleSpinItem::store() { setDouble( myDouble->value() ); } +/*! + Retrieve value to resource manager +*/ void QtxListResourceEdit::DoubleSpinItem::retrieve() { myDouble->setValue( getDouble() ); } +/*! + \return value of property + \param prop - property name +*/ QVariant QtxListResourceEdit::DoubleSpinItem::property( const QString& name ) const { QVariant var; @@ -869,6 +1076,11 @@ QVariant QtxListResourceEdit::DoubleSpinItem::property( const QString& name ) co return var; } +/*! + Sets property value + \param name - name of property + \param var - value of property +*/ void QtxListResourceEdit::DoubleSpinItem::setProperty( const QString& name, const QVariant& var ) { QVariant prop = var; @@ -889,15 +1101,17 @@ void QtxListResourceEdit::DoubleSpinItem::setProperty( const QString& name, cons myDouble->setSuffix( prop.toString() ); } -/* - Class: QtxListResourceEdit::ColorItem - Descr: GUI implementation of resources color item. +/*! + Constructor */ - QtxListResourceEdit::ColorItem::ColorItem( const QString& title, QtxResourceEdit* edit, Item* pItem, QWidget* parent ) : PrefItem( Color, edit, pItem, parent ) { + /*! + \class QtxListResourceEdit::ColorItem::ColorSelector + \brief Label, showing color and allowing to pick color with help of standard color dialog + */ class ColorSelector : public QLabel { public: @@ -931,24 +1145,32 @@ QtxListResourceEdit::ColorItem::ColorItem( const QString& title, QtxResourceEdit myColor->setSizePolicy( QSizePolicy( QSizePolicy::Expanding, QSizePolicy::Fixed ) ); } +/*! + Destructor +*/ QtxListResourceEdit::ColorItem::~ColorItem() { } +/*! + Stores value to resource manager +*/ void QtxListResourceEdit::ColorItem::store() { setColor( myColor->paletteBackgroundColor() ); } +/*! + Retrieve value to resource manager +*/ void QtxListResourceEdit::ColorItem::retrieve() { myColor->setPaletteBackgroundColor( getColor() ); } -/* - Class: QtxListResourceEdit::FontItem - Descr: GUI implementation of resources font item. +/*! + Constructor */ QtxListResourceEdit::FontItem::FontItem( const QString& title, QtxResourceEdit* edit, Item* pItem, QWidget* parent ) @@ -974,10 +1196,16 @@ QtxListResourceEdit::FontItem::FontItem( const QString& title, QtxResourceEdit* setProperty( "widget_flags", ( int )All ); } +/*! + Destructor +*/ QtxListResourceEdit::FontItem::~FontItem() { } +/*! + Stores value to resource manager +*/ void QtxListResourceEdit::FontItem::store() { QFont f( family(), size() ); @@ -989,6 +1217,9 @@ void QtxListResourceEdit::FontItem::store() Item::setFont( f ); } +/*! + Retrieve value to resource manager +*/ void QtxListResourceEdit::FontItem::retrieve() { QFont f = getFont(); @@ -997,6 +1228,10 @@ void QtxListResourceEdit::FontItem::retrieve() setParams( f.bold(), f.italic(), f.underline() ); } +/*! + \return value of property + \param prop - property name +*/ QVariant QtxListResourceEdit::FontItem::property( const QString& name ) const { if( name=="system" ) @@ -1066,6 +1301,11 @@ QVariant QtxListResourceEdit::FontItem::property( const QString& name ) const return QVariant(); } +/*! + Sets property value + \param name - name of property + \param var - value of property +*/ void QtxListResourceEdit::FontItem::setProperty( const QString& name, const QVariant& value ) { if( name=="system" ) @@ -1117,6 +1357,10 @@ void QtxListResourceEdit::FontItem::setProperty( const QString& name, const QVar myProperties[ name ] = value; } +/*! + Sets family of font + \param f - new family +*/ void QtxListResourceEdit::FontItem::setFamily( const QString& f ) { QString curtext; @@ -1148,11 +1392,18 @@ void QtxListResourceEdit::FontItem::setFamily( const QString& f ) onActivateFamily( idx ); } +/*! + \return family of font +*/ QString QtxListResourceEdit::FontItem::family() const { return myFamilies->currentText(); } +/*! + Sets size of font + \param s - new size of font +*/ void QtxListResourceEdit::FontItem::setSize( const int s ) { int cursize = -1; @@ -1171,6 +1422,9 @@ void QtxListResourceEdit::FontItem::setSize( const int s ) mySizes->setCurrentText( cursize>0 ? QString( "%1" ).arg( cursize ) : "" ); } +/*! + \return size of font +*/ int QtxListResourceEdit::FontItem::size() const { QString s = mySizes->currentText(); @@ -1179,6 +1433,12 @@ int QtxListResourceEdit::FontItem::size() const return ( ok ? pSize : 0 ); } +/*! + Sets font parameters + \param bold - is font bold + \param italic - is font italic + \param underline - is font underlined +*/ void QtxListResourceEdit::FontItem::setParams( const bool bold, const bool italic, const bool underline ) { bool curbold = false, curitalic = false, curunderline = false; @@ -1211,6 +1471,12 @@ void QtxListResourceEdit::FontItem::setParams( const bool bold, const bool itali myUnderline->setChecked( curunderline ); } +/*! + \return font parameters + \param bold - is font bold + \param italic - is font italic + \param underline - is font underlined +*/ void QtxListResourceEdit::FontItem::params( bool& bold, bool& italic, bool& underline ) { bold = myBold->isChecked(); @@ -1218,9 +1484,11 @@ void QtxListResourceEdit::FontItem::params( bool& bold, bool& italic, bool& unde underline = myUnderline->isChecked(); } +/*! + Updates internal selection of font properties +*/ void QtxListResourceEdit::FontItem::internalUpdate() { - //update internal selection of font properties setFamily( family() ); setSize( size() ); bool b1, b2, b3; @@ -1228,6 +1496,9 @@ void QtxListResourceEdit::FontItem::internalUpdate() setParams( b1, b2, b3 ); } +/*! + SLOT: called if family is activated, updates list of possible sizes +*/ void QtxListResourceEdit::FontItem::onActivateFamily( int ) { QVariant sizes = property( QString( "%1:sizes" ).arg( family() ) ); @@ -1248,6 +1519,9 @@ void QtxListResourceEdit::FontItem::onActivateFamily( int ) setSize( s ); } +/*! + SLOT: called if it is necessary to show font preview +*/ void QtxListResourceEdit::FontItem::onPreview() { QFont f( family(), size() ); @@ -1270,11 +1544,8 @@ void QtxListResourceEdit::FontItem::onPreview() - - -/* - Class: QtxListResourceEdit::DirListItem - Descr: +/*! + Constructor */ QtxListResourceEdit::DirListItem::DirListItem( const QString& title, QtxResourceEdit* edit, Item* pItem, QWidget* parent ) : PrefItem( Font, edit, pItem, parent ) @@ -1282,10 +1553,16 @@ QtxListResourceEdit::DirListItem::DirListItem( const QString& title, QtxResource myDirListEditor = new QtxDirListEditor( this ); } +/*! + Destructor +*/ QtxListResourceEdit::DirListItem::~DirListItem() { } +/*! + Stores value to resource manager +*/ void QtxListResourceEdit::DirListItem::store() { QStringList list; @@ -1293,6 +1570,9 @@ void QtxListResourceEdit::DirListItem::store() setString( QString(list.join(";")) ); } +/*! + Retrieve value to resource manager +*/ void QtxListResourceEdit::DirListItem::retrieve() { myDirListEditor->setPathList(QStringList::split(";", getString())); @@ -1300,9 +1580,8 @@ void QtxListResourceEdit::DirListItem::retrieve() -/* - Class: QtxListResourceEdit::FileItem - Descr: GUI implementation of resources file item. +/*! + Constructor */ QtxListResourceEdit::FileItem::FileItem( const QString& title, QtxResourceEdit* edit, Item* pItem, QWidget* parent ) @@ -1321,22 +1600,35 @@ QtxListResourceEdit::FileItem::FileItem( const QString& title, QtxResourceEdit* connect( myOpenFile, SIGNAL( clicked() ), this, SLOT( onOpenFile() ) ); } +/*! + Destructor +*/ QtxListResourceEdit::FileItem::~FileItem() { if( myFileDlg ) delete myFileDlg; } +/*! + Stores value to resource manager +*/ void QtxListResourceEdit::FileItem::store() { setString( myFile->text() ); } +/*! + Retrieve value to resource manager +*/ void QtxListResourceEdit::FileItem::retrieve() { myFile->setText( getString() ); } +/*! + \return value of property + \param prop - property name +*/ QVariant QtxListResourceEdit::FileItem::property( const QString& name ) const { if( name=="filter" ) @@ -1351,6 +1643,11 @@ QVariant QtxListResourceEdit::FileItem::property( const QString& name ) const return QVariant(); } +/*! + Sets property value + \param name - name of property + \param var - value of property +*/ void QtxListResourceEdit::FileItem::setProperty( const QString& name, const QVariant& value ) { if( name=="filter" ) @@ -1375,6 +1672,9 @@ void QtxListResourceEdit::FileItem::setProperty( const QString& name, const QVar } } +/*! + SLOT: called if user click "Open File" button, shows dialog +*/ void QtxListResourceEdit::FileItem::onOpenFile() { if( !myFileDlg ) @@ -1393,6 +1693,10 @@ void QtxListResourceEdit::FileItem::onOpenFile() } } +/*! + \return true if file satisfies permissions + \param f - file name +*/ bool QtxListResourceEdit::FileItem::isFileCorrect( const QString& f ) const { bool res = false; @@ -1403,6 +1707,10 @@ bool QtxListResourceEdit::FileItem::isFileCorrect( const QString& f ) const return res; } +/*! + SLOT: called if user has selected file in file dialog, checks file permissions and passes it's name to widget + \param f - file name +*/ void QtxListResourceEdit::FileItem::onFileSelected( const QString& f ) { if( myFileDlg && !isFileCorrect( f ) ) @@ -1410,17 +1718,26 @@ void QtxListResourceEdit::FileItem::onFileSelected( const QString& f ) } - +/*! + Constructor +*/ QtxListResourceEdit::FileItem::FileValidator::FileValidator( FileItem* item, QObject* parent ) : QValidator( parent ), myItem( item ) { } +/*! + Destructor +*/ QtxListResourceEdit::FileItem::FileValidator::~FileValidator() { } +/*! + Check file permissions + \param f - file name +*/ QValidator::State QtxListResourceEdit::FileItem::FileValidator::validate( QString& f, int& ) const { if( myItem && myItem->isFileCorrect( f ) ) diff --git a/src/Qtx/QtxListResourceEdit.h b/src/Qtx/QtxListResourceEdit.h index 19713ca08..7b3aa7ea7 100644 --- a/src/Qtx/QtxListResourceEdit.h +++ b/src/Qtx/QtxListResourceEdit.h @@ -43,9 +43,9 @@ class QtxDblSpinBox; class QtxDirListEditor; -/* - Class: QtxListResourceEdit - Descr: GUI implementation of QtxResourceEdit - manager of resources +/*! + \class QtxListResourceEdit + GUI implementation of QtxResourceEdit - manager of resources */ class QTX_EXPORT QtxListResourceEdit : public QFrame, public QtxResourceEdit @@ -101,9 +101,9 @@ private: QWidgetStack* myStack; }; -/* - Class: QtxListResourceEdit::Category - Descr: GUI implementation of 'Category' frame +/*! + \class QtxListResourceEdit::Category + GUI implementation of 'Category' frame */ class QtxListResourceEdit::Category : public QFrame, public Item @@ -132,9 +132,9 @@ private: QTabWidget* myTabs; }; -/* - Class: QtxListResourceEdit::Tab - Descr: GUI implementation of resources tab. +/*! + \class QtxListResourceEdit::Tab + GUI implementation of resources tab. */ class QtxListResourceEdit::Tab : public QFrame, public Item @@ -160,9 +160,9 @@ private: QWidget* myMainFrame; }; -/* - Class: QtxListResourceEdit::Group - Descr: GUI implementation of resources group. +/*! + \class QtxListResourceEdit::Group + GUI implementation of resources group. */ class QtxListResourceEdit::Group : public QGroupBox, public Item @@ -184,9 +184,9 @@ protected: virtual Item* createItem( const QString&, const int ); }; -/* - Class: QtxListResourceEdit::PrefItem - Descr: Base class for preferences items. +/*! + \class QtxListResourceEdit::PrefItem + Base class for preferences items. */ class QtxListResourceEdit::PrefItem : public QHBox, public Item @@ -204,9 +204,9 @@ private: int myType; }; -/* - Class: QtxListResourceEdit::Spacer - Descr: GUI implementation of resources spacer. +/*! + \class QtxListResourceEdit::Spacer + GUI implementation of resources spacer. */ class QtxListResourceEdit::Spacer : public PrefItem @@ -219,9 +219,9 @@ public: virtual void retrieve(); }; -/* - Class: QtxListResourceEdit::SelectItem - Descr: GUI implementation of resources selector item. +/*! + \class QtxListResourceEdit::SelectItem + GUI implementation of resources selector item. */ class QtxListResourceEdit::SelectItem : public PrefItem @@ -248,11 +248,10 @@ private: QMap myIndex; }; -/* - Class: QtxListResourceEdit::StateItem - Descr: GUI implementation of resources bool item. +/*! + \class QtxListResourceEdit::StateItem + GUI implementation of resources bool item. */ - class QtxListResourceEdit::StateItem : public PrefItem { public: @@ -266,9 +265,9 @@ private: QCheckBox* myState; }; -/* - Class: QtxListResourceEdit::StringItem - Descr: GUI implementation of resources string item. +/*! + \class QtxListResourceEdit::StringItem + GUI implementation of resources string item. */ class QtxListResourceEdit::StringItem : public PrefItem @@ -284,9 +283,9 @@ private: QLineEdit* myString; }; -/* - Class: QtxListResourceEdit::IntegerEditItem - Descr: GUI implementation of resources integer item. +/*! + \class QtxListResourceEdit::IntegerEditItem + GUI implementation of resources integer item. */ class QtxListResourceEdit::IntegerEditItem : public PrefItem @@ -302,9 +301,9 @@ private: QLineEdit* myInteger; }; -/* - Class: QtxListResourceEdit::IntegerSpinItem - Descr: GUI implementation of resources integer item. +/*! + \class QtxListResourceEdit::IntegerSpinItem + GUI implementation of resources integer item. */ class QtxListResourceEdit::IntegerSpinItem : public PrefItem @@ -323,9 +322,9 @@ private: QtxIntSpinBox* myInteger; }; -/* - Class: QtxListResourceEdit::DoubleEditItem - Descr: GUI implementation of resources double item. +/*! + \class QtxListResourceEdit::DoubleEditItem + GUI implementation of resources double item. */ class QtxListResourceEdit::DoubleEditItem : public PrefItem @@ -341,9 +340,9 @@ private: QLineEdit* myDouble; }; -/* - Class: QtxListResourceEdit::DoubleSpinItem - Descr: GUI implementation of resources double item. +/*! + \class QtxListResourceEdit::DoubleSpinItem + GUI implementation of resources double item. */ class QtxListResourceEdit::DoubleSpinItem : public PrefItem @@ -362,9 +361,9 @@ private: QtxDblSpinBox* myDouble; }; -/* - Class: QtxListResourceEdit::ColorItem - Descr: GUI implementation of resources color item. +/*! + \class QtxListResourceEdit::ColorItem + GUI implementation of resources color item. */ class QtxListResourceEdit::ColorItem : public PrefItem @@ -380,14 +379,13 @@ private: QWidget* myColor; }; -/* - Class: QtxListResourceEdit::FontItem - Descr: GUI implementation of resources font item. -*/ - class QtxComboBox; class QToolButton; +/*! + \class QtxListResourceEdit::FontItem + GUI implementation of resources font item. +*/ class QtxListResourceEdit::FontItem : public PrefItem { Q_OBJECT @@ -441,10 +439,9 @@ private: /*! - * \brief GUI implementation of resources directory list item. - * - * - */ + \class QtxListResourceEdit + \brief GUI implementation of resources directory list item. +*/ class QtxListResourceEdit::DirListItem : public PrefItem { Q_OBJECT @@ -474,20 +471,25 @@ private: QtxDirListEditor* myDirListEditor; //!< The widget wich implements in GUI the list of directories }; -/* - Class: QtxListResourceEdit::FontItem - Descr: GUI implementation of resources font item. -*/ - class QtxComboBox; class QToolButton; class QFileDialog; +/*! + \class QtxListResourceEdit::FontItem + GUI implementation of resources font item. +*/ + class QtxListResourceEdit::FileItem : public PrefItem { Q_OBJECT private: + /*! + \class QtxListResourceEdit::FileItem::FileValidator + custom file validator: checks files on some rights + */ + class FileValidator : public QValidator { public: diff --git a/src/Qtx/QtxListView.cxx b/src/Qtx/QtxListView.cxx index e0ccd4991..83e74d95d 100755 --- a/src/Qtx/QtxListView.cxx +++ b/src/Qtx/QtxListView.cxx @@ -48,6 +48,9 @@ static const char* list_xpm[] = { "................", "................" }; +/*! + Constructor +*/ QtxListView::QtxListView( const int state, QWidget* parent, const char* name, WFlags f ) : QListView( parent, name, f ), myButton( 0 ), @@ -56,6 +59,9 @@ myHeaderState( state ) initialize(); } +/*! + Constructor +*/ QtxListView::QtxListView( QWidget* parent, const char* name, WFlags f ) : QListView( parent, name, f ), myButton( 0 ), @@ -64,6 +70,9 @@ myHeaderState( HeaderAuto ) initialize(); } +/*! + Initialization +*/ void QtxListView::initialize() { if ( myHeaderState == HeaderButton ) @@ -91,10 +100,18 @@ void QtxListView::initialize() connect( header(), SIGNAL( sizeChange( int, int, int ) ), this, SLOT( onHeaderResized() ) ); } +/*! + Destructor +*/ QtxListView::~QtxListView() { } +/*! + Add new column + \param label - column title + \param width - column width +*/ int QtxListView::addColumn( const QString& label, int width ) { int res = QListView::addColumn( label, width ); @@ -104,6 +121,12 @@ int QtxListView::addColumn( const QString& label, int width ) return res; } +/*! + Add new column + \param iconset - column icon + \param label - column title + \param width - column width +*/ int QtxListView::addColumn( const QIconSet& iconset, const QString& label, int width ) { int res = QListView::addColumn( iconset, label, width ); @@ -113,6 +136,10 @@ int QtxListView::addColumn( const QIconSet& iconset, const QString& label, int w return res; } +/*! + Removes column + \param index - column index +*/ void QtxListView::removeColumn( int index ) { QListView::removeColumn( index ); @@ -121,11 +148,19 @@ void QtxListView::removeColumn( int index ) onHeaderResized(); } +/*! + \return true if column is situated in popup for show/hide columns +*/ bool QtxListView::appropriate( const int index ) const { return index >= 0 && index < (int)myAppropriate.count() && myAppropriate[index]; } +/*! + Sets appropriate state: whether column is situated in popup for show/hide columns + \param index - column index + \param on - new state +*/ void QtxListView::setAppropriate( const int index, const bool on ) { if ( index < 0 || index >= (int)myAppropriate.count() ) @@ -134,18 +169,27 @@ void QtxListView::setAppropriate( const int index, const bool on ) myAppropriate[index] = on ? 1 : 0; } +/*! + Resizes list view and header +*/ void QtxListView::resize( int w, int h ) { QListView::resize( w, h ); onHeaderResized(); } +/*! + Shows list view +*/ void QtxListView::show() { QListView::show(); onHeaderResized(); } +/*! + Update on resize contents +*/ void QtxListView::resizeContents( int w, int h ) { /* @@ -162,16 +206,28 @@ void QtxListView::resizeContents( int w, int h ) onHeaderResized(); } +/*! + Shows column + \param ind - column index +*/ void QtxListView::show( int ind ) { setShown( ind, true ); } +/*! + Hides column + \param ind - column index +*/ void QtxListView::hide( int ind ) { setShown( ind, false ); } +/*! + \return true if column is shown + \param ind - column index +*/ bool QtxListView::isShown( int ind ) const { if ( ind>=0 && indcount() ) @@ -180,6 +236,11 @@ bool QtxListView::isShown( int ind ) const return false; } +/*! + Shows/hides column + \param ind - column index + \param sh - new is shown state +*/ void QtxListView::setShown( int ind, bool sh ) { if( ind<0 || ind>=header()->count() || isShown( ind )==sh ) @@ -207,6 +268,11 @@ void QtxListView::setShown( int ind, bool sh ) updateContents(); } +/*! + Changes column width + \param c - column index + \param w - new width +*/ void QtxListView::setColumnWidth( int c, int w ) { if ( myColumns.contains( c ) ) @@ -215,6 +281,9 @@ void QtxListView::setColumnWidth( int c, int w ) QListView::setColumnWidth( c, !myColumns.contains( c ) ? w : 0 ); } +/*! + \return the recommended size for the widget +*/ QSize QtxListView::sizeHint() const { QSize sz = QListView::sizeHint(); @@ -225,6 +294,9 @@ QSize QtxListView::sizeHint() const return sz; } +/*! + \return the recommended minimum size for the widget +*/ QSize QtxListView::minimumSizeHint() const { QSize sz = QListView::minimumSizeHint(); @@ -235,6 +307,9 @@ QSize QtxListView::minimumSizeHint() const return sz; } +/*! + SLOT: called if header is resized +*/ void QtxListView::onHeaderResized() { if ( myHeaderState == HeaderAuto ) @@ -273,6 +348,10 @@ void QtxListView::onHeaderResized() } } +/*! + Shows popup filled with column names to show/hide column + \param x, y - position of popup +*/ void QtxListView::showPopup( const int x, const int y ) { myPopup->clear(); @@ -289,6 +368,9 @@ void QtxListView::showPopup( const int x, const int y ) myPopup->exec( mapToGlobal( QPoint( x, y ) ) ); } +/*! + SLOT: shows popup on button ".." click +*/ void QtxListView::onButtonClicked() { if ( myHeaderState != HeaderButton ) @@ -300,6 +382,10 @@ void QtxListView::onButtonClicked() showPopup( x, y ); } +/*! + SLOT: called on popup action is activated, toggles shown state of column + \param id - column index +*/ void QtxListView::onShowHide( int id ) { //if ( myHeaderState != HeaderButton ) @@ -308,12 +394,18 @@ void QtxListView::onShowHide( int id ) setShown( id, !isShown( id ) ); } +/*! + Receives all resize events sent to the viewport +*/ void QtxListView::viewportResizeEvent( QResizeEvent* e ) { QListView::viewportResizeEvent( e ); onHeaderResized(); } +/*! + Custom event filter, shows popup on right button click +*/ bool QtxListView::eventFilter( QObject* o, QEvent* e ) { if( o==header() && e->type()==QEvent::MouseButtonPress ) diff --git a/src/Qtx/QtxLogoMgr.cxx b/src/Qtx/QtxLogoMgr.cxx index 68811c5f3..5156bc795 100644 --- a/src/Qtx/QtxLogoMgr.cxx +++ b/src/Qtx/QtxLogoMgr.cxx @@ -27,6 +27,9 @@ #include #include +/*! + Constructor +*/ QtxLogoMgr::QtxLogoMgr( QMenuBar* mb ) : QObject( mb ), myMenus( mb ), @@ -34,6 +37,9 @@ myId( 0 ) { } +/*! + Destructor +*/ QtxLogoMgr::~QtxLogoMgr() { } @@ -106,6 +112,9 @@ void QtxLogoMgr::clear() generate(); } +/*! + Inserts logo to menu bar +*/ void QtxLogoMgr::generate() { if ( !menuBar() ) @@ -175,6 +184,10 @@ void QtxLogoMgr::generate() QApplication::postEvent( menuBar()->parentWidget(), new QEvent( QEvent::LayoutHint ) ); } +/*! + \return index of found logo + \param id - logo id +*/ int QtxLogoMgr::find( const QString& id ) const { int idx = -1; diff --git a/src/Qtx/QtxMainWindow.cxx b/src/Qtx/QtxMainWindow.cxx index 5f7ce9a2e..39b385fea 100644 --- a/src/Qtx/QtxMainWindow.cxx +++ b/src/Qtx/QtxMainWindow.cxx @@ -47,6 +47,9 @@ private: QWidget* myWidget; }; +/*! + Constructor +*/ QtxMainWindow::Filter::Filter( QWidget* wid, QtxMainWindow* mw, QObject* parent ) : QObject( parent ), myMain( mw ), @@ -55,10 +58,16 @@ myWidget( wid ) myMain->installEventFilter( this ); }; +/*! + Destructor +*/ QtxMainWindow::Filter::~Filter() { } +/*! + Custom event filter +*/ bool QtxMainWindow::Filter::eventFilter( QObject* o, QEvent* e ) { if ( myMain == o && e->type() == QEvent::ChildRemoved && @@ -73,7 +82,6 @@ bool QtxMainWindow::Filter::eventFilter( QObject* o, QEvent* e ) Descr: Main window with support of dockable menubar/status bar and geometry store/retrieve. */ - QtxMainWindow::QtxMainWindow( QWidget* parent, const char* name, WFlags f ) : QMainWindow( parent, name, f ), myMode( -1 ), @@ -82,17 +90,27 @@ myStatusBar( NULL ) { } +/*! + Destructor +*/ QtxMainWindow::~QtxMainWindow() { setDockableMenuBar( false ); setDockableStatusBar( false ); } +/*! + \return true if menu bar exists +*/ bool QtxMainWindow::isDockableMenuBar() const { return myMenuBar; } +/*! + Creates or deletes menu bar + \param on - if it is true, then to create, otherwise - to delete +*/ void QtxMainWindow::setDockableMenuBar( const bool on ) { if ( isDockableMenuBar() == on ) @@ -134,11 +152,18 @@ void QtxMainWindow::setDockableMenuBar( const bool on ) setUpLayout(); } +/*! + \return true if status bar exists +*/ bool QtxMainWindow::isDockableStatusBar() const { return myStatusBar; } +/*! + Creates or deletes status bar + \param on - if it is true, then to create, otherwise - to delete +*/ void QtxMainWindow::setDockableStatusBar( const bool on ) { if ( isDockableStatusBar() == on ) @@ -185,6 +210,11 @@ void QtxMainWindow::setDockableStatusBar( const bool on ) setUpLayout(); } +/*! + Retrieve the geometry information from the specified resource manager section. + \param resMgr - instance of ersource manager + \param section - section name +*/ void QtxMainWindow::loadGeometry( QtxResourceMgr* resMgr, const QString& section ) { QString sec = section.stripWhiteSpace(); @@ -232,6 +262,9 @@ void QtxMainWindow::loadGeometry( QtxResourceMgr* resMgr, const QString& section myMode = winState; } +/*! + Shows main window +*/ void QtxMainWindow::show() { if ( myMode != -1 ) @@ -242,6 +275,9 @@ void QtxMainWindow::show() QMainWindow::show(); } +/*! + Handler of custom events +*/ void QtxMainWindow::customEvent( QCustomEvent* e ) { QMainWindow::customEvent( e ); @@ -261,6 +297,12 @@ void QtxMainWindow::customEvent( QCustomEvent* e ) } } +/*! + \return relative co-ordinate by two points + \param type - type of result: WP_Center (center), WP_Left (left), WP_Right (right) + \param wh - left point + \param WH - right point +*/ int QtxMainWindow::relativeCoordinate( const int type, const int WH, const int wh ) const { int res = 0; @@ -279,6 +321,11 @@ int QtxMainWindow::relativeCoordinate( const int type, const int WH, const int w return res; } +/*! + Store the geometry information into the specified resource manager section. + \param resMgr - instance of ersource manager + \param section - section name +*/ void QtxMainWindow::saveGeometry( QtxResourceMgr* resMgr, const QString& section ) const { QString sec = section.stripWhiteSpace(); @@ -299,16 +346,28 @@ void QtxMainWindow::saveGeometry( QtxResourceMgr* resMgr, const QString& section resMgr->setValue( sec, "state", winState ); } +/*! + Custom event filter +*/ bool QtxMainWindow::eventFilter( QObject* o, QEvent* e ) { return QMainWindow::eventFilter( o, e ); } +/*! + Controls whether or not the dw dock window's caption should appear + as a menu item on the dock window menu that lists the dock windows. + \param dw - window + \param a - if it is true, then it appears in menu +*/ void QtxMainWindow::setAppropriate( QDockWindow* dw, bool a ) { QMainWindow::setAppropriate( dw, myStatusBar != dw && myMenuBar != dw && a ); } +/*! + Sets up layout +*/ void QtxMainWindow::setUpLayout() { QMainWindow::setUpLayout(); @@ -317,6 +376,9 @@ void QtxMainWindow::setUpLayout() layout()->setMenuBar( 0 ); } +/*! + SLOT: called on object destroyed, clears internal fields in case of deletion of menu bar or status bar +*/ void QtxMainWindow::onDestroyed( QObject* obj ) { QObject* o = 0; @@ -338,6 +400,10 @@ void QtxMainWindow::onDestroyed( QObject* obj ) } } +/*! + \return flag of window state by it's name + \param str - name of flag +*/ int QtxMainWindow::windowState( const QString& str ) const { static QMap winStateMap; @@ -363,6 +429,10 @@ int QtxMainWindow::windowState( const QString& str ) const return res; } +/*! + \return flag of position by it's name + \param str - name of position +*/ int QtxMainWindow::windowPosition( const QString& str ) const { static QMap winPosMap; diff --git a/src/Qtx/QtxMenuButton.cxx b/src/Qtx/QtxMenuButton.cxx index 88bfc1061..ef4ac5253 100755 --- a/src/Qtx/QtxMenuButton.cxx +++ b/src/Qtx/QtxMenuButton.cxx @@ -39,6 +39,11 @@ private: QtxMenuButton* myMenuButton; }; +/*! + Sets the widget's minimum size + \param w - width + \param h - height +*/ void QtxMenuButton::PopupMenu::setMinimumSize( int w, int h ) { if ( myMenuButton->isAlignWidth() && @@ -49,6 +54,12 @@ void QtxMenuButton::PopupMenu::setMinimumSize( int w, int h ) } +/*! + Constructor + \param pos - position + \param parent - parent widget + \param name - name +*/ QtxMenuButton::QtxMenuButton( int pos, QWidget* parent, const char* name ) : QPushButton( parent, name ), myPos( pos ) @@ -56,6 +67,12 @@ myPos( pos ) initialize(); } +/*! + Constructor + \param text - button text + \param parent - parent widget + \param name - name +*/ QtxMenuButton::QtxMenuButton( const QString& text, QWidget* parent, const char* name ) : QPushButton( parent, name ), myPos( Bottom ) @@ -64,6 +81,13 @@ myPos( Bottom ) initialize(); } +/*! + Constructor + \param pos - position + \param text - button text + \param parent - parent widget + \param name - name +*/ QtxMenuButton::QtxMenuButton( int pos, const QString& text, QWidget* parent, const char* name ) : QPushButton( parent, name ), myPos( pos ) @@ -72,6 +96,11 @@ myPos( pos ) initialize(); } +/*! + Constructor + \param parent - parent widget + \param name - name +*/ QtxMenuButton::QtxMenuButton( QWidget* parent, const char* name ) : QPushButton( parent, name ), myPos( Bottom ) @@ -79,10 +108,16 @@ myPos( Bottom ) initialize(); } +/*! + Destructor +*/ QtxMenuButton::~QtxMenuButton() { } +/*! + Initialization +*/ void QtxMenuButton::initialize() { myArrow = true; @@ -96,21 +131,34 @@ void QtxMenuButton::initialize() connect( this, SIGNAL( clicked() ), this, SLOT( onShowPopup() ) ); } +/*! + \return position +*/ int QtxMenuButton::position() const { return myPos; } +/*! + \return true if align is enabled +*/ bool QtxMenuButton::isAlignWidth() const { return myAlign; } +/*! + \return true if arrow is shown +*/ bool QtxMenuButton::isArrowEnabled() const { return myArrow; } +/*! + Changes position + \param pos - new position +*/ void QtxMenuButton::setPosition( const int pos ) { if ( myPos == pos ) @@ -121,6 +169,10 @@ void QtxMenuButton::setPosition( const int pos ) onShowPopup(); } +/*! + Changes align state + \param on - new align state +*/ void QtxMenuButton::setAlignWidth( const bool on ) { if ( myAlign == on ) @@ -130,6 +182,10 @@ void QtxMenuButton::setAlignWidth( const bool on ) updateGeometry(); } +/*! + Enables/disable arrow + \param on - new enabled state +*/ void QtxMenuButton::setArrowEnabled( const bool on ) { if ( myArrow == on ) @@ -139,6 +195,9 @@ void QtxMenuButton::setArrowEnabled( const bool on ) repaint(); } +/*! + Clears popup +*/ void QtxMenuButton::clear() { if ( myPopup ) @@ -147,13 +206,21 @@ void QtxMenuButton::clear() updateGeometry(); } +/*! + Removes item from popup + \param id - item id +*/ void QtxMenuButton::removeItem( int id ) { if ( myPopup ) - removeItem( id ); + myPopup->removeItem( id ); updateGeometry(); } +/*! + Inserts separator into popup + \param id - position +*/ int QtxMenuButton::insertSeparator( int id ) { int res = -1; @@ -162,6 +229,12 @@ int QtxMenuButton::insertSeparator( int id ) return res; } +/*! + Inserts item into popup + \param t - menu text + \param id - item id + \param index - position +*/ int QtxMenuButton::insertItem( const QString& t, int id, int index ) { int resId = -1; @@ -174,6 +247,13 @@ int QtxMenuButton::insertItem( const QString& t, int id, int index ) return resId; } +/*! + Inserts item into popup + \param is - icons + \param t - menu text + \param id - item id + \param index - position +*/ int QtxMenuButton::insertItem( const QIconSet& is, const QString& t, int id, int index ) { int resId = -1; @@ -186,6 +266,9 @@ int QtxMenuButton::insertItem( const QIconSet& is, const QString& t, int id, int return resId; } +/*! + SLOT: calls when button is clicked, shows popup +*/ void QtxMenuButton::onShowPopup() { if ( !myPopup || !myPopup->count() ) @@ -224,6 +307,9 @@ void QtxMenuButton::onShowPopup() myPopup->exec( QPoint( x, y ) ); } +/*! + Custom event handler +*/ bool QtxMenuButton::event( QEvent* e ) { if ( e->type() == QEvent::MouseButtonPress || @@ -237,6 +323,9 @@ bool QtxMenuButton::event( QEvent* e ) return QPushButton::event( e ); } +/*! + \return the recommended size for the widget +*/ QSize QtxMenuButton::sizeHint() const { QSize sz = QPushButton::sizeHint(); @@ -246,6 +335,9 @@ QSize QtxMenuButton::sizeHint() const return sz; } +/*! + \return the recommended minimum size for the widget +*/ QSize QtxMenuButton::minimumSizeHint() const { QSize sz = QPushButton::minimumSizeHint(); @@ -255,6 +347,9 @@ QSize QtxMenuButton::minimumSizeHint() const return sz; } +/*! + Custom resize event handler +*/ void QtxMenuButton::resizeEvent( QResizeEvent* re ) { if ( re ) @@ -264,11 +359,17 @@ void QtxMenuButton::resizeEvent( QResizeEvent* re ) myPopup->setMinimumWidth( re ? re->size().width() : width() ); } +/*! + \return corresponding popup +*/ QPopupMenu* QtxMenuButton::popup() const { return myPopup; } +/*! + Draws label +*/ void QtxMenuButton::drawButtonLabel( QPainter* p ) { QPushButton::drawButtonLabel( p ); diff --git a/src/Qtx/QtxOperations.cxx b/src/Qtx/QtxOperations.cxx index 0034d41e4..5e4517428 100644 --- a/src/Qtx/QtxOperations.cxx +++ b/src/Qtx/QtxOperations.cxx @@ -19,26 +19,23 @@ #include "QtxOperations.h" -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Default constructor +*/ QtxOperations::QtxOperations() { } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Destructor +*/ QtxOperations::~QtxOperations() { } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Creates QtxValue by it's string representation +*/ bool QtxOperations::createValue( const QString& str, QtxValue& v ) const { v = str; diff --git a/src/Qtx/QtxOperations.h b/src/Qtx/QtxOperations.h index 9dae0b336..a4a8524a9 100644 --- a/src/Qtx/QtxOperations.h +++ b/src/Qtx/QtxOperations.h @@ -25,10 +25,6 @@ #include "Qtx.h" #include "QtxParser.h" -//================================================================ -// Class : -// Purpose : -//================================================================ class QTX_EXPORT QtxOperations { public: diff --git a/src/Qtx/QtxParser.cxx b/src/Qtx/QtxParser.cxx index 105ddb7a5..b71f26bed 100644 --- a/src/Qtx/QtxParser.cxx +++ b/src/Qtx/QtxParser.cxx @@ -20,12 +20,10 @@ #include "QtxParser.h" #include "QtxOperations.h" -//================================================================ -// Function : -// Purpose : -//================================================================ -QtxParser::QtxParser( QtxOperations* operations, - const QString& expr ) +/*! + Constructor +*/ +QtxParser::QtxParser( QtxOperations* operations, const QString& expr ) : myOperations( operations ) { if( myOperations ) @@ -37,18 +35,22 @@ QtxParser::QtxParser( QtxOperations* operations, setLastError( OperationsNull ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Destructor +*/ QtxParser::~QtxParser() { } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Search elements of list as substrings starting on 'offset' + \returns the least position of substrings inside string + \param list - list of substrings + \param str - string where search + \param offset - starting index for search + \param matchLen - the length of appropriate substring + \param listind - list index of appropriate substring +*/ int QtxParser::search( const QStringList& list, const QString& str, int offset, int& matchLen, int& listind ) { @@ -71,19 +73,22 @@ int QtxParser::search( const QStringList& list, const QString& str, int offset, return min; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return substring + \param str - string + \param pos - start position of substring + \param len - length of substring +*/ QString QtxParser::note( const QString& str, int pos, int len ) { return str.mid( pos, len ).stripWhiteSpace(); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + First step of parsing: finding tokens, determining its types and creating of unsorted pseudo-postfix (with brackets) + \param expr - string expression + \param post - postfix to be created +*/ bool QtxParser::prepare( const QString& expr, Postfix& post ) { int pos = 0, len = expr.length(); @@ -225,10 +230,10 @@ bool QtxParser::prepare( const QString& expr, Postfix& post ) return lastError()==OK; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Second step of parsing: determining types of operations + \param post - unsorted postfix +*/ bool QtxParser::setOperationTypes( Postfix& post ) { Postfix::iterator aStart = post.begin(), @@ -279,10 +284,12 @@ bool QtxParser::setOperationTypes( Postfix& post ) return lastError()==OK; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return how many global brackets there is (for example '((2+3))' has 2 global brackets) + \param post - postfix to be checked + \param f - start index to search + \param l - last index to search +*/ int QtxParser::globalBrackets( const QtxParser::Postfix& post, int f, int l ) { int i, @@ -317,10 +324,15 @@ int QtxParser::globalBrackets( const QtxParser::Postfix& post, int f, int l ) return br+min_br_num; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Third step of parsing: sorting of postfix in order to convert it to real postfix + \param post - source postfix + \param res - destination postfix + \param anOpen - list of open brackets + \param aClose - list of close brackets + \param f - start index of postfix to sorting + \param l - last index of postfix to sorting +*/ bool QtxParser::sort( const Postfix& post, Postfix& res, const QStringList& anOpen, const QStringList& aClose, @@ -478,10 +490,10 @@ bool QtxParser::sort( const Postfix& post, Postfix& res, return lastError()==OK; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Build posfix by expression + \param expr - string expression +*/ bool QtxParser::parse( const QString& expr ) { myPost.clear(); @@ -506,10 +518,12 @@ bool QtxParser::parse( const QString& expr ) sort( p, myPost, opens, closes ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Calculate operation + \param op - operation name + \param v1 - first argument (it is not valid for unary prefix operations and it is used to store result) + \param v2 - second argument (it is not valid for unary postfix operations) +*/ bool QtxParser::calculate( const QString& op, QtxValue& v1, QtxValue& v2 ) { Error err = myOperations->isValid( op, v1.type(), v2.type() ); @@ -521,10 +535,10 @@ bool QtxParser::calculate( const QString& op, QtxValue& v1, QtxValue& v2 ) return lastError()==OK; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Calculates expression without postfix rebuilding + \return QtxValue as result (it is invalid if there were errors during calculation) +*/ QtxValue QtxParser::calculate() { setLastError( OK ); @@ -639,47 +653,47 @@ QtxValue QtxParser::calculate() return res; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Change expression, rebuild postfix and calculate it + \return QtxValue as result (it is invalid if there were errors during calculation) +*/ QtxValue QtxParser::calculate( const QString& expr ) { setExpr( expr ); return calculate(); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Change expression and rebuild postfix +*/ bool QtxParser::setExpr( const QString& expr ) { return parse( expr ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return true, if parser contain parameter + \param name - name of parameter +*/ bool QtxParser::has( const QString& name ) const { return myParameters.contains( name.stripWhiteSpace() ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Sets parameter value + \param name - name of parameter + \param value - value of parameter +*/ void QtxParser::set( const QString& name, const QtxValue& value ) { myParameters[ name.stripWhiteSpace() ] = value; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Removes parameter + \param name - name of parameter +*/ bool QtxParser::remove( const QString& name ) { QString sname = name.stripWhiteSpace(); @@ -689,10 +703,10 @@ bool QtxParser::remove( const QString& name ) return res; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return value of parameter (result is invalid if there is no such parameter) + \param name - name of parameter +*/ QtxValue QtxParser::value( const QString& name ) const { QString sname = name.stripWhiteSpace(); @@ -702,10 +716,11 @@ QtxValue QtxParser::value( const QString& name ) const return QtxValue(); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Searches first parameter with assigned invalid QtxValue + \return true if it is found + \param name - variable to return name of parameter +*/ bool QtxParser::firstInvalid( QString& name ) const { QMap< QString, QtxValue >::const_iterator anIt = myParameters.begin(), @@ -719,10 +734,9 @@ bool QtxParser::firstInvalid( QString& name ) const return false; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Removes all parameters with assigned invalid QtxValues +*/ void QtxParser::removeInvalids() { QStringList toDelete; @@ -738,37 +752,34 @@ void QtxParser::removeInvalids() myParameters.remove( *aLIt ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return last error occured during parsing +*/ QtxParser::Error QtxParser::lastError() const { return myLastError; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Sets last error occured during parsing (for internal using only) +*/ void QtxParser::setLastError( QtxParser::Error err ) { myLastError = err; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return string dump of internal parser postfix +*/ QString QtxParser::dump() const { return dump( myPost ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return string dump of postfix + \param post - postfix to be dumped +*/ QString QtxParser::dump( const Postfix& post ) const { QString res; @@ -798,10 +809,10 @@ QString QtxParser::dump( const Postfix& post ) const return res; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Fills list with names of parameters + \param list - list to be filled +*/ void QtxParser::paramsList( QStringList& list ) { PostfixIterator anIt = myPost.begin(), @@ -815,19 +826,18 @@ void QtxParser::paramsList( QStringList& list ) } } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Removes all parameters +*/ void QtxParser::clear() { myParameters.clear(); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return string representation for list of QtxValues + \param list - list to be converted +*/ QString QtxParser::toString( const QValueList< QtxValue >& list ) { QValueList< QtxValue >::const_iterator anIt = list.begin(), diff --git a/src/Qtx/QtxParser.h b/src/Qtx/QtxParser.h index 737fc96ce..25b5f5511 100644 --- a/src/Qtx/QtxParser.h +++ b/src/Qtx/QtxParser.h @@ -33,21 +33,44 @@ class QtxOperations; +/*! \var QtxValue + \brief Alias for QVariant +*/ typedef QVariant QtxValue; -//================================================================ -// Class : -// Purpose : -//================================================================ +/*! + \class QtxParser + + This class allows to calculate values of expressions using different set of operations. + It is provided some of standard set of operations (arithmetics, logic, strings, etc - in QtxStdOperations.h). + This parser allows to use parameters with help of methods has(), set(), remove(), value(). It uses + postfix representation of expressions and uses class QtxOperations in order to make certain operation + Every instance of parser contains only one postfix, so that if expression has been changed, then postfix + must be rebuilt. In order to increase performance of frequent calculation for many of expressions it is + recommended to use different instances of parser for expressions + +*/ class QTX_EXPORT QtxParser { public: + /*! + \enum Error + \brief Errors during parsing + */ typedef enum { - OK, OperandsNotMatch, InvalidResult, InvalidOperation, - OperationsNull, InvalidToken, CloseExpected, ExcessClose, - BracketsNotMatch, StackUnderflow, ExcessData + OK, /*! \var All right */ + OperandsNotMatch, /*! \var Types of arguments are invalid for this operation */ + InvalidResult, /*! \var Operation cannot find result (for example, division by zero) */ + InvalidOperation, /*! \var Name of operation is unknown */ + OperationsNull, /*! \var Internal operations pointer of parser is null */ + InvalidToken, /*! \var It isn't operation, parameter of value */ + CloseExpected, /*! \var Close bracket is expected */ + ExcessClose, /*! \var The one of close bracket is excess */ + BracketsNotMatch, /*! \var Last open and this close bracket are different, for example [) */ + StackUnderflow, /*! \var There is no arguments in stack for operation */ + ExcessData /*! \var The parsing is finished, but there is more then one value in stack */ } Error; @@ -74,8 +97,23 @@ public: static QString toString( const QValueList< QtxValue >& ); protected: - typedef enum { Value, Param, Open, Close, Pre, Post, Binary } PostfixItemType; + /*! + \enum PostfixItemType + \brief Types of postfix representation elements + */ + typedef enum + { + Value, /*! \var Value (number, string, etc.)*/ + Param, /*! \var Parameter */ + Open, /*! \var Open bracket */ + Close, /*! \var Close bracket */ + Pre, /*! \var Unary prefix operation */ + Post, /*! \var Unary postfix operation */ + Binary /*! \var Binary operation */ + + } PostfixItemType; + /*! \var postfix representation element */ typedef struct { QtxValue myValue; @@ -83,7 +121,10 @@ protected: } PostfixItem; + /*! \var postfix representation */ typedef QValueList< PostfixItem > Postfix; + + /*! \var postfix representation iterator */ typedef Postfix::const_iterator PostfixIterator; protected: @@ -105,6 +146,7 @@ protected: static int globalBrackets( const Postfix&, int, int ); private: + /*! \var stack of QtxValues */ typedef QValueStack < QtxValue > QtxValueStack; private: diff --git a/src/Qtx/QtxPathDialog.cxx b/src/Qtx/QtxPathDialog.cxx index 55df5d781..260c1d090 100755 --- a/src/Qtx/QtxPathDialog.cxx +++ b/src/Qtx/QtxPathDialog.cxx @@ -60,11 +60,9 @@ static const char* open_icon[] = { " " }; -//================================================================ -// Function : QtxPathDialog -// Purpose : Constructor. -//================================================================ - +/*! + Constructor. +*/ QtxPathDialog::QtxPathDialog( const bool import, QWidget* parent, const bool modal, const bool resize, const int buttons, WFlags f ) : QtxDialog( parent, 0, modal, resize, buttons, f ), myDefault( -1 ), @@ -85,11 +83,9 @@ myOptionsFrame( 0 ) setFocusProxy( le ); } -//================================================================ -// Function : QtxPathDialog -// Purpose : Constructor. -//================================================================ - +/*! + Constructor. +*/ QtxPathDialog::QtxPathDialog( QWidget* parent, const bool modal, const bool resize, const int buttons, WFlags f ) : QtxDialog( parent, 0, modal, resize, buttons, f ), myDefault( -1 ), @@ -99,60 +95,51 @@ myOptionsFrame( 0 ) initialize(); } -//================================================================ -// Function : ~QtxPathDialog -// Purpose : Destructor. -//================================================================ - +/*! + Destructor. +*/ QtxPathDialog::~QtxPathDialog() { } -//================================================================ -// Function : fileName -// Purpose : -//================================================================ - +/*! + \return file name +*/ QString QtxPathDialog::fileName() const { return fileName( defaultEntry() ); } -//================================================================ -// Function : setFileName -// Purpose : -//================================================================ - +/*! + Sets file name + \param txt - new file name + \param autoExtension - auto extension determination by file +*/ void QtxPathDialog::setFileName( const QString& txt, const bool autoExtension ) { setFileName( defaultEntry(), txt, autoExtension ); } -//================================================================ -// Function : filter -// Purpose : -//================================================================ - +/*! + \return filter +*/ QString QtxPathDialog::filter() const { return myFilter; } -//================================================================ -// Function : setFilter -// Purpose : -//================================================================ - +/*! + Changes filter (filter is a list of masks, separated by ';;') + \param fltr - new filter +*/ void QtxPathDialog::setFilter( const QString& fltr ) { myFilter = fltr; } -//================================================================ -// Function : show -// Purpose : -//================================================================ - +/*! + Shows path dialog +*/ void QtxPathDialog::show() { if ( hasVisibleChildren( myEntriesFrame ) ) @@ -168,11 +155,9 @@ void QtxPathDialog::show() QtxDialog::show(); } -//================================================================ -// Function : onBrowse -// Purpose : -//================================================================ - +/*! + SLOT: called if user click button to show standard file dialog +*/ void QtxPathDialog::onBrowse() { const QObject* obj = sender(); @@ -247,11 +232,9 @@ void QtxPathDialog::onBrowse() emit fileNameChanged( fName ); } -//================================================================ -// Function : onReturnPressed -// Purpose : -//================================================================ - +/*! + SLOT: called if user presses RETURN in line edit +*/ void QtxPathDialog::onReturnPressed() { const QObject* obj = sender(); @@ -270,31 +253,25 @@ void QtxPathDialog::onReturnPressed() emit fileNameChanged( fileName() ); } -//================================================================ -// Function : onTextChanged -// Purpose : -//================================================================ - +/*! + SLOT: called if text in line edit is changed +*/ void QtxPathDialog::onTextChanged( const QString& ) { validate(); } -//================================================================ -// Function : validate -// Purpose : -//================================================================ - +/*! + Checks validity of text and according to it enables/disables OK, Yes buttons +*/ void QtxPathDialog::validate() { setButtonEnabled( isValid(), OK | Yes ); } -//================================================================ -// Function : isValid -// Purpose : -//================================================================ - +/*! + \return true if selected file is valid +*/ bool QtxPathDialog::isValid() { bool ok = true; @@ -305,11 +282,9 @@ bool QtxPathDialog::isValid() return ok; } -//================================================================ -// Function : acceptData -// Purpose : -//================================================================ - +/*! + \return true entered data is accepted +*/ bool QtxPathDialog::acceptData() const { bool ok = true; @@ -383,30 +358,25 @@ bool QtxPathDialog::acceptData() const return ok; } -//================================================================ -// Function : fileNameChanged -// Purpose : -//================================================================ - +/*! + Some custom activity on file name changing (must be redefined, default implementation is empty +*/ void QtxPathDialog::fileNameChanged( int, QString ) { } -//================================================================ -// Function : optionsFrame -// Purpose : -//================================================================ - +/*! + \return frame with options +*/ QFrame* QtxPathDialog::optionsFrame() { return myOptionsFrame; } -//================================================================ -// Function : getFileName -// Purpose : -//================================================================ - +/*! + \return file name + \param id - id of file entry +*/ QString QtxPathDialog::fileName( const int id ) const { QString res; @@ -416,11 +386,12 @@ QString QtxPathDialog::fileName( const int id ) const return res; } -//================================================================ -// Function : setFileName -// Purpose : -//================================================================ - +/*! + Change file name of file entry + \param id - id of file entry + \param txt - new file name + \param autoExt - assign extension automatically +*/ void QtxPathDialog::setFileName( const int id, const QString& txt, const bool autoExt ) { int mode; @@ -435,11 +406,10 @@ void QtxPathDialog::setFileName( const int id, const QString& txt, const bool au } } -//================================================================ -// Function : fileEntry -// Purpose : -//================================================================ - +/*! + \return line edit of file entry + \param id - id of file entry +*/ QLineEdit* QtxPathDialog::fileEntry( const int id ) const { QLineEdit* le = 0; @@ -449,11 +419,11 @@ QLineEdit* QtxPathDialog::fileEntry( const int id ) const return le; } -//================================================================ -// Function : fileEntry -// Purpose : -//================================================================ - +/*! + \return line edit and mode of file entry + \param id - id of file entry + \param theMode - for return mode of file entry +*/ QLineEdit* QtxPathDialog::fileEntry( const int theId, int& theMode ) const { QLineEdit* le = 0; @@ -466,11 +436,13 @@ QLineEdit* QtxPathDialog::fileEntry( const int theId, int& theMode ) const return le; } -//================================================================ -// Function : createFileEntry -// Purpose : -//================================================================ - +/*! + Creates file entry + \return id of just created file entry + \param lab - title of entry + \param mode - mode of entry + \param id - proposed id (if it is -1, then id will be chosen automatically) +*/ int QtxPathDialog::createFileEntry( const QString& lab, const int mode, const int id ) { int num = id; @@ -500,31 +472,26 @@ int QtxPathDialog::createFileEntry( const QString& lab, const int mode, const in return num; } -//================================================================ -// Function : defaultEntry -// Purpose : -//================================================================ - +/*! + \return id of default entry +*/ int QtxPathDialog::defaultEntry() const { return myDefault; } -//================================================================ -// Function : setDefaultEntry -// Purpose : -//================================================================ - +/*! + Change default entry id + \param id - new default entry id +*/ void QtxPathDialog::setDefaultEntry( const int id ) { myDefault = id; } -//================================================================ -// Function : initialize -// Purpose : -//================================================================ - +/*! + Initialize dialog layout +*/ void QtxPathDialog::initialize() { setCaption( tr( "File dialog" ) ); @@ -539,11 +506,9 @@ void QtxPathDialog::initialize() myOptionsFrame = new QFrame( mainGroup ); } -//================================================================ -// Function : prepareFilters -// Purpose : -//================================================================ - +/*! + \return list of filters +*/ QStringList QtxPathDialog::prepareFilters() const { QStringList res; @@ -564,11 +529,9 @@ QStringList QtxPathDialog::prepareFilters() const return res; } -//================================================================ -// Function : filterWildCards -// Purpose : -//================================================================ - +/*! + \return list of filters with filtered wild cards +*/ QStringList QtxPathDialog::filterWildCards( const QString& theFilter ) const { QStringList res; @@ -586,11 +549,11 @@ QStringList QtxPathDialog::filterWildCards( const QString& theFilter ) const return res; } -//================================================================ -// Function : autoExtension -// Purpose : -//================================================================ - +/*! + \return file name with assigned extension + \param theFileName - source file name + \param theFilter - list of filters +*/ QString QtxPathDialog::autoExtension( const QString& theFileName, const QString& theFilter ) const { QString fName = theFileName; @@ -620,11 +583,10 @@ QString QtxPathDialog::autoExtension( const QString& theFileName, const QString& return fName; } -//================================================================ -// Function : hasVisibleChildren -// Purpose : -//================================================================ - +/*! + \return true if widget has visible children + \param wid - widget +*/ bool QtxPathDialog::hasVisibleChildren( QWidget* wid ) const { bool res = false; diff --git a/src/Qtx/QtxPopupMenu.cxx b/src/Qtx/QtxPopupMenu.cxx index 5da53d034..f46537eac 100644 --- a/src/Qtx/QtxPopupMenu.cxx +++ b/src/Qtx/QtxPopupMenu.cxx @@ -45,6 +45,9 @@ private: int myAlign; }; +/*! + Constructor +*/ QtxPopupMenu::TitleMenuItem::TitleMenuItem( const QString& txt, const QIconSet& ico, const int align ) : QCustomMenuItem(), myText( txt ), @@ -53,26 +56,42 @@ myAlign( align ) { } +/*! + Destructor +*/ QtxPopupMenu::TitleMenuItem::~TitleMenuItem() { } +/*! + \return TRUE if this item wants to span the entire popup menu width +*/ bool QtxPopupMenu::TitleMenuItem::fullSpan() const { return true; } +/*! + \return TRUE if this item is just a separator +*/ bool QtxPopupMenu::TitleMenuItem::isSeparator() const { return false; } +/*! + Changes font of item + \param font - new font +*/ void QtxPopupMenu::TitleMenuItem::setFont( const QFont& font ) { myFont = font; myFont.setBold( true ); } +/*! + Draws item +*/ void QtxPopupMenu::TitleMenuItem::paint( QPainter* p, const QColorGroup& cg, bool act, bool enabled, int x, int y, int w, int h ) { @@ -119,6 +138,9 @@ void QtxPopupMenu::TitleMenuItem::paint( QPainter* p, const QColorGroup& cg, p->setFont( f ); } +/*! + \return the recommended size for item +*/ QSize QtxPopupMenu::TitleMenuItem::sizeHint() { QFontMetrics fM( myFont ); @@ -132,10 +154,8 @@ QSize QtxPopupMenu::TitleMenuItem::sizeHint() } /*! - Class: QtxPopupMenu [Public] - Descr: Popup menu item with title. + Constructor */ - QtxPopupMenu::QtxPopupMenu( QWidget* parent, const char* name ) : QPopupMenu( parent, name ), myId( -1 ), @@ -144,30 +164,49 @@ myAlign( AlignCenter ) { } +/*! + Destructor +*/ QtxPopupMenu::~QtxPopupMenu() { } +/*! + \return popup menu title +*/ QString QtxPopupMenu::titleText() const { return myText; } +/*! + \return popup menu icon +*/ QIconSet QtxPopupMenu::titleIcon() const { return myIcon; } +/*! + \return popup menu title policy +*/ int QtxPopupMenu::titlePolicy() const { return myPolicy; } +/*! + \return popup menu title alignment +*/ int QtxPopupMenu::titleAlignment() const { return myAlign; } +/*! + Changes title text + \param txt - new text +*/ void QtxPopupMenu::setTitleText( const QString& txt ) { if ( myText == txt ) @@ -178,6 +217,10 @@ void QtxPopupMenu::setTitleText( const QString& txt ) updateTitle(); } +/*! + Changes title icon + \param icon - new icon +*/ void QtxPopupMenu::setTitleIcon( const QIconSet& ico ) { myIcon = ico; @@ -185,6 +228,10 @@ void QtxPopupMenu::setTitleIcon( const QIconSet& ico ) updateTitle(); } +/*! + Changes title policy + \param p - new policy +*/ void QtxPopupMenu::setTitlePolicy( const int p ) { if ( myPolicy == p ) @@ -195,6 +242,10 @@ void QtxPopupMenu::setTitlePolicy( const int p ) updateTitle(); } +/*! + Changes title alignment + \param a - new alignment +*/ void QtxPopupMenu::setTitleAlignment( const int a ) { if ( myAlign == a ) @@ -205,6 +256,9 @@ void QtxPopupMenu::setTitleAlignment( const int a ) updateTitle(); } +/*! + Shows menu +*/ void QtxPopupMenu::show() { insertTitle(); @@ -212,6 +266,9 @@ void QtxPopupMenu::show() QPopupMenu::show(); } +/*! + Hides menu +*/ void QtxPopupMenu::hide() { QPopupMenu::hide(); @@ -219,12 +276,21 @@ void QtxPopupMenu::hide() removeTitle(); } +/*! + Creates title item + \param txt - item text + \param icon - item icon + \param align - item alignment +*/ QtxPopupMenu::TitleMenuItem* QtxPopupMenu::createTitleItem( const QString& txt, const QIconSet& ico, const int align ) const { return new TitleMenuItem( txt, ico, align ); } +/*! + Inserts title item to popup menu +*/ void QtxPopupMenu::insertTitle() { if ( myId != -1 || titlePolicy() == TitleOff || @@ -237,6 +303,9 @@ void QtxPopupMenu::insertTitle() setItemEnabled( myId, false ); } +/*! + Removes title item from popup menu +*/ void QtxPopupMenu::removeTitle() { if ( myId == -1 ) @@ -246,6 +315,9 @@ void QtxPopupMenu::removeTitle() myId = -1; } +/*! + Updates title item +*/ void QtxPopupMenu::updateTitle() { if ( myId != -1 ) diff --git a/src/Qtx/QtxPopupMgr.cxx b/src/Qtx/QtxPopupMgr.cxx index f01716c16..37d0cbbc1 100644 --- a/src/Qtx/QtxPopupMgr.cxx +++ b/src/Qtx/QtxPopupMgr.cxx @@ -25,10 +25,13 @@ #include #include -//================================================================ -// Function : -// Purpose : -//================================================================ + +/*! + \return value of global parameter (depending on whole selection, but not dependending on one object of selection) + \param str - name of parameter + + By default, it returns count of selected objects ("selcount") and list of parameters ("$") +*/ QtxValue QtxPopupMgr::Selection::globalParam( const QString& str ) const { if( str==selCountParam() ) @@ -54,37 +57,33 @@ QtxValue QtxPopupMgr::Selection::globalParam( const QString& str ) const return QtxValue(); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return symbole to detect name of parameter list +*/ QChar QtxPopupMgr::Selection::equality() const { return defEquality(); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return name of parameter for count of selected objects +*/ QString QtxPopupMgr::Selection::selCountParam() const { return defSelCountParam(); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return default symbole to detect name of parameter list +*/ QChar QtxPopupMgr::Selection::defEquality() { return '$'; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return default name of parameter for count of selected objects +*/ QString QtxPopupMgr::Selection::defSelCountParam() { return "selcount"; @@ -92,12 +91,15 @@ QString QtxPopupMgr::Selection::defSelCountParam() +/*! + \class QtxCacheSelection + Special selection class, that caches parameter values. + Every parameter during popup building is calculated only one time, + although it may be included to many rules. After calculation + it is stored in internal map +*/ -//================================================================ -// Class : -// Purpose : -//================================================================ class QtxCacheSelection : public QtxPopupMgr::Selection { public: @@ -115,36 +117,37 @@ private: CacheMap myParamCache; }; -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Constructor + \param sel - base selection used for parameter calculation +*/ QtxCacheSelection::QtxCacheSelection( QtxPopupMgr::Selection* sel ) : mySel( sel ) { } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Destructor +*/ QtxCacheSelection::~QtxCacheSelection() { } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return count of selected objects +*/ int QtxCacheSelection::count() const { return mySel ? mySel->count() : 0; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Calculates and caches parameters. + Already calculated parameters are returned without calculation + \return parameter value + \param i - index of selected object + \param name - name of parameter +*/ QtxValue QtxCacheSelection::param( const int i, const QString& name ) const { QString param_name = name + "#####" + QString::number( i ); @@ -161,10 +164,12 @@ QtxValue QtxCacheSelection::param( const int i, const QString& name ) const } } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Calculates and caches global parameters. + Already calculated parameters are returned without calculation + \return parameter value + \param name - name of parameter +*/ QtxValue QtxCacheSelection::globalParam( const QString& name ) const { if( myParamCache.contains( name ) ) @@ -183,11 +188,10 @@ QtxValue QtxCacheSelection::globalParam( const QString& name ) const - -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Constructor + \param mgr - popup manager +*/ QtxPopupMgr::Operations::Operations( QtxPopupMgr* mgr ) : QtxStrings(), myPopupMgr( mgr ) @@ -201,19 +205,19 @@ QtxPopupMgr::Operations::Operations( QtxPopupMgr* mgr ) myParser = new QtxParser( mgr->myOperations ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Destructor + Deletes internal parser +*/ QtxPopupMgr::Operations::~Operations() { delete myParser; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return priority of popup operation 'op'. + \param isBin indicate whether the operation is binary +*/ int QtxPopupMgr::Operations::prior( const QString& op, bool isBin ) const { if( !isBin && ( op=="every" || op=="any" || op=="onlyone" ) ) @@ -223,10 +227,13 @@ int QtxPopupMgr::Operations::prior( const QString& op, bool isBin ) const } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Calculates result of operation + \return one of error states + \param op - name of operation + \param v1 - first operation argument (must be used also to store result) + \param v2 - second operation argument +*/ QtxParser::Error QtxPopupMgr::Operations::calculate ( const QString& op, QtxValue& v1, QtxValue& v2 ) const { @@ -299,10 +306,9 @@ QtxParser::Error QtxPopupMgr::Operations::calculate return QtxStrings::calculate( op, v1, v2 ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Clears internal map of values +*/ void QtxPopupMgr::Operations::clear() { myValues.clear(); @@ -315,11 +321,9 @@ void QtxPopupMgr::Operations::clear() - -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Constructor +*/ QtxPopupMgr::QtxPopupMgr( QPopupMenu* popup, QObject* parent ) : QtxActionMenuMgr( popup, parent ), myCurrentSelection( 0 ) @@ -327,18 +331,16 @@ QtxPopupMgr::QtxPopupMgr( QPopupMenu* popup, QObject* parent ) createOperations(); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Destructor +*/ QtxPopupMgr::~QtxPopupMgr() { } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Creates popup operations instance +*/ void QtxPopupMgr::createOperations() { myOperations = new QtxListOfOperations; @@ -349,10 +351,13 @@ void QtxPopupMgr::createOperations() myOperations->append( "custom", new Operations( this ), 200 ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Additional version of registerAction + \param act - action to be registered + \param visible - rule for visibility state + \param toggle - rule for toggle on state + \param id - proposed id (if it is less than 0, then id will be generated automatically) +*/ int QtxPopupMgr::registerAction( QAction* act, const QString& visible, const QString& toggle, @@ -364,10 +369,10 @@ int QtxPopupMgr::registerAction( QAction* act, return _id; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Removes action from internal map + \param id - action id +*/ void QtxPopupMgr::unRegisterAction( const int id ) { QAction* act = action( id ); @@ -379,28 +384,32 @@ void QtxPopupMgr::unRegisterAction( const int id ) //QtxActionMenuMgr::unRegisterAction( id ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return true if manager has rule for action + \param act - action + \param visibility - if it is true, then rule for "visibility" is checked, otherwise - for "toggle" +*/ bool QtxPopupMgr::hasRule( QAction* act, bool visibility ) const { return map( visibility ).contains( act ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return true if manager has rule for action + \param id - action id + \param visibility - if it is true, then rule for "visibility" is checked, otherwise - for "toggle" +*/ bool QtxPopupMgr::hasRule( const int id, bool visibility ) const { return hasRule( action( id ), visibility ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Sets new rule for action + \param act - action + \param rule - string expression of rule + \param visibility - if it is true, then rule for "visibility" will be set, otherwise - for "toggle" +*/ void QtxPopupMgr::setRule( QAction* act, const QString& rule, bool visibility ) { if( !act || rule.isEmpty() ) @@ -423,19 +432,21 @@ void QtxPopupMgr::setRule( QAction* act, const QString& rule, bool visibility ) } } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Sets new rule for action + \param id - action id + \param rule - string expression of rule + \param visibility - if it is true, then rule for "visibility" will be set, otherwise - for "toggle" +*/ void QtxPopupMgr::setRule( const int id, const QString& rule, bool visibility ) { setRule( action( id ), rule, visibility ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return true if parser has finished work without errors + \param p - parser +*/ bool result( QtxParser* p ) { bool res = false; @@ -449,10 +460,11 @@ bool result( QtxParser* p ) return res; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Fills parser parameters with help of Selection::globalParam() method + \param p - parser + \param specific - list will be filled with names of parameters depending on selection objects (not global) +*/ void QtxPopupMgr::setParams( QtxParser* p, QStringList& specific ) const { if( !p || !myCurrentSelection ) @@ -473,6 +485,10 @@ void QtxPopupMgr::setParams( QtxParser* p, QStringList& specific ) const } } +/*! + \return true if 'v1'<'v2' + This function can work with many types of values +*/ bool operator<( const QtxValue& v1, const QtxValue& v2 ) { QVariant::Type t1 = v1.type(), t2 = v2.type(); @@ -512,10 +528,11 @@ bool operator<( const QtxValue& v1, const QtxValue& v2 ) return t1menuText(); @@ -580,10 +597,11 @@ bool QtxPopupMgr::isSatisfied( QAction* act, bool visibility ) const return res; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return true if item corresponding to action is visible + \param actId - action id + \param place - index of place +*/ bool QtxPopupMgr::isVisible( const int actId, const int place ) const { bool res = QtxActionMenuMgr::isVisible( actId, place ); @@ -593,10 +611,11 @@ bool QtxPopupMgr::isVisible( const int actId, const int place ) const return res; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Updates popup according to selection + \param p - popup menu + \param sel - selection +*/ void QtxPopupMgr::updatePopup( QPopupMenu* p, Selection* sel ) { QTime t1 = QTime::currentTime(); @@ -620,19 +639,21 @@ void QtxPopupMgr::updatePopup( QPopupMenu* p, Selection* sel ) delete myCurrentSelection; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return reference to map of rules + \param visibility - type of map: visibility of toggle +*/ QtxPopupMgr::RulesMap& QtxPopupMgr::map( bool visibility ) const { return ( RulesMap& )( visibility ? myVisibility : myToggle ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Loads actions description from file + \param fname - name of file + \param r - reader of file + \return true on success +*/ bool QtxPopupMgr::load( const QString& fname, QtxActionMgr::Reader& r ) { PopupCreator cr( &r, this ); @@ -642,10 +663,11 @@ bool QtxPopupMgr::load( const QString& fname, QtxActionMgr::Reader& r ) -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Constructor + \param r - menu reader + \param mgr - menu manager +*/ QtxPopupMgr::PopupCreator::PopupCreator( QtxActionMgr::Reader* r, QtxPopupMgr* mgr ) : QtxActionMgr::Creator( r ), @@ -653,18 +675,20 @@ QtxPopupMgr::PopupCreator::PopupCreator( QtxActionMgr::Reader* r, { } -//================================================================ -// Function : -// Purpose : -//================================================================ -QtxPopupMgr::PopupCreator::~PopupCreator() +/*! + Destructor +*/QtxPopupMgr::PopupCreator::~PopupCreator() { } -//================================================================ -// Function : -// Purpose : -//================================================================ + +/*! + Appends new menu items + \param tag - tag of item + \param subMenu - it has submenu + \param attr - list of attributes + \param pId - id of action corresponding to parent item +*/ int QtxPopupMgr::PopupCreator::append( const QString& tag, const bool subMenu, const ItemAttributes& attr, const int pId ) { @@ -716,19 +740,19 @@ int QtxPopupMgr::PopupCreator::append( const QString& tag, const bool subMenu, return res; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return visibility rule by attributes + Default implementation is empty +*/ QString QtxPopupMgr::PopupCreator::visibleRule( const ItemAttributes& ) const { return QString::null; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return toggle rule by attributes + Default implementation is empty +*/ QString QtxPopupMgr::PopupCreator::toggleRule( const ItemAttributes& ) const { return QString::null; diff --git a/src/Qtx/QtxPopupMgr.h b/src/Qtx/QtxPopupMgr.h index a75a7dced..7e8d2ff13 100644 --- a/src/Qtx/QtxPopupMgr.h +++ b/src/Qtx/QtxPopupMgr.h @@ -29,10 +29,6 @@ class QtxListOfOperations; -//================================================================ -// Class : -// Purpose : -//================================================================ class QTX_EXPORT QtxPopupMgr : public QtxActionMenuMgr { Q_OBJECT diff --git a/src/Qtx/QtxResourceEdit.cxx b/src/Qtx/QtxResourceEdit.cxx index e499236ff..d4398e2ad 100644 --- a/src/Qtx/QtxResourceEdit.cxx +++ b/src/Qtx/QtxResourceEdit.cxx @@ -23,16 +23,18 @@ #include "QtxResourceMgr.h" -/* - Class: QtxResourceEdit - Descr: Class for managing preferences items -*/ +/*! + Constructor +*/ QtxResourceEdit::QtxResourceEdit( QtxResourceMgr* mgr ) : myResMgr( mgr ) { } +/*! + Destructor +*/ QtxResourceEdit::~QtxResourceEdit() { ItemMap items; @@ -44,11 +46,22 @@ QtxResourceEdit::~QtxResourceEdit() delete itr.data(); } +/*! + \return assigned resource manager +*/ QtxResourceMgr* QtxResourceEdit::resourceMgr() const { return myResMgr; } +/*! + Adds new item + \param label - label of widget to edit preference + \param pId - parent item id + \param type - type of item + \param section - section of resource assigned with item + \param param - name of resource assigned with item +*/ int QtxResourceEdit::addItem( const QString& label, const int pId, const int type, const QString& section, const QString& param ) { @@ -72,6 +85,11 @@ int QtxResourceEdit::addItem( const QString& label, const int pId, const int typ return i->id(); } +/*! + \return value of item property + \param id - item id + \propName - propertyName +*/ QVariant QtxResourceEdit::itemProperty( const int id, const QString& propName ) const { QVariant propValue; @@ -81,6 +99,12 @@ QVariant QtxResourceEdit::itemProperty( const int id, const QString& propName ) return propValue; } +/*! + Sets value of item property + \param id - item id + \propName - propertyName + \propValue - new value of property +*/ void QtxResourceEdit::setItemProperty( const int id, const QString& propName, const QVariant& propValue ) { Item* i = item( id ); @@ -88,6 +112,12 @@ void QtxResourceEdit::setItemProperty( const int id, const QString& propName, co i->setProperty( propName, propValue ); } +/*! + \return resource assigned with item + \param id - item id + \param section - to return section of resource + \param param - to return name of resource +*/ void QtxResourceEdit::resource( const int id, QString& sec, QString& param ) const { Item* i = item( id ); @@ -95,6 +125,9 @@ void QtxResourceEdit::resource( const int id, QString& sec, QString& param ) con i->resource( sec, param ); } +/*! + Stores all values to resource manager +*/ void QtxResourceEdit::store() { QMap before; @@ -112,18 +145,27 @@ void QtxResourceEdit::store() changedResources( changed ); } +/*! + Retrieve all values from resource manager +*/ void QtxResourceEdit::retrieve() { for ( ItemMap::ConstIterator it = myItems.begin(); it != myItems.end(); ++it ) it.data()->retrieve(); } +/*! + Stores all values to backup container +*/ void QtxResourceEdit::toBackup() { myBackup.clear(); resourceValues( myBackup ); } +/*! + Retrieve all values from backup container +*/ void QtxResourceEdit::fromBackup() { QMap before; @@ -140,10 +182,17 @@ void QtxResourceEdit::fromBackup() changedResources( changed ); } +/*! + Updates resource edit (default implementation is empty) +*/ void QtxResourceEdit::update() { } +/*! + \return item by it's id + \param id - item id +*/ QtxResourceEdit::Item* QtxResourceEdit::item( const int id ) const { Item* i = 0; @@ -152,6 +201,10 @@ QtxResourceEdit::Item* QtxResourceEdit::item( const int id ) const return i; } +/*! + \return item by it's title (finds first item) + \param title - item title +*/ QtxResourceEdit::Item* QtxResourceEdit::item( const QString& title ) const { Item* i = 0; @@ -163,6 +216,11 @@ QtxResourceEdit::Item* QtxResourceEdit::item( const QString& title ) const return i; } +/*! + \return item by it's title and parent id + \param title - item title + \param pId - parent id +*/ QtxResourceEdit::Item* QtxResourceEdit::item( const QString& title, const int pId ) const { Item* i = 0; @@ -175,6 +233,13 @@ QtxResourceEdit::Item* QtxResourceEdit::item( const QString& title, const int pI return i; } +/*! + Creates item + \return new item + \param label - text of label for new item + \param type - type of new item + \param pId - parent id +*/ QtxResourceEdit::Item* QtxResourceEdit::createItem( const QString& label, const int type, const int pId ) { Item* i = 0; @@ -193,6 +258,10 @@ QtxResourceEdit::Item* QtxResourceEdit::createItem( const QString& label, const return i; } +/*! + Removes item + \param item - item to be removed +*/ void QtxResourceEdit::removeItem( Item* item ) { if ( !item ) @@ -204,6 +273,10 @@ void QtxResourceEdit::removeItem( Item* item ) itemRemoved( item ); } +/*! + \return children items of resource edit + \param lst - list of items to be filled with children +*/ void QtxResourceEdit::childItems( QPtrList& lst ) const { lst.clear(); @@ -211,6 +284,10 @@ void QtxResourceEdit::childItems( QPtrList& lst ) const lst.append( it.current() ); } +/*! + \return all resources values from widgets + \param map - map to be filled by resources values +*/ void QtxResourceEdit::resourceValues( QMap& map ) const { QString sect, name; @@ -222,6 +299,10 @@ void QtxResourceEdit::resourceValues( QMap& map ) const } } +/*! + \return all resources values from widgets + \param map - map to be filled by resources values +*/ void QtxResourceEdit::resourceValues( QMap& map ) const { QString sect, name; @@ -233,6 +314,10 @@ void QtxResourceEdit::resourceValues( QMap& map ) const } } +/*! + Sets to widgets all resources values from map + \param map - map with resources values +*/ void QtxResourceEdit::setResourceValues( QMap& map ) const { for ( QMap::ConstIterator it = map.begin(); it != map.end(); ++it ) @@ -243,13 +328,23 @@ void QtxResourceEdit::setResourceValues( QMap& map ) const } } +/*! + Sets to widgets all resources values from map + \param map - map with resources values +*/ void QtxResourceEdit::setResourceValues( QMap& map ) const { for ( QMap::ConstIterator it = map.begin(); it != map.end(); ++it ) it.key()->setResourceValue( it.data() ); } - +/*! + Compares two map of resources values and finds different ones + \param map1 - first map + \param map2 - second map + \param resMap - map to be filled with different values + \param fromFirst - if it is true, then resMap will be filled with values from first map, otherwise - from second +*/ void QtxResourceEdit::differentValues( const QMap& map1, const QMap& map2, QMap& resMap, const bool fromFirst ) const { @@ -264,6 +359,13 @@ void QtxResourceEdit::differentValues( const QMap& map1, const QMa } } +/*! + Compares two map of resources values and finds different ones + \param map1 - first map + \param map2 - second map + \param resMap - map to be filled with different values + \param fromFirst - if it is true, then resMap will be filled with values from first map, otherwise - from second +*/ void QtxResourceEdit::differentValues( const QMap& map1, const QMap& map2, QMap& resMap, const bool fromFirst ) const { @@ -278,23 +380,31 @@ void QtxResourceEdit::differentValues( const QMap& map1, const Q } } +/*! + Makes some activity on resource changing (called from store() method) + \sa store() +*/ void QtxResourceEdit::changedResources( const QMap& ) { } +/*! + Some activity on item addition (default implementation is empty) +*/ void QtxResourceEdit::itemAdded( Item* ) { } +/*! + Some activity on item removing (default implementation is empty) +*/ void QtxResourceEdit::itemRemoved( Item* ) { } -/* - Class: QtxResourceEdit::Item - Descr: Class for incapsulation of one preference item +/*! + Constructor */ - QtxResourceEdit::Item::Item( QtxResourceEdit* edit, Item* parent ) : myEdit( edit ), myParent( 0 ) @@ -305,22 +415,35 @@ myParent( 0 ) parent->insertChild( this ); } +/*! + Destructor +*/ QtxResourceEdit::Item::~Item() { if ( resourceEdit() ) resourceEdit()->removeItem( this ); } +/*! + \return id of item +*/ int QtxResourceEdit::Item::id() const { return myId; } +/*! + \return parent item +*/ QtxResourceEdit::Item* QtxResourceEdit::Item::parentItem() const { return myParent; } +/*! + Appends child and (if necessary) removes item from old parent + \param item - item to be added +*/ void QtxResourceEdit::Item::insertChild( Item* item ) { if ( !item || myChildren.contains( item ) ) @@ -333,6 +456,10 @@ void QtxResourceEdit::Item::insertChild( Item* item ) myChildren.append( item ); } +/*! + Removes child + \param item - item to be removed +*/ void QtxResourceEdit::Item::removeChild( Item* item ) { if ( !item || !myChildren.contains( item ) ) @@ -342,62 +469,105 @@ void QtxResourceEdit::Item::removeChild( Item* item ) item->myParent = 0; } +/*! + Fills list with children items + \param lst - list to be filled with +*/ void QtxResourceEdit::Item::childItems( QPtrList& lst ) const { for ( ItemListIterator it( myChildren ); it.current(); ++it ) lst.append( it.current() ); } +/*! + \return true if there is no children of this item +*/ bool QtxResourceEdit::Item::isEmpty() const { return myChildren.isEmpty(); } +/*! + \return title of item +*/ QString QtxResourceEdit::Item::title() const { return myTitle; } +/*! + \return assigned resource placement + \param sec - to return section + \param param - to return param name +*/ void QtxResourceEdit::Item::resource( QString& sec, QString& param ) const { sec = myResSection; param = myResParameter; } +/*! + Sets item title + \param title - new item title +*/ void QtxResourceEdit::Item::setTitle( const QString& title ) { myTitle = title; } +/*! + Assigns new resource to item + \param sec - section + \param sec - param name +*/ void QtxResourceEdit::Item::setResource( const QString& sec, const QString& param ) { myResSection = sec; myResParameter = param; } +/*! + Updates item (default implementation is empty) +*/ void QtxResourceEdit::Item::update() { } +/*! + \return property value +*/ QVariant QtxResourceEdit::Item::property( const QString& ) const { return QVariant(); } +/*! + Sets property value +*/ void QtxResourceEdit::Item::setProperty( const QString&, const QVariant& ) { } +/*! + \return value of assigned resource +*/ QString QtxResourceEdit::Item::resourceValue() const { return getString(); } +/*! + Sets value of assigned resource + \param val - new value +*/ void QtxResourceEdit::Item::setResourceValue( const QString& val ) { setString( val ); } +/*! + \return corresponding resource manager +*/ QtxResourceMgr* QtxResourceEdit::Item::resourceMgr() const { QtxResourceMgr* resMgr = 0; @@ -406,47 +576,78 @@ QtxResourceMgr* QtxResourceEdit::Item::resourceMgr() const return resMgr; } +/*! + \return corresponding resource edit +*/ QtxResourceEdit* QtxResourceEdit::Item::resourceEdit() const { return myEdit; } +/*! + \return integer value of resource corresponding to item + \param val - default value (it is returned if there is no such resource) +*/ int QtxResourceEdit::Item::getInteger( const int val ) const { QtxResourceMgr* resMgr = resourceMgr(); return resMgr ? resMgr->integerValue( myResSection, myResParameter, val ) : val; } +/*! + \return double value of resource corresponding to item + \param val - default value (it is returned if there is no such resource) +*/ double QtxResourceEdit::Item::getDouble( const double val ) const { QtxResourceMgr* resMgr = resourceMgr(); return resMgr ? resMgr->doubleValue( myResSection, myResParameter, val ) : val; } +/*! + \return boolean value of resource corresponding to item + \param val - default value (it is returned if there is no such resource) +*/ bool QtxResourceEdit::Item::getBoolean( const bool val ) const { QtxResourceMgr* resMgr = resourceMgr(); return resMgr ? resMgr->booleanValue( myResSection, myResParameter, val ) : val; } +/*! + \return string value of resource corresponding to item + \param val - default value (it is returned if there is no such resource) +*/ QString QtxResourceEdit::Item::getString( const QString& val ) const { QtxResourceMgr* resMgr = resourceMgr(); return resMgr ? resMgr->stringValue( myResSection, myResParameter, val ) : val; } +/*! + \return color value of resource corresponding to item + \param val - default value (it is returned if there is no such resource) +*/ QColor QtxResourceEdit::Item::getColor( const QColor& val ) const { QtxResourceMgr* resMgr = resourceMgr(); return resMgr ? resMgr->colorValue( myResSection, myResParameter, val ) : val; } +/*! + \return font value of resource corresponding to item + \param val - default value (it is returned if there is no such resource) +*/ QFont QtxResourceEdit::Item::getFont( const QFont& val ) const { QtxResourceMgr* resMgr = resourceMgr(); return resMgr ? resMgr->fontValue( myResSection, myResParameter, val ) : val; } +/*! + Sets value of resource + \param val - value +*/ void QtxResourceEdit::Item::setInteger( const int val ) { QtxResourceMgr* resMgr = resourceMgr(); @@ -454,6 +655,10 @@ void QtxResourceEdit::Item::setInteger( const int val ) resMgr->setValue( myResSection, myResParameter, val ); } +/*! + Sets value of resource + \param val - value +*/ void QtxResourceEdit::Item::setDouble( const double val ) { QtxResourceMgr* resMgr = resourceMgr(); @@ -461,6 +666,10 @@ void QtxResourceEdit::Item::setDouble( const double val ) resMgr->setValue( myResSection, myResParameter, val ); } +/*! + Sets value of resource + \param val - value +*/ void QtxResourceEdit::Item::setBoolean( const bool val ) { QtxResourceMgr* resMgr = resourceMgr(); @@ -468,6 +677,10 @@ void QtxResourceEdit::Item::setBoolean( const bool val ) resMgr->setValue( myResSection, myResParameter, val ); } +/*! + Sets value of resource + \param val - value +*/ void QtxResourceEdit::Item::setString( const QString& val ) { QtxResourceMgr* resMgr = resourceMgr(); @@ -475,6 +688,10 @@ void QtxResourceEdit::Item::setString( const QString& val ) resMgr->setValue( myResSection, myResParameter, val ); } +/*! + Sets value of resource + \param val - value +*/ void QtxResourceEdit::Item::setColor( const QColor& val ) { QtxResourceMgr* resMgr = resourceMgr(); @@ -482,6 +699,10 @@ void QtxResourceEdit::Item::setColor( const QColor& val ) resMgr->setValue( myResSection, myResParameter, val ); } +/*! + Sets value of resource + \param val - value +*/ void QtxResourceEdit::Item::setFont( const QFont& val ) { QtxResourceMgr* resMgr = resourceMgr(); @@ -489,21 +710,37 @@ void QtxResourceEdit::Item::setFont( const QFont& val ) resMgr->setValue( myResSection, myResParameter, val ); } +/*! + \return other item + \param id - other item id +*/ QtxResourceEdit::Item* QtxResourceEdit::Item::item( const int id ) const { return resourceEdit() ? resourceEdit()->item( id ) : 0; } +/*! + \return other item + \param title - other item title +*/ QtxResourceEdit::Item* QtxResourceEdit::Item::item( const QString& title ) const { return resourceEdit() ? resourceEdit()->item( title ) : 0; } +/*! + \return other item + \param title - other item title + \param id - parent item id +*/ QtxResourceEdit::Item* QtxResourceEdit::Item::item( const QString& title, const int id ) const { return resourceEdit() ? resourceEdit()->item( title, id ) : 0; } +/*! + \return free item id +*/ int QtxResourceEdit::Item::generateId() { static int _id = 0; diff --git a/src/Qtx/QtxResourceEdit.h b/src/Qtx/QtxResourceEdit.h index 7c55abc7b..15dd6ceef 100644 --- a/src/Qtx/QtxResourceEdit.h +++ b/src/Qtx/QtxResourceEdit.h @@ -35,6 +35,10 @@ class QtxResourceMgr; #include #include +/*! + \class QtxResourceEdit + Class for managing preferences items +*/ class QTX_EXPORT QtxResourceEdit { public: @@ -104,9 +108,9 @@ private: friend class QtxResourceEdit::Item; }; -/* - Class: QtxResourceEditor::Item - Descr: Class for incapsulation of one preference item +/*! + \class QtxResourceEditor::Item + Class for incapsulation of one preference item */ class QTX_EXPORT QtxResourceEdit::Item diff --git a/src/Qtx/QtxResourceMgr.cxx b/src/Qtx/QtxResourceMgr.cxx index c6c417498..9824aff30 100644 --- a/src/Qtx/QtxResourceMgr.cxx +++ b/src/Qtx/QtxResourceMgr.cxx @@ -42,20 +42,41 @@ QtxResourceMgr::Resources::Resources( const QtxResourceMgr* mgr, const QString& { } +/*! + Destructor +*/ QtxResourceMgr::Resources::~Resources() { } +/*! + Returns name of resource file + This file is used to load/save operations +*/ QString QtxResourceMgr::Resources::file() const { return myFileName; } +/*! + Sets name of resource file + \param fn - name of file +*/ void QtxResourceMgr::Resources::setFile( const QString& fn ) { myFileName = fn; } +/*! + Returns string representation of parameter value + Returns QString::null if there is no such parameter + + \param sect - name of section + \param name - name of parameter + \param subst - if it is true, then the substitution of variables + will be done with help of makeSubstitution method + \sa makeSubstitution() +*/ QString QtxResourceMgr::Resources::value( const QString& sect, const QString& name, const bool subst ) const { QString val; @@ -69,27 +90,52 @@ QString QtxResourceMgr::Resources::value( const QString& sect, const QString& na return val; } +/*! + Sets value by it's string representation + + \param sect - name of section + \param name - name of parameter + \param val - string value +*/ void QtxResourceMgr::Resources::setValue( const QString& sect, const QString& name, const QString& val ) { Section& s = section( sect ); s.insert( name, val ); } +/*! + \return true if section exists + \param sect - name of section +*/ bool QtxResourceMgr::Resources::hasSection( const QString& sect ) const { return mySections.contains( sect ); } +/*! + \return true if parameter exists in section + \param sect - name of section + \param name - name of parameter +*/ bool QtxResourceMgr::Resources::hasValue( const QString& sect, const QString& name ) const { return hasSection( sect ) && section( sect ).contains( name ); } +/*! + Removes section from resources + \param sect - name of section +*/ void QtxResourceMgr::Resources::removeSection( const QString& sect ) { mySections.remove( sect ); } +/*! + Removes parameter from section + \param sect - name of section + \param name - name of parameter +*/ void QtxResourceMgr::Resources::removeValue( const QString& sect, const QString& name ) { if ( !hasSection( sect ) ) @@ -102,16 +148,26 @@ void QtxResourceMgr::Resources::removeValue( const QString& sect, const QString& mySections.remove( sect ); } +/*! + Removes all sections +*/ void QtxResourceMgr::Resources::clear() { mySections.clear(); } +/*! + \return list of section names +*/ QStringList QtxResourceMgr::Resources::sections() const { return mySections.keys(); } +/*! + \return list of parameter names from section + \param sec - name of section +*/ QStringList QtxResourceMgr::Resources::parameters( const QString& sec ) const { if ( !hasSection( sec ) ) @@ -120,6 +176,13 @@ QStringList QtxResourceMgr::Resources::parameters( const QString& sec ) const return section( sec ).keys(); } +/*! + \return path of file from directory built by parameter + \return QString::null if built path doesn't exist + \param sec - name of section + \param prefix - name of parameter containing some path + \param name - name of file +*/ QString QtxResourceMgr::Resources::path( const QString& sec, const QString& prefix, const QString& name ) const { QString filePath = fileName( sec, prefix, name ); @@ -131,11 +194,17 @@ QString QtxResourceMgr::Resources::path( const QString& sec, const QString& pref return filePath; } +/*! + \return corresponding resource manager +*/ QtxResourceMgr* QtxResourceMgr::Resources::resMgr() const { return myMgr; } +/*! + \return instance of section by it's name. Section will be created if it doesn't exist +*/ QtxResourceMgr::Section& QtxResourceMgr::Resources::section( const QString& sn ) { if ( !mySections.contains( sn ) ) @@ -144,11 +213,20 @@ QtxResourceMgr::Section& QtxResourceMgr::Resources::section( const QString& sn ) return mySections[sn]; } +/*! + \return instance of section by it's name. Section will be created if it doesn't exist +*/ const QtxResourceMgr::Section& QtxResourceMgr::Resources::section( const QString& sn ) const { return mySections[sn]; } +/*! + \return full path of file + \param sect - name of section + \param prefix - name of parameter containing some path + \param name - name of file +*/ QString QtxResourceMgr::Resources::fileName( const QString& sect, const QString& prefix, const QString& name ) const { QString path; @@ -173,6 +251,12 @@ QString QtxResourceMgr::Resources::fileName( const QString& sect, const QString& return QString(); } +/*! + \return QPixmap loaded from file + \param sect - name of section + \param prefix - name of parameter containing some path + \param name - name of picture file +*/ QPixmap QtxResourceMgr::Resources::loadPixmap( const QString& sect, const QString& prefix, const QString& name ) const { QString fname = fileName( sect, prefix, name ); @@ -189,6 +273,12 @@ QPixmap QtxResourceMgr::Resources::loadPixmap( const QString& sect, const QStrin return p; } +/*! + \return just created and loaded translator + \param sect - name of section + \param prefix - name of parameter containing some path + \param name - name of file +*/ QTranslator* QtxResourceMgr::Resources::loadTranslator( const QString& sect, const QString& prefix, const QString& name ) const { QTranslator* trans = new QTranslator( 0 ); @@ -200,6 +290,13 @@ QTranslator* QtxResourceMgr::Resources::loadTranslator( const QString& sect, con return trans; } +/*! + Finds in string variables by patterns: ${name} or $(name) or %name% + \return first found name or QString::null if there is no ones + \param str - string where the search is processed + \param start - integer value for returning start position of variable + \param len - integer value for returning length of variable +*/ QString QtxResourceMgr::Resources::environmentVariable( const QString& str, int& start, int& len ) const { QString varName = QString::null; @@ -219,6 +316,15 @@ QString QtxResourceMgr::Resources::environmentVariable( const QString& str, int& return varName; } +/*! + Substitutes variables by its' values. If variable is from enviroment, + it will be replaced by environment value. If it isn't, method tries to + find it's value among resources + \return new variant of string 'str' + \param str - string to process substitution + \param sect - section, in which the variables will be finding + \param name - name of variable which must be ignored during substitution +*/ QString QtxResourceMgr::Resources::makeSubstitution( const QString& str, const QString& sect, const QString& name ) const { QString res = str; @@ -259,7 +365,6 @@ QString QtxResourceMgr::Resources::makeSubstitution( const QString& str, const Q Class: QtxResourceMgr::IniFormat Level: Internal */ - class QtxResourceMgr::IniFormat : public Format { public: @@ -271,15 +376,26 @@ protected: virtual bool save( const QString&, const QMap& ); }; +/*! + Default constructor +*/ QtxResourceMgr::IniFormat::IniFormat() : Format( "ini" ) { } +/*! + Destructor +*/ QtxResourceMgr::IniFormat::~IniFormat() { } +/*! + Loads resources from ini-file to map of sections + \param fname - name of resource file + \param secMap - map of sections +*/ bool QtxResourceMgr::IniFormat::load( const QString& fname, QMap& secMap ) { QFile file( fname ); @@ -346,6 +462,11 @@ bool QtxResourceMgr::IniFormat::load( const QString& fname, QMap& secMap ) { QFile file( fname ); @@ -391,15 +512,26 @@ private: QString valueAttribute() const; }; +/*! + Default constructor +*/ QtxResourceMgr::XmlFormat::XmlFormat() : Format( "xml" ) { } +/*! + Destructor +*/ QtxResourceMgr::XmlFormat::~XmlFormat() { } +/*! + Loads resources from xml-file to map of sections + \param fname - name of resource file + \param secMap - map of sections +*/ bool QtxResourceMgr::XmlFormat::load( const QString& fname, QMap& secMap ) { bool res = false; @@ -495,6 +627,11 @@ bool QtxResourceMgr::XmlFormat::load( const QString& fname, QMap& secMap ) { bool res = false; @@ -532,6 +669,9 @@ bool QtxResourceMgr::XmlFormat::save( const QString& fname, const QMapclear(); } +/*! + Set state 'ignore user values'. + If it is true, then all resources loaded from user home directory is ignored +*/ void QtxResourceMgr::setIgnoreUserValues( const bool val ) { myIsIgnoreUserValues = val; } +/*! + \return state 'ignore user values' +*/ bool QtxResourceMgr::ignoreUserValues() const { return myIsIgnoreUserValues; @@ -1458,6 +1617,13 @@ QStringList QtxResourceMgr::parameters( const QString& sec ) const return res; } +/*! + \return path of file from directory built by parameter + \return QString::null if built path doesn't exist + \param sec - name of section + \param prefix - name of parameter containing some path + \param name - name of file +*/ QString QtxResourceMgr::path( const QString& sect, const QString& prefix, const QString& name ) const { QString res; @@ -1466,6 +1632,9 @@ QString QtxResourceMgr::path( const QString& sect, const QString& prefix, const return res; } +/*! + \return section corresponding to resources paths +*/ QString QtxResourceMgr::resSection() const { QString res = option( "res_section_name" ); @@ -1474,6 +1643,9 @@ QString QtxResourceMgr::resSection() const return res; } +/*! + \return section corresponding to language settings +*/ QString QtxResourceMgr::langSection() const { QString res = option( "lang_section_name" ); @@ -1482,26 +1654,55 @@ QString QtxResourceMgr::langSection() const return res; } +/*! + \return default image used when during loading the image file doesn't exist +*/ QPixmap QtxResourceMgr::defaultPixmap() const { return myDefaultPix; } +/*! + Set image as default image used when during loading the image file doesn't exist + \param pix - image +*/ void QtxResourceMgr::setDefaultPixmap( const QPixmap& pix ) { myDefaultPix = pix; } +/*! + \return image loaded from file + \param prefix - name of parameter containing some path + \param name - name of file +*/ QPixmap QtxResourceMgr::loadPixmap( const QString& prefix, const QString& name ) const { return loadPixmap( prefix, name, true ); } +/*! + \return image loaded from file + \param prefix - name of parameter containing some path + \param name - name of file + \param useDef - indicates if it is possible to use default image returning by defaultPixmap() method. + If it is false, the empty pixmap will be used as default + \sa defaultPixmap() +*/ QPixmap QtxResourceMgr::loadPixmap( const QString& prefix, const QString& name, const bool useDef ) const { return loadPixmap( prefix, name, useDef ? defaultPixmap() : QPixmap() ); } +/*! + Finds in all sections an existing path corresponding to 'prefix' parameter + and load image with name 'name' from this folder + + \return image loaded from file + \param prefix - name of parameter containing some path + \param name - name of file + \param defPix - default image used when file doesn't exist +*/ QPixmap QtxResourceMgr::loadPixmap( const QString& prefix, const QString& name, const QPixmap& defPix ) const { initialize(); @@ -1514,6 +1715,22 @@ QPixmap QtxResourceMgr::loadPixmap( const QString& prefix, const QString& name, return pix; } +/*! + Loads translator for language + Name of translator file is constructed by list returning by option "translators" or, + if it is empty, by predefined pattern "%P_msg_%L.qm". It is recommended to used in translators + name the strings %A, %P, %L whose will be replaced by application name, prefix and language name correspondingly + + \param pref - name of parameter containing path to translator's file. + If it is empty, the list of parameters from resource section ( resSection() ) + is used. + + \param l - name of language. If it is empty, then value of parameter "language" + from language section ( langSection() ) is used. If it is also empty, then + predefined name "en" is used + + \sa resSection(), langSection() +*/ void QtxResourceMgr::loadLanguage( const QString& pref, const QString& l ) { initialize(); @@ -1570,6 +1787,12 @@ void QtxResourceMgr::loadLanguage( const QString& pref, const QString& l ) } } +/*! + Loads translators by path and list of files + + \param prefix - value of this parameter must contain path + \param translators - list of translators' files +*/ void QtxResourceMgr::loadTranslators( const QString& prefix, const QStringList& translators ) { initialize(); @@ -1592,6 +1815,12 @@ void QtxResourceMgr::loadTranslators( const QString& prefix, const QStringList& } } +/*! + Loads translator by path and file name + + \param prefix - value of this parameter must contain path + \param name - name of translator file +*/ void QtxResourceMgr::loadTranslator( const QString& prefix, const QString& name ) { initialize(); @@ -1611,6 +1840,11 @@ void QtxResourceMgr::loadTranslator( const QString& prefix, const QString& name } } +/*! + Remove all translators corresponding to prefix + + \param prefix - parameter containing path +*/ void QtxResourceMgr::removeTranslators( const QString& prefix ) { if ( !myTranslator.contains( prefix ) ) @@ -1625,6 +1859,11 @@ void QtxResourceMgr::removeTranslators( const QString& prefix ) myTranslator.remove( prefix ); } +/*! + Moves translators corresponding to prefix to the top of translator stack + + \param prefix - parameter containing path +*/ void QtxResourceMgr::raiseTranslators( const QString& prefix ) { if ( !myTranslator.contains( prefix ) ) @@ -1637,6 +1876,9 @@ void QtxResourceMgr::raiseTranslators( const QString& prefix ) } } +/*! + Copies all resources to user resources, so that they will be saved in user home folder +*/ void QtxResourceMgr::refresh() { QStringList sl = sections(); @@ -1648,6 +1890,9 @@ void QtxResourceMgr::refresh() } } +/*! + \brief Sets the resource directories list except user home directory and clear resources +*/ void QtxResourceMgr::setDirList( const QStringList& dl ) { myDirList = dl; @@ -1657,6 +1902,12 @@ void QtxResourceMgr::setDirList( const QStringList& dl ) myResources.clear(); } +/*! + Sets resource value + \param sect - name of section + \param name - name of parameter + \param val - string representation of value +*/ void QtxResourceMgr::setResource( const QString& sect, const QString& name, const QString& val ) { initialize(); @@ -1665,6 +1916,12 @@ void QtxResourceMgr::setResource( const QString& sect, const QString& name, cons myResources.first()->setValue( sect, name, val ); } +/*! + \return name of resource file, which is being found in user home directory + \param appName - name of application + \param for_load - flag indicating that file will be used for loading (true) or for saving(false) + It makes possible to use different resource files for loading and saving +*/ QString QtxResourceMgr::userFileName( const QString& appName, const bool /*for_load*/ ) const { QString fileName; @@ -1682,11 +1939,20 @@ QString QtxResourceMgr::userFileName( const QString& appName, const bool /*for_l return pathName; } +/*! + \return name of resource file, which is being found in all resource directories, except user home +*/ QString QtxResourceMgr::globalFileName( const QString& appName ) const { return QString( "%1.%2" ).arg( appName ).arg( currentFormat() ); } +/*! + Replaced substrings by pattern %A, %B, etc by values from map + + \param src - string to be processed + \param substMap - map of values for replacing +*/ QString QtxResourceMgr::substMacro( const QString& src, const QMap& substMap ) const { QString trg = src; diff --git a/src/Qtx/QtxStdOperations.cxx b/src/Qtx/QtxStdOperations.cxx index 6d612b299..0e4bacb81 100644 --- a/src/Qtx/QtxStdOperations.cxx +++ b/src/Qtx/QtxStdOperations.cxx @@ -21,26 +21,23 @@ #include #include -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Default constructor +*/ QtxStdOperations::QtxStdOperations() { } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Destructor +*/ QtxStdOperations::~QtxStdOperations() { } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Fills list of brackets treated as open (when 'open' is 'true') or close ('open' is 'false') +*/ void QtxStdOperations::bracketsList( QStringList& list, bool open ) const { if( open ) @@ -49,19 +46,17 @@ void QtxStdOperations::bracketsList( QStringList& list, bool open ) const list.append( ")" ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Fills list with operation names by copying of internal list of operations +*/ void QtxStdOperations::opersList( QStringList& list ) const { - list += myOpers; + list += myOpers; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Add operation names from list to internal list of operations +*/ void QtxStdOperations::addOperations( const QStringList& list ) { QStringList::const_iterator anIt = list.begin(), @@ -71,10 +66,9 @@ void QtxStdOperations::addOperations( const QStringList& list ) myOpers.append( *anIt ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Append operation names from 'list' to internal list of operations +*/ void QtxStdOperations::addTypes( const ListOfTypes& list ) { ListOfTypes::const_iterator anIt = list.begin(), @@ -84,10 +78,12 @@ void QtxStdOperations::addTypes( const ListOfTypes& list ) myTypes.append( *anIt ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return whether values with passed types are valid for arguments of operation + \param op - name of operation + \param t1 - type of first argument + \param t2 - type of second argument +*/ QtxParser::Error QtxStdOperations::isValid( const QString& op, const QVariant::Type t1, const QVariant::Type t2 ) const @@ -110,10 +106,9 @@ QtxParser::Error QtxStdOperations::isValid( const QString& op, -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Default constructor +*/ QtxArithmetics::QtxArithmetics() : QtxStdOperations() { @@ -138,18 +133,16 @@ QtxArithmetics::QtxArithmetics() addTypes( aTypes ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Destructor +*/ QtxArithmetics::~QtxArithmetics() { } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Creates numbers by it's string representation [redefined virtual] +*/ bool QtxArithmetics::createValue( const QString& str, QtxValue& v ) const { bool ok = false; @@ -164,10 +157,10 @@ bool QtxArithmetics::createValue( const QString& str, QtxValue& v ) const return ok; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return priority of arithmetic operation 'op'. + \param isBin indicate whether the operation is binary +*/ int QtxArithmetics::prior( const QString& op, bool isBin ) const { if( isBin ) @@ -191,10 +184,13 @@ void set( QVariant& v1, bool v2 ) v1 = QVariant( v2, 0 ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Calculates result of operation + \return one of error states + \param op - name of operation + \param v1 - first operation argument (must be used also to store result) + \param v2 - second operation argument +*/ QtxParser::Error QtxArithmetics::calculate( const QString& op, QtxValue& v1, QtxValue& v2 ) const { @@ -286,10 +282,9 @@ QtxParser::Error QtxArithmetics::calculate( const QString& op, -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Default constructor +*/ QtxLogic::QtxLogic() : QtxStdOperations() { @@ -312,18 +307,16 @@ QtxLogic::QtxLogic() addTypes( aTypes ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Destructor +*/ QtxLogic::~QtxLogic() { } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Creates value 'true' or 'false' it's string representation [redefined virtual] +*/ bool QtxLogic::createValue( const QString& str, QtxValue& v ) const { bool ok = true; @@ -337,10 +330,10 @@ bool QtxLogic::createValue( const QString& str, QtxValue& v ) const return ok; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return priority of arithmetic operation 'op'. + \param isBin indicate whether the operation is binary +*/ int QtxLogic::prior( const QString& op, bool isBin ) const { if( isBin ) @@ -370,10 +363,13 @@ bool boolean_value( const QtxValue& v ) return false; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Calculates result of operation + \return one of error states + \param op - name of operation + \param v1 - first operation argument (must be used also to store result) + \param v2 - second operation argument +*/ QtxParser::Error QtxLogic::calculate( const QString& op, QtxValue& v1, QtxValue& v2 ) const { @@ -405,10 +401,9 @@ QtxParser::Error QtxLogic::calculate( const QString& op, -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Default constructor +*/ QtxFunctions::QtxFunctions() : QtxStdOperations() { @@ -427,18 +422,16 @@ QtxFunctions::QtxFunctions() addTypes( aTypes ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Destructor +*/ QtxFunctions::~QtxFunctions() { } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Creates numbers by it's string representation [redefined virtual] +*/ bool QtxFunctions::createValue( const QString& str, QtxValue& v ) const { bool ok = false; @@ -453,10 +446,10 @@ bool QtxFunctions::createValue( const QString& str, QtxValue& v ) const return ok; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return priority of arithmetic operation 'op'. + \param isBin indicate whether the operation is binary +*/ int QtxFunctions::prior( const QString& op, bool isBin ) const { if( isBin ) @@ -468,10 +461,13 @@ int QtxFunctions::prior( const QString& op, bool isBin ) const return 0; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Calculates result of operation + \return one of error states + \param op - name of operation + \param v1 - first operation argument (must be used also to store result) + \param v2 - second operation argument +*/ QtxParser::Error QtxFunctions::calculate( const QString& op, QtxValue& v1, QtxValue& v2 ) const { @@ -506,10 +502,9 @@ QtxParser::Error QtxFunctions::calculate( const QString& op, -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Default constructor +*/ QtxStrings::QtxStrings() : QtxStdOperations() { @@ -536,18 +531,16 @@ QtxStrings::QtxStrings() } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Destructor +*/ QtxStrings::~QtxStrings() { } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Creates string QtxValue by it's Qt string representation [redefined virtual] +*/ bool QtxStrings::createValue( const QString& str, QtxValue& v ) const { QChar st = str[0], @@ -561,10 +554,10 @@ bool QtxStrings::createValue( const QString& str, QtxValue& v ) const return QtxStdOperations::createValue( str, v ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return priority of arithmetic operation 'op'. + \param isBin indicate whether the operation is binary +*/ int QtxStrings::prior( const QString& op, bool isBin ) const { if( isBin ) @@ -582,10 +575,13 @@ int QtxStrings::prior( const QString& op, bool isBin ) const return 0; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Calculates result of operation + \return one of error states + \param op - name of operation + \param v1 - first operation argument (must be used also to store result) + \param v2 - second operation argument +*/ QtxParser::Error QtxStrings::calculate( const QString& op, QtxValue& v1, QtxValue& v2 ) const { @@ -628,10 +624,9 @@ QtxParser::Error QtxStrings::calculate( const QString& op, -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Default constructor +*/ QtxSets::QtxSets() { QStringList aList; @@ -652,18 +647,16 @@ QtxSets::QtxSets() addTypes( aTypes ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Destructor +*/ QtxSets::~QtxSets() { } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Fills list of brackets treated as open (when 'open' is 'true') or close ('open' is 'false') +*/ void QtxSets::bracketsList( QStringList& list, bool open ) const { if( open ) @@ -673,19 +666,18 @@ void QtxSets::bracketsList( QStringList& list, bool open ) const QtxStdOperations::bracketsList( list, open ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Creates set of QtxValues by their string representation [redefined virtual] +*/ bool QtxSets::createValue( const QString& str, QtxValue& val ) const { return QtxStdOperations::createValue( str, val ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return priority of arithmetic operation 'op'. + \param isBin indicate whether the operation is binary +*/ int QtxSets::prior( const QString& op, bool isBin ) const { if( isBin ) @@ -707,10 +699,12 @@ int QtxSets::prior( const QString& op, bool isBin ) const return 0; } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + \return whether values with passed types are valid for arguments of operation + \param op - name of operation + \param t1 - type of first argument + \param t2 - type of second argument +*/ QtxParser::Error QtxSets::isValid( const QString& op, const QVariant::Type t1, const QVariant::Type t2 ) const @@ -726,20 +720,18 @@ QtxParser::Error QtxSets::isValid( const QString& op, return QtxStdOperations::isValid( op, t1, t2 ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Adds new value 'v' to set 'set' [static] +*/ void QtxSets::add( ValueSet& set, const QtxValue& v ) { if( v.isValid() && set.contains( v )==0 ) set.append( v ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Adds values from set 's2' to set 's1' +*/ void QtxSets::add( ValueSet& s1, const ValueSet& s2 ) { ValueSet::const_iterator anIt = s2.begin(), @@ -748,19 +740,17 @@ void QtxSets::add( ValueSet& s1, const ValueSet& s2 ) add( s1, *anIt ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Removes value 'v' from set 'set' +*/ void QtxSets::remove( ValueSet& set, const QtxValue& v ) { set.remove( v ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Removes values of set 's2' from set 's1' +*/ void QtxSets::remove( ValueSet& s1, const ValueSet& s2 ) { ValueSet::const_iterator anIt = s2.begin(), @@ -769,10 +759,13 @@ void QtxSets::remove( ValueSet& s1, const ValueSet& s2 ) s1.remove( *anIt ); } -//================================================================ -// Function : -// Purpose : -//================================================================ +/*! + Calculates result of operation + \return one of error states + \param op - name of operation + \param v1 - first operation argument (must be used also to store result) + \param v2 - second operation argument +*/ QtxParser::Error QtxSets::calculate( const QString& op, QtxValue& v1, QtxValue& v2 ) const { QtxParser::Error err = QtxParser::OK; diff --git a/src/Qtx/QtxStdOperations.h b/src/Qtx/QtxStdOperations.h index 5a8cfd48e..27245e95d 100644 --- a/src/Qtx/QtxStdOperations.h +++ b/src/Qtx/QtxStdOperations.h @@ -25,10 +25,11 @@ #include "Qtx.h" #include "QtxOperations.h" -//================================================================ -// Class : -// Purpose : -//================================================================ +/*! + \class QtxStdOperations + Provides simplified interface for standard operations. + Conatins list of operation names, priority and possible types +*/ class QTX_EXPORT QtxStdOperations : public QtxOperations { public: @@ -52,10 +53,10 @@ private: ListOfTypes myTypes; }; -//================================================================ -// Class : -// Purpose : -//================================================================ +/*! + \class QtxArithmetics + Provides set of arithmetic operations for parser +*/ class QTX_EXPORT QtxArithmetics : public QtxStdOperations { public: @@ -67,10 +68,10 @@ public: virtual QtxParser::Error calculate( const QString&, QtxValue&, QtxValue& ) const; }; -//================================================================ -// Class : -// Purpose : -//================================================================ +/*! + \class QtxLogic + Provides set of logic operations for parser +*/ class QTX_EXPORT QtxLogic : public QtxStdOperations { public: @@ -82,10 +83,10 @@ public: virtual QtxParser::Error calculate( const QString&, QtxValue&, QtxValue& ) const; }; -//================================================================ -// Class : -// Purpose : -//================================================================ +/*! + \class QtxFunctions + Provides set of more complex operations for parser (sqrt, sin, cos, etc) +*/ class QTX_EXPORT QtxFunctions : public QtxStdOperations { public: @@ -97,10 +98,10 @@ public: virtual QtxParser::Error calculate( const QString&, QtxValue&, QtxValue& ) const; }; -//================================================================ -// Class : -// Purpose : -//================================================================ +/*! + \class QtxStrings + Provides set of string operations for parser +*/ class QTX_EXPORT QtxStrings : public QtxStdOperations { public: @@ -112,10 +113,10 @@ public: virtual QtxParser::Error calculate( const QString&, QtxValue&, QtxValue& ) const; }; -//================================================================ -// Class : -// Purpose : -//================================================================ +/*! + \class QtxSets + Provides set of operations with sets for parser +*/ class QTX_EXPORT QtxSets : public QtxStdOperations { public: diff --git a/src/Qtx/QtxTable.cxx b/src/Qtx/QtxTable.cxx index eac69ea60..4c0f1971f 100644 --- a/src/Qtx/QtxTable.cxx +++ b/src/Qtx/QtxTable.cxx @@ -25,6 +25,9 @@ #include +/*! + Constructor +*/ QtxTable::QtxTable( QWidget* parent, const char* name ) : QTable( parent, name ), myHeaderEditor( 0 ), @@ -39,6 +42,9 @@ myEditedSection( -1 ) connect( horizontalScrollBar(), SIGNAL( valueChanged( int ) ), this, SLOT( onScrollBarMoved( int ) ) ); } +/*! + Constructor +*/ QtxTable::QtxTable( int numRows, int numCols, QWidget* parent, const char* name ) : QTable( numRows, numCols, parent, name ), myHeaderEditor( 0 ), @@ -53,15 +59,27 @@ myEditedSection( -1 ) connect( horizontalScrollBar(), SIGNAL( valueChanged( int ) ), this, SLOT( onScrollBarMoved( int ) ) ); } +/*! + Destructor +*/ QtxTable::~QtxTable() { } +/*! + \return true if header is editable + \param o - header orientation +*/ bool QtxTable::headerEditable( Orientation o ) const { return myHeaderEditable.contains( o ) ? myHeaderEditable[o] : false; } +/*! + Changes editable state of header + \param o - header orientation + \param on - new state +*/ void QtxTable::setHeaderEditable( Orientation o, const bool on ) { if ( headerEditable( o ) == on ) @@ -80,16 +98,28 @@ void QtxTable::setHeaderEditable( Orientation o, const bool on ) hdr->removeEventFilter( this ); } +/*! + Starts edition of header + \param o - header orientation + \param sec - column/row +*/ bool QtxTable::editHeader( Orientation o, const int sec ) { return beginHeaderEdit( o, sec ); } +/*! + Finishes edition of header + \param accept - whether new value must be accepted +*/ void QtxTable::endEditHeader( const bool accept ) { endHeaderEdit( accept ); } +/*! + Finishes edition and hides table +*/ void QtxTable::hide() { endHeaderEdit(); @@ -97,6 +127,11 @@ void QtxTable::hide() QTable::hide(); } +/*! + Custom event filter + Starts edition of header by double click + Finishes edition by escape/return/enter pressing +*/ bool QtxTable::eventFilter( QObject* o, QEvent* e ) { if ( e->type() == QEvent::MouseButtonDblClick ) @@ -145,17 +180,26 @@ bool QtxTable::eventFilter( QObject* o, QEvent* e ) return QTable::eventFilter( o, e ); } +/*! + SLOT: called on scroll +*/ void QtxTable::onScrollBarMoved( int ) { updateHeaderEditor(); } +/*! + SLOT: called on header size changing +*/ void QtxTable::onHeaderSizeChange( int, int, int ) { if ( sender() == myEditedHeader ) updateHeaderEditor(); } +/*! + Custom resize event handler +*/ void QtxTable::resizeEvent( QResizeEvent* e ) { QTable::resizeEvent( e ); @@ -163,6 +207,11 @@ void QtxTable::resizeEvent( QResizeEvent* e ) updateHeaderEditor(); } +/*! + Starts edition of header + \param o - header orientation + \param sec - column/row +*/ bool QtxTable::beginHeaderEdit( Orientation o, const int section ) { if ( !headerEditable( o ) || !header( o ) || !header( o )->isVisibleTo( this ) ) @@ -202,6 +251,10 @@ bool QtxTable::beginHeaderEdit( Orientation o, const int section ) return true; } +/*! + Finishes edition of header + \param accept - whether new value must be accepted +*/ void QtxTable::endHeaderEdit( const bool accept ) { if ( !isHeaderEditing() ) @@ -231,11 +284,20 @@ void QtxTable::endHeaderEdit( const bool accept ) } } +/*! + \return true if header is being edited +*/ bool QtxTable::isHeaderEditing() const { return myHeaderEditor && myEditedHeader && myEditedSection != -1; } +/*! + Creates and \return header editor + \param hdr - header + \param sec - column/row + \param init - init editor with value +*/ QWidget* QtxTable::createHeaderEditor( QHeader* hdr, const int sec, const bool init ) { QLineEdit* ed = new QLineEdit( 0 ); @@ -246,6 +308,12 @@ QWidget* QtxTable::createHeaderEditor( QHeader* hdr, const int sec, const bool i return ed; } +/*! + Initialize editor with value + \param hdr - header + \param sec - column/row + \param editor - editor +*/ void QtxTable::setHeaderContentFromEditor( QHeader* hdr, const int sec, QWidget* editor ) { if ( !hdr || !editor ) @@ -255,11 +323,20 @@ void QtxTable::setHeaderContentFromEditor( QHeader* hdr, const int sec, QWidget* hdr->setLabel( sec, ((QLineEdit*)editor)->text() ); } +/*! + \return header + \param o - orientation +*/ QHeader* QtxTable::header( Orientation o ) const { return o == Horizontal ? horizontalHeader() : verticalHeader(); } +/*! + Starts edition of header + \param o - header orientation + \param p - point +*/ void QtxTable::beginHeaderEdit( Orientation o, const QPoint& p ) { QHeader* hdr = header( o ); @@ -272,6 +349,11 @@ void QtxTable::beginHeaderEdit( Orientation o, const QPoint& p ) beginHeaderEdit( o, sec ); } +/*! + \return rectangle of header section + \param hdr - header + \param sec - column/row +*/ QRect QtxTable::headerSectionRect( QHeader* hdr, const int sec ) const { QRect r( -1, -1, -1, -1 ); @@ -286,6 +368,9 @@ QRect QtxTable::headerSectionRect( QHeader* hdr, const int sec ) const return r; } +/*! + Updates header editor +*/ void QtxTable::updateHeaderEditor() { if ( !myHeaderEditor || !myEditedHeader || myEditedSection < 0 ) diff --git a/src/Qtx/QtxToolBar.cxx b/src/Qtx/QtxToolBar.cxx index b5f32845e..3ffb69750 100644 --- a/src/Qtx/QtxToolBar.cxx +++ b/src/Qtx/QtxToolBar.cxx @@ -66,6 +66,9 @@ private: bool myVisible; }; +/*! + Constructor +*/ QtxToolBar::Watcher::Watcher( QtxToolBar* cont ) : QObject( cont ), myCont( cont ), @@ -81,6 +84,9 @@ myEmpty( true ) installFilters(); } +/*! + Custom event filter +*/ bool QtxToolBar::Watcher::eventFilter( QObject* o, QEvent* e ) { if ( o == myCont && e->type() == QEvent::ChildInserted ) @@ -108,6 +114,9 @@ bool QtxToolBar::Watcher::eventFilter( QObject* o, QEvent* e ) return false; } +/*! + Sets internal visibility state to true +*/ void QtxToolBar::Watcher::shown( QtxToolBar* tb ) { if ( tb != myCont ) @@ -116,6 +125,9 @@ void QtxToolBar::Watcher::shown( QtxToolBar* tb ) myVisible = true; } +/*! + Sets internal visibility state to false +*/ void QtxToolBar::Watcher::hided( QtxToolBar* tb ) { if ( tb != myCont ) @@ -124,6 +136,9 @@ void QtxToolBar::Watcher::hided( QtxToolBar* tb ) myVisible = false; } +/*! + Shows corresponding QtxToolBar +*/ void QtxToolBar::Watcher::showContainer() { if ( !myCont ) @@ -135,6 +150,9 @@ void QtxToolBar::Watcher::showContainer() myCont = cont; } +/*! + Hides corresponding QtxToolBar +*/ void QtxToolBar::Watcher::hideContainer() { if ( !myCont ) @@ -146,6 +164,9 @@ void QtxToolBar::Watcher::hideContainer() myCont = cont; } +/*! + Event handler of custom events +*/ void QtxToolBar::Watcher::customEvent( QCustomEvent* e ) { switch ( e->type() ) @@ -159,6 +180,9 @@ void QtxToolBar::Watcher::customEvent( QCustomEvent* e ) } } +/*! + Installs event filters +*/ void QtxToolBar::Watcher::installFilters() { if ( !myCont ) @@ -176,6 +200,9 @@ void QtxToolBar::Watcher::installFilters() } } +/*! + Update visibility state +*/ void QtxToolBar::Watcher::updateVisibility() { if ( !myCont ) @@ -215,6 +242,9 @@ void QtxToolBar::Watcher::updateVisibility() vis ? showContainer() : hideContainer(); } +/*! + Updates icon +*/ void QtxToolBar::Watcher::updateIcon() { if ( !myCont || !myCont->widget() ) @@ -224,6 +254,9 @@ void QtxToolBar::Watcher::updateIcon() myCont->setIcon( ico ? *ico : QPixmap() ); } +/*! + Updates caption +*/ void QtxToolBar::Watcher::updateCaption() { if ( myCont && myCont->widget() && !myCont->widget()->caption().isNull() ) @@ -231,10 +264,8 @@ void QtxToolBar::Watcher::updateCaption() } /*! - Class: QtxToolBar [Public] - Descr: + Constructor */ - QtxToolBar::QtxToolBar( const bool watch, const QString& label, QMainWindow* main, QWidget* parent, bool newLine, const char* name, WFlags f ) : QToolBar( label, main, parent, newLine, name, f ), @@ -245,6 +276,9 @@ myStretch( false ) myWatcher = new Watcher( this ); } +/*! + Constructor +*/ QtxToolBar::QtxToolBar( const QString& label, QMainWindow* main, QWidget* parent, bool newLine, const char* name, WFlags f ) : QToolBar( label, main, parent, newLine, name, f ), @@ -253,6 +287,9 @@ myStretch( false ) { } +/*! + Constructor +*/ QtxToolBar::QtxToolBar( const bool watch, QMainWindow* main, const char* name ) : QToolBar( main, name ), myWatcher( 0 ), @@ -262,6 +299,9 @@ myStretch( false ) myWatcher = new Watcher( this ); } +/*! + Constructor +*/ QtxToolBar::QtxToolBar( QMainWindow* main, const char* name ) : QToolBar( main, name ), myWatcher( 0 ), @@ -269,10 +309,17 @@ myStretch( false ) { } +/*! + Destructor +*/ QtxToolBar::~QtxToolBar() { } +/*! + Change the toolbar's main widget + \param wid - new main widget +*/ void QtxToolBar::setWidget( QWidget* wid ) { if ( wid ) @@ -293,11 +340,18 @@ void QtxToolBar::setWidget( QWidget* wid ) } } +/*! + \return true if toolbar is stretchable +*/ bool QtxToolBar::isStretchable() const { return myStretch; } +/*! + Sets stretchable state of toolbar + \param on - new state +*/ void QtxToolBar::setStretchable( const bool on ) { if ( myStretch == on ) @@ -317,6 +371,9 @@ void QtxToolBar::setStretchable( const bool on ) } } +/*! + \return the recommended size for the widget +*/ QSize QtxToolBar::sizeHint() const { QSize sz = QToolBar::sizeHint(); @@ -332,6 +389,9 @@ QSize QtxToolBar::sizeHint() const return sz; } +/*! + \return the recommended minimum size for the widget +*/ QSize QtxToolBar::minimumSizeHint() const { QSize sz = QToolBar::minimumSizeHint(); @@ -347,6 +407,9 @@ QSize QtxToolBar::minimumSizeHint() const return sz; } +/*! + Shows toolbar +*/ void QtxToolBar::show() { if ( myWatcher ) @@ -355,6 +418,9 @@ void QtxToolBar::show() QToolBar::show(); } +/*! + Hides toolbar +*/ void QtxToolBar::hide() { if ( myWatcher ) diff --git a/src/Qtx/QtxToolTip.cxx b/src/Qtx/QtxToolTip.cxx index 5141e127d..ff00db58e 100755 --- a/src/Qtx/QtxToolTip.cxx +++ b/src/Qtx/QtxToolTip.cxx @@ -30,6 +30,9 @@ #define TOOLTIP_SHOW_DELAY 0500 #define TOOLTIP_HIDE_DELAY 7000 +/*! + Constructor +*/ QtxToolTip::QtxToolTip( QWidget* parent ) : QLabel( parent, "", WStyle_Customize | WStyle_NoBorder | WX11BypassWM | WStyle_Tool | WStyle_StaysOnTop | WType_TopLevel ) { @@ -55,10 +58,16 @@ QtxToolTip::QtxToolTip( QWidget* parent ) myShowDelayTime = 5000; } +/*! + Destructor +*/ QtxToolTip::~QtxToolTip() { } +/*! + Custom event filter +*/ bool QtxToolTip::eventFilter( QObject* o, QEvent* e ) { if ( ( e->type() == QEvent::Destroy ) || ( e->type() == QEvent::Close ) || ( e->type() == QEvent::Hide ) ) @@ -106,6 +115,12 @@ bool QtxToolTip::eventFilter( QObject* o, QEvent* e ) return false; } +/*! + Shows tool tip + \param aPos - position + \param text - tooltip text + \param aWidgetRegion - rectangle +*/ void QtxToolTip::showTip( const QPoint& aPos, const QString& text, const QRect& aWidgetRegion ) { QFontMetrics theFM = fontMetrics(); @@ -114,6 +129,12 @@ void QtxToolTip::showTip( const QPoint& aPos, const QString& text, const QRect& showTip( QRect( QPoint( aPos.x(), aPos.y() + 10 ), QSize( theWidth, theHeight ) ), text, aWidgetRegion ); } +/*! + Shows tool tip + \param aRegion - tooltip region + \param text - tooltip text + \param aWidgetRegion - widget rectangle +*/ void QtxToolTip::showTip( const QRect& aRegion, const QString& text, const QRect& aWidgetRegion ) { setText( text ); @@ -124,6 +145,9 @@ void QtxToolTip::showTip( const QRect& aRegion, const QString& text, const QRect show(); } +/*! + Hides tooltip +*/ void QtxToolTip::hideTip() { hide(); @@ -131,6 +155,11 @@ void QtxToolTip::hideTip() mySleepTimer->stop(); } +/*! + It is called when there is a possibility that a tool tip should be shown and + must decide whether there is a tool tip for the point p in the widget that this QToolTip object relates to + \param pos - position +*/ void QtxToolTip::maybeTip( const QPoint& pos ) { QString text; @@ -152,12 +181,18 @@ void QtxToolTip::maybeTip( const QPoint& pos ) } } +/*! + SLOT: called when sleep time is out +*/ void QtxToolTip::onSleepTimeOut() { mySleepTimer->stop(); hideTip(); } +/*! + SLOT: called when wake time is out +*/ void QtxToolTip::onWakeUpTimeOut() { myWakeUpTimer->stop(); @@ -167,6 +202,9 @@ void QtxToolTip::onWakeUpTimeOut() maybeTip( pos ); } +/*! + Custom mouse press event handler +*/ void QtxToolTip::mousePressEvent( QMouseEvent* e ) { hideTip(); @@ -177,6 +215,9 @@ void QtxToolTip::mousePressEvent( QMouseEvent* e ) QApplication::sendEvent( reciever, me ); } +/*! + Custom mouse double click event handler +*/ void QtxToolTip::mouseDoubleClickEvent( QMouseEvent* e ) { hideTip(); @@ -187,23 +228,37 @@ void QtxToolTip::mouseDoubleClickEvent( QMouseEvent* e ) QApplication::sendEvent( reciever, me ); } +/*! + Sets wake delay time + \param theTime +*/ void QtxToolTip::setWakeUpDelayTime( int theTime ) { if( !(theTime < 0) ) myWakeUpDelayTime = theTime; } +/*! + Sets show delay time + \param theTime +*/ void QtxToolTip::setShowDelayTime( int theTime ) { if( !(theTime < 0) ) myShowDelayTime = theTime; } +/*! + \return timer measuring time of sleeping +*/ QTimer* QtxToolTip::sleepTimer() const { return mySleepTimer; } +/*! + \return timer measuring time of waking up +*/ QTimer* QtxToolTip::wakeUpTimer() const { return myWakeUpTimer; diff --git a/src/Qtx/QtxWorkspaceAction.cxx b/src/Qtx/QtxWorkspaceAction.cxx index c630ff47d..9b6d98ae6 100644 --- a/src/Qtx/QtxWorkspaceAction.cxx +++ b/src/Qtx/QtxWorkspaceAction.cxx @@ -25,6 +25,9 @@ #include #include +/*! + Constructor +*/ QtxWorkspaceAction::QtxWorkspaceAction( QWorkspace* ws, QObject* parent, const char* name ) : QtxAction( tr( "Controls windows into workspace" ), tr( "Workspace management" ), 0, parent, name ), myFlags( Standard ), @@ -45,20 +48,33 @@ myWorkspace( ws ) connect( myItem[VTile], SIGNAL( activated() ), this, SLOT( tileHorizontal() ) ); } +/*! + Destructor +*/ QtxWorkspaceAction::~QtxWorkspaceAction() { } +/*! + \return corresponding workspace +*/ QWorkspace* QtxWorkspaceAction::workspace() const { return myWorkspace; } +/*! + \return set of action flags +*/ int QtxWorkspaceAction::items() const { return myFlags; } +/*! + Sets action flags + \param flags - new set of flags +*/ void QtxWorkspaceAction::setItems( const int flags ) { if ( !flags || flags == myFlags || !( flags & Operations ) ) @@ -67,11 +83,19 @@ void QtxWorkspaceAction::setItems( const int flags ) myFlags = flags; } +/*! + \return true if action contains all flags + \param flags - new set of flags +*/ bool QtxWorkspaceAction::hasItems( const int flags ) const { return ( myFlags & flags ) == flags; } +/*! + \return accelerator of item + \param id - item id +*/ int QtxWorkspaceAction::accel( const int id ) const { int a = 0; @@ -80,6 +104,10 @@ int QtxWorkspaceAction::accel( const int id ) const return a; } +/*! + \return icons of item + \param id - item id +*/ QIconSet QtxWorkspaceAction::iconSet( const int id ) const { QIconSet ico; @@ -88,6 +116,10 @@ QIconSet QtxWorkspaceAction::iconSet( const int id ) const return ico; } +/*! + \return menu text of item + \param id - item id +*/ QString QtxWorkspaceAction::menuText( const int id ) const { QString txt; @@ -96,6 +128,10 @@ QString QtxWorkspaceAction::menuText( const int id ) const return txt; } +/*! + \return status tip of item + \param id - item id +*/ QString QtxWorkspaceAction::statusTip( const int id ) const { QString txt; @@ -104,35 +140,64 @@ QString QtxWorkspaceAction::statusTip( const int id ) const return txt; } +/*! + Changes accelerator of item + \param id - item id + \param a - new accelerator +*/ void QtxWorkspaceAction::setAccel( const int id, const int a ) { if ( myItem.contains( id ) ) myItem[id]->setAccel( a ); } +/*! + Changes icons of item + \param id - item id + \param ico - new icons +*/ void QtxWorkspaceAction::setIconSet( const int id, const QIconSet& ico ) { if ( myItem.contains( id ) ) myItem[id]->setIconSet( ico ); } +/*! + Changes menu text of item + \param id - item id + \param txt - new menu text +*/ void QtxWorkspaceAction::setMenuText( const int id, const QString& txt ) { if ( myItem.contains( id ) ) myItem[id]->setMenuText( txt ); } +/*! + Changes status tip of item + \param id - item id + \param txt - new status tip +*/ void QtxWorkspaceAction::setStatusTip( const int id, const QString& txt ) { if ( myItem.contains( id ) ) myItem[id]->setStatusTip( txt ); } +/*! + Adds action to widget + \param wid - widget +*/ bool QtxWorkspaceAction::addTo( QWidget* wid ) { return addTo( wid, -1 ); } +/*! + Adds action to widget + \param wid - widget + \param idx - position +*/ bool QtxWorkspaceAction::addTo( QWidget* wid, const int idx ) { if ( !wid || !wid->inherits( "QPopupMenu" ) ) @@ -153,6 +218,10 @@ bool QtxWorkspaceAction::addTo( QWidget* wid, const int idx ) return true; } +/*! + Removes action from widget + \param wid - widget +*/ bool QtxWorkspaceAction::removeFrom( QWidget* wid ) { if ( !wid || !wid->inherits( "QPopupMenu" ) ) @@ -172,6 +241,10 @@ bool QtxWorkspaceAction::removeFrom( QWidget* wid ) return true; } +/*! + Performs action + \param type - action type +*/ void QtxWorkspaceAction::perform( const int type ) { switch ( type ) @@ -191,6 +264,9 @@ void QtxWorkspaceAction::perform( const int type ) } } +/*! + Performs tile action +*/ void QtxWorkspaceAction::tile() { QWorkspace* ws = workspace(); @@ -200,6 +276,9 @@ void QtxWorkspaceAction::tile() ws->tile(); } +/*! + Performs cascade action +*/ void QtxWorkspaceAction::cascade() { QWorkspace* ws = workspace(); @@ -216,6 +295,9 @@ void QtxWorkspaceAction::cascade() it.current()->resize( int( w * 0.8 ), int( h * 0.8 ) ); } +/*! + Performs tile vertical action +*/ void QtxWorkspaceAction::tileVertical() { QWorkspace* wrkSpace = workspace(); @@ -256,6 +338,9 @@ void QtxWorkspaceAction::tileVertical() } } +/*! + Performs tile horizontal action +*/ void QtxWorkspaceAction::tileHorizontal() { QWorkspace* wrkSpace = workspace(); @@ -295,6 +380,9 @@ void QtxWorkspaceAction::tileHorizontal() } } +/*! + SLOT: called just before the popup menu is displayed, updates popup +*/ void QtxWorkspaceAction::onAboutToShow() { const QObject* obj = sender(); @@ -304,11 +392,18 @@ void QtxWorkspaceAction::onAboutToShow() updatePopup( (QPopupMenu*)obj ); } +/*! + SLOT: called when popup menu is destroyed, removes it from menu +*/ void QtxWorkspaceAction::onPopupDestroyed( QObject* obj ) { myMenu.remove( (QPopupMenu*)obj ); } +/*! + Updates popup + \param pm - popup menu +*/ void QtxWorkspaceAction::checkPopup( QPopupMenu* pm ) { if ( !myMenu.contains( pm ) ) @@ -332,6 +427,10 @@ void QtxWorkspaceAction::checkPopup( QPopupMenu* pm ) } } +/*! + Clears and refills popup and updates state of actions + \param pm - popup menu +*/ void QtxWorkspaceAction::updatePopup( QPopupMenu* pm ) { if ( !myMenu.contains( pm ) ) @@ -346,6 +445,10 @@ void QtxWorkspaceAction::updatePopup( QPopupMenu* pm ) myItem[VTile]->setEnabled( count ); } +/*! + Clears popup + \param pm - popup menu +*/ int QtxWorkspaceAction::clearPopup( QPopupMenu* pm ) { if ( !myMenu.contains( pm ) ) @@ -365,6 +468,11 @@ int QtxWorkspaceAction::clearPopup( QPopupMenu* pm ) return idx; } +/*! + Fills popup with items + \param pm - popup menu + \param idx - position +*/ void QtxWorkspaceAction::fillPopup( QPopupMenu* pm, const int idx ) { if ( !pm ) @@ -405,6 +513,9 @@ void QtxWorkspaceAction::fillPopup( QPopupMenu* pm, const int idx ) } } +/*! + SLOT: called when popup item corresponding to window is activated, activates window +*/ void QtxWorkspaceAction::onItemActivated( int idx ) { QWorkspace* ws = workspace(); diff --git a/src/Qtx/QtxWorkstack.cxx b/src/Qtx/QtxWorkstack.cxx index 5e01f08e8..a2db630ea 100644 --- a/src/Qtx/QtxWorkstack.cxx +++ b/src/Qtx/QtxWorkstack.cxx @@ -41,10 +41,8 @@ #define DARK_COLOR_LIGHT 250 /*! - Class: QtxWorkstack [Public] - Descr: + Constructor */ - QtxWorkstack::QtxWorkstack( QWidget* parent ) : QWidget( parent ), myWin( 0 ), @@ -68,10 +66,16 @@ myWorkArea( 0 ) base->addWidget( mySplit ); } +/*! + Destructor +*/ QtxWorkstack::~QtxWorkstack() { } +/*! + \return list of all widgets in all areas +*/ QWidgetList QtxWorkstack::windowList() const { QPtrList lst; @@ -88,16 +92,26 @@ QWidgetList QtxWorkstack::windowList() const return widList; } +/*! + \return list of all widgets in active area +*/ QWidgetList QtxWorkstack::splitWindowList() const { return myArea ? myArea->widgetList() : QWidgetList(); } +/*! + \return active widget +*/ QWidget* QtxWorkstack::activeWindow() const { return myWin; } +/*! + Splits widgets + \param o - orientation (Qt::Orientation) +*/ void QtxWorkstack::split( const int o ) { QtxWorkstackArea* area = myWorkArea; @@ -145,10 +159,10 @@ void QtxWorkstack::split( const int o ) } /*! -* \brief Split workarea of the given widget on two parts. -* \param wid - widget, belonging to this workstack -* \param o - orientation of splitting (Qt::Horizontal or Qt::Vertical) -* \param type - type of splitting, see SplitType enumeration + \brief Split workarea of the given widget on two parts. + \param wid - widget, belonging to this workstack + \param o - orientation of splitting (Qt::Horizontal or Qt::Vertical) + \param type - type of splitting, see SplitType enumeration */ void QtxWorkstack::Split (QWidget* wid, const Qt::Orientation o, const SplitType type) { @@ -224,8 +238,8 @@ void QtxWorkstack::Split (QWidget* wid, const Qt::Orientation o, const SplitType } /*! -* \brief Put given widget on top of its workarea -* \param wid - widget, belonging to this workstack + \brief Put given widget on top of its workarea + \param wid - widget, belonging to this workstack */ /* void QtxWorkstack::OnTop (QWidget* wid) @@ -249,17 +263,17 @@ void QtxWorkstack::OnTop (QWidget* wid) */ /*! -* \brief Move widget(s) from source workarea into target workarea -* or just reorder widgets inside one workarea. -* \param wid1 - widget from target workarea -* \param wid2 - widget from source workarea -* \param all - if this parameter is TRUE, all widgets from source workarea will -* be moved into the target one, else only the \a wid2 will be moved -* -* Move \a wid2 in target workarea. Put it right after \a wid1. -* If value of boolean argument is TRUE, all widgets from source workarea -* will be moved together with \a wid2, source workarea will be deleted. -* If \a wid1 and \a wid2 belongs to one workarea, simple reordering will take place. + \brief Move widget(s) from source workarea into target workarea + or just reorder widgets inside one workarea. + \param wid1 - widget from target workarea + \param wid2 - widget from source workarea + \param all - if this parameter is TRUE, all widgets from source workarea will + be moved into the target one, else only the \a wid2 will be moved + + Move \a wid2 in target workarea. Put it right after \a wid1. + If value of boolean argument is TRUE, all widgets from source workarea + will be moved together with \a wid2, source workarea will be deleted. + If \a wid1 and \a wid2 belongs to one workarea, simple reordering will take place. */ void QtxWorkstack::Attract ( QWidget* wid1, QWidget* wid2, const bool all ) { @@ -711,6 +725,9 @@ int QtxWorkstack::setPosition( QWidget* wid, QSplitter* split, const Qt::Orienta return 0; } +/*! + Redistributes space among widgets equally +*/ void QtxWorkstack::distributeSpace( QSplitter* split ) const { if ( !split ) @@ -724,16 +741,25 @@ void QtxWorkstack::distributeSpace( QSplitter* split ) const split->setSizes( szList ); } +/*! + Splits widgets vertically +*/ void QtxWorkstack::splitVertical() { split( Qt::Horizontal ); } +/*! + Splits widgets horizontally +*/ void QtxWorkstack::splitHorizontal() { split( Qt::Vertical ); } +/*! + SLOT: called if action "Rename" is activated, changes caption of widget +*/ void QtxWorkstack::onRename() { if ( !myWorkWin ) @@ -746,6 +772,10 @@ void QtxWorkstack::onRename() myWorkWin->setCaption( newName ); } +/*! + Wraps area into new splitter + \return new splitter +*/ QSplitter* QtxWorkstack::wrapSplitter( QtxWorkstackArea* area ) { if ( !area ) @@ -774,6 +804,12 @@ QSplitter* QtxWorkstack::wrapSplitter( QtxWorkstackArea* area ) return wrap; } +/*! + Reparenst and adds widget + \param wid - widget + \param pWid - parent widget + \param after - after widget +*/ void QtxWorkstack::insertWidget( QWidget* wid, QWidget* pWid, QWidget* after ) { if ( !wid || !pWid ) @@ -818,6 +854,10 @@ void QtxWorkstack::onCloseWindow() activeWindow()->close(); } +/*! + SLOT: called on area is destroyed + Sets focus to neighbour area +*/ void QtxWorkstack::onDestroyed( QObject* obj ) { QtxWorkstackArea* area = (QtxWorkstackArea*)obj; @@ -835,6 +875,9 @@ void QtxWorkstack::onDestroyed( QObject* obj ) QApplication::postEvent( this, new QCustomEvent( QEvent::User ) ); } +/*! + SLOT: called on window activating +*/ void QtxWorkstack::onWindowActivated( QWidget* wid ) { const QObject* obj = sender(); @@ -844,6 +887,9 @@ void QtxWorkstack::onWindowActivated( QWidget* wid ) setActiveArea( (QtxWorkstackArea*)obj ); } +/*! + SLOT: called on window deactivating +*/ void QtxWorkstack::onDeactivated( QtxWorkstackArea* area ) { if ( myArea != area ) @@ -866,6 +912,11 @@ void QtxWorkstack::onDeactivated( QtxWorkstackArea* area ) QApplication::postEvent( this, new QCustomEvent( QEvent::User ) ); } +/*! + Creates and shows popup menu for area + \param w - area + \param p - popup position +*/ void QtxWorkstack::onContextMenuRequested( QWidget* w, QPoint p ) { QtxWorkstackArea* anArea = dynamic_cast( (QObject*)sender() ); @@ -906,6 +957,9 @@ void QtxWorkstack::onContextMenuRequested( QWidget* w, QPoint p ) myWorkArea = 0; } +/*! + Custom child event handler, inserts widget to active or current area +*/ void QtxWorkstack::childEvent( QChildEvent* e ) { if ( e->inserted() && e->child()->isWidgetType() ) @@ -920,11 +974,18 @@ void QtxWorkstack::childEvent( QChildEvent* e ) QWidget::childEvent( e ); } +/*! + Handler of custom events +*/ void QtxWorkstack::customEvent( QCustomEvent* e ) { updateState(); } +/*! + \return splitter corresponding to area + \param area +*/ QSplitter* QtxWorkstack::splitter( QtxWorkstackArea* area ) const { if ( !area ) @@ -939,6 +1000,12 @@ QSplitter* QtxWorkstack::splitter( QtxWorkstackArea* area ) const return split; } +/*! + Fills list with children splitters + \param split - parent splitter + \param splitList - list to be filled with + \param rec - recursive search of children +*/ void QtxWorkstack::splitters( QSplitter* split, QPtrList& splitList, const bool rec ) const { if ( !split ) @@ -957,6 +1024,12 @@ void QtxWorkstack::splitters( QSplitter* split, QPtrList& splitList, } } +/*! + Fills list with children areas + \param split - parent splitter + \param areaList - list to be filled with + \param rec - recursive search of children +*/ void QtxWorkstack::areas( QSplitter* split, QPtrList& areaList, const bool rec ) const { if ( !split ) @@ -975,11 +1048,17 @@ void QtxWorkstack::areas( QSplitter* split, QPtrList& areaList } } +/*! + \return active area +*/ QtxWorkstackArea* QtxWorkstack::activeArea() const { return myArea; } +/*! + \return active area or current area or create new area of there is no one +*/ QtxWorkstackArea* QtxWorkstack::targetArea() { QtxWorkstackArea* area = activeArea(); @@ -999,6 +1078,9 @@ QtxWorkstackArea* QtxWorkstack::targetArea() return area; } +/*! + \return current area (that has focus) +*/ QtxWorkstackArea* QtxWorkstack::currentArea() const { QtxWorkstackArea* area = 0; @@ -1013,6 +1095,9 @@ QtxWorkstackArea* QtxWorkstack::currentArea() const return area; } +/*! + Creates new area +*/ QtxWorkstackArea* QtxWorkstack::createArea( QWidget* parent ) const { QtxWorkstackArea* area = new QtxWorkstackArea( parent ); @@ -1026,6 +1111,10 @@ QtxWorkstackArea* QtxWorkstack::createArea( QWidget* parent ) const return area; } +/*! + Sets area as active + \param area +*/ void QtxWorkstack::setActiveArea( QtxWorkstackArea* area ) { QWidget* oldCur = myWin; @@ -1049,6 +1138,10 @@ void QtxWorkstack::setActiveArea( QtxWorkstackArea* area ) emit windowActivated( myWin ); } +/*! + \return neighbour area + \param area - area to search neighbour +*/ QtxWorkstackArea* QtxWorkstack::neighbourArea( QtxWorkstackArea* area ) const { QPtrList lst; @@ -1072,6 +1165,10 @@ QtxWorkstackArea* QtxWorkstack::neighbourArea( QtxWorkstackArea* area ) const return na; } +/*! + \return area covering point + \param p - point +*/ QtxWorkstackArea* QtxWorkstack::areaAt( const QPoint& p ) const { QtxWorkstackArea* area = 0; @@ -1089,11 +1186,17 @@ QtxWorkstackArea* QtxWorkstack::areaAt( const QPoint& p ) const return area; } +/*! + Update +*/ void QtxWorkstack::updateState() { updateState( mySplit ); } +/*! + Update splitters +*/ void QtxWorkstack::updateState( QSplitter* split ) { QPtrList recList; @@ -1133,6 +1236,11 @@ void QtxWorkstack::updateState( QSplitter* split ) split->hide(); } +/*! + Gets splitter info for debug + \param split - splitter + \param info - string to be filled with info +*/ void QtxWorkstack::splitterInfo( QSplitter* split, QString& info ) const { if ( !split ) @@ -1183,16 +1291,18 @@ void QtxWorkstack::splitterInfo( QSplitter* split, QString& info ) const } -// cuts starting '(' symbol and ending '(' symbol +//Cuts starting '(' symbol and ending '(' symbol void cutBrackets( QString& parameters ) { if ( !parameters.isEmpty() && parameters[0] == '(' && parameters[parameters.length()-1] == ')' ) parameters = parameters.mid( 1, parameters.length()-2 ); } -// for strings like "(splitter orientation=0 children=2 sizes=332:478" returns values of -// parameters. For example, getValue( example, "children" ) returns "2" -// getValue( example, "sizes" ) returns "332:478" +/* + for strings like "(splitter orientation=0 children=2 sizes=332:478" returns values of + parameters. For example, getValue( example, "children" ) returns "2" + getValue( example, "sizes" ) returns "332:478" +*/ QString getValue( const QString& str, const QString& valName ) { int i = str.find( valName ); @@ -1207,7 +1317,9 @@ QString getValue( const QString& str, const QString& valName ) return QString( "" ); } -// checks format of splitter parameters string +/* + checks format of splitter parameters string +*/ bool checkFormat( const QString& parameters ) { QString params( parameters ); @@ -1234,7 +1346,9 @@ bool checkFormat( const QString& parameters ) return ok; } -// returns children of splitter in a list. Children are separated by '(' and ')' symbols +/* + Returns children of splitter in a list. Children are separated by '(' and ')' symbols +*/ QStringList getChildren( const QString& str ) { QStringList lst; @@ -1290,7 +1404,9 @@ QWidget* getView( const QWidget* parent, const QString& aName ) return view; } -// installs a splitter described by given parameters string +/*! + Installs a splitter described by given parameters string +*/ void QtxWorkstack::setSplitter( QSplitter* splitter, const QString& parameters, QMap< QSplitter*, QValueList >& sMap ) { if ( !::checkFormat( parameters ) ) { @@ -1348,7 +1464,9 @@ void QtxWorkstack::setSplitter( QSplitter* splitter, const QString& parameters, } } -// Restore workstack's configuration stored in 'parameters' string +/*! + Restore workstack's configuration stored in 'parameters' string +*/ QtxWorkstack& QtxWorkstack::operator<<( const QString& parameters ) { // clear the main splitter - remove all child splitters and empty areas from it @@ -1383,9 +1501,10 @@ QtxWorkstack& QtxWorkstack::operator<<( const QString& parameters ) return (*this); } -// Example of string produced by operator>> : -// "(splitter orientation=0 sizes=186:624 (views active='OCCViewer_0_0' 'OCCViewer_0_0') -// (views active='VTKViewer_0_0' 'VTKViewer_0_0'))" +/*! + Example of string produced by operator>> : + "(splitter orientation=0 sizes=186:624 (views active='OCCViewer_0_0' 'OCCViewer_0_0') +/ (views active='VTKViewer_0_0' 'VTKViewer_0_0'))" QtxWorkstack& QtxWorkstack::operator>>( QString& outParameters ) { splitterInfo( mySplit, outParameters ); @@ -1394,10 +1513,8 @@ QtxWorkstack& QtxWorkstack::operator>>( QString& outParameters ) /*! - Class: QtxWorkstackArea [Internal] - Descr: + Constructor */ - QtxWorkstackArea::QtxWorkstackArea( QWidget* parent ) : QWidget( parent ) { @@ -1432,11 +1549,17 @@ QtxWorkstackArea::QtxWorkstackArea( QWidget* parent ) qApp->installEventFilter( this ); } +/*! + Destructor +*/ QtxWorkstackArea::~QtxWorkstackArea() { qApp->removeEventFilter( this ); } +/*! + \return true if area is empty +*/ bool QtxWorkstackArea::isEmpty() const { bool res = false; @@ -1445,6 +1568,11 @@ bool QtxWorkstackArea::isEmpty() const return !res; } +/*! + Adds widget to area + \param wid - widget + \param idx - index +*/ void QtxWorkstackArea::insertWidget( QWidget* wid, const int idx ) { if ( !wid ) @@ -1479,6 +1607,10 @@ void QtxWorkstackArea::insertWidget( QWidget* wid, const int idx ) wid->setFocus(); } +/*! + Creates and shows popup menu for area + \param p - popup position +*/ void QtxWorkstackArea::onContextMenuRequested( QPoint p ) { const QtxWorkstackTabBar* bar = ::qt_cast( sender() ); @@ -1493,12 +1625,20 @@ void QtxWorkstackArea::onContextMenuRequested( QPoint p ) emit contextMenuRequested( wid, p ); } +/*! + SLOT: called when widget added to area is destroyed, removes widget from area +*/ void QtxWorkstackArea::onWidgetDestroyed() { if ( sender() ) removeWidget( (QWidget*)sender(), false ); } +/*! + Removes widget from area + \param wid - widget + \param del - auto deleting +*/ void QtxWorkstackArea::removeWidget( QWidget* wid, const bool del ) { if ( !myList.contains( wid ) ) @@ -1524,6 +1664,9 @@ void QtxWorkstackArea::removeWidget( QWidget* wid, const bool del ) updateState(); } +/*! + \return list of visible widgets +*/ QWidgetList QtxWorkstackArea::widgetList() const { QWidgetList lst; @@ -1535,21 +1678,35 @@ QWidgetList QtxWorkstackArea::widgetList() const return lst; } +/*! + \return active widget +*/ QWidget* QtxWorkstackArea::activeWidget() const { return widget( myBar->currentTab() ); } +/*! + Sets widget as active + \param wid - widget +*/ void QtxWorkstackArea::setActiveWidget( QWidget* wid ) { myBar->setCurrentTab( widgetId( wid ) ); } +/*! + \return true if area contains widget + \param wid - widget +*/ bool QtxWorkstackArea::contains( QWidget* wid ) const { return myList.contains( wid ); } +/*! + Shows area +*/ void QtxWorkstackArea::show() { QMap map; @@ -1565,6 +1722,9 @@ void QtxWorkstackArea::show() setBlocked( itr.current(), map.contains( itr.current() ) ? map[itr.current()] : false ); } +/*! + Hides area +*/ void QtxWorkstackArea::hide() { QMap map; @@ -1580,6 +1740,9 @@ void QtxWorkstackArea::hide() setBlocked( itr.current(), map.contains( itr.current() ) ? map[itr.current()] : false ); } +/*! + \return true if area is active +*/ bool QtxWorkstackArea::isActive() const { QtxWorkstack* ws = workstack(); @@ -1589,11 +1752,17 @@ bool QtxWorkstackArea::isActive() const return ws->activeArea() == this; } +/*! + Update active state of tab bar +*/ void QtxWorkstackArea::updateActiveState() { myBar->setActive( isActive() ); } +/*! + \return corresponding workstack +*/ QtxWorkstack* QtxWorkstackArea::workstack() const { QtxWorkstack* ws = 0; @@ -1607,6 +1776,9 @@ QtxWorkstack* QtxWorkstackArea::workstack() const return ws; } +/*! + Custom event filter +*/ bool QtxWorkstackArea::eventFilter( QObject* o, QEvent* e ) { if ( o->isWidgetType() ) @@ -1627,17 +1799,28 @@ bool QtxWorkstackArea::eventFilter( QObject* o, QEvent* e ) return false; } +/*! + \return rectangle of area in order to draw drop rectangle on area +*/ QRect QtxWorkstackArea::floatRect() const { QRect r = myStack->geometry(); return QRect( mapToGlobal( r.topLeft() ), mapToGlobal( r.bottomRight() ) ); } +/*! + \return rectangle of tab in order to draw drop rectangle on tab + \param idx - tab index +*/ QRect QtxWorkstackArea::floatTab( const int idx ) const { return myBar->tabRect( idx ); } +/*! + \return tab covering point + \param p - point +*/ int QtxWorkstackArea::tabAt( const QPoint& p ) const { int idx = -1; @@ -1650,6 +1833,9 @@ int QtxWorkstackArea::tabAt( const QPoint& p ) const return idx; } +/*! + Event handler for custom events +*/ void QtxWorkstackArea::customEvent( QCustomEvent* e ) { switch ( e->type() ) @@ -1678,6 +1864,9 @@ void QtxWorkstackArea::customEvent( QCustomEvent* e ) } } +/*! + Custom focus in event handler +*/ void QtxWorkstackArea::focusInEvent( QFocusEvent* e ) { QWidget::focusInEvent( e ); @@ -1685,6 +1874,9 @@ void QtxWorkstackArea::focusInEvent( QFocusEvent* e ) emit activated( activeWidget() ); } +/*! + Custom mouse press event handler +*/ void QtxWorkstackArea::mousePressEvent( QMouseEvent* e ) { QWidget::mousePressEvent( e ); @@ -1692,6 +1884,9 @@ void QtxWorkstackArea::mousePressEvent( QMouseEvent* e ) emit activated( activeWidget() ); } +/*! + SLOT: called if button close is pressed +*/ void QtxWorkstackArea::onClose() { QWidget* wid = activeWidget(); @@ -1699,6 +1894,9 @@ void QtxWorkstackArea::onClose() wid->close(); } +/*! + SLOT: called if tab page is selected +*/ void QtxWorkstackArea::onSelected( int id ) { updateCurrent(); @@ -1706,6 +1904,9 @@ void QtxWorkstackArea::onSelected( int id ) emit activated( activeWidget() ); } +/*! + SLOT: called if active tab page is dragged +*/ void QtxWorkstackArea::onDragActiveTab() { QtxWorkstackChild* c = child( activeWidget() ); @@ -1715,6 +1916,9 @@ void QtxWorkstackArea::onDragActiveTab() new QtxWorkstackDrag( workstack(), c ); } +/*! + SLOT: called on child is destroyed, removes from area +*/ void QtxWorkstackArea::onChildDestroyed( QObject* obj ) { QtxWorkstackChild* child = (QtxWorkstackChild*)obj; @@ -1732,26 +1936,41 @@ void QtxWorkstackArea::onChildDestroyed( QObject* obj ) QApplication::postEvent( this, new QCustomEvent( (QEvent::Type)RemoveWidget, wid ) ); } +/*! + SLOT: called on child is shown +*/ void QtxWorkstackArea::onChildShown( QtxWorkstackChild* c ) { setWidgetShown( c->widget(), true ); } +/*! + SLOT: called on child is hidden +*/ void QtxWorkstackArea::onChildHided( QtxWorkstackChild* c ) { setWidgetShown( c->widget(), false ); } +/*! + SLOT: called on child is activated +*/ void QtxWorkstackArea::onChildActivated( QtxWorkstackChild* c ) { setWidgetActive( c->widget() ); } +/*! + SLOT: called on child caption is changed +*/ void QtxWorkstackArea::onChildCaptionChanged( QtxWorkstackChild* c ) { updateTab( c->widget() ); } +/*! + Raises widget when active tab is changed +*/ void QtxWorkstackArea::updateCurrent() { QMap map; @@ -1767,6 +1986,10 @@ void QtxWorkstackArea::updateCurrent() setBlocked( itr.current(), map.contains( itr.current() ) ? map[itr.current()] : false ); } +/*! + Updates tab + \param wid - tab widget +*/ void QtxWorkstackArea::updateTab( QWidget* wid ) { QTab* tab = myBar->tab( widgetId( wid ) ); @@ -1785,6 +2008,10 @@ void QtxWorkstackArea::updateTab( QWidget* wid ) tab->setText( wid->caption() ); } +/*! + \return widget + \param id - widget id +*/ QWidget* QtxWorkstackArea::widget( const int id ) const { QWidget* wid = 0; @@ -1796,6 +2023,10 @@ QWidget* QtxWorkstackArea::widget( const int id ) const return wid; } +/*! + \return widget id + \param wid - widget +*/ int QtxWorkstackArea::widgetId( QWidget* wid ) const { int id = -1; @@ -1804,6 +2035,10 @@ int QtxWorkstackArea::widgetId( QWidget* wid ) const return id; } +/*! + \return true if widget is visible + \param wid - widget +*/ bool QtxWorkstackArea::widgetVisibility( QWidget* wid ) const { bool res = false; @@ -1812,6 +2047,10 @@ bool QtxWorkstackArea::widgetVisibility( QWidget* wid ) const return res; } +/*! + Sets widget as active + \param wid - widget +*/ void QtxWorkstackArea::setWidgetActive( QWidget* wid ) { int id = widgetId( wid ); @@ -1821,6 +2060,11 @@ void QtxWorkstackArea::setWidgetActive( QWidget* wid ) myBar->setCurrentTab( id ); } +/*! + Shows/hides widget + \param wid - widget + \param on - new shown state +*/ void QtxWorkstackArea::setWidgetShown( QWidget* wid, const bool on ) { if ( isBlocked( wid ) || !myInfo.contains( wid ) || myInfo[wid].vis == on ) @@ -1830,6 +2074,9 @@ void QtxWorkstackArea::setWidgetShown( QWidget* wid, const bool on ) updateState(); } +/*! + Update +*/ void QtxWorkstackArea::updateState() { bool updBar = myBar->isUpdatesEnabled(); @@ -1931,6 +2178,9 @@ void QtxWorkstackArea::updateState() } } +/*! + \return first unshared widget id +*/ int QtxWorkstackArea::generateId() const { QMap map; @@ -1945,11 +2195,20 @@ int QtxWorkstackArea::generateId() const return id; } +/*! + \return true if widget is blocked + \param wid - widget +*/ bool QtxWorkstackArea::isBlocked( QWidget* wid ) const { return myBlock.contains( wid ); } +/*! + Blocks widget + \param wid - widget + \param on - new blocked state +*/ void QtxWorkstackArea::setBlocked( QWidget* wid, const bool on ) { if ( on ) @@ -1958,6 +2217,10 @@ void QtxWorkstackArea::setBlocked( QWidget* wid, const bool on ) myBlock.remove( wid ); } +/*! + \return child corresponding to widget + \param wid - widget +*/ QtxWorkstackChild* QtxWorkstackArea::child( QWidget* wid ) const { QtxWorkstackChild* res = 0; @@ -1967,10 +2230,8 @@ QtxWorkstackChild* QtxWorkstackArea::child( QWidget* wid ) const } /*! - Class: QtxWorkstackChild [Internal] - Descr: + Constructor */ - QtxWorkstackChild::QtxWorkstackChild( QWidget* wid, QWidget* parent ) : QHBox( parent ), myWidget( wid ) @@ -1981,6 +2242,9 @@ myWidget( wid ) connect( myWidget, SIGNAL( destroyed( QObject* ) ), this, SLOT( onDestroyed( QObject* ) ) ); } +/*! + Destructor +*/ QtxWorkstackChild::~QtxWorkstackChild() { qApp->removeEventFilter( this ); @@ -1993,11 +2257,17 @@ QtxWorkstackChild::~QtxWorkstackChild() disconnect( widget(), SIGNAL( destroyed( QObject* ) ), this, SLOT( onDestroyed( QObject* ) ) ); } +/*! + \return corresponding widget +*/ QWidget* QtxWorkstackChild::widget() const { return myWidget; } +/*! + Custom event filter +*/ bool QtxWorkstackChild::eventFilter( QObject* o, QEvent* e ) { if ( o->isWidgetType() ) @@ -2017,6 +2287,9 @@ bool QtxWorkstackChild::eventFilter( QObject* o, QEvent* e ) return QHBox::eventFilter( o, e ); } +/*! + SLOT: called on object is destroyed +*/ void QtxWorkstackChild::onDestroyed( QObject* obj ) { if ( obj != widget() ) @@ -2026,6 +2299,9 @@ void QtxWorkstackChild::onDestroyed( QObject* obj ) deleteLater(); } +/*! + Custom child event handler +*/ void QtxWorkstackChild::childEvent( QChildEvent* e ) { if ( e->type() == QEvent::ChildRemoved && e->child() == widget() ) @@ -2037,20 +2313,25 @@ void QtxWorkstackChild::childEvent( QChildEvent* e ) } /*! - Class: QtxWorkstackTabBar [Internal] - Descr: + Constructor */ - QtxWorkstackTabBar::QtxWorkstackTabBar( QWidget* parent ) : QTabBar( parent ), myId( -1 ) { } +/*! + Destructor +*/ QtxWorkstackTabBar::~QtxWorkstackTabBar() { } +/*! + Sets tab bar as active or inactive + \param on - new active state +*/ void QtxWorkstackTabBar::setActive( const bool on ) { QFont aFont = font(); @@ -2072,6 +2353,10 @@ void QtxWorkstackTabBar::setActive( const bool on ) update(); } +/*! + \return tab rectangle + \param idx - tab index +*/ QRect QtxWorkstackTabBar::tabRect( const int idx ) const { QRect r; @@ -2100,6 +2385,9 @@ QRect QtxWorkstackTabBar::tabRect( const int idx ) const return r; } +/*! + Custom mouse move event handler +*/ void QtxWorkstackTabBar::mouseMoveEvent( QMouseEvent* e ) { if ( myId != -1 && !tab( myId )->rect().contains( e->pos() ) ) @@ -2111,6 +2399,9 @@ void QtxWorkstackTabBar::mouseMoveEvent( QMouseEvent* e ) QTabBar::mouseMoveEvent( e ); } +/*! + Custom mouse press event handler +*/ void QtxWorkstackTabBar::mousePressEvent( QMouseEvent* e ) { QTabBar::mousePressEvent( e ); @@ -2119,6 +2410,9 @@ void QtxWorkstackTabBar::mousePressEvent( QMouseEvent* e ) myId = currentTab(); } +/*! + Custom mouse release event handler +*/ void QtxWorkstackTabBar::mouseReleaseEvent( QMouseEvent* e ) { QTabBar::mouseReleaseEvent( e ); @@ -2129,12 +2423,18 @@ void QtxWorkstackTabBar::mouseReleaseEvent( QMouseEvent* e ) emit contextMenuRequested( e->globalPos() ); } +/*! + Custom context menu event handler +*/ void QtxWorkstackTabBar::contextMenuEvent( QContextMenuEvent* e ) { if ( e->reason() != QContextMenuEvent::Mouse ) emit contextMenuRequested( e->globalPos() ); } +/*! + Draws label of tab bar +*/ void QtxWorkstackTabBar::paintLabel( QPainter* p, const QRect& br, QTab* t, bool has_focus ) const { if ( currentTab() != t->identifier() ) @@ -2147,10 +2447,8 @@ void QtxWorkstackTabBar::paintLabel( QPainter* p, const QRect& br, QTab* t, bool } /*! - Class: QtxWorkstackDrag [Internal] - Descr: + Constructor */ - QtxWorkstackDrag::QtxWorkstackDrag( QtxWorkstack* ws, QtxWorkstackChild* child ) : QObject( 0 ), myWS( ws ), @@ -2162,6 +2460,9 @@ myChild( child ) qApp->installEventFilter( this ); } +/*! + Destructor +*/ QtxWorkstackDrag::~QtxWorkstackDrag() { qApp->removeEventFilter( this ); @@ -2169,6 +2470,9 @@ QtxWorkstackDrag::~QtxWorkstackDrag() endDrawRect(); } +/*! + Custom event filter +*/ bool QtxWorkstackDrag::eventFilter( QObject*, QEvent* e ) { switch ( e->type() ) @@ -2188,6 +2492,10 @@ bool QtxWorkstackDrag::eventFilter( QObject*, QEvent* e ) return true; } +/*! + Updates internal field with widget-target for dropping + \param p - current point of dragging +*/ void QtxWorkstackDrag::updateTarget( const QPoint& p ) { int tab = -1; @@ -2195,6 +2503,11 @@ void QtxWorkstackDrag::updateTarget( const QPoint& p ) setTarget( area, tab ); } +/*! + \return target area for dropping by point + \param p - current point of dragging + \param tab - index of tab to dropping +*/ QtxWorkstackArea* QtxWorkstackDrag::detectTarget( const QPoint& p, int& tab ) const { if ( p.isNull() ) @@ -2206,6 +2519,11 @@ QtxWorkstackArea* QtxWorkstackDrag::detectTarget( const QPoint& p, int& tab ) co return area; } +/*! + Changes target area for dropping + \param area - new target area + \param tab - tab index +*/ void QtxWorkstackDrag::setTarget( QtxWorkstackArea* area, const int tab ) { if ( !area || ( myArea == area && tab == myTab ) ) @@ -2223,12 +2541,18 @@ void QtxWorkstackDrag::setTarget( QtxWorkstackArea* area, const int tab ) drawRect(); } +/*! + Called on widget drop, inserts dropped widget to area +*/ void QtxWorkstackDrag::dropWidget() { if ( myArea ) myArea->insertWidget( myChild->widget(), myTab ); } +/*! + Draws float rect +*/ void QtxWorkstackDrag::drawRect() { if ( !myPainter || !myArea ) @@ -2253,12 +2577,18 @@ void QtxWorkstackDrag::drawRect() myPainter->drawRect( tr ); } +/*! + Deletes internal painter +*/ void QtxWorkstackDrag::endDrawRect() { delete myPainter; myPainter = 0; } +/*! + Initialize internal painter +*/ void QtxWorkstackDrag::startDrawRect() { if ( myPainter ) diff --git a/src/Qtx/QtxWorkstackAction.cxx b/src/Qtx/QtxWorkstackAction.cxx index c26a9b0aa..3bc06761a 100644 --- a/src/Qtx/QtxWorkstackAction.cxx +++ b/src/Qtx/QtxWorkstackAction.cxx @@ -26,6 +26,9 @@ #include #include +/*! + Constructor +*/ QtxWorkstackAction::QtxWorkstackAction( QtxWorkstack* ws, QObject* parent, const char* name ) : QtxAction( tr( "Controls windows into workstack" ), tr( "Workstack management" ), 0, parent, name ), myFlags( Standard ), @@ -40,20 +43,33 @@ myWorkstack( ws ) connect( myItem[HSplit], SIGNAL( activated() ), ws, SLOT( splitHorizontal() ) ); } +/*! + Destructor +*/ QtxWorkstackAction::~QtxWorkstackAction() { } +/*! + \return corresponding workstack +*/ QtxWorkstack* QtxWorkstackAction::workstack() const { return myWorkstack; } +/*! + \return set of action flags +*/ int QtxWorkstackAction::items() const { return myFlags; } +/*! + Sets action flags + \param flags - new set of flags +*/ void QtxWorkstackAction::setItems( const int flags ) { if ( !flags || flags == myFlags || !( flags & Split ) ) @@ -62,11 +78,19 @@ void QtxWorkstackAction::setItems( const int flags ) myFlags = flags; } +/*! + \return true if action contains all flags + \param flags - new set of flags +*/ bool QtxWorkstackAction::hasItems( const int flags ) const { return ( myFlags & flags ) == flags; } +/*! + \return accelerator of item + \param id - item id +*/ int QtxWorkstackAction::accel( const int id ) const { int a = 0; @@ -75,6 +99,10 @@ int QtxWorkstackAction::accel( const int id ) const return a; } +/*! + \return icons of item + \param id - item id +*/ QIconSet QtxWorkstackAction::iconSet( const int id ) const { QIconSet ico; @@ -83,6 +111,10 @@ QIconSet QtxWorkstackAction::iconSet( const int id ) const return ico; } +/*! + \return menu text of item + \param id - item id +*/ QString QtxWorkstackAction::menuText( const int id ) const { QString txt; @@ -91,6 +123,10 @@ QString QtxWorkstackAction::menuText( const int id ) const return txt; } +/*! + \return status tip of item + \param id - item id +*/ QString QtxWorkstackAction::statusTip( const int id ) const { QString txt; @@ -99,35 +135,64 @@ QString QtxWorkstackAction::statusTip( const int id ) const return txt; } +/*! + Changes accelerator of item + \param id - item id + \param a - new accelerator +*/ void QtxWorkstackAction::setAccel( const int id, const int a ) { if ( myItem.contains( id ) ) myItem[id]->setAccel( a ); } +/*! + Changes icons of item + \param id - item id + \param ico - new icons +*/ void QtxWorkstackAction::setIconSet( const int id, const QIconSet& ico ) { if ( myItem.contains( id ) ) myItem[id]->setIconSet( ico ); } +/*! + Changes menu text of item + \param id - item id + \param txt - new menu text +*/ void QtxWorkstackAction::setMenuText( const int id, const QString& txt ) { if ( myItem.contains( id ) ) myItem[id]->setMenuText( txt ); } +/*! + Changes status tip of item + \param id - item id + \param txt - new status tip +*/ void QtxWorkstackAction::setStatusTip( const int id, const QString& txt ) { if ( myItem.contains( id ) ) myItem[id]->setStatusTip( txt ); } +/*! + Adds action to widget + \param wid - widget +*/ bool QtxWorkstackAction::addTo( QWidget* wid ) { return addTo( wid, -1 ); } +/*! + Adds action to widget + \param wid - widget + \param idx - position +*/ bool QtxWorkstackAction::addTo( QWidget* wid, const int idx ) { if ( !wid || !wid->inherits( "QPopupMenu" ) ) @@ -148,6 +213,10 @@ bool QtxWorkstackAction::addTo( QWidget* wid, const int idx ) return true; } +/*! + Removes action from widget + \param wid - widget +*/ bool QtxWorkstackAction::removeFrom( QWidget* wid ) { if ( !wid || !wid->inherits( "QPopupMenu" ) ) @@ -167,6 +236,10 @@ bool QtxWorkstackAction::removeFrom( QWidget* wid ) return true; } +/*! + Performs action + \param type - action type +*/ void QtxWorkstackAction::perform( const int type ) { switch ( type ) @@ -180,6 +253,9 @@ void QtxWorkstackAction::perform( const int type ) } } +/*! + SLOT: called just before the popup menu is displayed, updates popup +*/ void QtxWorkstackAction::onAboutToShow() { const QObject* obj = sender(); @@ -195,11 +271,18 @@ void QtxWorkstackAction::onAboutToShow() updatePopup( (QPopupMenu*)obj ); } +/*! + SLOT: called when popup menu is destroyed, removes it from menu +*/ void QtxWorkstackAction::onPopupDestroyed( QObject* obj ) { myMenu.remove( (QPopupMenu*)obj ); } +/*! + Updates popup + \param pm - popup menu +*/ void QtxWorkstackAction::checkPopup( QPopupMenu* pm ) { if ( !myMenu.contains( pm ) ) @@ -223,6 +306,10 @@ void QtxWorkstackAction::checkPopup( QPopupMenu* pm ) } } +/*! + Clears and refills popup and updates state of actions + \param pm - popup menu +*/ void QtxWorkstackAction::updatePopup( QPopupMenu* pm ) { if ( !myMenu.contains( pm ) ) @@ -235,6 +322,10 @@ void QtxWorkstackAction::updatePopup( QPopupMenu* pm ) myItem[HSplit]->setEnabled( count > 1 ); } +/*! + Clears popup + \param pm - popup menu +*/ int QtxWorkstackAction::clearPopup( QPopupMenu* pm ) { if ( !myMenu.contains( pm ) ) @@ -254,6 +345,11 @@ int QtxWorkstackAction::clearPopup( QPopupMenu* pm ) return idx; } +/*! + Fills popup with items + \param pm - popup menu + \param idx - position +*/ void QtxWorkstackAction::fillPopup( QPopupMenu* pm, const int idx ) { if ( !pm ) @@ -294,6 +390,9 @@ void QtxWorkstackAction::fillPopup( QPopupMenu* pm, const int idx ) } } +/*! + SLOT: called when popup item corresponding to window is activated, activates window +*/ void QtxWorkstackAction::onItemActivated( int idx ) { QtxWorkstack* ws = workstack(); diff --git a/src/RegistryDisplay/HelpWindow.cxx b/src/RegistryDisplay/HelpWindow.cxx index a75b6d4e0..79d6fdf19 100755 --- a/src/RegistryDisplay/HelpWindow.cxx +++ b/src/RegistryDisplay/HelpWindow.cxx @@ -36,6 +36,9 @@ using namespace std; +/*! + Constructor +*/ HelpWindow::HelpWindow(QWidget* parent, const char* name ) : QMainWindow( parent, name, WType_TopLevel | WDestructiveClose ) { diff --git a/src/RegistryDisplay/IntervalWindow.cxx b/src/RegistryDisplay/IntervalWindow.cxx index 9f1a5d212..7326dadf2 100755 --- a/src/RegistryDisplay/IntervalWindow.cxx +++ b/src/RegistryDisplay/IntervalWindow.cxx @@ -20,6 +20,9 @@ #define SPACING_SIZE 6 #define MIN_SPIN_WIDTH 100 +/*! + Constructor +*/ IntervalWindow::IntervalWindow ( QWidget* parent ) : QDialog( parent, "IntervalWindow" , true, WStyle_Customize | WStyle_NormalBorder | WStyle_Title | WStyle_SysMenu | WDestructiveClose ) { @@ -73,8 +76,13 @@ IntervalWindow::IntervalWindow ( QWidget* parent ) END_OF("IntervalWindow constructor") } + +/*! + Destructor +*/ IntervalWindow::~IntervalWindow() {} -/* + +/*! Sets start interval size */ void IntervalWindow::setValue(const int size) @@ -82,7 +90,7 @@ void IntervalWindow::setValue(const int size) mySpinBox->setValue(size); } -/* +/*! Gets interval size */ int IntervalWindow::getValue() @@ -90,7 +98,7 @@ int IntervalWindow::getValue() return mySpinBox->value(); } -/* +/*! gets a pointer to myButtonOk */ QPushButton* IntervalWindow::Ok() @@ -98,7 +106,7 @@ QPushButton* IntervalWindow::Ok() return myButtonOk; } -/* +/*! gets a pointer to myButtonCancel */ QPushButton* IntervalWindow::Cancel() diff --git a/src/RegistryDisplay/RegWidget.cxx b/src/RegistryDisplay/RegWidget.cxx index b57256445..5dadc9d9d 100755 --- a/src/RegistryDisplay/RegWidget.cxx +++ b/src/RegistryDisplay/RegWidget.cxx @@ -573,6 +573,9 @@ void RegWidget::slotSelectRefresh() END_OF("slotSelectRefresh"); } +/*! + SLOT: called when button OK is clicked in interval window +*/ void RegWidget::slotIntervalOk() { BEGIN_OF("slotIntervalOk"); diff --git a/src/ResExporter/ResourceExporter.cxx b/src/ResExporter/ResourceExporter.cxx index 29922a2cd..fbf30b27e 100644 --- a/src/ResExporter/ResourceExporter.cxx +++ b/src/ResExporter/ResourceExporter.cxx @@ -1,27 +1,27 @@ -//====================================================================================================== -// File: ResourceExporter.cxx -// Created: 27/06/05 -// Author: Vadim SANDLER -// Copyright (C) CEA 2005 -// -// This tool provides command-line interface allowing to modify user preferences. -// The tool can be used by the compilation procedures in order to set default preferences for the module. -// -// Usage: -// ResourceExporter -// Parameters have the following format: -// '
:=' - to set for the user -// preference from the
section; -// '
:+=[|]' - the is appended to the current value -// of the preference from the
section; -// separator is used to concatenate old and new values, -// by default comma (',') symbol is used -// '-
:' - to remove user preference from the
-// section. Note that only use preference file is -// influenced, you may need to use '
:=""' -// option -// The number of parameters is limeted only by maximum possible length of the command line. -//====================================================================================================== +/*! + File: ResourceExporter.cxx + Created: 27/06/05 + Author: Vadim SANDLER + Copyright (C) CEA 2005 + + This tool provides command-line interface allowing to modify user preferences. + The tool can be used by the compilation procedures in order to set default preferences for the module. + + Usage: + ResourceExporter + Parameters have the following format: + '
:=' - to set for the user + preference from the
section; + '
:+=[|]' - the is appended to the current value + of the preference from the
section; + separator is used to concatenate old and new values, + by default comma (',') symbol is used + '-
:' - to remove user preference from the
+ section. Note that only use preference file is + influenced, you may need to use '
:=""' + option + The number of parameters is limeted only by maximum possible length of the command line. +*/ #include "SUIT_ResourceMgr.h" #include @@ -30,9 +30,9 @@ #include #include -//============================================================ -// salomeVersion(): get the SALOME version number -//============================================================ +/*! + \return the SALOME version number +*/ static QString salomeVersion() { QString path( ::getenv( "GUI_ROOT_DIR" ) ); @@ -62,9 +62,9 @@ static QString salomeVersion() return ver; } -//============================================================ -// help(): print the help information -//============================================================ +/*! + print the help information +*/ static void help() { std::cout << "" << std::endl; @@ -87,9 +87,9 @@ static void help() std::cout << "" << std::endl; } -//============================================================ -// main(): application main() function -//============================================================ +/*! + application main() function +*/ int main( int argc, char** argv ) { QApplication app( argc, argv ); diff --git a/src/SALOME_PYQT/SALOME_PYQT_GUI/SALOME_PYQT_Module.cxx b/src/SALOME_PYQT/SALOME_PYQT_GUI/SALOME_PYQT_Module.cxx index 604c599bf..b761e719a 100644 --- a/src/SALOME_PYQT/SALOME_PYQT_GUI/SALOME_PYQT_Module.cxx +++ b/src/SALOME_PYQT/SALOME_PYQT_GUI/SALOME_PYQT_Module.cxx @@ -16,14 +16,6 @@ // // See http://www.salome-platform.org/ // -//============================================================================= -// File : SALOME_PYQT_Module.cxx -// Created : 25/04/05 -// Author : Vadim SANDLER -// Project : SALOME -// Copyright : 2003-2005 CEA/DEN, EDF R&D -// $Header : $ -//============================================================================= #include "SALOME_PYQT_Module.h" @@ -60,15 +52,16 @@ using namespace std; -/////////////////////////////////////////////////////////////////////////////// -// Default name of the module, replaced at the moment of module creation +/*! + \var __DEFAULT_NAME__ - Default name of the module, replaced at the moment of module creation +*/ const char* __DEFAULT_NAME__ = "SALOME_PYQT_Module"; -/////////////////////////////////////////////////////////////////////////////// -// Default menu group number +/*! + \var __DEFAULT_GROUP__ - Default menu group number +*/ const int __DEFAULT_GROUP__ = 40; -/////////////////////////////////////////////////////////////////////////////// // If __CALL_OLD_METHODS__ macro is not defined the invoking of obsolete Python // module's methods like setSetting(), definePopup(), etc. is blocked. // This macro is defined by default (in Makefile) @@ -78,18 +71,17 @@ const bool IsCallOldMethods = true; const bool IsCallOldMethods = false; #endif -/////////////////////////////////////////////////////////////////////////////// // NB: Python requests. // General rule for Python requests created by SALOME_PYQT_Module: // all requests should be executed SYNCHRONOUSLY within the main GUI thread. // However, it is obligatory that ANY Python call is wrapped with a request object, // so that ALL Python API calls are serialized with PyInterp_Dispatcher. -/////////////////////////////////////////////////////////////////////////////// -//============================================================================= -// The class for parsing of the XML resource files. -// Used for backward compatibility with existing Python modules. -//============================================================================= +/*! + \class SALOME_PYQT_XmlHandler + The class for parsing of the XML resource files. + Used for backward compatibility with existing Python modules. +*/ class SALOME_PYQT_XmlHandler { public: @@ -118,10 +110,8 @@ private: bool myMenuCreated; }; -//============================================================================= // SALOME_PYQT_Module class implementation (implements CAM_Module API for // all Python-based SALOME module -//============================================================================= // While the SalomePyQtGUI library is not imported in Python it's initialization function // should be called manually (and only once) in order to initialize global sip data @@ -1091,26 +1081,66 @@ int SALOME_PYQT_Module::defaultMenuGroup() * Also these methods are used to register created from outside menus * in order to enable dynamic menus handling. */ + + +/*! Create tool bar with name \a name, if it was't created before. + * \retval -1 - if tool manager was't be created. + */ int SALOME_PYQT_Module::createTool( const QString& name ) { return SalomeApp_Module::createTool( name ); } +/*! Create tool. + * Insert QAction with id \a id from action map(myActionMap) to tool manager. + *\param id - integer + *\param tBar - integer + *\param idx - integer + *\retval integer id of new action in tool manager. + *\retval Return -1 if something wrong. + */ int SALOME_PYQT_Module::createTool( const int id, const int tBar, const int idx ) { return SalomeApp_Module::createTool( id, tBar, idx ); } +/*! Create tool. + * Insert QAction with id \a id from action map(myActionMap) to tool manager. + *\param id - integer + *\param tBar - QString& + *\param idx - integer + *\retval integer id of new action in tool manager. + *\retval Return -1 if something wrong. + */ int SALOME_PYQT_Module::createTool( const int id, const QString& tBar, const int idx ) { return SalomeApp_Module::createTool( id, tBar, idx ); } +/*! Create tool. Register action \a a with id \a id. + * Insert QAction to tool manager. + *\param a - QAction + *\param tBar - integer + *\param id - integer + *\param idx - integer + *\retval integer id of new action in tool manager. + *\retval Return -1 if something wrong. + */ int SALOME_PYQT_Module::createTool( QAction* a, const int tBar, const int id, const int idx ) { return SalomeApp_Module::createTool( a, tBar, id, idx ); } +/*! Create tool. Register action \a a with id \a id. + * Insert QAction to tool manager. + *\param a - QAction + *\param tBar - QString& + *\param id - integer + *\param idx - integer + *\retval integer id of new action in tool manager. + *\retval Return -1 if something wrong. + */ int SALOME_PYQT_Module::createTool( QAction* a, const QString& tBar, const int id, const int idx ) { return SalomeApp_Module::createTool( a, tBar, id, idx ); } + int SALOME_PYQT_Module::createMenu( const QString& subMenu, const int menu, const int id, const int group, const int idx, const bool constantMenu ) { bool exists = hasMenu( subMenu, menu ); @@ -1119,6 +1149,7 @@ int SALOME_PYQT_Module::createMenu( const QString& subMenu, const int menu, cons registerMenu( regId, menu, constantMenu ); return regId; } + int SALOME_PYQT_Module::createMenu( const QString& subMenu, const QString& menu, const int id, const int group, const int idx, const bool constantMenu ) { QStringList menus = QStringList::split( "|", menu, false ); @@ -1131,6 +1162,7 @@ int SALOME_PYQT_Module::createMenu( const QString& subMenu, const QString& menu, pid = createMenu( subMenu, pid, id, group, idx, constantMenu ); return pid; } + int SALOME_PYQT_Module::createMenu( const int id, const int menu, const int group, const int idx, const bool constantMenu ) { int regId = SalomeApp_Module::createMenu( id, menu, group, idx ); @@ -1138,6 +1170,7 @@ int SALOME_PYQT_Module::createMenu( const int id, const int menu, const int grou registerMenu( regId, menu, constantMenu ); return regId; } + int SALOME_PYQT_Module::createMenu( const int id, const QString& menu, const int group, const int idx, const bool constantMenu ) { QStringList menus = QStringList::split( "|", menu, false ); @@ -1150,6 +1183,7 @@ int SALOME_PYQT_Module::createMenu( const int id, const QString& menu, const int pid = createMenu( id, pid, group, idx, constantMenu ); return pid; } + int SALOME_PYQT_Module::createMenu( QAction* a, const int menu, const int id, const int group, const int idx, const bool constantMenu ) { int regId = SalomeApp_Module::createMenu( a, menu, id, group, idx ); @@ -1157,6 +1191,7 @@ int SALOME_PYQT_Module::createMenu( QAction* a, const int menu, const int id, co registerMenu( regId, menu, constantMenu ); return regId; } + int SALOME_PYQT_Module::createMenu( QAction* a, const QString& menu, const int id, const int group, const int idx, const bool constantMenu ) { QStringList menus = QStringList::split( "|", menu, false ); @@ -1169,18 +1204,22 @@ int SALOME_PYQT_Module::createMenu( QAction* a, const QString& menu, const int i pid = createMenu( a, pid, id, group, idx, constantMenu ); return pid; } + QAction* SALOME_PYQT_Module::createSeparator() { return SalomeApp_Module::separator(); } + QAction* SALOME_PYQT_Module::action( const int id ) const { return SalomeApp_Module::action( id ); } + int SALOME_PYQT_Module::actionId( const QAction* a ) const { return SalomeApp_Module::actionId( a ); } + QAction* SALOME_PYQT_Module::createAction( const int id, const QString& text, const QString& icon, const QString& menu, const QString& tip, const int key, const bool toggle ) @@ -1395,9 +1434,7 @@ bool SALOME_PYQT_Module::clearMenu( const int id, const int menu, const bool rem return false; } -//============================================================================= // SALOME_PYQT_XmlHandler class implementation -//============================================================================= // gets an tag name for the dom element [ static ] // returns an empty string if the element does not have tag name diff --git a/src/SALOME_PYQT/SALOME_PYQT_GUI/SALOME_PYQT_Module.h b/src/SALOME_PYQT/SALOME_PYQT_GUI/SALOME_PYQT_Module.h index b22f8524d..1cfcf855f 100644 --- a/src/SALOME_PYQT/SALOME_PYQT_GUI/SALOME_PYQT_Module.h +++ b/src/SALOME_PYQT/SALOME_PYQT_GUI/SALOME_PYQT_Module.h @@ -16,14 +16,6 @@ // // See http://www.salome-platform.org/ // -//============================================================================= -// File : SALOME_PYQT_Module.h -// Created : 25/04/05 -// Author : Vadim SANDLER -// Project : SALOME -// Copyright : 2003-2005 CEA/DEN, EDF R&D -// $Header : $ -//============================================================================= #ifndef SALOME_PYQT_MODULE_H #define SALOME_PYQT_MODULE_H diff --git a/src/SALOME_PYQT/SALOME_PYQT_GUI/SALOME_PYQT_PyInterp.h b/src/SALOME_PYQT/SALOME_PYQT_GUI/SALOME_PYQT_PyInterp.h index 1e15494e8..8c4787640 100644 --- a/src/SALOME_PYQT/SALOME_PYQT_GUI/SALOME_PYQT_PyInterp.h +++ b/src/SALOME_PYQT/SALOME_PYQT_GUI/SALOME_PYQT_PyInterp.h @@ -16,14 +16,6 @@ // // See http://www.salome-platform.org/ // -//============================================================================= -// File : SALOME_PYQT_PyInterp.h -// Created : 25/04/05 -// Author : Christian CAREMOLI, Paul RASCLE, EDF -// Project : SALOME -// Copyright : 2003-2005 CEA/DEN, EDF R&D -// $Header : $ -//============================================================================= #ifndef SALOME_PYQT_PYINTERP_H #define SALOME_PYQT_PYINTERP_H diff --git a/src/SALOME_PYQT/SalomePyQt/SalomePyQt.cxx b/src/SALOME_PYQT/SalomePyQt/SalomePyQt.cxx index 67f222687..d6afaaf4d 100644 --- a/src/SALOME_PYQT/SalomePyQt/SalomePyQt.cxx +++ b/src/SALOME_PYQT/SalomePyQt/SalomePyQt.cxx @@ -16,14 +16,6 @@ // // See http://www.salome-platform.org/ // -//============================================================================= -// File : SalomePyQt.cxx -// Created : 25/04/05 -// Author : Vadim SANDLER -// Project : SALOME -// Copyright : 2003-2005 CEA/DEN, EDF R&D -// $Header : $ -//============================================================================= #include "SALOME_PYQT_Module.h" // this include must be first!!! #include "SalomePyQt.h" @@ -50,12 +42,8 @@ using namespace std; -//==================================================================================== -// static functions -//==================================================================================== /*! - getApplication() - Returns active application object [ static ] + \return active application object [ static ] */ static SalomeApp_Application* getApplication() { if ( SUIT_Session::session() ) @@ -64,8 +52,7 @@ static SalomeApp_Application* getApplication() { } /*! - getActiveStudy() - Gets active study or 0 if there is no study opened [ static ] + \return active study or 0 if there is no study opened [ static ] */ static SalomeApp_Study* getActiveStudy() { @@ -74,13 +61,9 @@ static SalomeApp_Study* getActiveStudy() return 0; } -//==================================================================================== -// SALOME_Selection class. -//==================================================================================== static QMap SelMap; /*! - SALOME_Selection::GetSelection Creates or finds the selection object (one per study). */ SALOME_Selection* SALOME_Selection::GetSelection( SalomeApp_Application* app ) @@ -94,7 +77,6 @@ SALOME_Selection* SALOME_Selection::GetSelection( SalomeApp_Application* app ) } /*! - SALOME_Selection::SALOME_Selection Selection constructor. */ SALOME_Selection::SALOME_Selection( QObject* p ) : QObject( p ), mySelMgr( 0 ) @@ -107,7 +89,6 @@ SALOME_Selection::SALOME_Selection( QObject* p ) : QObject( p ), mySelMgr( 0 ) } } /*! - SALOME_Selection::~SALOME_Selection Selection destructor. Removes selection object from the map. */ SALOME_Selection::~SALOME_Selection() @@ -118,7 +99,6 @@ SALOME_Selection::~SALOME_Selection() } /*! - SALOME_Selection::onSelMgrDestroyed Watches for the selection manager destroying when study is closed. */ void SALOME_Selection::onSelMgrDestroyed() @@ -127,7 +107,6 @@ void SALOME_Selection::onSelMgrDestroyed() } /*! - SALOME_Selection::Clear Clears the selection. */ void SALOME_Selection::Clear() @@ -146,7 +125,6 @@ void SALOME_Selection::Clear() } /*! - SALOME_Selection::ClearIObjects Clears the selection. */ void SALOME_Selection::ClearIObjects() @@ -155,7 +133,6 @@ void SALOME_Selection::ClearIObjects() } /*! - SALOME_Selection::ClearFilters Removes all selection filters. */ void SALOME_Selection::ClearFilters() @@ -173,13 +150,8 @@ void SALOME_Selection::ClearFilters() ProcessVoidEvent( new TEvent( mySelMgr ) ); } -//==================================================================================== -// SalomePyQt class -//==================================================================================== - /*! - SalomePyQt::getDesktop - Gets desktop. Returns 0 in error. + \return desktop (0 if error) */ class TGetDesktopEvent: public SALOME_Event { public: @@ -191,14 +163,17 @@ public: myResult = (QWidget*)( getApplication()->desktop() ); } }; + +/*! + \return desktop +*/ QWidget* SalomePyQt::getDesktop() { return ProcessEvent( new TGetDesktopEvent() ); } /*! - SalomePyQt::getMainFrame - Gets workspace widget. Returns 0 in error. + \return workspace widget (0 if error) */ class TGetMainFrameEvent: public SALOME_Event { public: @@ -212,6 +187,10 @@ public: } } }; + +/*! + \return workspace widget (0 if error) +*/ QWidget* SalomePyQt::getMainFrame() { return ProcessEvent( new TGetMainFrameEvent() ); @@ -232,6 +211,11 @@ public: } } }; + +/*! + \return main menu + \retval 0 in error. +*/ QMenuBar* SalomePyQt::getMainMenuBar() { return ProcessEvent( new TGetMainMenuBarEvent() ); @@ -277,6 +261,11 @@ public: } } }; + +/*! + \return popup menu + \param menu - menu name +*/ QPopupMenu* SalomePyQt::getPopupMenu( const MenuName menu ) { return ProcessEvent( new TGetPopupMenuEvent( menu ) ); @@ -297,6 +286,11 @@ public: } } }; + +/*! + SalomePyQt::getStudyId + Returns active study's ID or 0 if there is no active study. +*/ int SalomePyQt::getStudyId() { return ProcessEvent( new TGetStudyIdEvent() ); @@ -315,6 +309,11 @@ public: myResult = SALOME_Selection::GetSelection( getApplication() ); } }; + +/*! + Creates a Selection object (to provide a compatibility with previous SALOME GUI). + \return just created selection object +*/ SALOME_Selection* SalomePyQt::getSelection() { return ProcessEvent( new TGetSelectionEvent() ); @@ -336,6 +335,13 @@ public: } } }; + +/*! + Puts an information message to the desktop's status bar + (with optional delay parameter given in seconds) + \param msg - message text + \param sec - delay in seconds +*/ void SalomePyQt::putInfo( const QString& msg, const int sec ) { ProcessVoidEvent( new TPutInfoEvent( msg, sec ) ); @@ -358,6 +364,10 @@ public: } } }; + +/*! + \return an active component name or empty string if there is no active component +*/ const QString SalomePyQt::getActiveComponent() { return ProcessEvent( new TGetActiveComponentEvent() ); @@ -532,6 +542,12 @@ public: } } }; + +/*! + \return a setting value (as string) + This function is obsolete. Use stringSetting(), integerSetting(), + boolSetting(), stringSetting() or colorSetting() instead. +*/ QString SalomePyQt::getSetting( const QString& name ) { return ProcessEvent( new TGetSettingEvent( name ) ); @@ -653,6 +669,10 @@ public: } } }; + +/*! + \return an integer setting from the application preferences +*/ int SalomePyQt::integerSetting( const QString& section, const QString& name, const int def ) { return ProcessEvent( new TGetIntSettingEvent( section, name, def ) ); @@ -678,6 +698,10 @@ public: } } }; + +/*! + \return an double setting from the application preferences +*/ double SalomePyQt::doubleSetting( const QString& section, const QString& name, const int def ) { return ProcessEvent( new TGetDblSettingEvent( section, name, def ) ); @@ -703,6 +727,10 @@ public: } } }; + +/*! + \return an boolean setting from the application preferences +*/ bool SalomePyQt::boolSetting( const QString& section, const QString& name, const bool def ) { return ProcessEvent( new TGetBoolSettingEvent( section, name, def ) ); @@ -728,6 +756,10 @@ public: } } }; + +/*! + \return an string setting from the application preferences +*/ QString SalomePyQt::stringSetting( const QString& section, const QString& name, const QString& def ) { return ProcessEvent( new TGetStrSettingEvent( section, name, def ) ); @@ -753,6 +785,10 @@ public: } } }; + +/*! + \return a color setting from the application preferences +*/ QColor SalomePyQt::colorSetting ( const QString& section, const QString& name, const QColor& def ) { return ProcessEvent( new TGetColorSettingEvent( section, name, def ) ); @@ -809,6 +845,10 @@ public: } } }; + +/*! + Displays 'Open/Save file' dialog box and returns a user's choice (file name) +*/ QString SalomePyQt::getFileName( QWidget* parent, const QString& initial, const QStringList& filters, @@ -844,6 +884,10 @@ public: } } }; + +/*! + Displays 'Open files' dialog box and returns a user's choice (a list of file names) +*/ QStringList SalomePyQt::getOpenFileNames( QWidget* parent, const QString& initial, const QStringList& filters, @@ -875,6 +919,10 @@ public: } } }; + +/*! + Displays 'Get Directory' dialog box and returns a user's choice (a directory name) +*/ QString SalomePyQt::getExistingDirectory( QWidget* parent, const QString& initial, const QString& caption ) @@ -934,6 +982,11 @@ public: } } }; + +/*! + Dumps the contents of the currently active view to the image file + in the given format (JPEG, PNG, BMP are supported) +*/ bool SalomePyQt::dumpView( const QString& filename ) { return ProcessEvent( new TDumpViewEvent( filename ) ); @@ -952,6 +1005,10 @@ public: myResult = SALOME_PYQT_Module::defaultMenuGroup(); } }; + +/*! + \return default menu group +*/ int SalomePyQt::defaultMenuGroup() { return ProcessEvent( new TDefMenuGroupEvent() ); @@ -1023,27 +1080,34 @@ public: } } }; -// create new toolbar or get existing by name + +/*! + create new toolbar or get existing by name +*/ int SalomePyQt::createTool( const QString& tBar ) { return ProcessEvent( new TCreateToolEvent( CrTool( tBar ) ) ); } -// add action with id and index to the existing tollbar +/*! add action with id and index to the existing tollbar +*/ int SalomePyQt::createTool( const int id, const int tBar, const int idx ) { return ProcessEvent( new TCreateToolEvent( CrTool( id, tBar, idx ) ) ); } -// add action with id and index to the existing tollbar +/*! add action with id and index to the existing tollbar +*/ int SalomePyQt::createTool( const int id, const QString& tBar, const int idx ) { return ProcessEvent( new TCreateToolEvent( CrTool( id, tBar, idx ) ) ); } -// add action with id and index to the existing tollbar +/*! add action with id and index to the existing tollbar +*/ int SalomePyQt::createTool( QtxAction* a, const int tBar, const int id, const int idx ) { return ProcessEvent( new TCreateToolEvent( CrTool( a, tBar, id, idx ) ) ); } -// add action with id and index to the existing tollbar +/*! add action with id and index to the existing tollbar +*/ int SalomePyQt::createTool( QtxAction* a, const QString& tBar, const int id, const int idx ) { return ProcessEvent( new TCreateToolEvent( CrTool( a, tBar, id, idx ) ) ); diff --git a/src/SALOME_PYQT/SalomePyQt/SalomePyQt.h b/src/SALOME_PYQT/SalomePyQt/SalomePyQt.h index a3022cb2a..609a68e96 100644 --- a/src/SALOME_PYQT/SalomePyQt/SalomePyQt.h +++ b/src/SALOME_PYQT/SalomePyQt/SalomePyQt.h @@ -16,14 +16,6 @@ // // See http://www.salome-platform.org/ // -//============================================================================= -// File : SalomePyQt.h -// Created : 25/04/05 -// Author : Vadim SANDLER -// Project : SALOME -// Copyright : 2003-2005 CEA/DEN, EDF R&D -// $Header : $ -//============================================================================= #ifndef SALOME_PYQT_H #define SALOME_PYQT_H diff --git a/src/SOCC/SOCC_ViewModel.cxx b/src/SOCC/SOCC_ViewModel.cxx index ba47d8424..0a569f048 100755 --- a/src/SOCC/SOCC_ViewModel.cxx +++ b/src/SOCC/SOCC_ViewModel.cxx @@ -307,6 +307,7 @@ void SOCC_Viewer::rename( const Handle(SALOME_InteractiveObject)& obj, /*! Display presentation + \param prs - presentation */ void SOCC_Viewer::Display( const SALOME_OCCPrs* prs ) { @@ -427,6 +428,8 @@ void SOCC_Viewer::Display( const SALOME_OCCPrs* prs ) /*! Erase presentation + \param prs - presentation + \param forced - removes object from context */ void SOCC_Viewer::Erase( const SALOME_OCCPrs* prs, const bool forced ) { @@ -476,6 +479,7 @@ void SOCC_Viewer::Erase( const SALOME_OCCPrs* prs, const bool forced ) /*! Erase all presentations + \param forced - removes all objects from context */ void SOCC_Viewer::EraseAll( const bool forced ) { @@ -527,6 +531,7 @@ void SOCC_Viewer::EraseAll( const bool forced ) /*! Create presentation corresponding to the entry + \param entry - entry */ SALOME_Prs* SOCC_Viewer::CreatePrs( const char* entry ) { diff --git a/src/STD/STD_Application.cxx b/src/STD/STD_Application.cxx index a0c3f43a1..7c0f33498 100755 --- a/src/STD/STD_Application.cxx +++ b/src/STD/STD_Application.cxx @@ -839,6 +839,10 @@ QString STD_Application::getDirectory( const QString& initial, const QString& ca return QFileDialog::getExistingDirectory( initial, parent, 0, caption, true ); } +/*! + Changes desktop + \param desk - new desktop +*/ void STD_Application::setDesktop( SUIT_Desktop* desk ) { SUIT_Desktop* prev = desktop(); @@ -864,18 +868,30 @@ void STD_Application::savePreferences() { } +/*! + Custom activity after study is created + Updates desktop and actions +*/ void STD_Application::studyCreated( SUIT_Study* ) { updateDesktopTitle(); updateCommandsStatus(); } +/*! + Custom activity after study is opened + Updates desktop and actions +*/ void STD_Application::studyOpened( SUIT_Study* ) { updateDesktopTitle(); updateCommandsStatus(); } +/*! + Custom activity after study is opened + Updates desktop and actions +*/ void STD_Application::studySaved( SUIT_Study* ) { updateDesktopTitle(); diff --git a/src/STD/STD_CloseDlg.cxx b/src/STD/STD_CloseDlg.cxx index a06d8c6c5..bc6017978 100644 --- a/src/STD/STD_CloseDlg.cxx +++ b/src/STD/STD_CloseDlg.cxx @@ -85,12 +85,9 @@ STD_CloseDlg::STD_CloseDlg( QWidget* parent, bool modal, WFlags f ) connect( m_pb4, SIGNAL( clicked() ), this, SLOT( reject() ) ); } -//================================================================================ /*! * \brief reaction on clicked(pressed) button */ -//================================================================================ - void STD_CloseDlg::onButtonClicked() { QPushButton* btn = ( QPushButton* )sender(); diff --git a/src/SUIT/SUIT_Accel.cxx b/src/SUIT/SUIT_Accel.cxx index 72b9d04d1..63e8d1116 100644 --- a/src/SUIT/SUIT_Accel.cxx +++ b/src/SUIT/SUIT_Accel.cxx @@ -28,9 +28,6 @@ #include -/*!\class SUIT_Accel - * Class handles keyboard accelerator bindings. - */ SUIT_Accel* SUIT_Accel::myself = 0; /*! Constructor [private].*/ diff --git a/src/SUIT/SUIT_Accel.h b/src/SUIT/SUIT_Accel.h index ef1db0db3..a5bec6b16 100644 --- a/src/SUIT/SUIT_Accel.h +++ b/src/SUIT/SUIT_Accel.h @@ -27,6 +27,10 @@ #include #include +/*! + \class SUIT_Accel + Manager of keyboard accelerator bindings +*/ class SUIT_EXPORT SUIT_Accel: public QObject { Q_OBJECT diff --git a/src/SUIT/SUIT_DataObject.h b/src/SUIT/SUIT_DataObject.h index bb14608c3..263698f06 100755 --- a/src/SUIT/SUIT_DataObject.h +++ b/src/SUIT/SUIT_DataObject.h @@ -37,7 +37,9 @@ typedef QPtrListIterator DataObjectListIterator; #endif /*! - Class provide support data object. + \class SUIT_DataObject + Data Object represents uniform data tree structure recommended to use in SUIT-based applications + Many of standard classes (DataModel,ObjectBrowser) deal with SUIT_DataObjects */ class SUIT_EXPORT SUIT_DataObject { @@ -116,6 +118,13 @@ private: friend class SUIT_DataObjectIterator; }; +/*! + \class SUIT_DataObject::Signal + Auxiliary class providing functionality to use signals of data object state change + SUIT_DataObject cannot have signals, because it isn't QObject, but + methods connect/disconnect of SUIT_DataObject with help of this it is possible + to emulate Qt signal processing +*/ class SUIT_DataObject::Signal : public QObject { Q_OBJECT diff --git a/src/SUIT/SUIT_DataObjectIterator.h b/src/SUIT/SUIT_DataObjectIterator.h index 45b8f7082..f697a0f68 100644 --- a/src/SUIT/SUIT_DataObjectIterator.h +++ b/src/SUIT/SUIT_DataObjectIterator.h @@ -22,7 +22,10 @@ #include "SUIT_DataObject.h" /*! - Class provide data object iterator. + \class SUIT_DataObjectIterator + Provides functionality of SUIT tree detour + It is possible to use "to-depth" or "to-breadth" detour and + to control level detour (from left or from right) */ class SUIT_EXPORT SUIT_DataObjectIterator { @@ -51,6 +54,11 @@ private: int myDetourType, myCurrentLevel; }; +/*! + \class SUIT_DataObjectIterator + Provides functionality of SUIT tree detour between certain levels + Only "to-breadth" detour is used +*/ class SUIT_DataObjectLevelIterator : public SUIT_DataObjectIterator { public: diff --git a/src/SUIT/SUIT_DataOwner.h b/src/SUIT/SUIT_DataOwner.h index cbc5b8464..b718589e4 100755 --- a/src/SUIT/SUIT_DataOwner.h +++ b/src/SUIT/SUIT_DataOwner.h @@ -29,6 +29,12 @@ #pragma warning( disable:4275 ) #endif +/*! + \class SUIT_DataOwner + Represents abstract selected objects. + Used for selection synchronizing between windows(e.g. ObjectBrowser) and viewers +*/ + class SUIT_EXPORT SUIT_DataOwner : public RefCount { public: diff --git a/src/SUIT/SUIT_Desktop.h b/src/SUIT/SUIT_Desktop.h index c437dbb1c..d89aed0c7 100755 --- a/src/SUIT/SUIT_Desktop.h +++ b/src/SUIT/SUIT_Desktop.h @@ -31,6 +31,11 @@ class SUIT_ViewWindow; class QtxActionMenuMgr; class QtxActionToolMgr; +/*! + \class SUIT_Desktop + Provides standard desktop: main window with + main menu manager, toolbars manager and logo. +*/ class SUIT_EXPORT SUIT_Desktop : public QtxMainWindow { Q_OBJECT diff --git a/src/SUIT/SUIT_FileValidator.h b/src/SUIT/SUIT_FileValidator.h index ecba9f2c7..cbc4abfa3 100755 --- a/src/SUIT/SUIT_FileValidator.h +++ b/src/SUIT/SUIT_FileValidator.h @@ -15,6 +15,10 @@ #include #include "SUIT.h" +/*! + \class SUIT_FileValidator + Provides functionality to check file +*/ class SUIT_EXPORT SUIT_FileValidator { public: diff --git a/src/SUIT/SUIT_Selector.h b/src/SUIT/SUIT_Selector.h index 5d1ae0e3a..7d195ffbd 100755 --- a/src/SUIT/SUIT_Selector.h +++ b/src/SUIT/SUIT_Selector.h @@ -27,6 +27,13 @@ class SUIT_SelectionMgr; class SUIT_DataOwnerPtrList; +/*! + \class SUIT_Selector + Base class for all selectors used in SUIT-based applications. + Provides functionality to get/set selection from/into some widget + (ObjectBrowser, viewers, etc) + Used by selection manager for selection synhronizing +*/ class SUIT_EXPORT SUIT_Selector : public QObject { Q_OBJECT diff --git a/src/SUIT/SUIT_Tools.h b/src/SUIT/SUIT_Tools.h index 07d8ff059..56643dfea 100755 --- a/src/SUIT/SUIT_Tools.h +++ b/src/SUIT/SUIT_Tools.h @@ -27,6 +27,10 @@ #include #include +/*! + \class SUIT_Tools + Prodives set of auxiliary static methods +*/ class SUIT_EXPORT SUIT_Tools : public Qtx { public: diff --git a/src/SUIT/SUIT_TreeSync.h b/src/SUIT/SUIT_TreeSync.h index 0b0b59279..f5b4de285 100644 --- a/src/SUIT/SUIT_TreeSync.h +++ b/src/SUIT/SUIT_TreeSync.h @@ -5,25 +5,49 @@ #include #include +/*! + \struct DiffItem + \brief Struct representing difference between items +*/ template struct DiffItem { - SrcItem mySrc; //if it is null, then this item is to deleted - TrgItem myTrg; //if it is null, then this item is to added - //if both fields aren't null, then this item is to update + SrcItem mySrc; + /*! + \var mySrc + if it is null, then this item is to deleted + */ + TrgItem myTrg; + /*! + \var myTrg + if it is null, then this item is to added + if both fields aren't null, then this item is to update + */ }; +/*! + \brief synchronizes two trees +*/ template TrgItem synchronize( const SrcItem&, const TrgItem&, const TreeData& ); +/*! + \brief compares children +*/ template void diffSiblings( const SrcItem&, const TrgItem&, QValueList < DiffItem < SrcItem,TrgItem > >&, const TreeData& ); +/*! + \brief create item with children (subtree) +*/ template TrgItem createSubTree( const SrcItem&, const TrgItem&, const TrgItem&, const bool, const TreeData& ); +/*! + \brief find equal element in list +*/ template const typename QValueList::const_iterator findEqual( const QValueList& l, const typename QValueList::const_iterator& first, @@ -33,8 +57,31 @@ const typename QValueList::const_iterator findEqual( const QValueList +
  • bool isEqual( const SrcItem&, const TrgItem& ) const - returns true if items are equal +
  • SrcItem nullSrc() const - returns null SrcItem +
  • TrgItem nullTrg() const - returns null TrgItem +
  • TrgItem createItem( +
      +
    1. const SrcItem& src, - corresponding SrcItem +
    2. const TrgItem& parent, - parent TrgItem +
    3. const TrgItem& after, - TrgItem after that new item must be added +
    4. const bool prepend - whether new item must be added as first +
    + ) const - creates new TrgItem +
  • void updateItem( const TrgItem& ) const - updates TrgItem without recreation +
  • void deleteItemWithChildren( const TrgItem& ) const - deletes TrgItem with all children +
  • void children( const SrcItem&, QValueList& ) const - fills list with children +
  • void children( const TrgItem&, QValueList& ) const - fills list with children +
  • SrcItem parent( const SrcItem& ) const - return parent SrcItem +
  • TrgItem parent( const TrgItem& ) const - return parent SrcItem + +*/ template TrgItem synchronize( const SrcItem& r1, const TrgItem& r2, const TreeData& td ) { @@ -88,6 +135,14 @@ TrgItem synchronize( const SrcItem& r1, const TrgItem& r2, const TreeData& td ) } } +/*! + Finds equal element in list + \return iterator + \param l - list to search + \param first - start iterator + \param it - item to be found + \param td - tree data object (provides auxiliary methods) +*/ template const typename QValueList::const_iterator findEqual( const QValueList& l, const typename QValueList::const_iterator& first, @@ -101,6 +156,13 @@ const typename QValueList::const_iterator findEqual( const QValueList void diffSiblings( const SrcItem& src, const TrgItem& trg, QValueList < DiffItem < SrcItem,TrgItem > >& d, @@ -155,6 +217,15 @@ void diffSiblings( const SrcItem& src, const TrgItem& trg, } } +/*! + Creates sub-tree + \return root of just created sub-tree + \param src - corresponding SrcItem + \param parent - parent of new TrgItem + \param after - TrgItem, after that new item must be added + \param asFirst - true if TrgItem must be added as first + \param td - tree data object (provides auxiliary methods) +*/ template TrgItem createSubTree( const SrcItem& src, const TrgItem& parent, const TrgItem& after, const bool asFirst, diff --git a/src/SUPERVGraph/SUPERVGraph.cxx b/src/SUPERVGraph/SUPERVGraph.cxx index 2b8f3d87f..69aab0ec8 100755 --- a/src/SUPERVGraph/SUPERVGraph.cxx +++ b/src/SUPERVGraph/SUPERVGraph.cxx @@ -31,6 +31,9 @@ using namespace std; +/*! + Creates view +*/ SUIT_ViewWindow* SUPERVGraph::createView(SUIT_Desktop* parent) { return new SUPERVGraph_ViewFrame( parent/*, "vtkView"*/ ); @@ -38,6 +41,9 @@ SUIT_ViewWindow* SUPERVGraph::createView(SUIT_Desktop* parent) extern "C" { + /*! + Creates view + */ SUIT_ViewWindow* createView(SUIT_Desktop* parent) { return SUPERVGraph::createView(parent); diff --git a/src/SUPERVGraph/SUPERVGraph_ViewFrame.cxx b/src/SUPERVGraph/SUPERVGraph_ViewFrame.cxx index 1a8362daa..9bbf6431d 100755 --- a/src/SUPERVGraph/SUPERVGraph_ViewFrame.cxx +++ b/src/SUPERVGraph/SUPERVGraph_ViewFrame.cxx @@ -38,21 +38,33 @@ using namespace std; +/*! + Constructor +*/ SUPERVGraph_View::SUPERVGraph_View( QWidget* theParent ): QWidget( theParent ) { init(theParent); } +/*! + Constructor +*/ SUPERVGraph_View::SUPERVGraph_View( SUPERVGraph_View* theParent ): QWidget( theParent ) { init(theParent); } +/*! + Builds popup for SUPERVGraph viewer +*/ void SUPERVGraph_View::contextMenuPopup( QPopupMenu* ) { // to be implemented } +/*! + Initialization +*/ void SUPERVGraph_View::init( QWidget* theParent ) { if ( theParent->inherits( "QMainWindow" ) ) { @@ -88,6 +100,9 @@ SUPERVGraph_ViewFrame::SUPERVGraph_ViewFrame( SUIT_Desktop* theDesktop ) createToolBar(); } +/*! + Creates actions of SUPERVGraph view window +*/ void SUPERVGraph_ViewFrame::createActions() { if (!myActionsMap.isEmpty()) return; @@ -109,16 +124,18 @@ void SUPERVGraph_ViewFrame::createActions() myActionsMap[ ResetId ] = aAction; } -//================================================================ -// Function : createToolBar -// Purpose : -//================================================================ +/*! + Creates toolbar of SUPERVGraph view window +*/ void SUPERVGraph_ViewFrame::createToolBar() { myActionsMap[PanId]->addTo(myToolBar); myActionsMap[ResetId]->addTo(myToolBar); } +/*! + Destructor +*/ SUPERVGraph_ViewFrame::~SUPERVGraph_ViewFrame() {} /*! @@ -130,6 +147,10 @@ SUPERVGraph_View* SUPERVGraph_ViewFrame::getViewWidget() } +/*! + Sets new view widget + \param theView - new view widget +*/ void SUPERVGraph_ViewFrame::setViewWidget( SUPERVGraph_View* theView ) { myView = theView; @@ -271,40 +292,69 @@ QColor SUPERVGraph_ViewFrame::backgroundColor() const return QMainWindow::backgroundColor(); } +/*! +*/ void SUPERVGraph_ViewFrame::onAdjustTrihedron() { // MESSAGE ( "SUPERVGraph_ViewFrame::onAdjustTrihedron" ) } +/*! + Changes name of object + \param obj - object to be renamed + \param name - new name +*/ void SUPERVGraph_ViewFrame::rename( const Handle(SALOME_InteractiveObject)& IObject, QString newName ) { // MESSAGE ( "SUPERVGraph_ViewFrame::rename" ) } +/*! + Unhilights all object in viewer + \param updateviewer - update current viewer +*/ void SUPERVGraph_ViewFrame::unHighlightAll() { // MESSAGE ( "SUPERVGraph_ViewFrame::unHighlightAll" ) } +/*! + Hilights/unhilights object in viewer + \param obj - object to be updated + \param hilight - if it is true, object will be hilighted, otherwise it will be unhilighted + \param update - update current viewer +*/ void SUPERVGraph_ViewFrame::highlight( const Handle(SALOME_InteractiveObject)& IObject, bool highlight, bool immediatly ) { // MESSAGE ( "SUPERVGraph_ViewFrame::highlight" ) } +/*! + \return true if object is in viewer or in collector + \param obj - object to be checked + \param onlyInViewer - search object only in viewer (so object must be displayed) +*/ bool SUPERVGraph_ViewFrame::isInViewer( const Handle(SALOME_InteractiveObject)& IObject ) { // MESSAGE ( "SUPERVGraph_ViewFrame::isInViewer" ) return false; } +/*! + \return true if object is displayed in viewer + \param obj - object to be checked +*/ bool SUPERVGraph_ViewFrame::isVisible( const Handle(SALOME_InteractiveObject)& IObject ) { // MESSAGE ( "SUPERVGraph_ViewFrame::isVisible" ) return false; } +/*! + Custom resize event handler +*/ void SUPERVGraph_ViewFrame::resizeEvent( QResizeEvent* theEvent ) { QMainWindow::resizeEvent( theEvent ); diff --git a/src/SUPERVGraph/SUPERVGraph_ViewManager.cxx b/src/SUPERVGraph/SUPERVGraph_ViewManager.cxx index 9cf508b31..fa3bfdb4a 100644 --- a/src/SUPERVGraph/SUPERVGraph_ViewManager.cxx +++ b/src/SUPERVGraph/SUPERVGraph_ViewManager.cxx @@ -20,6 +20,9 @@ int SUPERVGraph_ViewManager::myMaxId = 0; +/*! + Constructor +*/ SUPERVGraph_ViewManager::SUPERVGraph_ViewManager( SUIT_Study* theStudy, SUIT_Desktop* theDesktop, SUIT_ViewModel* theViewModel ) @@ -28,16 +31,27 @@ SUPERVGraph_ViewManager::SUPERVGraph_ViewManager( SUIT_Study* theStudy, myId = ++myMaxId; } +/*! + Destructor +*/ SUPERVGraph_ViewManager::~SUPERVGraph_ViewManager() { } +/*! + Sets view name + \param theView - view to assign name +*/ void SUPERVGraph_ViewManager::setViewName(SUIT_ViewWindow* theView) { int aPos = myViews.find(theView); theView->setCaption( QString( "SUPERVISION scene:%1 - viewer:%2" ).arg( myId ).arg(aPos+1)); } +/*! + Fills popup menu with custom actions + \param popup - popup menu to be filled with +*/ void SUPERVGraph_ViewManager::contextMenuPopup( QPopupMenu* thePopup) { SUIT_ViewManager::contextMenuPopup( thePopup ); diff --git a/src/SUPERVGraph/SUPERVGraph_ViewModel.cxx b/src/SUPERVGraph/SUPERVGraph_ViewModel.cxx index c6fe5f9ea..aadb0a192 100644 --- a/src/SUPERVGraph/SUPERVGraph_ViewModel.cxx +++ b/src/SUPERVGraph/SUPERVGraph_ViewModel.cxx @@ -21,15 +21,25 @@ #include "SUIT_Desktop.h" #include "SUIT_ViewWindow.h" +/*! + Constructor +*/ SUPERVGraph_Viewer::SUPERVGraph_Viewer() :SUIT_ViewModel() { } +/*! + Destructor +*/ SUPERVGraph_Viewer::~SUPERVGraph_Viewer() { } +/*! + Creates new view window + \param theDesktop - main window of application +*/ SUIT_ViewWindow* SUPERVGraph_Viewer::createView(SUIT_Desktop* theDesktop) { SUPERVGraph_ViewFrame* aRes = new SUPERVGraph_ViewFrame( theDesktop ); diff --git a/src/SVTK/SALOME_Actor.cxx b/src/SVTK/SALOME_Actor.cxx index 2da51db4e..bb100848c 100644 --- a/src/SVTK/SALOME_Actor.cxx +++ b/src/SVTK/SALOME_Actor.cxx @@ -73,7 +73,6 @@ using namespace std; int SALOME_POINT_SIZE = 5; int SALOME_LINE_WIDTH = 3; -//---------------------------------------------------------------------------- namespace { int @@ -123,11 +122,11 @@ namespace } -//---------------------------------------------------------------------------- vtkStandardNewMacro(SALOME_Actor); - -//---------------------------------------------------------------------------- +/*! + Constructor +*/ SALOME_Actor ::SALOME_Actor(): myRenderer(NULL), @@ -165,14 +164,17 @@ SALOME_Actor myOutlineActor->SetVisibility( false ); } - -//---------------------------------------------------------------------------- +/*! + Destructor +*/ SALOME_Actor ::~SALOME_Actor() {} -//---------------------------------------------------------------------------- +/*! + \return true if the SALOME_Actor has a reference to SALOME_InteractiveObject +*/ Standard_Boolean SALOME_Actor ::hasIO() @@ -180,6 +182,9 @@ SALOME_Actor return !myIO.IsNull(); } +/*! + \return correspoinding reference to SALOME_InteractiveObject +*/ const Handle(SALOME_InteractiveObject)& SALOME_Actor ::getIO() @@ -187,6 +192,10 @@ SALOME_Actor return myIO; } +/*! + Sets reference to SALOME_InteractiveObject + \param theIO - new SALOME_InteractiveObject +*/ void SALOME_Actor ::setIO(const Handle(SALOME_InteractiveObject)& theIO) @@ -194,6 +203,10 @@ SALOME_Actor myIO = theIO; } +/*! + Sets name the SALOME_Actor + \param theName - new name +*/ void SALOME_Actor ::setName(const char* theName) @@ -204,7 +217,9 @@ SALOME_Actor } -//---------------------------------------------------------------------------- +/*! + Publishes the actor in all its internal devices +*/ void SALOME_Actor ::AddToRender(vtkRenderer* theRenderer) @@ -218,6 +233,9 @@ SALOME_Actor theRenderer->AddActor( myOutlineActor.GetPointer() ); } +/*! + Removes the actor from all its internal devices +*/ void SALOME_Actor ::RemoveFromRender(vtkRenderer* theRenderer) @@ -229,6 +247,9 @@ SALOME_Actor theRenderer->RemoveActor( myOutlineActor.GetPointer() ); } +/*! + \return reference on renderer where it is published +*/ vtkRenderer* SALOME_Actor ::GetRenderer() @@ -236,8 +257,10 @@ SALOME_Actor return myRenderer; } - -//---------------------------------------------------------------------------- +/*! + Sets interactor in order to use vtkInteractorObserver devices + \param theInteractor - new interactor +*/ void SALOME_Actor ::SetInteractor(vtkRenderWindowInteractor* theInteractor) @@ -245,6 +268,9 @@ SALOME_Actor myInteractor = theInteractor; } +/*! + Put a request to redraw the view +*/ void SALOME_Actor ::Update() @@ -252,8 +278,10 @@ SALOME_Actor myInteractor->CreateTimer(VTKI_TIMER_UPDATE); } - -//---------------------------------------------------------------------------- +/*! + Apply view transformation + \param theTransform - transformation +*/ void SALOME_Actor ::SetTransform(VTKViewer_Transform* theTransform) @@ -265,7 +293,9 @@ SALOME_Actor myOutlineActor->SetTransform(theTransform); } - +/*! + Apply additional position +*/ void SALOME_Actor ::SetPosition(vtkFloatingPointType _arg1, @@ -279,7 +309,9 @@ SALOME_Actor myOutlineActor->SetPosition(_arg1,_arg2,_arg3); } - +/*! + Apply additional position +*/ void SALOME_Actor ::SetPosition(vtkFloatingPointType _arg[3]) @@ -287,8 +319,10 @@ SALOME_Actor SetPosition(_arg[0],_arg[1],_arg[2]); } - -//---------------------------------------------------------------- +/*! + Shows/hides actor + \param theVisibility - new visibility state +*/ void SALOME_Actor ::SetVisibility( int theVisibility ) @@ -307,8 +341,10 @@ SALOME_Actor } } - -//---------------------------------------------------------------- +/*! + Set selector in order to the actor at any time can restore current selection + \param theSelector - new selector +*/ void SALOME_Actor ::SetSelector(SVTK_Selector* theSelector) @@ -316,6 +352,9 @@ SALOME_Actor mySelector = theSelector; } +/*! + To map current selection to VTK representation +*/ void SALOME_Actor ::Highlight(bool theIsHighlight) @@ -352,6 +391,9 @@ SALOME_Actor highlight(theIsHighlight); } +/*! + Updates visibility of the highlight devices +*/ void SALOME_Actor ::highlight(bool theIsHighlight) @@ -365,7 +407,9 @@ SALOME_Actor } -//---------------------------------------------------------------- +/*! + To process prehighlight (called from SVTK_InteractorStyle) +*/ bool SALOME_Actor ::PreHighlight(vtkInteractorStyle *theInteractorStyle, @@ -506,8 +550,9 @@ SALOME_Actor return anIsChanged; } - -//---------------------------------------------------------------- +/*! + To process highlight (called from SVTK_InteractorStyle) +*/ bool SALOME_Actor ::Highlight(vtkInteractorStyle *theInteractorStyle, @@ -708,7 +753,10 @@ SALOME_Actor return true; } -//---------------------------------------------------------------------------- +/*! + To set up a picker for nodal selection (initialized by SVTK_Renderer::AddActor) + \param thePointPicker - new picker +*/ void SALOME_Actor ::SetPointPicker(vtkPointPicker* thePointPicker) @@ -716,6 +764,10 @@ SALOME_Actor myPointPicker = thePointPicker; } +/*! + To set up a picker for cell selection (initialized by SVTK_Renderer::AddActor) + \param theCellPicker - new picker +*/ void SALOME_Actor ::SetCellPicker(vtkCellPicker* theCellPicker) @@ -723,6 +775,10 @@ SALOME_Actor myCellPicker = theCellPicker; } +/*! + To set up a picker for point rectangle selection (initialized by SVTK_Renderer::AddActor) + \param theRectPicker - new picker +*/ void SALOME_Actor ::SetPointRectPicker(SVTK_RectPicker* theRectPicker) @@ -730,6 +786,10 @@ SALOME_Actor myPointRectPicker = theRectPicker; } +/*! + To set up a picker for cell rectangle selection (initialized by SVTK_Renderer::AddActor) + \param theRectPicker - new picker +*/ void SALOME_Actor ::SetCellRectPicker(SVTK_RectPicker* theRectPicker) @@ -737,7 +797,9 @@ SALOME_Actor myCellRectPicker = theRectPicker; } -//---------------------------------------------------------------------------- +/*! + To set up a prehighlight property (initialized by SVTK_Renderer::AddActor) +*/ void SALOME_Actor ::SetPreHighlightProperty(vtkProperty* theProperty) @@ -745,6 +807,9 @@ SALOME_Actor myPreHighlightActor->SetProperty(theProperty); } +/*! + To set up a highlight property (initialized by SVTK_Renderer::AddActor) +*/ void SALOME_Actor ::SetHighlightProperty(vtkProperty* theProperty) diff --git a/src/SVTK/SVTK_Actor.cxx b/src/SVTK/SVTK_Actor.cxx index bc13af9f0..dbe6aad1b 100644 --- a/src/SVTK/SVTK_Actor.cxx +++ b/src/SVTK/SVTK_Actor.cxx @@ -46,10 +46,11 @@ CopyPoints(vtkUnstructuredGrid* theGrid, vtkDataSet *theSourceDataSet) aPoints->Delete(); } -//======================================================================= - vtkStandardNewMacro(SVTK_Actor); +/*! + Constructor +*/ SVTK_Actor ::SVTK_Actor(): myUnstructuredGrid(vtkUnstructuredGrid::New()) @@ -62,7 +63,6 @@ SVTK_Actor myUnstructuredGrid->Allocate(); } -//---------------------------------------------------------------------------- void SVTK_Actor ::Initialize() @@ -70,8 +70,6 @@ SVTK_Actor SetInput(GetSource()); } - -//---------------------------------------------------------------------------- void SVTK_Actor ::SetSource(vtkUnstructuredGrid* theUnstructuredGrid) @@ -91,15 +89,14 @@ SVTK_Actor return myUnstructuredGrid.GetPointer(); } - -//---------------------------------------------------------------------------- +/*! + Destructor +*/ SVTK_Actor ::~SVTK_Actor() { } - -//---------------------------------------------------------------------------- const TColStd_IndexedMapOfInteger& SVTK_Actor ::GetMapIndex() const @@ -107,8 +104,6 @@ SVTK_Actor return myMapIndex; } - -//---------------------------------------------------------------------------- void SVTK_Actor ::MapCells(SALOME_Actor* theMapActor, @@ -136,8 +131,6 @@ SVTK_Actor myMapIndex = theMapIndex; } - -//---------------------------------------------------------------------------- void SVTK_Actor ::MapPoints(SALOME_Actor* theMapActor, @@ -165,8 +158,6 @@ SVTK_Actor myMapIndex = theMapIndex; } - -//---------------------------------------------------------------------------- void SVTK_Actor ::MapEdge(SALOME_Actor* theMapActor, @@ -205,5 +196,3 @@ SVTK_Actor myMapIndex = theMapIndex; } - -//---------------------------------------------------------------------------- diff --git a/src/SVTK/SVTK_CubeAxesActor2D.cxx b/src/SVTK/SVTK_CubeAxesActor2D.cxx index f64dfbc07..7c2d6ae8c 100644 --- a/src/SVTK/SVTK_CubeAxesActor2D.cxx +++ b/src/SVTK/SVTK_CubeAxesActor2D.cxx @@ -48,7 +48,6 @@ vtkCxxRevisionMacro(SVTK_CubeAxesActor2D, "$Revision$"); vtkStandardNewMacro(SVTK_CubeAxesActor2D); -//---------------------------------------------------------------------------- // Instantiate this object. SVTK_CubeAxesActor2D::SVTK_CubeAxesActor2D() { @@ -130,7 +129,6 @@ SVTK_CubeAxesActor2D::SVTK_CubeAxesActor2D() } -//---------------------------------------------------------------------------- SVTK_CubeAxesActor2D::~SVTK_CubeAxesActor2D() { this->wireActorXY->Delete(); @@ -146,12 +144,10 @@ SVTK_CubeAxesActor2D::~SVTK_CubeAxesActor2D() this->rgridMapperXZ->Delete(); } -//---------------------------------------------------------------------------- // Static variable describes connections in cube. static int Conn[8][3] = {{1,2,4}, {0,3,5}, {3,0,6}, {2,1,7}, {5,6,0}, {4,7,1}, {7,4,2}, {6,5,3}}; -//---------------------------------------------------------------------------- // Project the bounding box and compute edges on the border of the bounding // cube. Determine which parts of the edges are visible via intersection // with the boundary of the viewport (minus borders). @@ -254,7 +250,6 @@ static void ChangeArrays(vtkFloatingPointType* xCoords, ChangeValues(zCoords,xCoords,zRange,xRange,false); } -//---------------------------------------------------------------------------- // Project the bounding box and compute edges on the border of the bounding // cube. Determine which parts of the edges are visible via intersection // with the boundary of the viewport (minus borders). @@ -655,7 +650,6 @@ int SVTK_CubeAxesActor2D::RenderOpaqueGeometry(vtkViewport *viewport) return renderedSomething; } -//---------------------------------------------------------------------------- // Release any graphics resources that are being consumed by this actor. // The parameter window could be used to determine which graphic // resources to release. diff --git a/src/SVTK/SVTK_CubeAxesDlg.cxx b/src/SVTK/SVTK_CubeAxesDlg.cxx index 3cec4197a..d5c83a39b 100644 --- a/src/SVTK/SVTK_CubeAxesDlg.cxx +++ b/src/SVTK/SVTK_CubeAxesDlg.cxx @@ -54,10 +54,9 @@ * Description : Tab of dialog */ -//======================================================================= -// name : SVTK_AxisWidget::AxisWg -// Purpose : Constructor -//======================================================================= +/*! + Constructor +*/ SVTK_AxisWidget::SVTK_AxisWidget (QWidget* theParent) : QFrame(theParent) { @@ -143,6 +142,9 @@ SVTK_AxisWidget::SVTK_AxisWidget (QWidget* theParent) connect(myIsTicksVisible, SIGNAL(stateChanged(int)), SLOT(onTicksChecked())); } +/*! + Destructor +*/ SVTK_AxisWidget::~SVTK_AxisWidget() { } @@ -154,10 +156,6 @@ void SVTK_AxisWidget::updateControlState() onTicksChecked(); } -//======================================================================= -// name : SVTK_AxisWidget::onNameChecked -// Purpose : -//======================================================================= void SVTK_AxisWidget::setEnabled(QGroupBox* theGrp, const bool theState) { QObjectList aChildren(*theGrp->children()); @@ -167,55 +165,31 @@ void SVTK_AxisWidget::setEnabled(QGroupBox* theGrp, const bool theState) ((QHBox*)anObj)->setEnabled(theState); } -//======================================================================= -// Labels : SVTK_AxisWidget::onLabelsChecked -// Purpose : -//======================================================================= void SVTK_AxisWidget::onLabelsChecked() { setEnabled(myLabelsGrp, myIsLabelsVisible->isChecked()); } -//======================================================================= -// Labels : SVTK_AxisWidget::onTicksChecked -// Purpose : -//======================================================================= void SVTK_AxisWidget::onTicksChecked() { setEnabled(myTicksGrp, myIsTicksVisible->isChecked()); } -//======================================================================= -// name : SVTK_AxisWidget::onNameChecked -// Purpose : -//======================================================================= void SVTK_AxisWidget::onNameChecked() { setEnabled(myNameGrp, myIsNameVisible->isChecked()); } -//======================================================================= -// name : SVTK_AxisWidget::UseName -// Purpose : -//======================================================================= void SVTK_AxisWidget::UseName(const bool toUse) { myIsNameVisible->setChecked(toUse); } -//======================================================================= -// name : SVTK_AxisWidget::SetName -// Purpose : -//================================================== ===================== void SVTK_AxisWidget::SetName(const QString& theName) { myAxisName->setText(theName); } -//======================================================================= -// name : SVTK_AxisWidget::SetNameFont -// Purpose : -//======================================================================= void SVTK_AxisWidget::SetNameFont(const QColor& theColor, const int theFont, const bool theIsBold, @@ -225,10 +199,6 @@ void SVTK_AxisWidget::SetNameFont(const QColor& theColor, myNameFont->SetData(theColor, theFont, theIsBold, theIsItalic, theIsShadow); } -//======================================================================= -// name : SVTK_AxisWidget::SetNameFont -// Purpose : -//======================================================================= bool SVTK_AxisWidget::ReadData(vtkAxisActor2D* theActor) { if (theActor == 0) @@ -300,10 +270,6 @@ bool SVTK_AxisWidget::ReadData(vtkAxisActor2D* theActor) return true; } -//======================================================================= -// name : SVTK_CubeAxesDlg::Apply -// Purpose : -//======================================================================= bool SVTK_AxisWidget::Apply(vtkAxisActor2D* theActor) { if (theActor == 0) @@ -383,10 +349,9 @@ bool SVTK_AxisWidget::Apply(vtkAxisActor2D* theActor) Description : Dialog for specifynig cube axes properties */ -//======================================================================= -// name : SVTK_CubeAxesDlg::SVTK_CubeAxesDlg -// Purpose : Constructor -//======================================================================= +/*! + Constructor +*/ SVTK_CubeAxesDlg::SVTK_CubeAxesDlg(QtxAction* theAction, SVTK_MainWindow* theParent, const char* theName): @@ -405,10 +370,9 @@ SVTK_CubeAxesDlg::SVTK_CubeAxesDlg(QtxAction* theAction, connect(theParent, SIGNAL(Hide( QHideEvent * )), this, SLOT(onParentHide())); } -//======================================================================= -// name : SVTK_CubeAxesDlg::createMainFrame -// Purpose : Create frame containing dialog's input fields -//======================================================================= +/*! + Create frame containing dialog's input fields +*/ QWidget* SVTK_CubeAxesDlg::createMainFrame(QWidget* theParent) { QFrame* aFrame = new QFrame(theParent); @@ -434,10 +398,9 @@ QWidget* SVTK_CubeAxesDlg::createMainFrame(QWidget* theParent) return aFrame; } -//======================================================================= -// name : SVTK_CubeAxesDlg::createButtonFrame -// Purpose : Create frame containing buttons -//======================================================================= +/*! + Create frame containing buttons +*/ QWidget* SVTK_CubeAxesDlg::createButtonFrame(QWidget* theParent) { QFrame* aFrame = new QFrame(theParent); @@ -463,18 +426,16 @@ QWidget* SVTK_CubeAxesDlg::createButtonFrame(QWidget* theParent) return aFrame; } -//======================================================================= -// name : SVTK_CubeAxesDlg::~SVTK_CubeAxesDlg -// Purpose : Destructor -//======================================================================= +/*! + Destructor +*/ SVTK_CubeAxesDlg::~SVTK_CubeAxesDlg() { } -//======================================================================= -// name : SVTK_CubeAxesDlg::Update -// Purpose : Update dialog fields, connect signals and slots, show dialog -//======================================================================= +/*! + Update dialog fields, connect signals and slots, show dialog +*/ void SVTK_CubeAxesDlg::Update() { myActor = myMainWindow->GetCubeAxes(); @@ -486,19 +447,17 @@ void SVTK_CubeAxesDlg::Update() myIsVisible->setChecked(myActor->GetVisibility() ? true : false); } -//======================================================================= -// name : SVTK_CubeAxesDlg::isValid -// Purpose : Verify validity of entry data -//======================================================================= +/*! + Verify validity of entry data +*/ bool SVTK_CubeAxesDlg::isValid() const { return true; } -//======================================================================= -// name : SVTK_CubeAxesDlg::onApply -// Purpose : Verify validity of entry data -//======================================================================= +/*! + Verify validity of entry data +*/ bool SVTK_CubeAxesDlg::onApply() { bool isOk = true; @@ -535,20 +494,18 @@ bool SVTK_CubeAxesDlg::onApply() return isOk; } -//======================================================================= -// name : SVTK_CubeAxesDlg::onOk -// Purpose : SLOT called when "Ok" button pressed. -//======================================================================= +/*! + SLOT called when "Ok" button pressed. +*/ void SVTK_CubeAxesDlg::onOk() { if (onApply()) onClose(); } -//======================================================================= -// name : SVTK_CubeAxesDlg::onClose -// Purpose : SLOT called when "Close" button pressed. Close dialog -//======================================================================= +/*! + SLOT: called when "Close" button pressed. Close dialog +*/ void SVTK_CubeAxesDlg::onClose() { reject(); diff --git a/src/SVTK/SVTK_DeviceActor.cxx b/src/SVTK/SVTK_DeviceActor.cxx index e9da753f5..6cdfca241 100644 --- a/src/SVTK/SVTK_DeviceActor.cxx +++ b/src/SVTK/SVTK_DeviceActor.cxx @@ -46,11 +46,11 @@ using namespace std; -//---------------------------------------------------------------------------- vtkStandardNewMacro(SVTK_DeviceActor); - -//---------------------------------------------------------------------------- +/*! + Constructor +*/ SVTK_DeviceActor ::SVTK_DeviceActor() { @@ -77,8 +77,9 @@ SVTK_DeviceActor myPassFilter.push_back(VTKViewer_PassThroughFilter::New()); } - -//---------------------------------------------------------------------------- +/*! + Destructor +*/ SVTK_DeviceActor ::~SVTK_DeviceActor() { @@ -96,8 +97,9 @@ SVTK_DeviceActor myPassFilter[i]->Delete(); } - -//---------------------------------------------------------------------------- +/*! + To insert some additional filters and then sets the given vtkMapper +*/ void SVTK_DeviceActor ::SetMapper(vtkMapper* theMapper) @@ -105,6 +107,9 @@ SVTK_DeviceActor InitPipeLine(theMapper); } +/*! + To initialize internal pipeline +*/ void SVTK_DeviceActor ::InitPipeLine(vtkMapper* theMapper) @@ -139,7 +144,9 @@ SVTK_DeviceActor Superclass::SetMapper(theMapper); } -//---------------------------------------------------------------------------- +/*! + Allows to get initial vtkDataSet +*/ vtkDataSet* SVTK_DeviceActor ::GetInput() @@ -147,6 +154,9 @@ SVTK_DeviceActor return myPassFilter.front()->GetOutput(); } +/*! + Allows to set initial vtkDataSet +*/ void SVTK_DeviceActor ::SetInput(vtkDataSet* theDataSet) @@ -155,7 +165,9 @@ SVTK_DeviceActor InitPipeLine(myMapper); } -//---------------------------------------------------------------------------- +/*! + To provide VTK to Object and backward mapping +*/ void SVTK_DeviceActor:: SetStoreMapping(bool theStoreMapping) @@ -165,7 +177,6 @@ SetStoreMapping(bool theStoreMapping) -//---------------------------------------------------------------------------- unsigned long int SVTK_DeviceActor ::GetMTime() @@ -185,8 +196,10 @@ SVTK_DeviceActor return mTime; } - -//---------------------------------------------------------------------------- +/*! + Apply a view transformation + \param theTransform - transformation +*/ void SVTK_DeviceActor ::SetTransform(VTKViewer_Transform* theTransform) @@ -195,7 +208,6 @@ SVTK_DeviceActor } -//---------------------------------------------------------------------------- bool SVTK_DeviceActor ::IsShrunkable() @@ -259,7 +271,6 @@ SVTK_DeviceActor -//---------------------------------------------------------------------------- void SVTK_DeviceActor ::SetRepresentation(SVTK::Representation::Type theMode) @@ -348,7 +359,6 @@ SVTK_DeviceActor } -//---------------------------------------------------------------------------- int SVTK_DeviceActor ::GetNodeObjId(int theVtkID) @@ -379,7 +389,6 @@ SVTK_DeviceActor } -//---------------------------------------------------------------------------- void SVTK_DeviceActor ::Render(vtkRenderer *ren, vtkMapper* m) diff --git a/src/SVTK/SVTK_DeviceActor.h b/src/SVTK/SVTK_DeviceActor.h index 04ae5b850..5eee841f4 100644 --- a/src/SVTK/SVTK_DeviceActor.h +++ b/src/SVTK/SVTK_DeviceActor.h @@ -47,7 +47,6 @@ class vtkDataSet; class vtkShrinkFilter; class vtkDataSetMapper; -//---------------------------------------------------------------------------- namespace SVTK { namespace Representation @@ -61,7 +60,6 @@ namespace SVTK } -//---------------------------------------------------------------------------- class SVTK_EXPORT SVTK_DeviceActor: public vtkLODActor { public: diff --git a/src/SVTK/SVTK_FontWidget.cxx b/src/SVTK/SVTK_FontWidget.cxx index edaa9a6c0..92f16923e 100644 --- a/src/SVTK/SVTK_FontWidget.cxx +++ b/src/SVTK/SVTK_FontWidget.cxx @@ -39,10 +39,9 @@ * Description : Dialog for specifynig font */ -//======================================================================= -// name : SVTK_FontWidget -// Purpose : Constructor -//======================================================================= +/*! + Constructor +*/ SVTK_FontWidget::SVTK_FontWidget( QWidget* theParent ) : QHBox( theParent ) { @@ -62,36 +61,23 @@ SVTK_FontWidget::SVTK_FontWidget( QWidget* theParent ) connect( myColorBtn, SIGNAL( clicked() ), SLOT( onColor() ) ); } -//======================================================================= -// name : ~SVTK_FontWidget -// Purpose : Destructor -//======================================================================= +/*! + Destructor +*/ SVTK_FontWidget::~SVTK_FontWidget() { } -//======================================================================= -// name : SetColor -// Purpose : -//======================================================================= void SVTK_FontWidget::SetColor( const QColor& theColor ) { myColorBtn->setPaletteBackgroundColor( theColor ); } -//======================================================================= -// name : GetColor -// Purpose : -//======================================================================= QColor SVTK_FontWidget::GetColor() const { return myColorBtn->paletteBackgroundColor(); } -//======================================================================= -// name : onColor -// Purpose : -//======================================================================= void SVTK_FontWidget::onColor() { QColor aColor = QColorDialog::getColor( GetColor(), this ); @@ -99,10 +85,6 @@ void SVTK_FontWidget::onColor() SetColor( aColor ); } -//======================================================================= -// name : SetData -// Purpose : -//======================================================================= void SVTK_FontWidget::SetData( const QColor& theColor, const int theFamily, const bool theBold, @@ -123,10 +105,6 @@ void SVTK_FontWidget::SetData( const QColor& theColor, myShadow->setChecked( theShadow ); } -//======================================================================= -// name : GetData -// Purpose : -//======================================================================= void SVTK_FontWidget::GetData( QColor& theColor, int& theFamily, bool& theBold, diff --git a/src/SVTK/SVTK_GenericRenderWindowInteractor.cxx b/src/SVTK/SVTK_GenericRenderWindowInteractor.cxx index e3cb3c8e2..4f7cbb599 100644 --- a/src/SVTK/SVTK_GenericRenderWindowInteractor.cxx +++ b/src/SVTK/SVTK_GenericRenderWindowInteractor.cxx @@ -36,9 +36,11 @@ using namespace std; -//---------------------------------------------------------------------------- vtkStandardNewMacro(QVTK_GenericRenderWindowInteractor); +/*! + Constructor +*/ QVTK_GenericRenderWindowInteractor ::QVTK_GenericRenderWindowInteractor() { @@ -46,14 +48,18 @@ QVTK_GenericRenderWindowInteractor connect(myTimer, SIGNAL(timeout()), this, SLOT(OnTimeOut())) ; } +/*! + Destructor +*/ QVTK_GenericRenderWindowInteractor ::~QVTK_GenericRenderWindowInteractor() { delete myTimer; } - -//---------------------------------------------------------------------------- +/*! + The slot connects to QTimer::timeout signal to invoke vtkCommand::TimerEvent +*/ void QVTK_GenericRenderWindowInteractor ::OnTimeOut() @@ -63,6 +69,9 @@ QVTK_GenericRenderWindowInteractor } } +/*! + Starts the QTimer instance on defined microseconds +*/ int QVTK_GenericRenderWindowInteractor ::CreateTimer(int vtkNotUsed(timertype)) @@ -75,6 +84,9 @@ QVTK_GenericRenderWindowInteractor return 1; } +/*! + Stops the QTimer instance +*/ int QVTK_GenericRenderWindowInteractor ::DestroyTimer(void) @@ -95,20 +107,28 @@ QVTK_GenericRenderWindowInteractor } -//---------------------------------------------------------------------------- vtkStandardNewMacro(SVTK_GenericRenderWindowInteractor); +/*! + Constructor +*/ SVTK_GenericRenderWindowInteractor ::SVTK_GenericRenderWindowInteractor(): myRenderWidget(NULL) { } +/*! + Destructor +*/ SVTK_GenericRenderWindowInteractor ::~SVTK_GenericRenderWindowInteractor() { } +/*! + To get access to SVTK_Selector +*/ SVTK_Selector* SVTK_GenericRenderWindowInteractor ::GetSelector() @@ -116,6 +136,10 @@ SVTK_GenericRenderWindowInteractor return mySelector.GetPointer(); } +/*! + To initialize mySelector field + \param theSelector - new selector +*/ void SVTK_GenericRenderWindowInteractor ::SetSelector(SVTK_Selector* theSelector) @@ -123,6 +147,9 @@ SVTK_GenericRenderWindowInteractor mySelector = theSelector; } +/*! + To get access to QWidget, where vtkRenderWindow maps to. +*/ QWidget* SVTK_GenericRenderWindowInteractor ::GetRenderWidget() @@ -130,6 +157,9 @@ SVTK_GenericRenderWindowInteractor return myRenderWidget; } +/*! + To initialize myRenderWidget field. +*/ void SVTK_GenericRenderWindowInteractor ::SetRenderWidget(QWidget* theRenderWidget) diff --git a/src/SVTK/SVTK_GenericRenderWindowInteractor.h b/src/SVTK/SVTK_GenericRenderWindowInteractor.h index d15fdc557..4e9ab968f 100644 --- a/src/SVTK/SVTK_GenericRenderWindowInteractor.h +++ b/src/SVTK/SVTK_GenericRenderWindowInteractor.h @@ -42,9 +42,9 @@ class SVTK_Selector; class SVTK_Renderer; -//============================================================================ -//! Introduction of the class is intended to implement Qt based #CreateTimer and #DestroyTimer functionality. /*! + \class QVTK_GenericRenderWindowInteractor + Introduction of the class is intended to implement Qt based #CreateTimer and #DestroyTimer functionality. The class intendes to implement platform indepenedant subclass of vtkRenderWindowInteractor. This is done by usage of Qt library. \note @@ -86,9 +86,9 @@ class SVTK_EXPORT QVTK_GenericRenderWindowInteractor: }; -//============================================================================ -//! This class introduce SALOME specific to the base one /*! + \class SVTK_GenericRenderWindowInteractor + This class introduce SALOME specific to the base one In this class new members is added (#mySelector and #myRenderWidget). They are used for initialization of #SVTK_InteractorStyle by redefinition of #SVTK_InteractorStyle::SetInteractor method diff --git a/src/SVTK/SVTK_InteractorStyle.cxx b/src/SVTK/SVTK_InteractorStyle.cxx index b3d49249a..3bd3cf075 100644 --- a/src/SVTK/SVTK_InteractorStyle.cxx +++ b/src/SVTK/SVTK_InteractorStyle.cxx @@ -98,9 +98,11 @@ namespace } -//---------------------------------------------------------------------------- vtkStandardNewMacro(SVTK_InteractorStyle); -//---------------------------------------------------------------------------- + +/*! + Constructor +*/ SVTK_InteractorStyle ::SVTK_InteractorStyle(): mySelectionEvent(new SVTK_SelectionEvent()), @@ -131,13 +133,17 @@ SVTK_InteractorStyle myControllerOnKeyDown->Delete(); } -//---------------------------------------------------------------------------- +/*! + Destructor +*/ SVTK_InteractorStyle ::~SVTK_InteractorStyle() { } -//---------------------------------------------------------------------------- +/*! + \return widget for rendering +*/ QWidget* SVTK_InteractorStyle ::GetRenderWidget() @@ -145,6 +151,9 @@ SVTK_InteractorStyle return myInteractor->GetRenderWidget(); } +/*! + \return selector +*/ SVTK_Selector* SVTK_InteractorStyle ::GetSelector() @@ -152,7 +161,9 @@ SVTK_InteractorStyle return myInteractor->GetSelector(); } -//---------------------------------------------------------------------------- +/*! + Generate special SVTK_SelectionEvent +*/ SVTK_SelectionEvent* SVTK_InteractorStyle ::GetSelectionEvent() @@ -170,7 +181,9 @@ SVTK_InteractorStyle return mySelectionEvent.get(); } -//---------------------------------------------------------------------------- +/*! + Generate special SVTK_SelectionEvent with flipped Y coordinate +*/ SVTK_SelectionEvent* SVTK_InteractorStyle ::GetSelectionEventFlipY() @@ -188,7 +201,6 @@ SVTK_InteractorStyle return mySelectionEvent.get(); } -//---------------------------------------------------------------------------- void SVTK_InteractorStyle ::RotateXY(int dx, int dy) @@ -213,7 +225,6 @@ SVTK_InteractorStyle this->Render(); } -//---------------------------------------------------------------------------- void SVTK_InteractorStyle ::PanXY(int x, int y, int oldX, int oldY) @@ -223,7 +234,6 @@ SVTK_InteractorStyle } -//---------------------------------------------------------------------------- void SVTK_InteractorStyle ::DollyXY(int dx, int dy) @@ -247,7 +257,6 @@ SVTK_InteractorStyle this->Render(); } -//---------------------------------------------------------------------------- void SVTK_InteractorStyle ::SpinXY(int x, int y, int oldX, int oldY) @@ -273,7 +282,9 @@ SVTK_InteractorStyle } -//---------------------------------------------------------------------------- +/*! + To reset reset view +*/ void SVTK_InteractorStyle ::OnConfigure() @@ -282,8 +293,9 @@ SVTK_InteractorStyle this->GetCurrentRenderer()->InvokeEvent(vtkCommand::ConfigureEvent,NULL); } - -//---------------------------------------------------------------------------- +/*! + To handle mouse move event +*/ void SVTK_InteractorStyle ::OnMouseMove() @@ -295,8 +307,9 @@ SVTK_InteractorStyle x, y ); } - -//---------------------------------------------------------------------------- +/*! + To handle left mouse button down event (reimplemented from vtkInteractorStyle) +*/ void SVTK_InteractorStyle ::OnLeftButtonDown() @@ -308,8 +321,9 @@ SVTK_InteractorStyle x, y ); } - -//---------------------------------------------------------------------------- +/*! + To handle left mouse button up event (reimplemented from vtkInteractorStyle) +*/ void SVTK_InteractorStyle ::OnLeftButtonUp() @@ -321,8 +335,9 @@ SVTK_InteractorStyle x, y ); } - -//---------------------------------------------------------------------------- +/*! + To handle middle mouse button down event (reimplemented from vtkInteractorStyle) +*/ void SVTK_InteractorStyle ::OnMiddleButtonDown() @@ -334,8 +349,9 @@ SVTK_InteractorStyle x, y ); } - -//---------------------------------------------------------------------------- +/*! + To handle middle mouse button up event (reimplemented from vtkInteractorStyle) +*/ void SVTK_InteractorStyle ::OnMiddleButtonUp() @@ -347,8 +363,9 @@ SVTK_InteractorStyle x, y ); } - -//---------------------------------------------------------------------------- +/*! + To handle right mouse button down event (reimplemented from vtkInteractorStyle) +*/ void SVTK_InteractorStyle ::OnRightButtonDown() @@ -360,7 +377,9 @@ SVTK_InteractorStyle x, y ); } -//---------------------------------------------------------------------------- +/*! + To handle right mouse button up event (reimplemented from vtkInteractorStyle) +*/ void SVTK_InteractorStyle ::OnRightButtonUp() @@ -372,8 +391,9 @@ SVTK_InteractorStyle x, y ); } - -//---------------------------------------------------------------------------- +/*! + To handle mouse move event +*/ void SVTK_InteractorStyle ::OnMouseMove(int vtkNotUsed(ctrl), @@ -387,8 +407,9 @@ SVTK_InteractorStyle onCursorMove(QPoint(x, y)); } - -//---------------------------------------------------------------------------- +/*! + To handle left mouse button down event (reimplemented from vtkInteractorStyle) +*/ void SVTK_InteractorStyle ::OnLeftButtonDown(int ctrl, int shift, @@ -416,8 +437,9 @@ SVTK_InteractorStyle return; } - -//---------------------------------------------------------------------------- +/*! + To handle left mouse button up event (reimplemented from vtkInteractorStyle) +*/ void SVTK_InteractorStyle ::OnLeftButtonUp(int vtkNotUsed(ctrl), @@ -433,8 +455,9 @@ SVTK_InteractorStyle } } - -//---------------------------------------------------------------------------- +/*! + To handle middle mouse button down event (reimplemented from vtkInteractorStyle) +*/ void SVTK_InteractorStyle ::OnMiddleButtonDown(int ctrl, @@ -462,7 +485,9 @@ SVTK_InteractorStyle } -//---------------------------------------------------------------------------- +/*! + To handle middle mouse button up event (reimplemented from vtkInteractorStyle) +*/ void SVTK_InteractorStyle ::OnMiddleButtonUp(int vtkNotUsed(ctrl), @@ -479,7 +504,9 @@ SVTK_InteractorStyle } -//---------------------------------------------------------------------------- +/*! + To handle right mouse button down event (reimplemented from vtkInteractorStyle) +*/ void SVTK_InteractorStyle ::OnRightButtonDown(int ctrl, @@ -506,7 +533,9 @@ SVTK_InteractorStyle } } -//---------------------------------------------------------------------------- +/*! + To handle right mouse button up event (reimplemented from vtkInteractorStyle) +*/ void SVTK_InteractorStyle ::OnRightButtonUp(int vtkNotUsed(ctrl), @@ -522,7 +551,6 @@ SVTK_InteractorStyle } } -//---------------------------------------------------------------------------- /* XPM */ const char* imageZoomCursor[] = { "32 32 3 1", @@ -601,8 +629,9 @@ const char* imageRotateCursor[] = { "................................"}; -//---------------------------------------------------------------------------- -// loads cursors for viewer operations - zoom, pan, etc... +/*! + loads cursors for viewer operations - zoom, pan, etc... +*/ void SVTK_InteractorStyle ::loadCursors() @@ -618,8 +647,9 @@ SVTK_InteractorStyle } -//---------------------------------------------------------------------------- -// starts Zoom operation (e.g. through menu command) +/*! + Starts Zoom operation (e.g. through menu command) +*/ void SVTK_InteractorStyle ::startZoom() @@ -634,8 +664,9 @@ SVTK_InteractorStyle } -//---------------------------------------------------------------------------- -// starts Pan operation (e.g. through menu command) +/*! + Starts Pan operation (e.g. through menu command) +*/ void SVTK_InteractorStyle ::startPan() @@ -649,8 +680,9 @@ SVTK_InteractorStyle ForcedState = VTK_INTERACTOR_STYLE_CAMERA_PAN; } -//---------------------------------------------------------------------------- -// starts Rotate operation (e.g. through menu command) +/*! + Starts Rotate operation (e.g. through menu command) +*/ void SVTK_InteractorStyle ::startRotate() @@ -665,8 +697,9 @@ SVTK_InteractorStyle } -//---------------------------------------------------------------------------- -// starts Spin operation (e.g. through menu command) +/*! + Starts Spin operation (e.g. through menu command) +*/ void SVTK_InteractorStyle ::startSpin() @@ -682,8 +715,9 @@ SVTK_InteractorStyle -//---------------------------------------------------------------------------- -// starts Fit Area operation (e.g. through menu command) +/*! + Starts Fit Area operation (e.g. through menu command) +*/ void SVTK_InteractorStyle ::startFitArea() @@ -698,8 +732,9 @@ SVTK_InteractorStyle } -//---------------------------------------------------------------------------- -// starts Global Panning operation (e.g. through menu command) +/*! + Starts Global Panning operation (e.g. through menu command) +*/ void SVTK_InteractorStyle ::startGlobalPan() @@ -721,8 +756,9 @@ SVTK_InteractorStyle } -//---------------------------------------------------------------------------- -// fits viewer contents to rect +/*! + Fits viewer contents to rect +*/ void SVTK_InteractorStyle ::fitRect(const int left, @@ -758,8 +794,9 @@ SVTK_InteractorStyle } -//---------------------------------------------------------------------------- -// starts viewer operation (!internal usage!) +/*! + Starts viewer operation (!internal usage!) +*/ void SVTK_InteractorStyle ::startOperation(int operation) @@ -789,8 +826,9 @@ SVTK_InteractorStyle } -//---------------------------------------------------------------------------- -// sets proper cursor for window when viewer operation is activated +/*! + Sets proper cursor for window when viewer operation is activated +*/ void SVTK_InteractorStyle ::setCursor(const int operation) @@ -832,8 +870,9 @@ SVTK_InteractorStyle } -//---------------------------------------------------------------------------- -// called when viewer operation started (!put necessary initialization here!) +/*! + Called when viewer operation started (!put necessary initialization here!) +*/ void SVTK_InteractorStyle ::onStartOperation() @@ -865,8 +904,9 @@ SVTK_InteractorStyle } -//---------------------------------------------------------------------------- -// called when viewer operation finished (!put necessary post-processing here!) +/*! + Called when viewer operation finished (!put necessary post-processing here!) +*/ void SVTK_InteractorStyle ::onFinishOperation() @@ -972,8 +1012,9 @@ SVTK_InteractorStyle } -// called during viewer operation when user moves mouse (!put necessary processing here!) -//---------------------------------------------------------------------------- +/*! + Called during viewer operation when user moves mouse (!put necessary processing here!) +*/ void SVTK_InteractorStyle ::onOperation(QPoint mousePos) @@ -1028,9 +1069,10 @@ SVTK_InteractorStyle } } -// called when user moves mouse inside viewer window and there is no active viewer operation -// (!put necessary processing here!) -//---------------------------------------------------------------------------- +/*! + Called when user moves mouse inside viewer window and there is no active viewer operation + (!put necessary processing here!) +*/ void SVTK_InteractorStyle ::onCursorMove(QPoint mousePos) @@ -1060,8 +1102,9 @@ SVTK_InteractorStyle this->Render(); } -// called on finsh GlobalPan operation -//---------------------------------------------------------------------------- +/*! + Called on finsh GlobalPan operation +*/ void SVTK_InteractorStyle ::Place(const int theX, const int theY) @@ -1086,8 +1129,9 @@ SVTK_InteractorStyle -// Translates view from Point to Point -//---------------------------------------------------------------------------- +/*! + Translates view from Point to Point +*/ void SVTK_InteractorStyle ::TranslateView(int toX, int toY, int fromX, int fromY) @@ -1121,7 +1165,6 @@ SVTK_InteractorStyle motionVector[2] + viewPoint[2]); } -//---------------------------------------------------------------------------- void SVTK_InteractorStyle ::IncrementalPan( const int incrX, const int incrY ) @@ -1129,7 +1172,6 @@ SVTK_InteractorStyle this->PanXY( incrX, incrY, 0, 0 ); } -//---------------------------------------------------------------------------- void SVTK_InteractorStyle ::IncrementalZoom( const int incr ) @@ -1137,7 +1179,6 @@ SVTK_InteractorStyle this->DollyXY( incr, incr ); } -//---------------------------------------------------------------------------- void SVTK_InteractorStyle ::IncrementalRotate( const int incrX, const int incrY ) @@ -1145,7 +1186,9 @@ SVTK_InteractorStyle this->RotateXY( incrX, -incrY ); } -//---------------------------------------------------------------------------- +/*! + Redefined in order to add an observer (callback) for custorm event (space mouse event) +*/ void SVTK_InteractorStyle ::SetInteractor( vtkRenderWindowInteractor* theInteractor ) @@ -1185,8 +1228,9 @@ SVTK_InteractorStyle } } - -//---------------------------------------------------------------------------- +/*! + To implement cached rendering +*/ void SVTK_InteractorStyle ::OnTimer() @@ -1195,7 +1239,9 @@ SVTK_InteractorStyle this->Interactor->Render(); } -//---------------------------------------------------------------------------- +/*! + To invoke #vtkRenderWindowInteractor::CreateTimer +*/ void SVTK_InteractorStyle ::Render() @@ -1203,7 +1249,6 @@ SVTK_InteractorStyle this->Interactor->CreateTimer(VTKI_TIMER_FIRST); } -//---------------------------------------------------------------------------- void SVTK_InteractorStyle ::onSpaceMouseMove( double* data ) @@ -1219,7 +1264,6 @@ SVTK_InteractorStyle IncrementalRotate( (int)data[3], 0 ); // 5. tilt the control forward/backward = rotate around X axis (Z axis of local coordinate system of space mouse) } -//---------------------------------------------------------------------------- void SVTK_InteractorStyle ::onSpaceMouseButton( int button ) @@ -1234,7 +1278,6 @@ SVTK_InteractorStyle DominantCombinedSwitch(); } -//---------------------------------------------------------------------------- void SVTK_InteractorStyle ::DominantCombinedSwitch() @@ -1242,7 +1285,9 @@ SVTK_InteractorStyle printf( "\n--DominantCombinedSwitch() NOT IMPLEMENTED--\n" ); } -//---------------------------------------------------------------------------- +/*! + Main process event method (reimplemented from #vtkInteractorStyle) +*/ void SVTK_InteractorStyle ::ProcessEvents( vtkObject* object, @@ -1333,11 +1378,17 @@ SVTK_InteractorStyle Superclass::ProcessEvents( object, event, clientData, callData ); } -//---------------------------------------------------------------------------- + +/*! + To handle keyboard event (reimplemented from #vtkInteractorStyle) +*/ void SVTK_InteractorStyle::OnChar() { } -//---------------------------------------------------------------------------- + +/*! + Redefined vtkInteractorStyle::OnKeyDown +*/ void SVTK_InteractorStyle::OnKeyDown() { bool bInvokeSuperclass=myControllerOnKeyDown->OnKeyDown(this); @@ -1345,7 +1396,10 @@ void SVTK_InteractorStyle::OnKeyDown() Superclass::OnKeyDown(); } } -//---------------------------------------------------------------------------- + +/*! + Provide instructions for Picking +*/ void SVTK_InteractorStyle::ActionPicking() { int x, y; @@ -1358,54 +1412,60 @@ void SVTK_InteractorStyle::ActionPicking() onFinishOperation(); startOperation(VTK_INTERACTOR_STYLE_CAMERA_NONE); } -//---------------------------------------------------------------------------- + +/*! + To set current increment controller +*/ void SVTK_InteractorStyle::SetControllerOnKeyDown(SVTK_ControllerOnKeyDown* theController) { myControllerOnKeyDown=theController; } -//---------------------------------------------------------------------------- + +/*! + To get current OnKeyDown controller +*/ SVTK_ControllerOnKeyDown* SVTK_InteractorStyle::ControllerOnKeyDown() { return myControllerOnKeyDown.GetPointer(); } -//---------------------------------------------------------------------------- + +/*! + To get current increment controller +*/ void SVTK_InteractorStyle::SetControllerIncrement(SVTK_ControllerIncrement* theController) { myControllerIncrement=theController; } -//---------------------------------------------------------------------------- + +/*! + To get current increment controller +*/ SVTK_ControllerIncrement* SVTK_InteractorStyle::ControllerIncrement() { return myControllerIncrement.GetPointer(); } vtkStandardNewMacro(SVTK_ControllerIncrement); -//---------------------------------------------------------------------------- SVTK_ControllerIncrement::SVTK_ControllerIncrement() { myIncrement=10; } -//---------------------------------------------------------------------------- SVTK_ControllerIncrement::~SVTK_ControllerIncrement() { } -//---------------------------------------------------------------------------- void SVTK_ControllerIncrement::SetStartValue(const int theValue) { myIncrement=theValue; } -//---------------------------------------------------------------------------- int SVTK_ControllerIncrement::Current()const { return myIncrement; } -//---------------------------------------------------------------------------- int SVTK_ControllerIncrement::Increase() { ++myIncrement; return myIncrement; } -//---------------------------------------------------------------------------- int SVTK_ControllerIncrement::Decrease() { if (myIncrement>1){ @@ -1415,15 +1475,21 @@ int SVTK_ControllerIncrement::Decrease() } vtkStandardNewMacro(SVTK_ControllerOnKeyDown); -//---------------------------------------------------------------------------- + +/*! + Constructor +*/ SVTK_ControllerOnKeyDown::SVTK_ControllerOnKeyDown() { } -//---------------------------------------------------------------------------- + +/*! + Destructor +*/ SVTK_ControllerOnKeyDown::~SVTK_ControllerOnKeyDown() { } -//---------------------------------------------------------------------------- + bool SVTK_ControllerOnKeyDown::OnKeyDown(vtkInteractorStyle* theIS) { return true; diff --git a/src/SVTK/SVTK_InteractorStyle.h b/src/SVTK/SVTK_InteractorStyle.h index 7ea671df4..eebe88ec5 100644 --- a/src/SVTK/SVTK_InteractorStyle.h +++ b/src/SVTK/SVTK_InteractorStyle.h @@ -45,7 +45,6 @@ #include // -//------------------------------------------- //! Control the value of increment in SALOME way. /*! This class controls of value of increment, @@ -77,7 +76,6 @@ class SVTK_ControllerIncrement : public vtkObject{ void operator=(const SVTK_ControllerIncrement&); //Not implemented }; // -//------------------------------------------- //! Control the behaviour of KeyDown event in SALOME way. /*! This class controls the behaviour of KeyDown event @@ -99,7 +97,6 @@ class SVTK_ControllerOnKeyDown : public vtkObject{ SVTK_ControllerOnKeyDown(const SVTK_ControllerOnKeyDown&);//Not implemented void operator=(const SVTK_ControllerOnKeyDown&); //Not implemented }; -//------------------------------------------- class vtkCell; class vtkPicker; @@ -143,7 +140,7 @@ class SVTK_EXPORT SVTK_InteractorStyle: public vtkInteractorStyle SVTK_SelectionEvent* GetSelectionEventFlipY(); - //! Redefined in order to add an observer (callback) for custorm event (space mouse event) + //! Redefined in order to add an observer (callback) for custom event (space mouse event) virtual void SetInteractor( vtkRenderWindowInteractor* ); diff --git a/src/SVTK/SVTK_MainWindow.cxx b/src/SVTK/SVTK_MainWindow.cxx index afeb1176e..be1e25c37 100644 --- a/src/SVTK/SVTK_MainWindow.cxx +++ b/src/SVTK/SVTK_MainWindow.cxx @@ -52,8 +52,9 @@ #include - -//---------------------------------------------------------------------------- +/*! + Constructor +*/ SVTK_MainWindow ::SVTK_MainWindow(QWidget* theParent, const char* theName, @@ -70,6 +71,9 @@ SVTK_MainWindow createToolBar(); } +/*! + To initialize the class +*/ void SVTK_MainWindow ::Initialize(SVTK_RenderWindowInteractor* theInteractor) @@ -89,15 +93,17 @@ SVTK_MainWindow myCubeAxesDlg = new SVTK_CubeAxesDlg(myActionsMap[GraduatedAxes],this,"SVTK_CubeAxesDlg"); } - -//---------------------------------------------------------------------------- +/*! + Destructor +*/ SVTK_MainWindow ::~SVTK_MainWindow() { } - -//---------------------------------------------------------------------------- +/*! + \return used SVTK_RenderWindowInteractor +*/ SVTK_RenderWindowInteractor* SVTK_MainWindow ::GetInteractor() @@ -105,6 +111,9 @@ SVTK_MainWindow return myInteractor; } +/*! + \return used #vtkRenderWindowInteractor (obsolete) +*/ vtkRenderWindowInteractor* SVTK_MainWindow ::getInteractor() @@ -112,6 +121,9 @@ SVTK_MainWindow return GetInteractor()->GetDevice(); } +/*! + \return used vtkRenderWindow (obsolete) +*/ vtkRenderWindow* SVTK_MainWindow ::getRenderWindow() @@ -119,7 +131,10 @@ SVTK_MainWindow return GetInteractor()->getRenderWindow(); } -//---------------------------------------------------------------------------- +/*! + To repaint the view + \param theUpdateTrihedron - adjust trihedron +*/ void SVTK_MainWindow ::Repaint(bool theUpdateTrihedron) @@ -130,7 +145,9 @@ SVTK_MainWindow GetInteractor()->update(); } -//---------------------------------------------------------------------------- +/*! + To invoke a VTK event on SVTK_RenderWindowInteractor instance +*/ void SVTK_MainWindow ::InvokeEvent(unsigned long theEvent, void* theCallData) @@ -138,7 +155,9 @@ SVTK_MainWindow GetInteractor()->InvokeEvent(theEvent,theCallData); } -//---------------------------------------------------------------------------- +/*! + Redirect the request to SVTK_RenderWindowInteractor::GetInteractorStyle +*/ vtkInteractorStyle* SVTK_MainWindow ::GetInteractorStyle() @@ -146,6 +165,9 @@ SVTK_MainWindow return GetInteractor()->GetInteractorStyle(); } +/*! + Redirect the request to SVTK_RenderWindowInteractor::PushInteractorStyle +*/ void SVTK_MainWindow ::PushInteractorStyle(vtkInteractorStyle* theStyle) @@ -153,6 +175,9 @@ SVTK_MainWindow GetInteractor()->PushInteractorStyle(theStyle); } +/*! + Redirect the request to SVTK_RenderWindowInteractor::PopInteractorStyle +*/ void SVTK_MainWindow ::PopInteractorStyle() @@ -160,7 +185,9 @@ SVTK_MainWindow GetInteractor()->PopInteractorStyle(); } -//---------------------------------------------------------------------------- +/*! + Redirect the request to SVTK_RenderWindowInteractor::GetSelector +*/ SVTK_Selector* SVTK_MainWindow ::GetSelector() @@ -168,6 +195,9 @@ SVTK_MainWindow return GetInteractor()->GetSelector(); } +/*! + Redirect the request to SVTK_RenderWindowInteractor::SelectionMode +*/ Selection_Mode SVTK_MainWindow ::SelectionMode() @@ -175,6 +205,9 @@ SVTK_MainWindow return GetSelector()->SelectionMode(); } +/*! + Redirect the request to SVTK_RenderWindowInteractor::SetSelectionMode +*/ void SVTK_MainWindow ::SetSelectionMode(Selection_Mode theMode) @@ -182,8 +215,9 @@ SVTK_MainWindow GetSelector()->SetSelectionMode(theMode); } - -//---------------------------------------------------------------------------- +/*! + Redirect the request to SVTK_RenderWindowInteractor::GetRenderer +*/ SVTK_Renderer* SVTK_MainWindow ::GetRenderer() @@ -191,6 +225,9 @@ SVTK_MainWindow return GetInteractor()->GetRenderer(); } +/*! + Redirect the request to SVTK_RenderWindowInteractor::getRenderer +*/ vtkRenderer* SVTK_MainWindow ::getRenderer() @@ -198,7 +235,10 @@ SVTK_MainWindow return GetInteractor()->getRenderer(); } -//---------------------------------------------------------------------------- +/*! + Sets background color of the view + \param theColor - new background color +*/ void SVTK_MainWindow ::SetBackgroundColor(const QColor& theColor) @@ -208,6 +248,9 @@ SVTK_MainWindow theColor.blue()/255.0); } +/*! + \return background color of the view +*/ QColor SVTK_MainWindow ::BackgroundColor() @@ -219,7 +262,9 @@ SVTK_MainWindow int(aBackgroundColor[2]*255)); } -//---------------------------------------------------------------------------- +/*! + Redirect the request to SVTK_Renderer::GetScale +*/ void SVTK_MainWindow ::GetScale( double theScale[3] ) @@ -227,6 +272,9 @@ SVTK_MainWindow GetRenderer()->GetScale( theScale ); } +/*! + Redirect the request to SVTK_Renderer::SetScale +*/ void SVTK_MainWindow ::SetScale( double theScale[3] ) @@ -235,8 +283,9 @@ SVTK_MainWindow Repaint(); } - -//---------------------------------------------------------------------------- +/*! + Redirect the request to SVTK_Renderer::AddActor +*/ void SVTK_MainWindow ::AddActor(VTKViewer_Actor* theActor, @@ -247,7 +296,9 @@ SVTK_MainWindow Repaint(); } -//---------------------------------------------------------------------------- +/*! + Redirect the request to SVTK_Renderer::RemoveActor +*/ void SVTK_MainWindow ::RemoveActor(VTKViewer_Actor* theActor, @@ -258,8 +309,9 @@ SVTK_MainWindow Repaint(); } - -//---------------------------------------------------------------------------- +/*! + Redirect the request to SVTK_Renderer::GetTrihedronSize +*/ int SVTK_MainWindow ::GetTrihedronSize() @@ -267,7 +319,9 @@ SVTK_MainWindow return GetRenderer()->GetTrihedronSize(); } -//---------------------------------------------------------------------------- +/*! + Redirect the request to SVTK_Renderer::SetTrihedronSize +*/ void SVTK_MainWindow ::SetTrihedronSize( const int theSize, const bool theRelative ) @@ -277,7 +331,6 @@ SVTK_MainWindow } -//---------------------------------------------------------------------------- /*! If parameter theIsForcedUpdate is true, recalculate parameters for * trihedron and cube axes, even if trihedron and cube axes is invisible. */ @@ -289,7 +342,9 @@ SVTK_MainWindow Repaint(); } -//---------------------------------------------------------------------------- +/*! + Redirect the request to SVTK_Renderer::IsTrihedronDisplayed +*/ bool SVTK_MainWindow ::IsTrihedronDisplayed() @@ -297,7 +352,9 @@ SVTK_MainWindow return GetRenderer()->IsTrihedronDisplayed(); } -//---------------------------------------------------------------------------- +/*! + Redirect the request to SVTK_Renderer::IsCubeAxesDisplayed +*/ bool SVTK_MainWindow ::IsCubeAxesDisplayed() @@ -305,7 +362,9 @@ SVTK_MainWindow return GetRenderer()->IsCubeAxesDisplayed(); } -//---------------------------------------------------------------------------- +/*! + Redirect the request to SVTK_Renderer::GetTrihedron +*/ VTKViewer_Trihedron* SVTK_MainWindow ::GetTrihedron() @@ -313,7 +372,9 @@ SVTK_MainWindow return GetRenderer()->GetTrihedron(); } -//---------------------------------------------------------------------------- +/*! + Redirect the request to SVTK_Renderer::GetCubeAxes +*/ SVTK_CubeAxesActor2D* SVTK_MainWindow ::GetCubeAxes() @@ -321,8 +382,9 @@ SVTK_MainWindow return GetRenderer()->GetCubeAxes(); } - -//---------------------------------------------------------------------------- +/*! + \return toolbar of svtk main window +*/ QToolBar* SVTK_MainWindow ::getToolBar() @@ -330,7 +392,6 @@ SVTK_MainWindow return myToolBar; } -//---------------------------------------------------------------------------- void SVTK_MainWindow ::SetEventDispatcher(vtkObject* theDispatcher) @@ -338,11 +399,13 @@ SVTK_MainWindow myEventDispatcher = theDispatcher; } -//---------------------------------------------------------------------------- #if defined(WIN32) && !defined(_DEBUG) #pragma optimize( "", off ) #endif +/*! + Creates all actions of svtk main window +*/ void SVTK_MainWindow ::createActions(SUIT_ResourceMgr* theResourceMgr) @@ -499,7 +562,9 @@ SVTK_MainWindow #pragma optimize( "", on ) #endif -//---------------------------------------------------------------------------- +/*! + Creates toolbar of svtk main window +*/ void SVTK_MainWindow ::createToolBar() @@ -533,7 +598,9 @@ SVTK_MainWindow myActionsMap[GraduatedAxes]->addTo(myToolBar); } -//---------------------------------------------------------------------------- +/*! + Custom show event handler +*/ void SVTK_MainWindow ::showEvent( QShowEvent * theEvent ) @@ -541,6 +608,9 @@ SVTK_MainWindow emit Show( theEvent ); } +/*! + Custom hide event handler +*/ void SVTK_MainWindow ::hideEvent( QHideEvent * theEvent ) @@ -548,8 +618,9 @@ SVTK_MainWindow emit Hide( theEvent ); } - -//---------------------------------------------------------------------------- +/*! + Starts zoom transformation +*/ void SVTK_MainWindow ::activateZoom() @@ -557,7 +628,9 @@ SVTK_MainWindow myEventDispatcher->InvokeEvent(SVTK::StartZoom,0); } -//---------------------------------------------------------------------------- +/*! + Starts panning transformation +*/ void SVTK_MainWindow ::activatePanning() @@ -565,7 +638,9 @@ SVTK_MainWindow myEventDispatcher->InvokeEvent(SVTK::StartPan,0); } -//---------------------------------------------------------------------------- +/*! + Starts rotation transformation +*/ void SVTK_MainWindow ::activateRotation() @@ -573,7 +648,9 @@ SVTK_MainWindow myEventDispatcher->InvokeEvent(SVTK::StartRotate,0); } -//---------------------------------------------------------------------------- +/*! + Starts global panning transformation +*/ void SVTK_MainWindow ::activateGlobalPanning() @@ -581,7 +658,9 @@ SVTK_MainWindow myEventDispatcher->InvokeEvent(SVTK::StartGlobalPan,0); } -//---------------------------------------------------------------------------- +/*! + Starts window fit transformation +*/ void SVTK_MainWindow ::activateWindowFit() @@ -589,7 +668,9 @@ SVTK_MainWindow myEventDispatcher->InvokeEvent(SVTK::StartFitArea,0); } -//---------------------------------------------------------------------------- +/*! + Processes transformation "front view" +*/ void SVTK_MainWindow ::onFrontView() @@ -598,7 +679,9 @@ SVTK_MainWindow Repaint(); } -//---------------------------------------------------------------------------- +/*! + Processes transformation "back view" +*/ void SVTK_MainWindow ::onBackView() @@ -607,7 +690,9 @@ SVTK_MainWindow Repaint(); } -//---------------------------------------------------------------------------- +/*! + Processes transformation "top view" +*/ void SVTK_MainWindow ::onTopView() @@ -616,7 +701,9 @@ SVTK_MainWindow Repaint(); } -//---------------------------------------------------------------------------- +/*! + Processes transformation "bottom view" +*/ void SVTK_MainWindow ::onBottomView() @@ -625,7 +712,9 @@ SVTK_MainWindow Repaint(); } -//---------------------------------------------------------------------------- +/*! + Processes transformation "left view" +*/ void SVTK_MainWindow ::onLeftView() @@ -634,7 +723,9 @@ SVTK_MainWindow Repaint(); } -//---------------------------------------------------------------------------- +/*! + Processes transformation "right view" +*/ void SVTK_MainWindow ::onRightView() @@ -643,7 +734,9 @@ SVTK_MainWindow Repaint(); } -//---------------------------------------------------------------------------- +/*! + Processes transformation "reset view": sets default orientation of viewport camera +*/ void SVTK_MainWindow ::onResetView() @@ -652,7 +745,9 @@ SVTK_MainWindow Repaint(); } -//---------------------------------------------------------------------------- +/*! + Processes transformation "fit all" +*/ void SVTK_MainWindow ::onFitAll() @@ -661,7 +756,9 @@ SVTK_MainWindow Repaint(); } -//---------------------------------------------------------------------------- +/*! + Shows trihedron +*/ void SVTK_MainWindow ::onViewTrihedron() @@ -670,7 +767,9 @@ SVTK_MainWindow Repaint(); } -//---------------------------------------------------------------------------- +/*! + Shows cube axes +*/ void SVTK_MainWindow ::onViewCubeAxes() @@ -679,7 +778,6 @@ SVTK_MainWindow Repaint(); } -//---------------------------------------------------------------------------- void SVTK_MainWindow ::onUpdateRate(bool theIsActivate) @@ -713,7 +811,6 @@ SVTK_MainWindow myCubeAxesDlg->hide(); } -//---------------------------------------------------------------------------- void SVTK_MainWindow ::onAdjustTrihedron() @@ -721,7 +818,6 @@ SVTK_MainWindow GetRenderer()->OnAdjustTrihedron(); } -//---------------------------------------------------------------------------- void SVTK_MainWindow ::onAdjustCubeAxes() @@ -729,7 +825,9 @@ SVTK_MainWindow GetRenderer()->OnAdjustCubeAxes(); } -//---------------------------------------------------------------------------- +/*! + \return QImage, containing all scene rendering in window +*/ QImage SVTK_MainWindow ::dumpView() diff --git a/src/SVTK/SVTK_MainWindow.h b/src/SVTK/SVTK_MainWindow.h index 0943f1e63..c8d03b432 100644 --- a/src/SVTK/SVTK_MainWindow.h +++ b/src/SVTK/SVTK_MainWindow.h @@ -37,7 +37,6 @@ class SVTK_Renderer; class SVTK_Selector; -//---------------------------------------------------------------------------- //! The class is a container for #SVTK_RenderWindowInteractor. /*! The class contains #SVTK_RenderWindowInteractor instance and diff --git a/src/SVTK/SVTK_Prs.cxx b/src/SVTK/SVTK_Prs.cxx index 9db710484..620202f40 100644 --- a/src/SVTK/SVTK_Prs.cxx +++ b/src/SVTK/SVTK_Prs.cxx @@ -29,55 +29,40 @@ #include "SVTK_Prs.h" using namespace std; -//========================================================== /*! - * SVTK_Prs::SVTK_Prs - * Default constructor - */ -//========================================================== + Default constructor +*/ SVTK_Prs::SVTK_Prs() : myObjects( 0 ) { } -//========================================================== /*! - * SVTK_Prs::SVTK_Prs - * tandard constructora - */ -//========================================================== + Standard constructor +*/ SVTK_Prs::SVTK_Prs( const vtkActor* obj ) { AddObject( obj ); } -//========================================================== /*! - * SVTK_Prs::~SVTK_Prs - * Destructor - */ -//========================================================== + Destructor +*/ SVTK_Prs:: ~SVTK_Prs() { if ( myObjects ) myObjects->Delete(); } -//========================================================== /*! - * SVTK_Prs::GetObjects - * Get actors list - */ -//========================================================== + \return actors list +*/ vtkActorCollection* SVTK_Prs::GetObjects() const { return myObjects; } -//========================================================== /*! - * SVTK_Prs::AddObject - * Add actor - */ -//========================================================== + Add actor +*/ void SVTK_Prs::AddObject( const vtkActor* obj ) { if ( !myObjects) @@ -85,13 +70,9 @@ void SVTK_Prs::AddObject( const vtkActor* obj ) myObjects->AddItem( (vtkActor*)obj ); } -//========================================================== /*! - * SVTK_Prs::IsNull - * Return 0 if list of the actors is empty - * [ Reimplemented from SALOME_Prs ] - */ -//========================================================== + \return 0 if list of the actors is empty [ Reimplemented from SALOME_Prs ] +*/ bool SVTK_Prs::IsNull() const { return !myObjects || myObjects->GetNumberOfItems() <= 0; diff --git a/src/SVTK/SVTK_RectPicker.cxx b/src/SVTK/SVTK_RectPicker.cxx index 0d3eb9ad6..88f085419 100644 --- a/src/SVTK/SVTK_RectPicker.cxx +++ b/src/SVTK/SVTK_RectPicker.cxx @@ -47,7 +47,6 @@ #include #include -//---------------------------------------------------------------------------- namespace { //---------------------------------------------------------------------------- @@ -324,10 +323,8 @@ namespace } } -//---------------------------------------------------------------------------- vtkStandardNewMacro(SVTK_RectPicker); -//---------------------------------------------------------------------------- SVTK_RectPicker ::SVTK_RectPicker() { @@ -349,7 +346,6 @@ SVTK_RectPicker return 0; } -//---------------------------------------------------------------------------- int SVTK_RectPicker ::Pick(vtkFloatingPointType theSelection[3], @@ -361,7 +357,6 @@ SVTK_RectPicker theRenderer); } -//---------------------------------------------------------------------------- int SVTK_RectPicker ::Pick(vtkFloatingPointType theSelectionX, @@ -481,7 +476,6 @@ SVTK_RectPicker } -//---------------------------------------------------------------------------- const SVTK_RectPicker::TVectorIdsMap& SVTK_RectPicker ::GetPointIdsMap() const diff --git a/src/SVTK/SVTK_RenderWindowInteractor.cxx b/src/SVTK/SVTK_RenderWindowInteractor.cxx index 0d4142995..50d12ef45 100644 --- a/src/SVTK/SVTK_RenderWindowInteractor.cxx +++ b/src/SVTK/SVTK_RenderWindowInteractor.cxx @@ -61,7 +61,9 @@ static bool GENERATE_SUIT_EVENTS = false; static bool FOCUS_UNDER_MOUSE = false; -//---------------------------------------------------------------------------- +/*! + Constructor +*/ QVTK_RenderWindowInteractor ::QVTK_RenderWindowInteractor(QWidget* theParent, const char* theName): @@ -79,7 +81,9 @@ QVTK_RenderWindowInteractor myRenderWindow->SetWindowId((void*)winId()); } - +/*! + To initialize by vtkGenericRenderWindowInteractor instance +*/ void QVTK_RenderWindowInteractor ::Initialize(vtkGenericRenderWindowInteractor* theDevice) @@ -93,7 +97,9 @@ QVTK_RenderWindowInteractor theDevice->SetRenderWindow(getRenderWindow()); } -//---------------------------------------------------------------------------- +/*! + Destructor +*/ QVTK_RenderWindowInteractor ::~QVTK_RenderWindowInteractor() { @@ -103,7 +109,6 @@ QVTK_RenderWindowInteractor } -//---------------------------------------------------------------------------- vtkGenericRenderWindowInteractor* QVTK_RenderWindowInteractor ::GetDevice() @@ -111,7 +116,6 @@ QVTK_RenderWindowInteractor return myDevice.GetPointer(); } -//---------------------------------------------------------------------------- vtkRenderWindow* QVTK_RenderWindowInteractor ::getRenderWindow() @@ -119,7 +123,9 @@ QVTK_RenderWindowInteractor return myRenderWindow.GetPointer(); } -//---------------------------------------------------------------------------- +/*! + Just to simplify usage of its device (vtkGenericRenderWindowInteractor) +*/ void QVTK_RenderWindowInteractor ::InvokeEvent(unsigned long theEvent, void* theCallData) @@ -127,7 +133,9 @@ QVTK_RenderWindowInteractor GetDevice()->InvokeEvent(theEvent,theCallData); } -//---------------------------------------------------------------------------- +/*! + Need for initial contents display on Win32 +*/ void QVTK_RenderWindowInteractor ::show() @@ -136,7 +144,9 @@ QVTK_RenderWindowInteractor update(); // needed for initial contents display on Win32 } -//---------------------------------------------------------------------------- +/*! + To implement final initialization, just before the widget is displayed +*/ void QVTK_RenderWindowInteractor ::polish() @@ -149,7 +159,9 @@ QVTK_RenderWindowInteractor } } -//---------------------------------------------------------------------------- +/*! + To adjust widget and vtkRenderWindow size +*/ void QVTK_RenderWindowInteractor ::resize(int w, int h) @@ -157,7 +169,6 @@ QVTK_RenderWindowInteractor GetDevice()->UpdateSize(w,h); } -//---------------------------------------------------------------------------- void QVTK_RenderWindowInteractor ::paintEvent( QPaintEvent* theEvent ) @@ -166,7 +177,6 @@ QVTK_RenderWindowInteractor } -//---------------------------------------------------------------------------- void QVTK_RenderWindowInteractor ::resizeEvent( QResizeEvent* theEvent ) @@ -198,14 +208,12 @@ QVTK_RenderWindowInteractor } -//---------------------------------------------------------------------------- void QVTK_RenderWindowInteractor ::contextMenuEvent( QContextMenuEvent* event ) {} -//---------------------------------------------------------------------------- void QVTK_RenderWindowInteractor ::mouseMoveEvent( QMouseEvent* event ) @@ -218,7 +226,6 @@ QVTK_RenderWindowInteractor } -//---------------------------------------------------------------------------- void QVTK_RenderWindowInteractor ::mousePressEvent( QMouseEvent* event ) @@ -236,7 +243,6 @@ QVTK_RenderWindowInteractor } -//---------------------------------------------------------------------------- void QVTK_RenderWindowInteractor ::mouseReleaseEvent( QMouseEvent *event ) @@ -255,14 +261,12 @@ QVTK_RenderWindowInteractor } -//---------------------------------------------------------------------------- void QVTK_RenderWindowInteractor ::mouseDoubleClickEvent( QMouseEvent* event ) {} -//---------------------------------------------------------------------------- void QVTK_RenderWindowInteractor ::wheelEvent( QWheelEvent* event ) @@ -272,7 +276,6 @@ QVTK_RenderWindowInteractor } -//---------------------------------------------------------------------------- void QVTK_RenderWindowInteractor ::keyPressEvent( QKeyEvent* event ) @@ -284,7 +287,6 @@ QVTK_RenderWindowInteractor GetDevice()->CharEvent(); } -//---------------------------------------------------------------------------- void QVTK_RenderWindowInteractor ::keyReleaseEvent( QKeyEvent * event ) @@ -296,7 +298,6 @@ QVTK_RenderWindowInteractor } -//---------------------------------------------------------------------------- void QVTK_RenderWindowInteractor ::enterEvent( QEvent* event ) @@ -308,7 +309,6 @@ QVTK_RenderWindowInteractor GetDevice()->EnterEvent(); } -//---------------------------------------------------------------------------- void QVTK_RenderWindowInteractor ::leaveEvent( QEvent * ) @@ -316,8 +316,10 @@ QVTK_RenderWindowInteractor GetDevice()->LeaveEvent(); } - -//---------------------------------------------------------------------------- +/*! + Reimplemented from QWidget in order to set window - receiver + of space mouse events. +*/ void QVTK_RenderWindowInteractor ::focusInEvent( QFocusEvent* event ) @@ -334,7 +336,10 @@ QVTK_RenderWindowInteractor } } -//---------------------------------------------------------------------------- +/*! + Reimplemented from QWidget in order to set window - receiver + of space mouse events. +*/ void QVTK_RenderWindowInteractor ::focusOutEvent ( QFocusEvent* event ) @@ -349,7 +354,9 @@ QVTK_RenderWindowInteractor } -//---------------------------------------------------------------------------- +/*! + To handle native X11 events (from such devices as SpaceMouse) +*/ bool QVTK_RenderWindowInteractor ::x11Event( XEvent *xEvent ) @@ -376,8 +383,9 @@ QVTK_RenderWindowInteractor return QWidget::x11Event( xEvent ); } - -//---------------------------------------------------------------------------- +/*! + Constructor +*/ SVTK_RenderWindowInteractor ::SVTK_RenderWindowInteractor(QWidget* theParent, const char* theName): @@ -392,6 +400,9 @@ SVTK_RenderWindowInteractor myEventCallbackCommand->SetCallback(SVTK_RenderWindowInteractor::ProcessEvents); } +/*! + To initialize properly the class +*/ void SVTK_RenderWindowInteractor ::Initialize(vtkGenericRenderWindowInteractor* theDevice, @@ -403,7 +414,9 @@ SVTK_RenderWindowInteractor SetSelector(theSelector); } -//---------------------------------------------------------------------------- +/*! + Destructor +*/ SVTK_RenderWindowInteractor ::~SVTK_RenderWindowInteractor() { @@ -421,7 +434,9 @@ SVTK_RenderWindowInteractor GetDevice()->SetRenderWindow(NULL); } -//---------------------------------------------------------------------------- +/*! + To get corresponding SVTK_Renderer instance +*/ SVTK_Renderer* SVTK_RenderWindowInteractor ::GetRenderer() @@ -429,6 +444,9 @@ SVTK_RenderWindowInteractor return myRenderer.GetPointer(); } +/*! + To get corresponding SVTK_Renderer device (just to simplify collobaration with SVTK_Renderer) +*/ vtkRenderer* SVTK_RenderWindowInteractor ::getRenderer() @@ -453,7 +471,6 @@ SVTK_RenderWindowInteractor } -//---------------------------------------------------------------------------- void SVTK_RenderWindowInteractor ::InitInteractorStyle(vtkInteractorStyle* theStyle) @@ -461,8 +478,9 @@ SVTK_RenderWindowInteractor GetDevice()->SetInteractorStyle(theStyle); } - -//---------------------------------------------------------------------------- +/*! + To change current interactor style by pushing the new one into the container +*/ void SVTK_RenderWindowInteractor ::PushInteractorStyle(vtkInteractorStyle* theStyle) @@ -471,8 +489,9 @@ SVTK_RenderWindowInteractor InitInteractorStyle(theStyle); } - -//---------------------------------------------------------------------------- +/*! + To restore previous interactor style +*/ void SVTK_RenderWindowInteractor ::PopInteractorStyle() @@ -484,8 +503,9 @@ SVTK_RenderWindowInteractor InitInteractorStyle(GetInteractorStyle()); } - -//---------------------------------------------------------------------------- +/*! + To get current interactor style +*/ vtkInteractorStyle* SVTK_RenderWindowInteractor ::GetInteractorStyle() @@ -494,7 +514,9 @@ SVTK_RenderWindowInteractor } -//---------------------------------------------------------------------------- +/*! + To get current selector +*/ SVTK_Selector* SVTK_RenderWindowInteractor ::GetSelector() @@ -518,8 +540,9 @@ SVTK_RenderWindowInteractor myPriority); } - -//---------------------------------------------------------------------------- +/*! + Main process VTK event method +*/ void SVTK_RenderWindowInteractor ::ProcessEvents(vtkObject* vtkNotUsed(theObject), @@ -536,8 +559,9 @@ SVTK_RenderWindowInteractor } } - -//---------------------------------------------------------------- +/*! + To change selection mode (just to simplify collobaration with SVTK_Selector) +*/ void SVTK_RenderWindowInteractor ::SetSelectionMode(Selection_Mode theMode) @@ -545,8 +569,9 @@ SVTK_RenderWindowInteractor mySelector->SetSelectionMode(theMode); } - -//---------------------------------------------------------------- +/*! + To get current selection mode (just to simplify collobaration with SVTK_Selector) +*/ Selection_Mode SVTK_RenderWindowInteractor ::SelectionMode() const @@ -555,7 +580,6 @@ SVTK_RenderWindowInteractor } -//---------------------------------------------------------------- void SVTK_RenderWindowInteractor ::onEmitSelectionChanged() @@ -564,7 +588,6 @@ SVTK_RenderWindowInteractor } -//---------------------------------------------------------------------------- void SVTK_RenderWindowInteractor ::mouseMoveEvent( QMouseEvent* event ) @@ -576,7 +599,6 @@ SVTK_RenderWindowInteractor } -//---------------------------------------------------------------------------- void SVTK_RenderWindowInteractor ::mousePressEvent( QMouseEvent* event ) @@ -588,7 +610,6 @@ SVTK_RenderWindowInteractor } -//---------------------------------------------------------------------------- void SVTK_RenderWindowInteractor ::mouseReleaseEvent( QMouseEvent *event ) @@ -600,7 +621,6 @@ SVTK_RenderWindowInteractor } -//---------------------------------------------------------------------------- void SVTK_RenderWindowInteractor ::mouseDoubleClickEvent( QMouseEvent* event ) @@ -612,7 +632,6 @@ SVTK_RenderWindowInteractor } -//---------------------------------------------------------------------------- void SVTK_RenderWindowInteractor ::wheelEvent( QWheelEvent* event ) @@ -629,7 +648,6 @@ SVTK_RenderWindowInteractor } -//---------------------------------------------------------------------------- void SVTK_RenderWindowInteractor ::keyPressEvent( QKeyEvent* event ) @@ -640,7 +658,6 @@ SVTK_RenderWindowInteractor emit KeyPressed( event ); } -//---------------------------------------------------------------------------- void SVTK_RenderWindowInteractor ::keyReleaseEvent( QKeyEvent * event ) @@ -651,7 +668,6 @@ SVTK_RenderWindowInteractor emit KeyReleased( event ); } -//---------------------------------------------------------------------------- void SVTK_RenderWindowInteractor ::contextMenuEvent( QContextMenuEvent* event ) diff --git a/src/SVTK/SVTK_RenderWindowInteractor.h b/src/SVTK/SVTK_RenderWindowInteractor.h index bc0020ddf..c67f86313 100644 --- a/src/SVTK/SVTK_RenderWindowInteractor.h +++ b/src/SVTK/SVTK_RenderWindowInteractor.h @@ -52,9 +52,9 @@ class vtkObject; class SVTK_Selector; class SVTK_Renderer; -//============================================================================ -//! Implemements Qt based vtkRenderWindowInteractor. /*! + \class QVTK_RenderWindowInteractor + Implements Qt based vtkRenderWindowInteractor. The class inherits #QWidget class in order to be possible process Qt events. It invokes corresponding VTK events through usage of its device - a #vtkGenericRenderWindowInteractor. Also, it creates, initialize and holds vtkRenderWindow instance. @@ -124,9 +124,9 @@ class SVTK_EXPORT QVTK_RenderWindowInteractor: public QWidget }; -//============================================================================ //! Extends QVTK_RenderWindowInteractor functionality. /*! + \class SVTK_RenderWindowInteractor Implements such features as support of selection, run-time interactor style management, diff --git a/src/SVTK/SVTK_Renderer.cxx b/src/SVTK/SVTK_Renderer.cxx index 2900a0c7f..e379b90b1 100644 --- a/src/SVTK/SVTK_Renderer.cxx +++ b/src/SVTK/SVTK_Renderer.cxx @@ -55,10 +55,11 @@ #undef max -//---------------------------------------------------------------------------- vtkStandardNewMacro(SVTK_Renderer); -//---------------------------------------------------------------------------- +/*! + Constructor +*/ SVTK_Renderer ::SVTK_Renderer(): myDevice(vtkRenderer::New()), @@ -152,6 +153,9 @@ SVTK_Renderer myPriority); } +/*! + Destructor +*/ SVTK_Renderer ::~SVTK_Renderer() { @@ -176,6 +180,9 @@ SVTK_Renderer } +/*! + Main process event method +*/ void SVTK_Renderer ::ProcessEvents(vtkObject* vtkNotUsed(theObject), @@ -198,7 +205,9 @@ SVTK_Renderer } } -//---------------------------------------------------------------------------- +/*! + \return renderer's device +*/ vtkRenderer* SVTK_Renderer ::GetDevice() @@ -206,6 +215,9 @@ SVTK_Renderer return myDevice.GetPointer(); } +/*! + Initialize renderer +*/ void SVTK_Renderer ::Initialize(vtkRenderWindowInteractor* theInteractor, @@ -215,7 +227,9 @@ SVTK_Renderer mySelector = theSelector; } -//---------------------------------------------------------------------------- +/*! + Publishes pointed actor into the renderer +*/ void SVTK_Renderer ::AddActor(VTKViewer_Actor* theActor) @@ -239,6 +253,9 @@ SVTK_Renderer } } +/*! + Removes pointed actor from the renderer +*/ void SVTK_Renderer ::RemoveActor(VTKViewer_Actor* theActor) @@ -264,6 +281,9 @@ SVTK_Renderer } } +/*! + Get special container that keeps scaling of the scene +*/ VTKViewer_Transform* SVTK_Renderer ::GetTransform() @@ -271,6 +291,9 @@ SVTK_Renderer return myTransform.GetPointer(); } +/*! + Allows to get a scale that is applied on the whole scene +*/ void SVTK_Renderer ::GetScale( double theScale[3] ) @@ -278,6 +301,9 @@ SVTK_Renderer myTransform->GetMatrixScale( theScale ); } +/*! + Allows to apply a scale on the whole scene +*/ void SVTK_Renderer ::SetScale( double theScale[3] ) @@ -286,8 +312,9 @@ SVTK_Renderer AdjustActors(); } - -//---------------------------------------------------------------------------- +/*! + Applies color and size (PointSize and LineWidth) of primitives in selection mode +*/ void SVTK_Renderer ::SetSelectionProp(const double& theRed, @@ -300,7 +327,9 @@ SVTK_Renderer myHighlightProperty->SetPointSize( theWidth ); } -//---------------------------------------------------------------------------- +/*! + Applies color and size (PointSize and LineWidth) of primitives in preselection mode +*/ void SVTK_Renderer ::SetPreselectionProp(const double& theRed, @@ -313,7 +342,9 @@ SVTK_Renderer myPreHighlightProperty->SetPointSize( theWidth ); } -//---------------------------------------------------------------------------- +/*! + Setup requested tolerance for the picking +*/ void SVTK_Renderer ::SetSelectionTolerance(const double& theTolNodes, @@ -327,7 +358,6 @@ SVTK_Renderer } -//---------------------------------------------------------------------------- /*! If parameter theIsForcedUpdate is true, recalculate parameters for * trihedron and cube axes, even if trihedron and cube axes is invisible. */ @@ -447,7 +477,6 @@ SVTK_Renderer return myIsTrihedronRelative; } -//---------------------------------------------------------------------------- VTKViewer_Trihedron* SVTK_Renderer ::GetTrihedron() @@ -480,7 +509,6 @@ SVTK_Renderer } -//---------------------------------------------------------------------------- SVTK_CubeAxesActor2D* SVTK_Renderer ::GetCubeAxes() @@ -513,7 +541,6 @@ SVTK_Renderer } -//---------------------------------------------------------------------------- void SVTK_Renderer ::OnResetView() @@ -545,7 +572,6 @@ SVTK_Renderer } -//---------------------------------------------------------------------------- void SVTK_Renderer ::OnFitAll() @@ -585,7 +611,6 @@ SVTK_Renderer } -//---------------------------------------------------------------------------- void SVTK_Renderer ::OnResetClippingRange() @@ -595,7 +620,6 @@ SVTK_Renderer } -//---------------------------------------------------------------------------- void SVTK_Renderer ::OnFrontView() @@ -607,7 +631,6 @@ SVTK_Renderer this->OnFitAll(); } -//---------------------------------------------------------------------------- void SVTK_Renderer ::OnBackView() @@ -619,7 +642,6 @@ SVTK_Renderer this->OnFitAll(); } -//---------------------------------------------------------------------------- void SVTK_Renderer ::OnTopView() @@ -631,7 +653,6 @@ SVTK_Renderer this->OnFitAll(); } -//---------------------------------------------------------------------------- void SVTK_Renderer ::OnBottomView() @@ -643,7 +664,6 @@ SVTK_Renderer this->OnFitAll(); } -//---------------------------------------------------------------------------- void SVTK_Renderer ::OnLeftView() @@ -655,7 +675,6 @@ SVTK_Renderer this->OnFitAll(); } -//---------------------------------------------------------------------------- void SVTK_Renderer ::OnRightView() diff --git a/src/SVTK/SVTK_Renderer.h b/src/SVTK/SVTK_Renderer.h index 14cc30696..6012689ec 100644 --- a/src/SVTK/SVTK_Renderer.h +++ b/src/SVTK/SVTK_Renderer.h @@ -53,13 +53,13 @@ class VTKViewer_Actor; class SVTK_Selector; -//! The class is a container for #vtkRenderer instance. -/*! +/*! + \class SVTK_Renderer + The class is a container for #vtkRenderer instance. Main goal of the class is to apply common behaviour to all #SALOME_Actor, like selection and preselection colors. Also, the class is responsible for management of internal actors like trihedron an so on. */ -//============================================================================ class SVTK_EXPORT SVTK_Renderer : public vtkObject { public: @@ -78,12 +78,12 @@ class SVTK_EXPORT SVTK_Renderer : public vtkObject SVTK_Selector* theSelector); //---------------------------------------------------------------------------- - //! This method publishes pointed actor into the renderer + //! Publishes pointed actor into the renderer virtual void AddActor(VTKViewer_Actor* theActor); - //! This method removes pointed actor from the renderer + //! Removes pointed actor from the renderer virtual void RemoveActor(VTKViewer_Actor* theActor); @@ -92,12 +92,12 @@ class SVTK_EXPORT SVTK_Renderer : public vtkObject VTKViewer_Transform* GetTransform(); - //! This method allow to apply a scale on the whole scene + //! Allows to apply a scale on the whole scene virtual void SetScale( double theScale[3] ); - //! This method allow to get a scale that is applied on the whole scene + //! Allows to get a scale that is applied on the whole scene void GetScale( double theScale[3] ); @@ -116,7 +116,7 @@ class SVTK_EXPORT SVTK_Renderer : public vtkObject const double& theBlue = 1, const int& theWidth = 5); - //! Setup requested tollerance for the picking + //! Setup requested tolerance for the picking void SetSelectionTolerance(const double& theTolNodes = 0.025, const double& theTolCell = 0.001); diff --git a/src/SVTK/SVTK_Selector.cxx b/src/SVTK/SVTK_Selector.cxx index bc6dad148..22a32c6dd 100644 --- a/src/SVTK/SVTK_Selector.cxx +++ b/src/SVTK/SVTK_Selector.cxx @@ -43,7 +43,6 @@ SVTK_Selector return new SVTK_SelectorDef(); } -//---------------------------------------------------------------------------- SVTK_SelectorDef ::SVTK_SelectorDef() { @@ -55,7 +54,6 @@ SVTK_SelectorDef { } -//---------------------------------------------------------------------------- void SVTK_SelectorDef ::StartPickCallback() @@ -63,7 +61,6 @@ SVTK_SelectorDef this->InvokeEvent(vtkCommand::StartPickEvent,NULL); } -//---------------------------------------------------------------------------- void SVTK_SelectorDef ::EndPickCallback() @@ -71,7 +68,6 @@ SVTK_SelectorDef this->InvokeEvent(vtkCommand::EndPickEvent,NULL); } -//---------------------------------------------------------------------------- void SVTK_SelectorDef ::SetSelectionMode(Selection_Mode theMode) @@ -92,7 +88,6 @@ SVTK_SelectorDef myMapIOSubIndex.clear(); } -//---------------------------------------------------------------------------- bool SVTK_SelectorDef ::IsSelected(const Handle(SALOME_InteractiveObject)& theIO) const @@ -118,7 +113,6 @@ SVTK_SelectorDef return NULL; } -//---------------------------------------------------------------------------- bool SVTK_SelectorDef ::AddIObject(const Handle(SALOME_InteractiveObject)& theIO) @@ -147,7 +141,6 @@ SVTK_SelectorDef return !anIsIOBound || !anIsActorBound; } -//---------------------------------------------------------------------------- bool SVTK_SelectorDef ::RemoveIObject(const Handle(SALOME_InteractiveObject)& theIO) @@ -174,7 +167,6 @@ SVTK_SelectorDef return RemoveIObject(anIO) || anIsActorBound; } -//---------------------------------------------------------------------------- const SALOME_ListIO& SVTK_SelectorDef ::StoredIObjects() const @@ -363,7 +355,6 @@ SVTK_SelectorDef myMapIOSubIndex.clear(); } -//---------------------------------------------------------------------------- void SVTK_SelectorDef ::SetFilter(const Handle(VTKViewer_Filter)& theFilter) @@ -371,7 +362,6 @@ SVTK_SelectorDef myFilters.insert(TFilters::value_type(theFilter->GetId(),theFilter)); } -//---------------------------------------------------------------------------- bool SVTK_SelectorDef ::IsFilterPresent(const TFilterID theId) const @@ -379,7 +369,6 @@ SVTK_SelectorDef return myFilters.find(theId) != myFilters.end(); } -//---------------------------------------------------------------------------- void SVTK_SelectorDef ::RemoveFilter(const TFilterID theId) @@ -388,7 +377,6 @@ SVTK_SelectorDef myFilters.erase(theId); } -//---------------------------------------------------------------------------- bool SVTK_SelectorDef ::IsValid(SALOME_Actor* theActor, @@ -405,7 +393,6 @@ SVTK_SelectorDef return true; } -//---------------------------------------------------------------------------- Handle(VTKViewer_Filter) SVTK_SelectorDef ::GetFilter(const TFilterID theId) const diff --git a/src/SVTK/SVTK_SpaceMouse.cxx b/src/SVTK/SVTK_SpaceMouse.cxx index 620e97ec0..bc73352fa 100644 --- a/src/SVTK/SVTK_SpaceMouse.cxx +++ b/src/SVTK/SVTK_SpaceMouse.cxx @@ -38,10 +38,11 @@ #include "SVTK_SpaceMouse.h" -//--------------------------------------------- SVTK_SpaceMouse* SVTK_SpaceMouse::myInstance = 0; -//--------------------------------------------- +/*! + \return shared instance of object (creates if there is no one) +*/ SVTK_SpaceMouse* SVTK_SpaceMouse::getInstance() { if ( !myInstance ) @@ -49,14 +50,18 @@ SVTK_SpaceMouse* SVTK_SpaceMouse::getInstance() return myInstance; } -//--------------------------------------------- +/*! + Constructor +*/ SVTK_SpaceMouse::SVTK_SpaceMouse() { win = InputFocus; spaceMouseOn = 0; } -//--------------------------------------------- +/*! + Initialization +*/ int SVTK_SpaceMouse::initialize( Display *display, Window window ) { XMotionEvent = XInternAtom( display, "MotionEvent", 1 ); @@ -78,7 +83,6 @@ int SVTK_SpaceMouse::initialize( Display *display, Window window ) return spaceMouseOn; } -//--------------------------------------------- static int errorCallback( Display *display, XErrorEvent *Error ) { char msg[ 128 ]; @@ -89,7 +93,9 @@ static int errorCallback( Display *display, XErrorEvent *Error ) return 0; } -//--------------------------------------------- +/*! + Initialize by window +*/ int SVTK_SpaceMouse::setWindow( Display *display, Window window ) { XTextProperty winName; @@ -146,7 +152,9 @@ int SVTK_SpaceMouse::setWindow( Display *display, Window window ) return result; } -//--------------------------------------------- +/*! + Close +*/ int SVTK_SpaceMouse::close(Display *display) { initialize( display, (Window)InputFocus ); @@ -155,7 +163,9 @@ int SVTK_SpaceMouse::close(Display *display) return 1; } -//--------------------------------------------- +/*! + Custom event handler +*/ int SVTK_SpaceMouse::translateEvent( Display* display, XEvent* xEvent, MoveEvent* spaceMouseEvent, double scale, double rScale ) { diff --git a/src/SVTK/SVTK_Trihedron.cxx b/src/SVTK/SVTK_Trihedron.cxx index ea8783a07..4e6d78c99 100644 --- a/src/SVTK/SVTK_Trihedron.cxx +++ b/src/SVTK/SVTK_Trihedron.cxx @@ -23,16 +23,20 @@ #include #include -//**************************************************************** vtkStandardNewMacro(SVTK_Trihedron); -//**************************************************************** +/*! + Constructor +*/ SVTK_Trihedron ::SVTK_Trihedron() { } -//**************************************************************** +/*! + \return count of visible actors + \param theRenderer - renderer to be checked +*/ int SVTK_Trihedron ::GetVisibleActorCount(vtkRenderer* theRenderer) diff --git a/src/SVTK/SVTK_UpdateRateDlg.cxx b/src/SVTK/SVTK_UpdateRateDlg.cxx index 7363e1fc6..b9f487488 100644 --- a/src/SVTK/SVTK_UpdateRateDlg.cxx +++ b/src/SVTK/SVTK_UpdateRateDlg.cxx @@ -298,8 +298,8 @@ SVTK_UpdateRateDlg myPriority); } -/* - * Destroys the object and frees any allocated resources +/*! + Destroys the object and frees any allocated resources */ SVTK_UpdateRateDlg ::~SVTK_UpdateRateDlg() @@ -307,6 +307,9 @@ SVTK_UpdateRateDlg // no need to delete child widgets, Qt does it all for us } +/*! + Processes events +*/ void SVTK_UpdateRateDlg ::ProcessEvents(vtkObject* vtkNotUsed(theObject), @@ -322,6 +325,9 @@ SVTK_UpdateRateDlg } } +/*! + Update +*/ void SVTK_UpdateRateDlg ::Update() @@ -342,6 +348,9 @@ SVTK_UpdateRateDlg myRWInteractor->getRenderWindow()->Render(); } +/*! + SLOT on OK clicked +*/ void SVTK_UpdateRateDlg ::onClickOk() @@ -350,6 +359,9 @@ SVTK_UpdateRateDlg onClickClose(); } +/*! + SLOT on Apply clicked +*/ void SVTK_UpdateRateDlg ::onClickApply() @@ -357,6 +369,9 @@ SVTK_UpdateRateDlg Update(); } +/*! + SLOT on Close clicked +*/ void SVTK_UpdateRateDlg ::onClickClose() diff --git a/src/SVTK/SVTK_View.cxx b/src/SVTK/SVTK_View.cxx index f16de8862..86b28ed83 100644 --- a/src/SVTK/SVTK_View.cxx +++ b/src/SVTK/SVTK_View.cxx @@ -40,8 +40,9 @@ #include #include - -//---------------------------------------------------------------------------- +/*! + Constructor +*/ SVTK_SignalHandler ::SVTK_SignalHandler(SVTK_MainWindow* theMainWindow): QObject(theMainWindow), @@ -67,11 +68,17 @@ SVTK_SignalHandler this,SIGNAL(selectionChanged())); } +/*! + Destructor +*/ SVTK_SignalHandler ::~SVTK_SignalHandler() { } +/*! + \return corresponding svtk main window +*/ SVTK_MainWindow* SVTK_SignalHandler ::GetMainWindow() @@ -80,7 +87,9 @@ SVTK_SignalHandler } -//---------------------------------------------------------------- +/*! + Redirect the request to #SVTK_MainWindow::Repaint (just for flexibility) +*/ void SVTK_SignalHandler ::Repaint(bool theUpdateTrihedron) @@ -88,7 +97,9 @@ SVTK_SignalHandler myMainWindow->Repaint(theUpdateTrihedron); } -//---------------------------------------------------------------------------- +/*! + Redirect the request to #SVTK_MainWindow::GetRenderer (just for flexibility) +*/ SVTK_Renderer* SVTK_SignalHandler ::GetRenderer() @@ -96,6 +107,9 @@ SVTK_SignalHandler return myMainWindow->GetRenderer(); } +/*! + Redirect the request to #SVTK_MainWindow::getRenderer (just for flexibility) +*/ vtkRenderer* SVTK_SignalHandler ::getRenderer() @@ -103,7 +117,6 @@ SVTK_SignalHandler return myMainWindow->getRenderer(); } -//---------------------------------------------------------------- namespace SVTK { struct THighlightAction @@ -123,6 +136,9 @@ namespace SVTK }; } +/*! + SLOT: called on selection change +*/ void SVTK_SignalHandler ::onSelectionChanged() @@ -144,21 +160,26 @@ SVTK_SignalHandler myMainWindow->Repaint(false); } - -//---------------------------------------------------------------------------- +/*! + Constructor +*/ SVTK_View ::SVTK_View(SVTK_MainWindow* theMainWindow) : SVTK_SignalHandler(theMainWindow) { } -//---------------------------------------------------------------------------- +/*! + Destructor +*/ SVTK_View ::~SVTK_View() { } -//---------------------------------------------------------------- +/*! + Unhilights all objects in viewer +*/ void SVTK_View ::unHighlightAll() @@ -169,7 +190,12 @@ SVTK_View Repaint(); } -//---------------------------------------------------------------- +/*! + Hilights/unhilights object in viewer + \param theIO - object to be updated + \param theIsHighlight - if it is true, object will be hilighted, otherwise it will be unhilighted + \param theIsUpdate - update current viewer +*/ void SVTK_View ::highlight( const Handle(SALOME_InteractiveObject)& theIO, @@ -183,7 +209,9 @@ SVTK_View Repaint(); } -//---------------------------------------------------------------------------- +/*! + Redirect the request to #SVTK_Renderer::SetPreselectionProp +*/ void SVTK_View ::SetSelectionProp(const double& theRed, @@ -194,7 +222,9 @@ SVTK_View GetRenderer()->SetSelectionProp(theRed,theGreen,theBlue,theWidth); } -//---------------------------------------------------------------------------- +/*! + Redirect the request to #SVTK_Renderer::SetPreselectionProp +*/ void SVTK_View ::SetPreselectionProp(const double& theRed, @@ -205,7 +235,9 @@ SVTK_View GetRenderer()->SetPreselectionProp(theRed,theGreen,theBlue,theWidth); } -//---------------------------------------------------------------------------- +/*! + Redirect the request to #SVTK_Renderer::SetPreselectionProp +*/ void SVTK_View ::SetSelectionTolerance(const double& theTolNodes, @@ -214,7 +246,10 @@ SVTK_View GetRenderer()->SetSelectionTolerance(theTolNodes,theTolCell); } -//---------------------------------------------------------------------------- +/*! + \return true if object is in viewer or in collector + \param theIO - object to be checked +*/ bool SVTK_View ::isInViewer(const Handle(SALOME_InteractiveObject)& theIObject) @@ -226,7 +261,10 @@ SVTK_View return anActor != NULL; } -//---------------------------------------------------------------------------- +/*! + \return true if object is displayed in viewer + \param theIO - object to be checked +*/ bool SVTK_View ::isVisible(const Handle(SALOME_InteractiveObject)& theIObject) @@ -238,7 +276,11 @@ SVTK_View return anActor != NULL && anActor->GetVisibility(); } -//---------------------------------------------------------------------------- +/*! + Changes name of object + \param theIObject - object to be renamed + \param theName - new name +*/ void SVTK_View ::rename(const Handle(SALOME_InteractiveObject)& theIObject, @@ -251,7 +293,9 @@ SVTK_View (&SALOME_Actor::setName,theName.latin1())); } -//---------------------------------------------------------------------------- +/*! + \return current display mode (obsolete) +*/ int SVTK_View ::GetDisplayMode() @@ -259,6 +303,10 @@ SVTK_View return myDisplayMode; } +/*! + Set current display mode + \param theMode - new display mode +*/ void SVTK_View ::SetDisplayMode(int theMode) @@ -270,6 +318,11 @@ SVTK_View myDisplayMode = theMode; } +/*! + Set current display mode + \param theIObject - object + \param theMode - new display mode +*/ void SVTK_View ::SetDisplayMode(const Handle(SALOME_InteractiveObject)& theIObject, @@ -282,7 +335,9 @@ SVTK_View (&SALOME_Actor::setDisplayMode,theMode)); } -//---------------------------------------------------------------------------- +/*! + Change all actors to wireframe +*/ void SVTK_View ::ChangeRepresentationToWireframe() @@ -290,6 +345,9 @@ SVTK_View ChangeRepresentationToWireframe(getRenderer()->GetActors()); } +/*! + Change all actors to shading +*/ void SVTK_View ::ChangeRepresentationToSurface() @@ -297,7 +355,10 @@ SVTK_View ChangeRepresentationToSurface(getRenderer()->GetActors()); } - +/*! + Change to wireframe a list of vtkactor + theCollection - list of vtkactor +*/ void SVTK_View ::ChangeRepresentationToWireframe(vtkActorCollection* theCollection) @@ -309,6 +370,10 @@ SVTK_View Repaint(); } +/*! + Change to shading a list of vtkactor + theCollection - list of vtkactor +*/ void SVTK_View ::ChangeRepresentationToSurface(vtkActorCollection* theCollection) @@ -320,7 +385,6 @@ SVTK_View Repaint(); } -//---------------------------------------------------------------------------- namespace SVTK { struct TErase @@ -342,6 +406,9 @@ namespace SVTK }; } +/*! + To erase all existing VTK presentations +*/ void SVTK_View ::EraseAll() @@ -352,6 +419,9 @@ SVTK_View Repaint(); } +/*! + To display all existing VTK presentations +*/ void SVTK_View ::DisplayAll() @@ -362,7 +432,11 @@ SVTK_View Repaint(); } - +/*! + To erase VTK presentation + \param theActor - actor + \param theIsUpdate - updates current viewer +*/ void SVTK_View ::Erase(SALOME_Actor* theActor, @@ -375,6 +449,11 @@ SVTK_View } +/*! + To erase VTK presentation + \param theIObject - object + \param theIsUpdate - updates current viewer +*/ void SVTK_View ::Erase(const Handle(SALOME_InteractiveObject)& theIObject, @@ -388,7 +467,9 @@ SVTK_View Repaint(); } -//---------------------------------------------------------------------------- +/*! + To display the VTK presentation +*/ void SVTK_View ::Display(SALOME_Actor* theActor, @@ -401,6 +482,9 @@ SVTK_View Repaint(); } +/*! + To display the VTK presentation +*/ void SVTK_View ::Display(const Handle(SALOME_InteractiveObject)& theIObject, @@ -415,6 +499,9 @@ SVTK_View Repaint(); } +/*! + To display VTK presentation with defined #SALOME_InteractiveObject and erase all others +*/ void SVTK_View ::DisplayOnly(const Handle(SALOME_InteractiveObject)& theIObject) @@ -424,7 +511,6 @@ SVTK_View } -//---------------------------------------------------------------------------- namespace SVTK { struct TRemoveAction @@ -441,6 +527,9 @@ namespace SVTK }; } +/*! + To remove the VTK presentation +*/ void SVTK_View ::Remove(const Handle(SALOME_InteractiveObject)& theIObject, @@ -454,6 +543,9 @@ SVTK_View Repaint(); } +/*! + To remove the VTK presentation +*/ void SVTK_View ::Remove(SALOME_Actor* theActor, @@ -464,6 +556,9 @@ SVTK_View Repaint(); } +/*! + To remove all VTK presentations +*/ void SVTK_View ::RemoveAll(bool theIsUpdate) @@ -483,7 +578,10 @@ SVTK_View } } -//---------------------------------------------------------------------------- +/*! + \return current transparency + \param theIObject - object +*/ float SVTK_View ::GetTransparency(const Handle(SALOME_InteractiveObject)& theIObject) @@ -498,6 +596,11 @@ SVTK_View } +/*! + Sets current transparency + \param theIObject - object + \param theTrans - new transparency +*/ void SVTK_View ::SetTransparency(const Handle(SALOME_InteractiveObject)& theIObject, @@ -511,7 +614,11 @@ SVTK_View (&SALOME_Actor::SetOpacity,anOpacity)); } -//---------------------------------------------------------------------------- +/*! + Change color + \param theIObject - object + \param theColor - new color +*/ void SVTK_View ::SetColor(const Handle(SALOME_InteractiveObject)& theIObject, @@ -527,6 +634,10 @@ SVTK_View } +/*! + \return object color + \param theIObject - object +*/ QColor SVTK_View ::GetColor(const Handle(SALOME_InteractiveObject)& theIObject) diff --git a/src/SVTK/SVTK_View.h b/src/SVTK/SVTK_View.h index 2512c3497..4736bd544 100644 --- a/src/SVTK/SVTK_View.h +++ b/src/SVTK/SVTK_View.h @@ -18,7 +18,6 @@ class SVTK_Renderer; class SALOME_Actor; -//---------------------------------------------------------------------------- //! Main purpose of the class is to provide a way to customize #SVTK_MainWindow. /*! This class is initialized by #SVTK_MainWindow and just pass Qt signals from @@ -78,7 +77,6 @@ public: }; -//---------------------------------------------------------------------------- //! This class is introduced just for compatibility with old code. /*! This class contains frequantly used functionality in old code. diff --git a/src/SVTK/SVTK_ViewManager.cxx b/src/SVTK/SVTK_ViewManager.cxx index 04dc0f3f4..44c4e72be 100644 --- a/src/SVTK/SVTK_ViewManager.cxx +++ b/src/SVTK/SVTK_ViewManager.cxx @@ -21,7 +21,9 @@ int SVTK_ViewManager::_SVTKViewMgr_Id = 0; -//*************************************************************** +/*! + Constructor +*/ SVTK_ViewManager::SVTK_ViewManager( SUIT_Study* study, SUIT_Desktop* theDesktop ) : SUIT_ViewManager( study, theDesktop ) @@ -30,18 +32,24 @@ SVTK_ViewManager::SVTK_ViewManager( SUIT_Study* study, setViewModel( new SVTK_Viewer() ); } -//*************************************************************** +/*! + Destructor +*/ SVTK_ViewManager::~SVTK_ViewManager() { } -//*************************************************************** +/*! + \return corresponding main window +*/ SUIT_Desktop* SVTK_ViewManager::getDesktop() { return myDesktop; } -//*************************************************************** +/*! + Sets default name of view +*/ void SVTK_ViewManager::setViewName(SUIT_ViewWindow* theView) { int aPos = myViews.find(theView); diff --git a/src/SVTK/SVTK_ViewModel.cxx b/src/SVTK/SVTK_ViewModel.cxx index 03b8ca4a1..c1354eeab 100644 --- a/src/SVTK/SVTK_ViewModel.cxx +++ b/src/SVTK/SVTK_ViewModel.cxx @@ -59,18 +59,25 @@ // return aMgr->GetStudyByID( id ); //} -//========================================================== +/*! + Constructor +*/ SVTK_Viewer::SVTK_Viewer() { myTrihedronSize = 105; myTrihedronRelative = true; } -//========================================================== +/*! + Destructor +*/ SVTK_Viewer::~SVTK_Viewer() { } +/*! + \return background color +*/ QColor SVTK_Viewer ::backgroundColor() const @@ -78,6 +85,10 @@ SVTK_Viewer return myBgColor; } +/*! + Changes background color + \param theColor - new background color +*/ void SVTK_Viewer ::setBackgroundColor( const QColor& theColor ) @@ -97,7 +108,9 @@ SVTK_Viewer myBgColor = theColor; } -//========================================================== +/*!Create new instance of view window on desktop \a theDesktop. + *\retval SUIT_ViewWindow* - created view window pointer. + */ SUIT_ViewWindow* SVTK_Viewer:: createView( SUIT_Desktop* theDesktop ) @@ -111,16 +124,27 @@ createView( SUIT_Desktop* theDesktop ) return aViewWindow; } +/*! + \return trihedron size +*/ int SVTK_Viewer::trihedronSize() const { return myTrihedronSize; } +/*! + \return true if thihedron changes size in accordance with bounding box +*/ bool SVTK_Viewer::trihedronRelative() const { return myTrihedronRelative; } +/*! + Sets trihedron size and relativeness( whether thihedron changes size in accordance with bounding box) + \param theSize - new size + \param theRelative - new relativeness +*/ void SVTK_Viewer::setTrihedronSize( const int theSize, const bool theRelative ) { myTrihedronSize = theSize; @@ -136,7 +160,10 @@ void SVTK_Viewer::setTrihedronSize( const int theSize, const bool theRelative ) } } -//========================================================== +/*! + Sets new view manager + \param theViewManager - new view manager +*/ void SVTK_Viewer::setViewManager(SUIT_ViewManager* theViewManager) { SUIT_ViewModel::setViewManager(theViewManager); @@ -154,7 +181,9 @@ void SVTK_Viewer::setViewManager(SUIT_ViewManager* theViewManager) this, SLOT(onMouseRelease(SUIT_ViewWindow*, QMouseEvent*))); } -//========================================================== +/*! + Builds popup for vtk viewer +*/ void SVTK_Viewer ::contextMenuPopup( QPopupMenu* thePopup ) @@ -171,25 +200,34 @@ SVTK_Viewer } } -//========================================================== +/*! + SLOT: called on mouse button press, empty implementation +*/ void SVTK_Viewer ::onMousePress(SUIT_ViewWindow* vw, QMouseEvent* event) {} -//========================================================== +/*! + SLOT: called on mouse move, empty implementation +*/ void SVTK_Viewer ::onMouseMove(SUIT_ViewWindow* vw, QMouseEvent* event) {} -//========================================================== +/*! + SLOT: called on mouse button release, empty implementation +*/ void SVTK_Viewer ::onMouseRelease(SUIT_ViewWindow* vw, QMouseEvent* event) {} -//========================================================== +/*! + Enables/disables selection + \param isEnabled - new state +*/ void SVTK_Viewer ::enableSelection(bool isEnabled) @@ -198,7 +236,10 @@ SVTK_Viewer //!! To be done for view windows } -//========================================================== +/*! + Enables/disables selection of many object + \param isEnabled - new state +*/ void SVTK_Viewer ::enableMultiselection(bool isEnable) @@ -207,6 +248,9 @@ SVTK_Viewer //!! To be done for view windows } +/*! + SLOT: called on dump view operation is activated, stores scene to raster file +*/ void SVTK_Viewer ::onDumpView() @@ -215,7 +259,9 @@ SVTK_Viewer aView->onDumpView(); } -//========================================================== +/*! + SLOT: called if background color is to be changed changed, passes new color to view port +*/ void SVTK_Viewer ::onChangeBgColor() @@ -226,7 +272,9 @@ SVTK_Viewer } } -//========================================================== +/*! + SLOT: called when popup item "Show toolbar" is activated, shows toolbar of active view window +*/ void SVTK_Viewer ::onShowToolbar() @@ -239,7 +287,10 @@ SVTK_Viewer } } -//========================================================== +/*! + Display presentation + \param prs - presentation +*/ void SVTK_Viewer ::Display( const SALOME_VTKPrs* prs ) @@ -284,7 +335,11 @@ SVTK_Viewer } } -//========================================================== +/*! + Erase presentation + \param prs - presentation + \param forced - removes object from view +*/ void SVTK_Viewer ::Erase( const SALOME_VTKPrs* prs, const bool forced ) @@ -324,8 +379,11 @@ SVTK_Viewer } } } - -//========================================================== + +/*! + Erase all presentations + \param forced - removes all objects from view +*/ void SVTK_Viewer ::EraseAll( const bool forced ) @@ -370,7 +428,10 @@ SVTK_Viewer Repaint(); } -//========================================================== +/*! + Create presentation corresponding to the entry + \param entry - entry +*/ SALOME_Prs* SVTK_Viewer ::CreatePrs( const char* entry ) @@ -394,7 +455,9 @@ SVTK_Viewer return prs; } -//========================================================== +/*! + Auxiliary method called before displaying of objects +*/ void SVTK_Viewer ::BeforeDisplay( SALOME_Displayer* d ) @@ -402,14 +465,19 @@ SVTK_Viewer d->BeforeDisplay( this, SALOME_VTKViewType() ); } -//========================================================== +/*! + Auxiliary method called after displaying of objects +*/ void SVTK_Viewer::AfterDisplay( SALOME_Displayer* d ) { d->AfterDisplay( this, SALOME_VTKViewType() ); } -//========================================================== +/*! + \return true if object is displayed in viewer + \param obj - object to be checked +*/ bool SVTK_Viewer ::isVisible( const Handle(SALOME_InteractiveObject)& io ) @@ -425,7 +493,9 @@ SVTK_Viewer return true; } -//========================================================== +/*! + Updates current viewer +*/ void SVTK_Viewer ::Repaint() diff --git a/src/SVTK/SVTK_ViewWindow.cxx b/src/SVTK/SVTK_ViewWindow.cxx index cf8a045c6..19c045751 100755 --- a/src/SVTK/SVTK_ViewWindow.cxx +++ b/src/SVTK/SVTK_ViewWindow.cxx @@ -61,7 +61,9 @@ #include "VTKViewer_Algorithm.h" #include "SVTK_Functor.h" -//---------------------------------------------------------------------------- +/*! + Constructor +*/ SVTK_ViewWindow ::SVTK_ViewWindow(SUIT_Desktop* theDesktop): SUIT_ViewWindow(theDesktop), @@ -69,6 +71,9 @@ SVTK_ViewWindow myView(NULL) {} +/*! + To initialize #SVTK_ViewWindow instance +*/ void SVTK_ViewWindow ::Initialize(SVTK_ViewModelBase* theModel) @@ -108,6 +113,9 @@ SVTK_ViewWindow } } +/*! + To initialize #SVTK_ViewWindow instance +*/ void SVTK_ViewWindow ::Initialize(SVTK_View* theView, @@ -131,12 +139,17 @@ SVTK_ViewWindow theModel,SLOT(onSelectionChanged())); } +/*! + Destructor +*/ SVTK_ViewWindow ::~SVTK_ViewWindow() {} -//---------------------------------------------------------------------------- +/*! + \return corresponding view +*/ SVTK_View* SVTK_ViewWindow ::getView() @@ -144,6 +157,9 @@ SVTK_ViewWindow return myView; } +/*! + \return corresponding vtk main window +*/ SVTK_MainWindow* SVTK_ViewWindow ::getMainWindow() @@ -151,6 +167,9 @@ SVTK_ViewWindow return myMainWindow; } +/*! + \return corresponding vtk render window +*/ vtkRenderWindow* SVTK_ViewWindow ::getRenderWindow() @@ -158,6 +177,9 @@ SVTK_ViewWindow return getMainWindow()->getRenderWindow(); } +/*! + \return corresponding vtk render window interactor +*/ vtkRenderWindowInteractor* SVTK_ViewWindow ::getInteractor() @@ -165,6 +187,9 @@ SVTK_ViewWindow return getMainWindow()->getInteractor(); } +/*! + \return corresponding vtk renderer +*/ vtkRenderer* SVTK_ViewWindow ::getRenderer() @@ -172,6 +197,9 @@ SVTK_ViewWindow return myMainWindow->getRenderer(); } +/*! + \return corresponding vtk selector +*/ SVTK_Selector* SVTK_ViewWindow ::GetSelector() @@ -179,8 +207,9 @@ SVTK_ViewWindow return myMainWindow->GetSelector(); } - -//---------------------------------------------------------------------------- +/*! + Processes transformation "front view" +*/ void SVTK_ViewWindow ::onFrontView() @@ -188,7 +217,9 @@ SVTK_ViewWindow myMainWindow->onFrontView(); } -//---------------------------------------------------------------------------- +/*! + Processes transformation "back view" +*/ void SVTK_ViewWindow ::onBackView() @@ -196,7 +227,9 @@ SVTK_ViewWindow myMainWindow->onBackView(); } -//---------------------------------------------------------------------------- +/*! + Processes transformation "top view" +*/ void SVTK_ViewWindow ::onTopView() @@ -204,7 +237,9 @@ SVTK_ViewWindow myMainWindow->onTopView(); } -//---------------------------------------------------------------------------- +/*! + Processes transformation "bottom view" +*/ void SVTK_ViewWindow ::onBottomView() @@ -212,7 +247,9 @@ SVTK_ViewWindow myMainWindow->onBottomView(); } -//---------------------------------------------------------------------------- +/*! + Processes transformation "left view" +*/ void SVTK_ViewWindow ::onLeftView() @@ -220,7 +257,9 @@ SVTK_ViewWindow myMainWindow->onLeftView(); } -//---------------------------------------------------------------------------- +/*! + Processes transformation "right view" +*/ void SVTK_ViewWindow ::onRightView() @@ -228,7 +267,9 @@ SVTK_ViewWindow myMainWindow->onRightView(); } -//---------------------------------------------------------------------------- +/*! + Processes transformation "reset view": sets default orientation of viewport camera +*/ void SVTK_ViewWindow ::onResetView() @@ -236,7 +277,9 @@ SVTK_ViewWindow myMainWindow->onResetView(); } -//---------------------------------------------------------------------------- +/*! + Processes transformation "fit all" +*/ void SVTK_ViewWindow ::onFitAll() @@ -244,7 +287,9 @@ SVTK_ViewWindow myMainWindow->onFitAll(); } -//---------------------------------------------------------------- +/*! + SLOT: called if selection is changed +*/ void SVTK_ViewWindow ::onSelectionChanged() @@ -252,7 +297,10 @@ SVTK_ViewWindow myView->onSelectionChanged(); } -//---------------------------------------------------------------- +/*! + Change selection mode + \param theMode - new selection mode +*/ void SVTK_ViewWindow ::SetSelectionMode(Selection_Mode theMode) @@ -260,7 +308,9 @@ SVTK_ViewWindow myMainWindow->SetSelectionMode( theMode ); } -//---------------------------------------------------------------- +/*! + \return selection mode +*/ Selection_Mode SVTK_ViewWindow ::SelectionMode() const @@ -268,7 +318,9 @@ SVTK_ViewWindow return myMainWindow->SelectionMode(); } -//---------------------------------------------------------------- +/*! + Unhilights all objects in viewer +*/ void SVTK_ViewWindow ::unHighlightAll() @@ -276,7 +328,12 @@ SVTK_ViewWindow myView->unHighlightAll(); } -//---------------------------------------------------------------- +/*! + Hilights/unhilights object in viewer + \param theIO - object to be updated + \param theIsHighlight - if it is true, object will be hilighted, otherwise it will be unhilighted + \param theIsUpdate - update current viewer +*/ void SVTK_ViewWindow ::highlight(const Handle(SALOME_InteractiveObject)& theIO, @@ -286,7 +343,10 @@ SVTK_ViewWindow myView->highlight( theIO, theIsHighlight, theIsUpdate ); } -//---------------------------------------------------------------- +/*! + \return true if object is in viewer or in collector + \param theIO - object to be checked +*/ bool SVTK_ViewWindow ::isInViewer( const Handle(SALOME_InteractiveObject)& theIO ) @@ -294,7 +354,10 @@ SVTK_ViewWindow return myView->isInViewer( theIO ); } -//---------------------------------------------------------------- +/*! + \return true if object is displayed in viewer + \param theIO - object to be checked +*/ bool SVTK_ViewWindow ::isVisible( const Handle(SALOME_InteractiveObject)& theIO ) @@ -302,7 +365,11 @@ SVTK_ViewWindow return myView->isVisible( theIO ); } -//---------------------------------------------------------------- +/*! + Display object + \param theIO - object + \param theImmediatly - update viewer +*/ void SVTK_ViewWindow ::Display(const Handle(SALOME_InteractiveObject)& theIO, @@ -311,6 +378,11 @@ SVTK_ViewWindow myView->Display(theIO,theImmediatly); } +/*! + Erase object + \param theIO - object + \param theImmediatly - update viewer +*/ void SVTK_ViewWindow ::Erase(const Handle(SALOME_InteractiveObject)& theIO, @@ -319,6 +391,10 @@ SVTK_ViewWindow myView->Erase(theIO,theImmediatly); } +/*! + Display only passed object + \param theIO - object +*/ void SVTK_ViewWindow ::DisplayOnly(const Handle(SALOME_InteractiveObject)& theIO) @@ -326,6 +402,9 @@ SVTK_ViewWindow myView->DisplayOnly(theIO); } +/*! + Display all objects in view +*/ void SVTK_ViewWindow ::DisplayAll() @@ -333,6 +412,9 @@ SVTK_ViewWindow myView->DisplayAll(); } +/*! + Erase all objects in view +*/ void SVTK_ViewWindow ::EraseAll() @@ -340,7 +422,10 @@ SVTK_ViewWindow myView->EraseAll(); } -//---------------------------------------------------------------------------- +/*! + Sets background color + \param color - new background color +*/ void SVTK_ViewWindow ::setBackgroundColor( const QColor& color ) @@ -348,7 +433,9 @@ SVTK_ViewWindow myMainWindow->SetBackgroundColor( color ); } -//---------------------------------------------------------------------------- +/*! + \return background color of viewer +*/ QColor SVTK_ViewWindow ::backgroundColor() const @@ -356,7 +443,9 @@ SVTK_ViewWindow return myMainWindow->BackgroundColor(); } -//---------------------------------------------------------------------------- +/*! + Updates current viewer +*/ void SVTK_ViewWindow ::Repaint(bool theUpdateTrihedron) @@ -364,7 +453,9 @@ SVTK_ViewWindow myMainWindow->Repaint( theUpdateTrihedron ); } -//---------------------------------------------------------------------------- +/*! + Redirect the request to #SVTK_Renderer::GetScale +*/ void SVTK_ViewWindow ::GetScale( double theScale[3] ) @@ -372,7 +463,9 @@ SVTK_ViewWindow myMainWindow->GetScale( theScale ); } -//---------------------------------------------------------------------------- +/*! + Redirect the request to #SVTK_Renderer::SetScale +*/ void SVTK_ViewWindow ::SetScale( double theScale[3] ) @@ -380,7 +473,9 @@ SVTK_ViewWindow myMainWindow->SetScale( theScale ); } -//---------------------------------------------------------------------------- +/*! + Redirect the request to #SVTK_Renderer::IsTrihedronDisplayed +*/ bool SVTK_ViewWindow ::isTrihedronDisplayed() @@ -388,6 +483,9 @@ SVTK_ViewWindow return myMainWindow->IsTrihedronDisplayed(); } +/*! + Redirect the request to #SVTK_Renderer::IsCubeAxesDisplayed +*/ bool SVTK_ViewWindow ::isCubeAxesDisplayed() @@ -395,7 +493,9 @@ SVTK_ViewWindow return myMainWindow->IsCubeAxesDisplayed(); } -//---------------------------------------------------------------------------- +/*! + Redirect the request to #SVTK_Renderer::OnViewTrihedron +*/ void SVTK_ViewWindow ::onViewTrihedron() @@ -403,6 +503,9 @@ SVTK_ViewWindow myMainWindow->onViewTrihedron(); } +/*! + Redirect the request to #SVTK_Renderer::OnViewCubeAxes +*/ void SVTK_ViewWindow ::onViewCubeAxes() @@ -410,7 +513,9 @@ SVTK_ViewWindow myMainWindow->onViewCubeAxes(); } -//---------------------------------------------------------------------------- +/*! + Redirect the request to #SVTK_Renderer::GetTrihedron +*/ VTKViewer_Trihedron* SVTK_ViewWindow:: GetTrihedron() @@ -418,6 +523,9 @@ GetTrihedron() return myMainWindow->GetTrihedron(); } +/*! + Redirect the request to #SVTK_Renderer::GetCubeAxes +*/ SVTK_CubeAxesActor2D* SVTK_ViewWindow ::GetCubeAxes() @@ -425,6 +533,9 @@ SVTK_ViewWindow return myMainWindow->GetCubeAxes(); } +/*! + \return trihedron size +*/ int SVTK_ViewWindow ::GetTrihedronSize() const @@ -432,6 +543,11 @@ SVTK_ViewWindow return myMainWindow->GetTrihedronSize(); } +/*! + Sets trihedron size + \param theSize - new trihedron size + \param theRelative - trihedron relativeness +*/ void SVTK_ViewWindow ::SetTrihedronSize(const int theSize, const bool theRelative) @@ -449,7 +565,9 @@ SVTK_ViewWindow myMainWindow->AdjustActors(); } -//---------------------------------------------------------------------------- +/*! + Redirect the request to #SVTK_Renderer::OnAdjustTrihedron +*/ void SVTK_ViewWindow ::onAdjustTrihedron() @@ -457,6 +575,9 @@ SVTK_ViewWindow myMainWindow->onAdjustTrihedron(); } +/*! + Redirect the request to #SVTK_Renderer::OnAdjustCubeAxes +*/ void SVTK_ViewWindow ::onAdjustCubeAxes() @@ -464,7 +585,9 @@ SVTK_ViewWindow myMainWindow->onAdjustCubeAxes(); } -//======================================================================= +/*! + Emits key pressed +*/ void SVTK_ViewWindow ::onKeyPressed(QKeyEvent* event) @@ -472,7 +595,9 @@ SVTK_ViewWindow emit keyPressed( this, event ); } -//======================================================================= +/*! + Emits key released +*/ void SVTK_ViewWindow ::onKeyReleased(QKeyEvent* event) @@ -480,7 +605,9 @@ SVTK_ViewWindow emit keyReleased( this, event ); } -//======================================================================= +/*! + Emits mouse pressed +*/ void SVTK_ViewWindow ::onMousePressed(QMouseEvent* event) @@ -488,7 +615,9 @@ SVTK_ViewWindow emit mousePressed(this, event); } -//======================================================================= +/*! + Emits mouse released +*/ void SVTK_ViewWindow ::onMouseReleased(QMouseEvent* event) @@ -496,7 +625,9 @@ SVTK_ViewWindow emit mouseReleased( this, event ); } -//======================================================================= +/*! + Emits mouse moving +*/ void SVTK_ViewWindow ::onMouseMoving(QMouseEvent* event) @@ -504,7 +635,9 @@ SVTK_ViewWindow emit mouseMoving( this, event ); } -//======================================================================= +/*! + Emits mouse double clicked +*/ void SVTK_ViewWindow ::onMouseDoubleClicked( QMouseEvent* event ) @@ -512,7 +645,9 @@ SVTK_ViewWindow emit mouseDoubleClicked( this, event ); } -//---------------------------------------------------------------------------- +/*! + Redirect the request to #SVTK_Renderer::AddActor +*/ void SVTK_ViewWindow ::AddActor( VTKViewer_Actor* theActor, @@ -521,7 +656,9 @@ SVTK_ViewWindow myMainWindow->AddActor( theActor, theUpdate ); } -//---------------------------------------------------------------------------- +/*! + Redirect the request to #SVTK_Renderer::RemoveActor +*/ void SVTK_ViewWindow ::RemoveActor( VTKViewer_Actor* theActor, @@ -530,7 +667,9 @@ SVTK_ViewWindow myMainWindow->RemoveActor( theActor, theUpdate ); } -//---------------------------------------------------------------------------- +/*! + \return QImage, containing all scene rendering in window +*/ QImage SVTK_ViewWindow ::dumpView() @@ -538,7 +677,9 @@ SVTK_ViewWindow return myMainWindow->dumpView(); } -//---------------------------------------------------------------------------- +/*! + Redirect the request to #SVTK_Renderer::SetSelectionProp +*/ void SVTK_ViewWindow ::SetSelectionProp(const double& theRed, @@ -549,7 +690,9 @@ SVTK_ViewWindow myView->SetSelectionProp(theRed,theGreen,theBlue,theWidth); } -//---------------------------------------------------------------------------- +/*! + Redirect the request to #SVTK_Renderer::SetSelectionProp +*/ void SVTK_ViewWindow ::SetPreselectionProp(const double& theRed, @@ -560,7 +703,9 @@ SVTK_ViewWindow myView->SetPreselectionProp(theRed,theGreen,theBlue,theWidth); } -//---------------------------------------------------------------------------- +/*! + Redirect the request to #SVTK_Renderer::SetSelectionTolerance +*/ void SVTK_ViewWindow ::SetSelectionTolerance(const double& theTolNodes, @@ -569,7 +714,6 @@ SVTK_ViewWindow myView->SetSelectionTolerance(theTolNodes,theTolItems); } -//---------------------------------------------------------------------------- int convertAction( const int accelAction ) { switch ( accelAction ) { @@ -587,7 +731,10 @@ int convertAction( const int accelAction ) return accelAction; } -//---------------------------------------------------------------------------- +/*! + Performs action + \param accelAction - action +*/ void SVTK_ViewWindow ::action( const int accelAction ) @@ -767,8 +914,9 @@ SVTK_ViewWindow return retStr; } -/* The method restores visual parameters of this view or postpones it untill the view is shown - */ +/*! + The method restores visual parameters of this view or postpones it untill the view is shown +*/ void SVTK_ViewWindow ::setVisualParameters( const QString& parameters ) @@ -783,8 +931,9 @@ SVTK_ViewWindow } } -/* The method restores visual parameters of this view from a formated string - */ +/*! + The method restores visual parameters of this view from a formated string +*/ void SVTK_ViewWindow ::doSetVisualParameters( const QString& parameters ) @@ -835,11 +984,9 @@ SVTK_ViewWindow } -//================================================================ -// Function : eventFilter -/*! Purpose : delayed setVisualParameters +/*! + Delayed setVisualParameters */ -//================================================================ bool SVTK_ViewWindow::eventFilter( QObject* theWatched, QEvent* theEvent ) { if ( theEvent->type() == QEvent::Show && theWatched->inherits( "SVTK_RenderWindowInteractor" ) ) { diff --git a/src/SalomeApp/SalomeApp_Application.cxx b/src/SalomeApp/SalomeApp_Application.cxx index 772adfb7d..c75f9867f 100644 --- a/src/SalomeApp/SalomeApp_Application.cxx +++ b/src/SalomeApp/SalomeApp_Application.cxx @@ -69,11 +69,6 @@ extern "C" SALOMEAPP_EXPORT SUIT_Application* createApplication() return new SalomeApp_Application(); } -/* - Class : SalomeApp_Application - Description : Application containing SalomeApp module or LightApp module -*/ - /*!Constructor.*/ SalomeApp_Application::SalomeApp_Application() : LightApp_Application() @@ -443,10 +438,9 @@ void SalomeApp_Application::onOpenWith() QApplication::restoreOverrideCursor(); } -//======================================================================= -// name : createNewStudy -/*! Purpose : Create new study*/ -//======================================================================= +/*! + Creates new study +*/ SUIT_Study* SalomeApp_Application::createNewStudy() { SalomeApp_Study* aStudy = new SalomeApp_Study( this ); @@ -460,10 +454,9 @@ SUIT_Study* SalomeApp_Application::createNewStudy() return aStudy; } -//======================================================================= -// name : updateCommandsStatus -/*! Purpose : Enable/Disable menu items and toolbar buttons. Rebuild menu*/ -//======================================================================= +/*! + Enable/Disable menu items and toolbar buttons. Rebuild menu +*/ void SalomeApp_Application::updateCommandsStatus() { LightApp_Application::updateCommandsStatus(); @@ -492,10 +485,10 @@ void SalomeApp_Application::updateCommandsStatus() onSelectionChanged(); } -/* - Class : DumpStudyFileDlg - Description : Private class used in Dump Study operation. Consists 2 check boxes: - "Publish in study" and "Save GUI parameters" +/*! + \class DumpStudyFileDlg + Private class used in Dump Study operation. Consists 2 check boxes: + "Publish in study" and "Save GUI parameters" */ class DumpStudyFileDlg : public SUIT_FileDlg { @@ -922,6 +915,10 @@ void SalomeApp_Application::onDblClick( QListViewItem* it ) } } +/*! + Creates new view manager + \param type - type of view manager +*/ SUIT_ViewManager* SalomeApp_Application::newViewManager(const QString& type) { return createViewManager(type); diff --git a/src/SalomeApp/SalomeApp_Application.h b/src/SalomeApp/SalomeApp_Application.h index d44c08a4c..083cd6a90 100644 --- a/src/SalomeApp/SalomeApp_Application.h +++ b/src/SalomeApp/SalomeApp_Application.h @@ -38,7 +38,8 @@ class QListViewItem; #endif /*! - Description : Application containing SalomeApp module or LightApp module + \class SalomeApp_Application + \brief Application containing SalomeApp module or LightApp module */ class SALOMEAPP_EXPORT SalomeApp_Application : public LightApp_Application diff --git a/src/SalomeApp/SalomeApp_DataModel.cxx b/src/SalomeApp/SalomeApp_DataModel.cxx index af945617e..21c0b4aba 100644 --- a/src/SalomeApp/SalomeApp_DataModel.cxx +++ b/src/SalomeApp/SalomeApp_DataModel.cxx @@ -25,14 +25,13 @@ #include #include CORBA_SERVER_HEADER(SALOME_Exception) -//======================================================================= -// name : SalomeApp_DataModelSync -/*!Purpose : Auxiliary class for synchronizing tree of kernel objects and SUIT_DataObjects */ -//======================================================================= - typedef _PTR(SObject) kerPtr; typedef SUIT_DataObject* suitPtr; +/*! + \class SalomeApp_DataModelSync + Auxiliary class for synchronizing tree of kernel objects and SUIT_DataObjects +*/ class SalomeApp_DataModelSync { public: @@ -54,13 +53,18 @@ private: SUIT_DataObject* myRoot; }; - +/*! + Constructor +*/ SalomeApp_DataModelSync::SalomeApp_DataModelSync( _PTR( Study ) aStudy, SUIT_DataObject* aRoot ) : myStudy( aStudy ), myRoot( aRoot ) { } +/*! + \return true if kernel object is correct (has non empty name or is reference) +*/ bool SalomeApp_DataModelSync::isCorrect( const kerPtr& so ) const { kerPtr refObj; @@ -69,6 +73,13 @@ bool SalomeApp_DataModelSync::isCorrect( const kerPtr& so ) const return res; } +/*! + Creates SUIT object by KERNEL object + \param so - corresponding KERNEL object + \param parent - parent for SUIT object + \param after - previous sibling for SUIT object + \param prepend - SUIT object must be added to start of children list +*/ suitPtr SalomeApp_DataModelSync::createItem( const kerPtr& so, const suitPtr& parent, const suitPtr& after, @@ -100,6 +111,10 @@ suitPtr SalomeApp_DataModelSync::createItem( const kerPtr& so, return nitem; } +/*! + Deletes object with all children + \param p - SUIT object +*/ void SalomeApp_DataModelSync::deleteItemWithChildren( const suitPtr& p ) const { if( !p ) @@ -113,6 +128,11 @@ void SalomeApp_DataModelSync::deleteItemWithChildren( const suitPtr& p ) const delete p; } +/*! + \return true if objects correspond each other at all + \param p - kernel object + \param q - suit object +*/ bool SalomeApp_DataModelSync::isEqual( const kerPtr& p, const suitPtr& q ) const { LightApp_ModuleObject* lobj = dynamic_cast( q ); @@ -124,16 +144,27 @@ bool SalomeApp_DataModelSync::isEqual( const kerPtr& p, const suitPtr& q ) const return res; } +/*! + \return null kernel object +*/ kerPtr SalomeApp_DataModelSync::nullSrc() const { return kerPtr(); } +/*! + \return null suit object +*/ suitPtr SalomeApp_DataModelSync::nullTrg() const { return suitPtr( 0 ); } +/*! + Fills list with children of kernel object + \param obj - kernel object + \param ch - list to be filled +*/ void SalomeApp_DataModelSync::children( const kerPtr& obj, QValueList& ch ) const { ch.clear(); @@ -142,6 +173,11 @@ void SalomeApp_DataModelSync::children( const kerPtr& obj, QValueList& c ch.append( it->Value() ); } +/*! + Fills list with children of SUIT object + \param p - SUIT object + \param ch - list to be filled +*/ void SalomeApp_DataModelSync::children( const suitPtr& p, QValueList& ch ) const { DataObjectList l; @@ -154,15 +190,26 @@ void SalomeApp_DataModelSync::children( const suitPtr& p, QValueList& c } } +/*! + \return parent of SUIT object + \param p - SUIT object +*/ suitPtr SalomeApp_DataModelSync::parent( const suitPtr& p ) const { return p ? p->parent(): 0; } +/*! + Updates SUIT object + \param p - SUIT object +*/ void SalomeApp_DataModelSync::updateItem( const suitPtr& ) const { } +/*! + Auxiliary function, shows SUIT tree +*/ void showTree( SUIT_DataObject* root ) { qDebug( root ? "" : "" ); @@ -178,27 +225,24 @@ void showTree( SUIT_DataObject* root ) } } -//======================================================================= -// name : SalomeApp_DataModel::SalomeApp_DataModel -/*!Purpose : Constructor*/ -//======================================================================= +/*! + Constructor +*/ SalomeApp_DataModel::SalomeApp_DataModel( CAM_Module* theModule ) : LightApp_DataModel( theModule ) { } -//======================================================================= -// name : SalomeApp_DataModel::~SalomeApp_DataModel -/*! Purpose : Destructor*/ -//======================================================================= +/*! + Destructor +*/ SalomeApp_DataModel::~SalomeApp_DataModel() { } -//================================================================ -// Function : open -/*! Purpose : Open data model*/ -//================================================================ +/*! + Opens data model +*/ bool SalomeApp_DataModel::open( const QString& name, CAM_Study* study, QStringList ) { SalomeApp_Study* aDoc = dynamic_cast( study ); @@ -219,20 +263,18 @@ bool SalomeApp_DataModel::open( const QString& name, CAM_Study* study, QStringLi return true; } -//================================================================ -// Function : create -/*! Purpose : Create data model*/ -//================================================================ +/*! + Creates data model +*/ bool SalomeApp_DataModel::create( CAM_Study* theStudy ) { update(NULL, (LightApp_Study*)theStudy); return true; } -//================================================================ -// Function : update -/*! Purpose : Update application.*/ -//================================================================ +/*! + Updates application. +*/ void SalomeApp_DataModel::update( LightApp_DataObject*, LightApp_Study* study ) { SalomeApp_Study* aSStudy = dynamic_cast(study); @@ -266,10 +308,9 @@ void SalomeApp_DataModel::update( LightApp_DataObject*, LightApp_Study* study ) updateTree( sobj, aSStudy ); } -//================================================================ -// Function : synchronize -/*! Purpose : synchronizes kernel tree and suit data tree starting from component 'sobj' */ -//================================================================ +/*! + Synchronizes kernel tree and suit data tree starting from component 'sobj' +*/ SUIT_DataObject* SalomeApp_DataModel::synchronize( const _PTR( SComponent )& sobj, SalomeApp_Study* study ) { if( !study || !study->root() || !sobj ) @@ -296,10 +337,9 @@ SUIT_DataObject* SalomeApp_DataModel::synchronize( const _PTR( SComponent )& sob return 0; } -//================================================================ -// Function : updateTree -/*! Purpose : updates tree.*/ -//================================================================ +/*! + Updates tree. +*/ void SalomeApp_DataModel::updateTree( const _PTR( SComponent )& comp, SalomeApp_Study* study ) { SalomeApp_ModuleObject* aNewRoot = dynamic_cast( synchronize( comp, study ) ); @@ -310,20 +350,17 @@ void SalomeApp_DataModel::updateTree( const _PTR( SComponent )& comp, SalomeApp_ } } -//================================================================ -// Function : getModule -/*! Purpose : gets module*/ -//================================================================ - +/*! + \return module +*/ SalomeApp_Module* SalomeApp_DataModel::getModule() const { return dynamic_cast( module() ); } -//================================================================ -// Function : getStudy -/*! Purpose : gets study */ -//================================================================ +/*! + \return study +*/ SalomeApp_Study* SalomeApp_DataModel::getStudy() const { if(!root()) return 0; @@ -336,10 +373,9 @@ SalomeApp_Study* SalomeApp_DataModel::getStudy() const return aStudy; } -//================================================================ -// Function : getRootEntry -/*! Purpose : returns study entry corresponding to this data model*/ -//================================================================ +/*! + \return study entry corresponding to this data model +*/ QString SalomeApp_DataModel::getRootEntry( SalomeApp_Study* study ) const { QString anEntry; diff --git a/src/SalomeApp/SalomeApp_DataObject.cxx b/src/SalomeApp/SalomeApp_DataObject.cxx index 5bb857865..04d9aaf07 100644 --- a/src/SalomeApp/SalomeApp_DataObject.cxx +++ b/src/SalomeApp/SalomeApp_DataObject.cxx @@ -35,10 +35,6 @@ #include #include -/* - Class: SalomeApp_DataObject - Level: Public -*/ /*!Constructor. Initialize by \a parent*/ SalomeApp_DataObject::SalomeApp_DataObject( SUIT_DataObject* parent ) : LightApp_DataObject( parent ), @@ -333,10 +329,9 @@ QString SalomeApp_DataObject::value( const _PTR(SObject)& obj ) const return val; } -/* - Class: SalomeApp_ModuleObject - Level: Public -*/ + + + /*!Constructor.Initialize by \a parent.*/ SalomeApp_ModuleObject::SalomeApp_ModuleObject( SUIT_DataObject* parent ) @@ -373,10 +368,8 @@ QString SalomeApp_ModuleObject::name() const return SalomeApp_DataObject::name(); } -/* - Class: SalomeApp_SavePointObject - Level: Public -*/ + + /*!Constructor.Initialize by \a parent.*/ SalomeApp_SavePointObject::SalomeApp_SavePointObject( SUIT_DataObject* _parent, const int id, SalomeApp_Study* study ) @@ -410,11 +403,13 @@ QString SalomeApp_SavePointObject::name() const return myStudy->getNameOfSavePoint( myId ); } +/*!Gets icon picture of object.*/ QPixmap SalomeApp_SavePointObject::icon() const { return QPixmap(); } +/*!Gets tooltip.*/ QString SalomeApp_SavePointObject::toolTip() const { return QObject::tr( "SAVE_POINT_OBJECT_TOOLTIP" ).arg( name() ); diff --git a/src/SalomeApp/SalomeApp_Displayer.cxx b/src/SalomeApp/SalomeApp_Displayer.cxx index 6e2caeda2..03d1f1f78 100644 --- a/src/SalomeApp/SalomeApp_Displayer.cxx +++ b/src/SalomeApp/SalomeApp_Displayer.cxx @@ -30,14 +30,26 @@ #include +/*! + Default constructor +*/ SalomeApp_Displayer::SalomeApp_Displayer() { } +/*! + Destructor +*/ SalomeApp_Displayer::~SalomeApp_Displayer() { } +/*! + Displays object in view + \param entry - object entry + \param updateViewer - is it necessary to update viewer + \param theViewFrame - view +*/ void SalomeApp_Displayer::Display( const QString& entry, const bool updateViewer, SALOME_View* theViewFrame ) { SALOME_View* vf = theViewFrame ? theViewFrame : GetActiveView(); @@ -59,6 +71,11 @@ void SalomeApp_Displayer::Display( const QString& entry, const bool updateViewer } } +/*! + Redisplays object in view + \param entry - object entry + \param updateViewer - is it necessary to update viewer +*/ void SalomeApp_Displayer::Redisplay( const QString& entry, const bool updateViewer ) { // Remove the object permanently ( == true) @@ -89,6 +106,13 @@ void SalomeApp_Displayer::Redisplay( const QString& entry, const bool updateView } } +/*! + Erases object in view + \param entry - object entry + \param forced - deletes object from viewer (otherwise it will be erased, but cached) + \param updateViewer - is it necessary to update viewer + \param theViewFrame - view +*/ void SalomeApp_Displayer::Erase( const QString& entry, const bool forced, const bool updateViewer, SALOME_View* theViewFrame ) { @@ -105,6 +129,12 @@ void SalomeApp_Displayer::Erase( const QString& entry, const bool forced, } } +/*! + Erases all objects in view + \param forced - deletes objects from viewer + \param updateViewer - is it necessary to update viewer + \param theViewFrame - view +*/ void SalomeApp_Displayer::EraseAll( const bool forced, const bool updateViewer, SALOME_View* theViewFrame ) const { SALOME_View* vf = theViewFrame ? theViewFrame : GetActiveView(); @@ -116,6 +146,11 @@ void SalomeApp_Displayer::EraseAll( const bool forced, const bool updateViewer, } } +/*! + \return true if object is displayed in viewer + \param entry - object entry + \param theViewFrame - view +*/ bool SalomeApp_Displayer::IsDisplayed( const QString& entry, SALOME_View* theViewFrame ) const { SALOME_View* vf = theViewFrame ? theViewFrame : GetActiveView(); @@ -129,6 +164,9 @@ bool SalomeApp_Displayer::IsDisplayed( const QString& entry, SALOME_View* theVie return false; } +/*! + Updates active view +*/ void SalomeApp_Displayer::UpdateViewer() const { SALOME_View* vf = GetActiveView(); @@ -136,6 +174,12 @@ void SalomeApp_Displayer::UpdateViewer() const vf->Repaint(); } +/*! + \return presentation of object, built with help of CreatePrs method + \param entry - object entry + \param theViewFrame - view + \sa CreatePrs() +*/ SALOME_Prs* SalomeApp_Displayer::buildPresentation( const QString& entry, SALOME_View* theViewFrame ) { SALOME_Prs* prs = 0; @@ -148,6 +192,9 @@ SALOME_Prs* SalomeApp_Displayer::buildPresentation( const QString& entry, SALOME return prs; } +/*! + \return active view +*/ SALOME_View* SalomeApp_Displayer::GetActiveView() { SUIT_Session* session = SUIT_Session::session(); diff --git a/src/SalomeApp/SalomeApp_EventFilter.cxx b/src/SalomeApp/SalomeApp_EventFilter.cxx index 0db6f5fe3..e21971eaf 100755 --- a/src/SalomeApp/SalomeApp_EventFilter.cxx +++ b/src/SalomeApp/SalomeApp_EventFilter.cxx @@ -38,6 +38,9 @@ SalomeApp_EventFilter::~SalomeApp_EventFilter() qApp->removeEventFilter( this ); } +/*! + Custom event filter +*/ bool SalomeApp_EventFilter::eventFilter( QObject* o, QEvent* e ) { if ( e->type() == SALOME_EVENT ) diff --git a/src/SalomeApp/SalomeApp_ListView.cxx b/src/SalomeApp/SalomeApp_ListView.cxx index 6f3bd20e1..776c83b1b 100644 --- a/src/SalomeApp/SalomeApp_ListView.cxx +++ b/src/SalomeApp/SalomeApp_ListView.cxx @@ -27,14 +27,9 @@ using namespace std; -////////////////////////////////////////////////////////////////////// -// SalomeApp_ListView class implementation -////////////////////////////////////////////////////////////////////// - -//================================================================ -// Function : computeEditGeometry -/*! Purpose : static function - used for resizing editing widget*/ -//================================================================ +/*! + Used for resizing editing widget +*/ void computeEditGeometry(SalomeApp_ListViewItem* theItem, SalomeApp_EntityEdit* theWidget) { @@ -61,10 +56,9 @@ void computeEditGeometry(SalomeApp_ListViewItem* theItem, theWidget->setGeometry(aX, aY, aW, aH); } -//================================================================ -// Function : SalomeApp_ListView::SalomeApp_ListView -/*! Purpose : constructor*/ -//================================================================ +/*! + Constructor +*/ SalomeApp_ListView::SalomeApp_ListView( QWidget* parent ) : QtxListView( parent ) { @@ -88,10 +82,9 @@ SalomeApp_ListView::SalomeApp_ListView( QWidget* parent ) this, SLOT(onHeaderSizeChange(int, int, int))); } -//================================================================ -// Function : SalomeApp_ListView::~SalomeApp_ListView -/*! Purpose : destructor*/ -//================================================================ +/*! + Destructor +*/ SalomeApp_ListView::~SalomeApp_ListView() { if (myEdit) { @@ -101,10 +94,9 @@ SalomeApp_ListView::~SalomeApp_ListView() myEditedItem = 0; } -//================================================================ -// Function : SalomeApp_ListView::updateViewer -/*! Purpose : updates all data viewer*/ -//================================================================ +/*! + Updates all data viewer +*/ void SalomeApp_ListView::updateViewer() { // temporary disconnecting selection changed SIGNAL @@ -118,10 +110,9 @@ void SalomeApp_ListView::updateViewer() emit selectionChanged(); } -//================================================================ -// Function : SalomeApp_ListView::updateSelected -/*! Purpose : updates currently selected item(s)*/ -//================================================================ +/*! + Updates currently selected item(s) +*/ void SalomeApp_ListView::updateSelected() { // temporary disconnecting selection changed SIGNAL @@ -135,19 +126,17 @@ void SalomeApp_ListView::updateSelected() emit selectionChanged(); } -//================================================================ -// Function : SalomeApp_ListView::popupClientType -/*! Purpose : returns popup client type*/ -//================================================================ +/*! + Returns popup client type +*/ QString SalomeApp_ListView::popupClientType() const { return "SalomeApp_ListView"; } -//================================================================ -// Function : SalomeApp_ListView::contextMenuPopup -/*! Purpose : fills popup menu with items*/ -//================================================================ +/*! + Fills popup menu with items +*/ void SalomeApp_ListView::contextMenuPopup( QPopupMenu* aPopup ) { if (aPopup) { @@ -155,10 +144,9 @@ void SalomeApp_ListView::contextMenuPopup( QPopupMenu* aPopup ) } } -//================================================================ -// Function : SalomeApp_ListView::clear -/*! Purpose : clears view*/ -//================================================================ +/*! + Clears view +*/ void SalomeApp_ListView::clear() { if (myEdit) { @@ -169,28 +157,25 @@ void SalomeApp_ListView::clear() QListView::clear(); } -//================================================================ -// Function : SalomeApp_ListView::isMouseEnabled -/*! Purpose : returms true if mouse events are enabled*/ -//================================================================ +/*! + \return true if mouse events are enabled +*/ bool SalomeApp_ListView::isMouseEnabled() { return myMouseEnabled; } -//================================================================ -// Function : SalomeApp_ListView::enableMouse -// Purpose : enabled/disables mouse events (excluding MouseMove) -//================================================================ +/*! + Enables/disables mouse events (excluding MouseMove) +*/ void SalomeApp_ListView::enableMouse(bool enable) { myMouseEnabled = enable; } -//================================================================ -// Function : SalomeApp_ListView::eventFilter -/*! Purpose : event filter*/ -//================================================================ +/*! + Event filter +*/ bool SalomeApp_ListView::eventFilter(QObject* object, QEvent* event) { if (object == viewport() && @@ -203,10 +188,9 @@ bool SalomeApp_ListView::eventFilter(QObject* object, QEvent* event) return QListView::eventFilter(object, event); } -//================================================================ -// Function : SalomeApp_ListView::enableEditing -/*! Purpose : setting editing of items availbale/not available*/ -//================================================================ +/*! + Setting editing of items availbale/not available +*/ void SalomeApp_ListView::enableEditing(bool theFlag) { myEditingEnabled = theFlag; @@ -219,28 +203,25 @@ void SalomeApp_ListView::enableEditing(bool theFlag) } } -//================================================================ -// Function : SalomeApp_ListView::isEnableEditing -/*! Purpose : says if editing is enabled*/ -//================================================================ +/*! + Says if editing is enabled +*/ bool SalomeApp_ListView::isEnableEditing() { return myEditingEnabled; } -//================================================================ -// Function : SalomeApp_ListView::accept -/*! Purpose : calls finishEditing(true)...*/ -//================================================================ +/*! + Calls finishEditing(true)... +*/ void SalomeApp_ListView::accept() { finishEditing(true); } -//================================================================ -// Function : QAD_ListView::onSelectionChanged -/*! Purpose : slot, called when selection changed in List Viewer*/ -//================================================================ +/*! + Slot, called when selection changed in List Viewer +*/ void SalomeApp_ListView::onSelectionChanged() { if (myEdit) { @@ -271,10 +252,9 @@ void SalomeApp_ListView::onSelectionChanged() } } -//================================================================ -// Function : SalomeApp_ListView::resizeEvent -/*! Purpose : called when Data Viewer is resized*/ -//================================================================ +/*! + Called when Data Viewer is resized +*/ void SalomeApp_ListView::resizeEvent( QResizeEvent * e) { QListView::resizeEvent(e); @@ -285,10 +265,9 @@ void SalomeApp_ListView::resizeEvent( QResizeEvent * e) updateContents(); } -//================================================================ -// Function : SalomeApp_ListView::onHeaderSizeChange -/*! Purpose : slot, called when columns sizes are changed*/ -//================================================================ +/*! + Slot, called when columns sizes are changed +*/ void SalomeApp_ListView::onHeaderSizeChange(int, int, int) { int aW = columnWidth(columns()-1); @@ -297,10 +276,9 @@ void SalomeApp_ListView::onHeaderSizeChange(int, int, int) setColumnWidth(columns()-1, width() - frameWidth() * 2 - aX - 1); } -//================================================================ -// Function : SalomeApp_ListView::viewportPaintEvent -/*! Purpose : handler for paint event*/ -//================================================================ +/*! + Handler for paint event +*/ void SalomeApp_ListView::viewportPaintEvent(QPaintEvent* e) { QListView::viewportPaintEvent(e); @@ -309,28 +287,25 @@ void SalomeApp_ListView::viewportPaintEvent(QPaintEvent* e) } } -//================================================================ -// Function : SalomeApp_ListView::onEditOk -/*! Purpose : called when user finishes in editing of item*/ -//================================================================ +/*! + Called when user finishes in editing of item +*/ void SalomeApp_ListView::onEditOk() { finishEditing(true); } -//================================================================ -// Function : SalomeApp_ListView::onEditCancel -/*! Purpose : called when user cancels item editing*/ -//================================================================ +/*! + Called when user cancels item editing +*/ void SalomeApp_ListView::onEditCancel() { finishEditing(false); } -//================================================================ -// Function : SalomeApp_ListView::finishEditing -/*! Purpose : finishes editing of entity*/ -//================================================================ +/*! + Finishes editing of entity +*/ UpdateType SalomeApp_ListView::finishEditing(bool ok) { UpdateType aNeedsUpdate = utCancel; @@ -392,12 +367,10 @@ UpdateType SalomeApp_ListView::finishEditing(bool ok) return aNeedsUpdate; } -//================================================================ -// Function : SalomeApp_ListView::tip -/*! Purpose : gets current tooltip for list view - * \retval valid rect in success - */ -//================================================================ +/*! + \return current tooltip for list view + \retval valid rect in success +*/ QRect SalomeApp_ListView::tip(QPoint aPos, QString& aText, QRect& dspRect, @@ -429,24 +402,18 @@ QRect SalomeApp_ListView::tip(QPoint aPos, return result; } -////////////////////////////////////////////////////////////////////// -// SalomeApp_ListViewItem Class Implementation -////////////////////////////////////////////////////////////////////// - -//================================================================ -// Function : SalomeApp_ListViewItem::SalomeApp_ListViewItem -/*! Purpose : constructor*/ -//================================================================ +/*! + Constructor +*/ SalomeApp_ListViewItem::SalomeApp_ListViewItem(SalomeApp_ListView* parent) : QListViewItem( parent ) { init(); } -//================================================================ -// Function : SalomeApp_ListViewItem::SalomeApp_ListViewItem -/*! Purpose : constructor*/ -//================================================================ +/*! + Constructor +*/ SalomeApp_ListViewItem::SalomeApp_ListViewItem(SalomeApp_ListView* parent, SalomeApp_ListViewItem* after) : QListViewItem( parent, after ) @@ -454,10 +421,9 @@ QListViewItem( parent, after ) init(); } -//================================================================ -// Function : SalomeApp_ListViewItem::SalomeApp_ListViewItem -/*! Purpose : constructor*/ -//================================================================ +/*! + Constructor +*/ SalomeApp_ListViewItem::SalomeApp_ListViewItem(SalomeApp_ListView* parent, const QString& theName, const bool theEditable) : @@ -467,10 +433,9 @@ QListViewItem(parent, theName) setEditable(theEditable); } -//================================================================ -// Function : SalomeApp_ListViewItem::SalomeApp_ListViewItem -/*! Purpose : constructor*/ -//================================================================ +/*! + Constructor +*/ SalomeApp_ListViewItem::SalomeApp_ListViewItem(SalomeApp_ListView* parent, const QString& theName, const QString& theValue, @@ -481,10 +446,9 @@ QListViewItem(parent, theName, theValue) setEditable(theEditable); } -//================================================================ -// Function : SalomeApp_ListViewItem::SalomeApp_ListViewItem -/*! Purpose : constructor*/ -//================================================================ +/*! + Constructor +*/ SalomeApp_ListViewItem::SalomeApp_ListViewItem(SalomeApp_ListViewItem* parent, const QString& theName, const bool theEditable) : @@ -494,10 +458,9 @@ QListViewItem(parent, theName) setEditable(theEditable); } -//================================================================ -// Function : SalomeApp_ListViewItem::SalomeApp_ListViewItem -/*! Purpose : constructor*/ -//================================================================ +/*! + Constructor +*/ SalomeApp_ListViewItem::SalomeApp_ListViewItem(SalomeApp_ListViewItem* parent, SalomeApp_ListViewItem* after, const QString& theName, @@ -508,10 +471,9 @@ QListViewItem(parent, after, theName) setEditable(theEditable); } -//================================================================ -// Function : SalomeApp_ListViewItem::SalomeApp_ListViewItem -/*! Purpose : constructor*/ -//================================================================ +/*! + Constructor +*/ SalomeApp_ListViewItem::SalomeApp_ListViewItem(SalomeApp_ListView* parent, SalomeApp_ListViewItem* after, const QString& theName, @@ -523,10 +485,9 @@ QListViewItem(parent, after, theName) } -//================================================================ -// Function : SalomeApp_ListViewItem::SalomeApp_ListViewItem -/*! Purpose : constructor*/ -//================================================================ +/*! + Constructor +*/ SalomeApp_ListViewItem::SalomeApp_ListViewItem(SalomeApp_ListViewItem* parent, const QString& theName, const QString& theValue, @@ -538,10 +499,9 @@ QListViewItem(parent, theName, theValue) } -//================================================================ -// Function : SalomeApp_ListViewItem::SalomeApp_ListViewItem -/*! Purpose : constructor*/ -//================================================================ +/*! + Constructor +*/ SalomeApp_ListViewItem::SalomeApp_ListViewItem(SalomeApp_ListViewItem* parent, SalomeApp_ListViewItem* after, const QString& theName, @@ -553,10 +513,9 @@ QListViewItem(parent, after, theName, theValue) setEditable(theEditable); } -//================================================================ -// Function : SalomeApp_ListViewItem::SalomeApp_ListViewItem -/*! Purpose : constructor*/ -//================================================================ +/*! + Constructor +*/ SalomeApp_ListViewItem::SalomeApp_ListViewItem(SalomeApp_ListView* parent, SalomeApp_ListViewItem* after, const QString& theName, @@ -568,18 +527,16 @@ QListViewItem(parent, after, theName, theValue) setEditable(theEditable); } -//================================================================ -// Function : SalomeApp_ListViewItem::~SalomeApp_ListViewItem -/*! Purpose : destructor*/ -//================================================================ +/*! + Destructor +*/ SalomeApp_ListViewItem::~SalomeApp_ListViewItem() { } -//================================================================ -// Function : SalomeApp_ListViewItem::init -/*! Purpose : initialization*/ -//================================================================ +/*! + Initialization +*/ void SalomeApp_ListViewItem::init() { myEditable = false; @@ -590,19 +547,17 @@ void SalomeApp_ListViewItem::init() myUserType = -1; } -//================================================================ -// Function : SalomeApp_ListViewItem::getName -/*! Purpose : as default returns text in the first column*/ -//================================================================ +/*! + \return text in the first column +*/ QString SalomeApp_ListViewItem::getName() const { return ( listView()->columns() > 0 ) ? text(0) : QString(""); } -//================================================================ -// Function : SalomeApp_ListViewItem::setName -/*! Purpose : as default sets text in the first column*/ -//================================================================ +/*! + Sets text in the first column +*/ UpdateType SalomeApp_ListViewItem::setName(const QString& theName) { UpdateType aNeedsUpdate = utCancel; @@ -613,19 +568,17 @@ UpdateType SalomeApp_ListViewItem::setName(const QString& theName) return aNeedsUpdate; } -//================================================================ -// Function : SalomeApp_ListViewItem::getValue -/*! Purpose : as default returns text in the second column*/ -//================================================================ +/*! + \return text in the second column +*/ QString SalomeApp_ListViewItem::getValue() const { return ( listView()->columns() > 1 ) ? text(1) : QString(""); } -//================================================================ -// Function : SalomeApp_ListViewItem::setValue -/*! Purpose : as default sets text in the second column*/ -//================================================================ +/*! + Sets text in the second column +*/ UpdateType SalomeApp_ListViewItem::setValue(const QString& theValue) { UpdateType aNeedsUpdate = utCancel; @@ -636,10 +589,9 @@ UpdateType SalomeApp_ListViewItem::setValue(const QString& theValue) return aNeedsUpdate; } -//================================================================ -// Function : SalomeApp_ListViewItem::fullName -/*! Purpose : returns full path to the entity from the root*/ -//================================================================ +/*! + \return full path to the entity from the root +*/ QString SalomeApp_ListViewItem::fullName() { QString aFullName = getName(); @@ -651,10 +603,9 @@ QString SalomeApp_ListViewItem::fullName() return aFullName; } -//================================================================ -// Function : SalomeApp_ListViewItem::openAllLevels -/*! Purpose : expands all entities beginning from this level*/ -//================================================================ +/*! + expands all entities beginning from this level +*/ void SalomeApp_ListViewItem::openAllLevels() { setOpen(true); @@ -665,10 +616,9 @@ void SalomeApp_ListViewItem::openAllLevels() } } -//================================================================ -// Function : SalomeApp_ListViewItem::updateAllLevels -/*! Purpose : update all entites beginning from this level*/ -//================================================================ +/*! + update all entites beginning from this level +*/ void SalomeApp_ListViewItem::updateAllLevels() { SalomeApp_ListViewItem* aChild = (SalomeApp_ListViewItem*)firstChild(); @@ -678,145 +628,121 @@ void SalomeApp_ListViewItem::updateAllLevels() } } -//================================================================ -// Function : SalomeApp_EditBox::isEditable -/*! Purpose : return true if entity is editable*/ -//================================================================ +/*! + \return true if entity is editable +*/ bool SalomeApp_ListViewItem::isEditable() const { return myEditable; } -//================================================================ -// Function : SalomeApp_ListViewItem::setEditable -/*! Purpose : sets editable flag fo the entity*/ -//================================================================ +/*! + Sets editable flag fo the entity +*/ void SalomeApp_ListViewItem::setEditable(bool theEditable) { myEditable = theEditable; } -//================================================================ -// Function : SalomeApp_ListViewItem::isAccepted -/*! Purpose : returns true if entitiy is accepted after editing*/ -//================================================================ +/*! + \return true if entitiy is accepted after editing +*/ bool SalomeApp_ListViewItem::isAccepted() const { return myAccepted; } -//================================================================ -// Function : SalomeApp_ListViewItem::setAccepted -/*! Purpose : set entitiy accepted or not after editing*/ -//================================================================ +/*! + Sets entitiy accepted or not after editing +*/ void SalomeApp_ListViewItem::setAccepted(bool theAccepted) { myAccepted = theAccepted; } -//================================================================ -// Function : SalomeApp_ListViewItem::getEditingType -/*! Purpose : - * \retval type of edit control (default is edit box) - * \li 0 - edit box - * \li 1 - combo box - * \li 2 - editable combo box - */ -//================================================================ +/*! + \retval type of edit control (default is edit box) + \li 0 - edit box + \li 1 - combo box + \li 2 - editable combo box +*/ int SalomeApp_ListViewItem::getEditingType() { return myEditingType; } -//================================================================ -// Function : SalomeApp_ListViewItem::setEditingType -/*! Purpose : - * \retval type of edit control (negative value means none) - * \li 0 - edit box - * \li 1 - combo box - * \li 2 - editable combo box - */ -//================================================================ +/*! + \retval type of edit control (negative value means none) + \li 0 - edit box + \li 1 - combo box + \li 2 - editable combo box +*/ void SalomeApp_ListViewItem::setEditingType(const int type) { myEditingType = type; } -//================================================================ -// Function : SalomeApp_ListViewItem::getEditedColumn -// Purpose : /*! \retval edited column, default is last column - * negative value means there are no editable columns - */ -//================================================================ + negative value means there are no editable columns +*/ int SalomeApp_ListViewItem::getEditedColumn() { return listView()->columns()-1; } -//================================================================ -// Function : SalomeApp_ListViewItem::getValueType -// Purpose : -/*!\retval type of edited value (string, int, double) - * default is string - */ -//================================================================ +/*! + \retval type of edited value (string, int, double) + default is string +*/ int SalomeApp_ListViewItem::getValueType() { return myValueType; } -//================================================================ -// Function : SalomeApp_ListViewItem::setValueType -/*! Purpose : sets type of edited value*/ -//================================================================ +/*! + Sets type of edited value +*/ void SalomeApp_ListViewItem::setValueType(const int valueType) { myValueType = valueType; } -//================================================================ -// Function : SalomeApp_ListViewItem::getUserType -/*! Purpose : sets type of edited value*/ -//================================================================ +/*! + Sets type of edited value +*/ int SalomeApp_ListViewItem::getUserType() { return myUserType; } -//================================================================ -// Function : SalomeApp_ListViewItem::setUserType -/*! Purpose : sets type of edited value*/ -//================================================================ +/*! + Sets type of edited value +*/ void SalomeApp_ListViewItem::setUserType(const int userType) { myUserType = userType; } -//================================================================ -// Function : SalomeApp_ListViewItem::getButtons -/*! Purpose : returns buttons for editing widget (Apply (V), Cancel (X)) - * default is both buttons - */ -//================================================================ +/*! + \return buttons for editing widget (Apply (V), Cancel (X)) + default is both buttons +*/ int SalomeApp_ListViewItem::getButtons() { return myButtons; } -//================================================================ -// Function : SalomeApp_ListViewItem::getButtons -/*! Purpose : sets buttons for editing widget (Apply (V), Cancel (X))*/ -//================================================================ +/*! + Sets buttons for editing widget (Apply (V), Cancel (X)) +*/ void SalomeApp_ListViewItem::setButtons(const int buttons) { myButtons = buttons; } -//================================================================ -// Function : SalomeApp_ListViewItem::startEditing -/*! Purpose : creates control for editing and fills it with values*/ -//================================================================ +/*! + Creates control for editing and fills it with values +*/ SalomeApp_EntityEdit* SalomeApp_ListViewItem::startEditing() { SalomeApp_EntityEdit* aWidget = 0; @@ -842,10 +768,9 @@ SalomeApp_EntityEdit* SalomeApp_ListViewItem::startEditing() return aWidget; } -//================================================================ -// Function : SalomeApp_ListViewItem::fillWidgetWithValues -/*! Purpose : fills widget with initial values (list or single value)*/ -//================================================================ +/*! + Fills widget with initial values (list or single value) +*/ void SalomeApp_ListViewItem::fillWidgetWithValues(SalomeApp_EntityEdit* theWidget) { int anEditColumn = getEditedColumn(); @@ -853,10 +778,9 @@ void SalomeApp_ListViewItem::fillWidgetWithValues(SalomeApp_EntityEdit* theWidge theWidget->insertItem(text(anEditColumn), true); } -//================================================================ -// Function : SalomeApp_ListViewItem::finishEditing -/*! Purpose : finishes editing of entity*/ -//================================================================ +/*! + Finishes editing of entity +*/ UpdateType SalomeApp_ListViewItem::finishEditing(SalomeApp_EntityEdit* theWidget) { UpdateType aNeedsUpdate = utCancel; @@ -881,10 +805,9 @@ UpdateType SalomeApp_ListViewItem::finishEditing(SalomeApp_EntityEdit* theWidget return aNeedsUpdate; } -//================================================================ -// Function : SalomeApp_ListViewItem::tipRect -/*! Purpose : calculates rectangle which should contain item's tip*/ -//================================================================ +/*! + Calculates rectangle which should contain item's tip +*/ QRect SalomeApp_ListViewItem::tipRect() { QRect aRect = QRect(-1, -1, -1, -1); @@ -906,10 +829,9 @@ QRect SalomeApp_ListViewItem::tipRect() return aRect; } -//================================================================ -// Function : SalomeApp_ListViewItem::tipText -/*! Purpose : returns text for tooltip*/ -//================================================================ +/*! + \return text for tooltip +*/ QString SalomeApp_ListViewItem::tipText() { QString aText = getName(); @@ -918,10 +840,9 @@ QString SalomeApp_ListViewItem::tipText() return aText; } -//================================================================ -// Function : SalomeApp_ListViewItem::textRect -/*! Purpose : calculates rect of item text in viewport coordinates*/ -//================================================================ +/*! + Calculates rect of item text in viewport coordinates +*/ QRect SalomeApp_ListViewItem::textRect(const int column) const { QRect aItemRect = listView()->itemRect( this ); @@ -956,10 +877,9 @@ QRect SalomeApp_ListViewItem::textRect(const int column) const return theResult; } -//================================================================ -// Function : SalomeApp_ListViewItem::itemRect -/*! Purpose : calculates rect of item data in viewport coordinates*/ -//================================================================ +/*! + Calculates rect of item data in viewport coordinates +*/ QRect SalomeApp_ListViewItem::itemRect(const int column) const { QRect aItemRect = listView()->itemRect( this ); @@ -991,23 +911,17 @@ QRect SalomeApp_ListViewItem::itemRect(const int column) const return theResult; } -////////////////////////////////////////////////////////////////////// -// SalomeApp_EditBox class implementation -////////////////////////////////////////////////////////////////////// - -//================================================================ -// Function : SalomeApp_EditBox::SalomeApp_EditBox -/*! Purpose : constructor*/ -//================================================================ +/*! + Constructor +*/ SalomeApp_EditBox::SalomeApp_EditBox(QWidget* parent) : QLineEdit(parent) { } -//================================================================ -// Function : SalomeApp_EditBox::keyPressEvent -/*! Purpose : event filter for key pressing*/ -//================================================================ +/*! + Event filter for key pressing +*/ void SalomeApp_EditBox::keyPressEvent( QKeyEvent *e ) { if ( e->key() == Key_Escape ) @@ -1017,23 +931,18 @@ void SalomeApp_EditBox::keyPressEvent( QKeyEvent *e ) e->accept(); } -////////////////////////////////////////////////////////////////////// -// SalomeApp_ComboBox class implementation -////////////////////////////////////////////////////////////////////// -//================================================================ -// Function : SalomeApp_ComboBox::SalomeApp_ComboBox -/*! Purpose : constructor*/ -//================================================================ +/*! + Constructor +*/ SalomeApp_ComboBox::SalomeApp_ComboBox(bool rw, QWidget* parent, const char* name) : QComboBox(rw, parent, name) { } -//================================================================ -// Function : SalomeApp_ComboBox::findItem -/*! Purpose : searches item in list and returns its index*/ -//================================================================ +/*! + Searches item in list and returns its index +*/ int SalomeApp_ComboBox::findItem(const QString& theText) { for (int i = 0; i < count(); i++) @@ -1042,10 +951,9 @@ int SalomeApp_ComboBox::findItem(const QString& theText) return -1; } -//================================================================ -// Function : SalomeApp_ComboBox::insertItem -/*! Purpose : adds item in combo box*/ -//================================================================ +/*! + Adds item in combo box +*/ void SalomeApp_ComboBox::insertItem(const QString& theValue, int theIndex) { @@ -1053,20 +961,18 @@ void SalomeApp_ComboBox::insertItem(const QString& theValue, QComboBox::insertItem(theValue, theIndex); } -//================================================================ -// Function : SalomeApp_ComboBox::insertList -/*! Purpose : adds list of items in combo box*/ -//================================================================ +/*! + Adds list of items in combo box +*/ void SalomeApp_ComboBox::insertList(const QStringList& theList) { for (unsigned i = 0; i < theList.count(); i++) insertItem(theList[i]); } -//================================================================ -// Function : SalomeApp_ComboBox::insertItem -/*! Purpose : adds item in combo box*/ -//================================================================ +/*! + Adds item in combo box +*/ void SalomeApp_ComboBox::insertItem(const int theValue) { int aNum; @@ -1083,20 +989,18 @@ void SalomeApp_ComboBox::insertItem(const int theValue) insertItem(QString::number(theValue)); } -//================================================================ -// Function : SalomeApp_ComboBox::insertList -/*! Purpose : adds list of items in combo box*/ -//================================================================ +/*! + Adds list of items in combo box +*/ void SalomeApp_ComboBox::insertList(const TColStd_ListOfInteger& theList) { for (TColStd_ListIteratorOfListOfInteger aIter(theList); aIter.More(); aIter.Next()) insertItem(aIter.Value()); } -//================================================================ -// Function : SalomeApp_ComboBox::insertItem -/*! Purpose : adds item in combo box*/ -//================================================================ +/*! + Adds item in combo box +*/ void SalomeApp_ComboBox::insertItem(const double theValue) { double aNum; @@ -1113,29 +1017,23 @@ void SalomeApp_ComboBox::insertItem(const double theValue) insertItem(QString::number(theValue)); } -//================================================================ -// Function : SalomeApp_ComboBox::insertList -/*! Purpose : adds list of items in combo box*/ -//================================================================ +/*! + Adds list of items in combo box +*/ void SalomeApp_ComboBox::insertList(const TColStd_ListOfReal& theList) { for (TColStd_ListIteratorOfListOfReal aIter(theList); aIter.More(); aIter.Next()) insertItem(aIter.Value()); } -////////////////////////////////////////////////////////////////////// -// SalomeApp_EntityEdit class implementation -////////////////////////////////////////////////////////////////////// - #include #define MIN_COMBO_WIDTH 1 #define MIN_EDIT_WIDTH 1 -//================================================================ -// Function : SalomeApp_EntityEdit::SalomeApp_EntityEdit -/*! Purpose : constructor*/ -//================================================================ +/*! + Constructor +*/ SalomeApp_EntityEdit::SalomeApp_EntityEdit(QWidget* parent, int controlType, int valueType, @@ -1224,18 +1122,16 @@ myCancelBtn(0) } } -//================================================================ -// Function : SalomeApp_EntityEdit::~SalomeApp_EntityEdit -/*! Purpose : destructor*/ -//================================================================ +/*! + Destructor +*/ SalomeApp_EntityEdit::~SalomeApp_EntityEdit() { } -//================================================================ -// Function : SalomeApp_EntityEdit::clear -/*! Purpose : clears edit/combo box*/ -//================================================================ +/*! + Clears edit/combo box +*/ void SalomeApp_EntityEdit::clear() { if (myEdit) @@ -1244,10 +1140,9 @@ void SalomeApp_EntityEdit::clear() myCombo->clear(); } -//================================================================ -// Function : SalomeApp_EntityEdit::getText -/*! Purpose : returns current text in edit box or combo box*/ -//================================================================ +/*! + \return current text in edit box or combo box +*/ QString SalomeApp_EntityEdit::getText() { if (myEdit) @@ -1258,10 +1153,9 @@ QString SalomeApp_EntityEdit::getText() return ""; } -//================================================================ -// Function : SalomeApp_EntityEdit::setText -/*! Purpose : sets text*/ -//================================================================ +/*! + Sets text +*/ void SalomeApp_EntityEdit::setText(const QString& theText) { myString = theText; @@ -1276,12 +1170,9 @@ void SalomeApp_EntityEdit::setText(const QString& theText) } } -//================================================================ -// Function : SalomeApp_EntityEdit::insertItem -/*! Purpose : adds item in combo box, - * sets it current if theSetCurrent is true - */ -//================================================================ +/*! + Adds item in combo box, sets it current if theSetCurrent is true +*/ void SalomeApp_EntityEdit::insertItem(const QString& theValue, bool theSetCurrent, int theOrder) @@ -1302,12 +1193,9 @@ void SalomeApp_EntityEdit::insertItem(const QString& theValue, setText(theValue); } -//================================================================ -// Function : SalomeApp_EntityEdit::insertList -/*! Purpose : adds items in combo box, - * sets item theCurrent as current - */ -//================================================================ +/*! + Adds items in combo box, sets item theCurrent as current +*/ void SalomeApp_EntityEdit::insertList(const QStringList& theList, const int theCurrent) { @@ -1317,12 +1205,9 @@ void SalomeApp_EntityEdit::insertList(const QStringList& theList, setText(theList[theCurrent]); } -//================================================================ -// Function : SalomeApp_EntityEdit::insertItem -/*! Purpose : adds item in combo box, - * sets it current if theSetCurrent is true - */ -//================================================================ +/*! + Adds item in combo box, sets it current if theSetCurrent is true +*/ void SalomeApp_EntityEdit::insertItem(const int theValue, bool theSetCurrent) { @@ -1333,12 +1218,9 @@ void SalomeApp_EntityEdit::insertItem(const int theValue, setText(QString::number(theValue)); } -//================================================================ -// Function : SalomeApp_EntityEdit::insertList -/*! Purpose : adds items in combo box, - * sets item theCurrent as current - */ -//================================================================ +/*! + Adds items in combo box, sets item theCurrent as current +*/ void SalomeApp_EntityEdit::insertList(const TColStd_ListOfInteger& theList, const int theCurrent) { @@ -1354,11 +1236,9 @@ void SalomeApp_EntityEdit::insertList(const TColStd_ListOfInteger& theList, } } -//================================================================ -// Function : SalomeApp_EntityEdit::insertItem -// Purpose : adds item in combo box, -// sets it current if theSetCurrent is true -//================================================================ +/*! + Adds item in combo box, sets it current if theSetCurrent is true +*/ void SalomeApp_EntityEdit::insertItem(const double theValue, bool theSetCurrent) { @@ -1369,12 +1249,9 @@ void SalomeApp_EntityEdit::insertItem(const double theValue, setText(QString::number(theValue)); } -//================================================================ -// Function : SalomeApp_EntityEdit::insertList -/*! Purpose : adds items in combo box, - * sets item theCurrent as current - */ -//================================================================ +/*! + Adds items in combo box, sets item theCurrent as current +*/ void SalomeApp_EntityEdit::insertList(const TColStd_ListOfReal& theList, const int theCurrent) { @@ -1390,10 +1267,9 @@ void SalomeApp_EntityEdit::insertList(const TColStd_ListOfReal& theList, } } -//================================================================ -// Function : SalomeApp_EntityEdit::getControl -/*! Purpose : gets actual widget*/ -//================================================================ +/*! + \return actual widget +*/ QWidget* SalomeApp_EntityEdit::getControl() { if (myEdit) @@ -1404,10 +1280,9 @@ QWidget* SalomeApp_EntityEdit::getControl() return 0; } -//================================================================ -// Function : SalomeApp_EntityEdit::setFocus -/*! Purpose : redirect focus to corresponding widget*/ -//================================================================ +/*! + redirect focus to corresponding widget +*/ void SalomeApp_EntityEdit::setFocus() { if (myEdit) { @@ -1420,10 +1295,9 @@ void SalomeApp_EntityEdit::setFocus() } } -//================================================================ -// Function : SalomeApp_EntityEdit::setValidator -/*! Purpose : sets validator for the control*/ -//================================================================ +/*! + Sets validator for the control +*/ void SalomeApp_EntityEdit::setValidator(const QValidator* theValidator) { if (myEdit) @@ -1432,10 +1306,9 @@ void SalomeApp_EntityEdit::setValidator(const QValidator* theValidator) myCombo->setValidator(theValidator); } -//================================================================ -// Function : SalomeApp_EntityEdit::keyPressEvent -/*! Purpose : event filter for KeyPress event*/ -//================================================================ +/*! + Event filter for KeyPress event +*/ void SalomeApp_EntityEdit::keyPressEvent( QKeyEvent * e) { if ( (e->key() == Key_Enter || @@ -1445,19 +1318,17 @@ void SalomeApp_EntityEdit::keyPressEvent( QKeyEvent * e) onCancel(); } -//================================================================ -// Function : SalomeApp_EntityEdit::onComboActivated -/*! Purpose : called when item activated in combo box*/ -//================================================================ +/*! + Called when item activated in combo box +*/ void SalomeApp_EntityEdit::onComboActivated(const QString& theText) { onTextChanged(theText); } -//================================================================ -// Function : SalomeApp_EntityEdit::onTextChanged -/*! Purpose : slot, called when text changed in line edit*/ -//================================================================ +/*! + Slot, called when text changed in line edit +*/ void SalomeApp_EntityEdit::onTextChanged(const QString& theText) { if (myApplyBtn) @@ -1466,10 +1337,9 @@ void SalomeApp_EntityEdit::onTextChanged(const QString& theText) myCancelBtn->setEnabled(!(theText == myString)); } -//================================================================ -// Function : SalomeApp_EntityEdit::onCancel -/*! Purpose : slot, called when user presses Cancel button*/ -//================================================================ +/*! + Slot, called when user presses Cancel button +*/ void SalomeApp_EntityEdit::onCancel() { setText(myString); @@ -1480,10 +1350,9 @@ void SalomeApp_EntityEdit::onCancel() emit escapePressed(); } -//================================================================ -// Function : SalomeApp_EntityEdit::onApply -/*! Purpose : slot, called when user presses Apply button*/ -//================================================================ +/*! + Slot, called when user presses Apply button +*/ void SalomeApp_EntityEdit::onApply() { myString = getText(); @@ -1494,10 +1363,9 @@ void SalomeApp_EntityEdit::onApply() emit returnPressed(); } -//================================================================ -// Function : SalomeApp_EntityEdit::showButtons -/*! Purpose : shows/hides buttons*/ -//================================================================ +/*! + Shows/hides buttons +*/ void SalomeApp_EntityEdit::showButtons(bool show) { if (myApplyBtn) @@ -1506,10 +1374,9 @@ void SalomeApp_EntityEdit::showButtons(bool show) show ? myCancelBtn->show() : myCancelBtn->hide(); } -//================================================================ -// Function : SalomeApp_EntityEdit::setDuplicatesEnabled -/*! Purpose : enables/disables data duplication (for combo box)*/ -//================================================================ +/*! + Enables/disables data duplication (for combo box) +*/ void SalomeApp_EntityEdit::setDuplicatesEnabled(bool enabled) { if (myCombo) diff --git a/src/SalomeApp/SalomeApp_ListView.h b/src/SalomeApp/SalomeApp_ListView.h index e7b7552cf..4e54e423c 100644 --- a/src/SalomeApp/SalomeApp_ListView.h +++ b/src/SalomeApp/SalomeApp_ListView.h @@ -44,10 +44,10 @@ enum UpdateType { class SalomeApp_ListViewItem; class SalomeApp_EntityEdit; -//================================================================ -// Class : SalomeApp_ListView -// Description : parent class for Data Viewer and Properties Viewer -//================================================================ +/*! + \class SalomeApp_ListView + parent class for Data Viewer and Properties Viewer +*/ class SalomeApp_ListView : public QtxListView , public SUIT_PopupClient { Q_OBJECT diff --git a/src/SalomeApp/SalomeApp_Module.cxx b/src/SalomeApp/SalomeApp_Module.cxx index ac431df27..9afbe27e4 100644 --- a/src/SalomeApp/SalomeApp_Module.cxx +++ b/src/SalomeApp/SalomeApp_Module.cxx @@ -65,6 +65,12 @@ LightApp_Selection* SalomeApp_Module::createSelection() const return LightApp_Module::createSelection(); } +/*! + Converts objects-containers to list of objects, those are contained + Other objects must be added without conversion + \param source - source list of objects + \param dest - list of converted objects +*/ void SalomeApp_Module::extractContainers( const SALOME_ListIO& source, SALOME_ListIO& dest ) const { SalomeApp_Study* study = dynamic_cast( SUIT_Session::session()->activeApplication()->activeStudy() ); diff --git a/src/SalomeApp/SalomeApp_PyInterp.cxx b/src/SalomeApp/SalomeApp_PyInterp.cxx index 19bc57559..88c6b5fa5 100755 --- a/src/SalomeApp/SalomeApp_PyInterp.cxx +++ b/src/SalomeApp/SalomeApp_PyInterp.cxx @@ -108,12 +108,12 @@ bool SalomeApp_PyInterp::initContext() return true; } +/*! + Do nothing + The initialization has been done in main + */ void SalomeApp_PyInterp::init_python() { - /* - * Do nothing - * The initialization has been done in main - */ MESSAGE("PyInterp_base::init_python"); ASSERT(KERNEL_PYTHON::_gtstate); // initialisation in main SCRUTE(KERNEL_PYTHON::_gtstate); diff --git a/src/SalomeApp/SalomeApp_Study.cxx b/src/SalomeApp/SalomeApp_Study.cxx index db29ddb35..3d693f374 100644 --- a/src/SalomeApp/SalomeApp_Study.cxx +++ b/src/SalomeApp/SalomeApp_Study.cxx @@ -109,10 +109,10 @@ void SalomeApp_Study::createDocument() emit created( this ); } -//======================================================================= -// name : openDocument -/*! Purpose : Open document*/ -//======================================================================= +/*! + Opens document + \param theFileName - name of file +*/ bool SalomeApp_Study::openDocument( const QString& theFileName ) { MESSAGE( "openDocument" ); @@ -152,10 +152,10 @@ bool SalomeApp_Study::openDocument( const QString& theFileName ) return res; } -//======================================================================= -// name : loadDocument -/*! Purpose : Connects GUI study to SALOMEDS one already loaded into StudyManager*/ -//======================================================================= +/*! + Connects GUI study to SALOMEDS one already loaded into StudyManager + \param theStudyName - name of study +*/ bool SalomeApp_Study::loadDocument( const QString& theStudyName ) { MESSAGE( "loadDocument" ); @@ -198,10 +198,10 @@ bool SalomeApp_Study::loadDocument( const QString& theStudyName ) return res; } -//======================================================================= -// name : saveDocumentAs -/*! Purpose : Save document*/ -//======================================================================= +/*! + Saves document + \param theFileName - name of file +*/ bool SalomeApp_Study::saveDocumentAs( const QString& theFileName ) { bool store = application()->resourceMgr()->booleanValue( "Study", "store_visual_state", true ); @@ -239,10 +239,9 @@ bool SalomeApp_Study::saveDocumentAs( const QString& theFileName ) return res; } -//======================================================================= -// name : saveDocument -/*! Purpose : Save document*/ -//======================================================================= +/*! + Saves previously opened document +*/ bool SalomeApp_Study::saveDocument() { bool store = application()->resourceMgr()->booleanValue( "Study", "store_visual_state", true ); @@ -278,10 +277,9 @@ bool SalomeApp_Study::saveDocument() return res; } -//================================================================ -// Function : closeDocument -/*! Purpose : Close document*/ -//================================================================ +/*! + Closes document +*/ void SalomeApp_Study::closeDocument(bool permanently) { LightApp_Study::closeDocument(permanently); @@ -296,10 +294,9 @@ void SalomeApp_Study::closeDocument(bool permanently) } } -//================================================================ -// Function : isModified -// Purpose : -//================================================================ +/*! + \return true, if study is modified in comparison with last open/save +*/ bool SalomeApp_Study::isModified() const { bool isAnyChanged = studyDS() && studyDS()->IsModified(); @@ -309,10 +306,9 @@ bool SalomeApp_Study::isModified() const return isAnyChanged; } -//================================================================ -// Function : isSaved -/*! Purpose : Check: data model is saved?*/ -//================================================================ +/*! + \return if data model is saved +*/ bool SalomeApp_Study::isSaved() const { bool isAllSaved = studyDS() && studyDS()->GetPersistentReference().size(); @@ -322,10 +318,11 @@ bool SalomeApp_Study::isSaved() const return isAllSaved; } -//======================================================================= -// name : saveModuleData -/*! Purpose : save list file for module 'theModuleName' */ -//======================================================================= +/*! + Saves data of module + \param theModuleName - name of module + \param theListOfFiles - list of files to be saved +*/ void SalomeApp_Study::saveModuleData( QString theModuleName, QStringList theListOfFiles ) { int aNb = theListOfFiles.count(); @@ -343,10 +340,11 @@ void SalomeApp_Study::saveModuleData( QString theModuleName, QStringList theList SetListOfFiles(theModuleName, aListOfFiles); } -//======================================================================= -// name : openModuleData -/*! Purpose : gets list of file for module 'theModuleNam' */ -//======================================================================= +/*! + Loads data of module + \param theModuleName - name of module + \param theListOfFiles - list of files to be loaded +*/ void SalomeApp_Study::openModuleData( QString theModuleName, QStringList& theListOfFiles ) { std::vector aListOfFiles = GetListOfFiles( theModuleName ); @@ -362,10 +360,9 @@ void SalomeApp_Study::openModuleData( QString theModuleName, QStringList& theLis theListOfFiles.append(aListOfFiles[i+1].c_str()); } -//======================================================================= -// name : saveStudyData -/*! Purpose : save data from study */ -//======================================================================= +/*! + Saves data from study +*/ bool SalomeApp_Study::saveStudyData( const QString& theFileName ) { ModelList list; dataModels( list ); @@ -376,10 +373,9 @@ bool SalomeApp_Study::saveStudyData( const QString& theFileName ) return true; } -//======================================================================= -// name : openStudyData -/*! Purpose : open data for study */ -//======================================================================= +/*! + Loads data for study +*/ bool SalomeApp_Study::openStudyData( const QString& theFileName ) { return true; @@ -406,7 +402,7 @@ void SalomeApp_Study::dataModelInserted (const CAM_DataModel* dm) } /*! - Create SComponent for module, using default engine (CORBAless) + Create SComponent for module, using default engine (CORBAless) */ void SalomeApp_Study::addComponent(const CAM_DataModel* dm) { @@ -524,10 +520,10 @@ QString SalomeApp_Study::newStudyName() const return newName; } -//================================================================ -// Function : GetListOfFiles -/*! Purpose : to be used by CORBAless modules*/ -//================================================================ +/*! + \return list of files used by module: to be used by CORBAless modules + \param theModuleName - name of module +*/ std::vector SalomeApp_Study::GetListOfFiles( const char* theModuleName ) const { SalomeApp_Engine_i* aDefaultEngine = SalomeApp_Engine_i::GetInstance(); @@ -538,10 +534,11 @@ std::vector SalomeApp_Study::GetListOfFiles( const char* theModuleN return aListOfFiles; } -//================================================================ -// Function : SetListOfFiles -/*! Purpose : to be used by CORBAless modules*/ -//================================================================ +/*! + Sets list of files used by module: to be used by CORBAless modules + \param theModuleName - name of module + \param theListOfFiles - list of files +*/ void SalomeApp_Study::SetListOfFiles ( const char* theModuleName, const std::vector theListOfFiles ) { @@ -550,10 +547,9 @@ void SalomeApp_Study::SetListOfFiles ( const char* theModuleName, aDefaultEngine->SetListOfFiles(theListOfFiles, id(), theModuleName); } -//================================================================ -// Function : GetTmpDir -/*! Purpose : to be used by CORBAless modules*/ -//================================================================ +/*! + \return temporary directory for saving files of modules +*/ std::string SalomeApp_Study::GetTmpDir ( const char* theURL, const bool isMultiFile ) { std::string anURLDir = SALOMEDS_Tool::GetDirFromPath(theURL); @@ -561,10 +557,9 @@ std::string SalomeApp_Study::GetTmpDir ( const char* theURL, const bool isMulti return aTmpDir; } -//================================================================ -// Function : RemoveTemporaryFiles -/*! Purpose : to be used by CORBAless modules*/ -//================================================================ +/*! + Removes temporary files +*/ void SalomeApp_Study::RemoveTemporaryFiles ( const char* theModuleName, const bool isMultiFile ) const { if (isMultiFile) @@ -584,8 +579,10 @@ void SalomeApp_Study::RemoveTemporaryFiles ( const char* theModuleName, const bo } } -// END: methods to be used by CORBAless modules - +/*! + Deletes all references to object + \param obj - object +*/ void SalomeApp_Study::deleteReferencesTo( _PTR( SObject ) obj ) { _PTR(StudyBuilder) sb = studyDS()->NewBuilder(); @@ -601,10 +598,10 @@ void SalomeApp_Study::deleteReferencesTo( _PTR( SObject ) obj ) } } -//================================================================ -// Function : referencedToEntry -/*! Purpose : Return referenced entry from entry*/ -//================================================================ +/*! + \return real entry by entry of reference + \param entry - entry of reference object +*/ QString SalomeApp_Study::referencedToEntry( const QString& entry ) const { _PTR(SObject) obj = studyDS()->FindObjectID( entry.latin1() ); @@ -615,10 +612,9 @@ QString SalomeApp_Study::referencedToEntry( const QString& entry ) const return LightApp_Study::referencedToEntry( entry ); } -//================================================================ -// Function : componentDataType -/*! Purpose : Return component data type from entry*/ -//================================================================ +/*! + \return component data type for entry +*/ QString SalomeApp_Study::componentDataType( const QString& entry ) const { _PTR(SObject) obj( studyDS()->FindObjectID( entry.latin1() ) ); @@ -627,20 +623,18 @@ QString SalomeApp_Study::componentDataType( const QString& entry ) const return obj->GetFatherComponent()->ComponentDataType().c_str(); } -//================================================================ -// Function : componentDataType -/*! Purpose : Return component data type from entry*/ -//================================================================ +/*! + \return true if entry corresponds to component +*/ bool SalomeApp_Study::isComponent( const QString& entry ) const { _PTR(SObject) obj( studyDS()->FindObjectID( entry.latin1() ) ); return obj && QString( obj->GetID().c_str() ) == obj->GetFatherComponent()->GetID().c_str(); } -//================================================================ -// Function : children -/*! Purpose : Return entries of children of object*/ -//================================================================ +/*! + \return entries of object children +*/ void SalomeApp_Study::children( const QString& entry, QStringList& child_entries ) const { _PTR(SObject) SO = studyDS()->FindObjectID( entry.latin1() ); @@ -654,6 +648,10 @@ void SalomeApp_Study::children( const QString& entry, QStringList& child_entries } } +/*! + Fills list with components names + \param comp - list to be filled +*/ void SalomeApp_Study::components( QStringList& comps ) const { for( _PTR(SComponentIterator) it ( studyDS()->NewComponentIterator() ); it->More(); it->Next() ) @@ -665,11 +663,9 @@ void SalomeApp_Study::components( QStringList& comps ) const } } -//================================================================ -// Function : getSavePoints -/*! Purpose : returns a list of saved points' IDs +/*! + \return a list of saved points' IDs */ -//================================================================ std::vector SalomeApp_Study::getSavePoints() { std::vector v; @@ -689,11 +685,9 @@ std::vector SalomeApp_Study::getSavePoints() return v; } -//================================================================ -// Function :removeSavePoint -/*! Purpose : remove a given save point +/*! + Removes a given save point */ -//================================================================ void SalomeApp_Study::removeSavePoint(int savePoint) { if(savePoint <= 0) return; @@ -703,11 +697,9 @@ void SalomeApp_Study::removeSavePoint(int savePoint) builder->RemoveObjectWithChildren(so); } -//================================================================ -// Function : getNameOfSavePoint -/*! Purpose : returns a name of save point +/*! + \return a name of save point */ -//================================================================ QString SalomeApp_Study::getNameOfSavePoint(int savePoint) { _PTR(AttributeParameter) AP = studyDS()->GetCommonParameters(getVisualComponentName(), savePoint); @@ -715,11 +707,9 @@ QString SalomeApp_Study::getNameOfSavePoint(int savePoint) return ip->getProperty("AP_SAVEPOINT_NAME"); } -//================================================================ -// Function : setNameOfSavePoint -/*! Purpose : sets a name of save point +/*! + Sets a name of save point */ -//================================================================ void SalomeApp_Study::setNameOfSavePoint(int savePoint, const QString& nameOfSavePoint) { _PTR(AttributeParameter) AP = studyDS()->GetCommonParameters(getVisualComponentName(), savePoint); @@ -727,21 +717,17 @@ void SalomeApp_Study::setNameOfSavePoint(int savePoint, const QString& nameOfSav ip->setProperty("AP_SAVEPOINT_NAME", nameOfSavePoint.latin1()); } -//================================================================ -// Function : getVisualComponentName -/*! Purpose : returns a name of the component where visual - * parameters are stored +/*! + \return a name of the component where visual parameters are stored */ -//================================================================ std::string SalomeApp_Study::getVisualComponentName() { return "Interface Applicative"; } -//================================================================ -// Function : updateModelRoot -/*! Purpose : slot called on change of a root of a data model. redefined from CAM_Study*/ -//================================================================ +/*! + Slot: called on change of a root of a data model. Redefined from CAM_Study +*/ void SalomeApp_Study::updateModelRoot( const CAM_DataModel* dm ) { LightApp_Study::updateModelRoot( dm ); diff --git a/src/SalomeApp/SalomeApp_VisualState.cxx b/src/SalomeApp/SalomeApp_VisualState.cxx index f4d53cf9b..88a0b888c 100644 --- a/src/SalomeApp/SalomeApp_VisualState.cxx +++ b/src/SalomeApp/SalomeApp_VisualState.cxx @@ -52,18 +52,16 @@ SalomeApp_VisualState::~SalomeApp_VisualState() { } -//================================================================ -// Function : nameViewWindows -/*! Purpose : set names of all view windows in given list. This is used -// in order to apply the same naming algorithm when saving and restoring -// view windows. Names of view windows must be the same before saving -// workstack (splitters) information, and before its restoring! -// Naming rule: ViewerType_IndexOfViewerOfThisType_IndexOfViewInThisViewer -// VTKViewer_0_0 -// OCCViewer_0_0 OCCViewer_0_1 OCCViewer_0_2 -// VTKViewer_1_0 +/*! + Sets names of all view windows in given list. This is used + in order to apply the same naming algorithm when saving and restoring + view windows. Names of view windows must be the same before saving + workstack (splitters) information, and before its restoring! + Naming rule: ViewerType_IndexOfViewerOfThisType_IndexOfViewInThisViewer + VTKViewer_0_0 + OCCViewer_0_0 OCCViewer_0_1 OCCViewer_0_2 + VTKViewer_1_0 */ -//================================================================ void nameViewWindows( const ViewManagerList& lst ) { QDict viewersCounter; // map viewerType - to - index_of_this_viewer_type @@ -90,11 +88,9 @@ void nameViewWindows( const ViewManagerList& lst ) } } -//================================================================ -// Function : storeState -/*! Purpose : store the visual parameters of the viewers +/*! + Stores the visual parameters of the viewers */ -//================================================================ int SalomeApp_VisualState::storeState() { SalomeApp_Study* study = dynamic_cast( myApp->activeStudy() ); @@ -170,11 +166,9 @@ int SalomeApp_VisualState::storeState() return savePoint; } -//================================================================ -// Function : restoreState -/*! Purpose : restore the visual parameters of the viewers +/*! + Restores the visual parameters of the viewers */ -//================================================================ void SalomeApp_VisualState::restoreState(int savePoint) { SalomeApp_Study* study = dynamic_cast( myApp->activeStudy() ); diff --git a/src/Session/InquireServersQThread.cxx b/src/Session/InquireServersQThread.cxx index 3a4b9ddd6..43bee4c5d 100755 --- a/src/Session/InquireServersQThread.cxx +++ b/src/Session/InquireServersQThread.cxx @@ -49,6 +49,9 @@ using namespace std; #define MARGIN_SIZE 5 #define SPACING_SIZE 3 +/*! + Constructor +*/ InquireServersGUI::InquireServersGUI() : QVBox(0, "SFA splash", Qt::WDestructiveClose | Qt::WStyle_Customize | Qt::WStyle_NoBorder | WType_TopLevel | WStyle_StaysOnTop | WX11BypassWM ) { @@ -148,6 +151,9 @@ void InquireServersGUI::setPixmap( QPixmap pix ) } } +/*! + Destructor +*/ InquireServersGUI::~InquireServersGUI() { delete myThread; @@ -159,10 +165,9 @@ void InquireServersGUI::getArgs( int& _argc, char *** _argv) *_argv = qApp->argv(); } -//================================================================================= -// function : ClickOnCancel() -// purpose : cancel loading of SALOME -//================================================================================= +/*! + Cancel loading of SALOME +*/ void InquireServersGUI::ClickOnCancel() { myThread->stop(); //it's necessary to stop asking servers @@ -209,6 +214,9 @@ int InquireServersGUI::getExitStatus() return myThread->getExitStatus(); } +/*! + Constructor +*/ InquireServersQThread::InquireServersQThread( InquireServersGUI* r ) : receiver(r), myExitStatus(0) { @@ -311,6 +319,9 @@ void InquireServersQThread::stop() myExitStatus = 1; } +/*! + Destructor +*/ InquireServersQThread::~InquireServersQThread() { } diff --git a/src/Session/InquireServersQThread.h b/src/Session/InquireServersQThread.h index b97bfd012..9aada570c 100755 --- a/src/Session/InquireServersQThread.h +++ b/src/Session/InquireServersQThread.h @@ -17,11 +17,10 @@ #define SALOME_WNT_EXPORT #endif -/********************************************************** -** Class: InquireEvent -** Descr: Contains QCustomEvents for posting to InquireServersQThread -** Level: Private -***********************************************************/ +/*! + \class InquireEvent + Contains QCustomEvents for posting to InquireServersQThread +*/ class SALOME_WNT_EXPORT InquireEvent : public QCustomEvent { public: diff --git a/src/Session/SalomeApp_Engine_i.cxx b/src/Session/SalomeApp_Engine_i.cxx index 27cc1cdd3..4fc9bbac8 100644 --- a/src/Session/SalomeApp_Engine_i.cxx +++ b/src/Session/SalomeApp_Engine_i.cxx @@ -38,11 +38,17 @@ using namespace std; SalomeApp_Engine_i* SalomeApp_Engine_i::myInstance = NULL; +/*! + Constructor +*/ SalomeApp_Engine_i::SalomeApp_Engine_i() { myInstance = this; } +/*! + Destructor +*/ SalomeApp_Engine_i::~SalomeApp_Engine_i() { } diff --git a/src/Session/Session_ServerLauncher.cxx b/src/Session/Session_ServerLauncher.cxx index 9cfd7b7cf..b73bebeab 100755 --- a/src/Session/Session_ServerLauncher.cxx +++ b/src/Session/Session_ServerLauncher.cxx @@ -31,23 +31,17 @@ #include "Utils_SALOME_Exception.hxx" #include "utilities.h" using namespace std; -//============================================================================= /*! - * default constructor not for use + default constructor not for use */ -//============================================================================= - Session_ServerLauncher::Session_ServerLauncher() { ASSERT(0); // must not be called } -//============================================================================= /*! - * constructor - */ -//============================================================================= - + constructor +*/ Session_ServerLauncher::Session_ServerLauncher(int argc, char ** argv, CORBA::ORB_ptr orb, @@ -70,22 +64,16 @@ Session_ServerLauncher::Session_ServerLauncher(int argc, start(); } -//============================================================================= /*! - * destructor - */ -//============================================================================= - + destructor +*/ Session_ServerLauncher::~Session_ServerLauncher() { } -//============================================================================= /*! - * Check args and activate servers - */ -//============================================================================= - + Check args and activate servers +*/ void Session_ServerLauncher::run() { // wait until main thread is ready @@ -111,12 +99,9 @@ void Session_ServerLauncher::run() _orb->run(); // this thread waits, during omniORB process events } -//============================================================================= /*! - * controls and dispatchs arguments given with command - */ -//============================================================================= - + controls and dispatchs arguments given with command +*/ void Session_ServerLauncher::CheckArgs() { int argState = 0; @@ -191,12 +176,6 @@ void Session_ServerLauncher::CheckArgs() throw SALOME_Exception(LOCALIZED("Error in command arguments, missing parenthesis ')'")); } -//============================================================================= -/*! - * - */ -//============================================================================= - void Session_ServerLauncher::ActivateAll() { list::iterator itServ; @@ -236,12 +215,9 @@ void Session_ServerLauncher::ActivateAll() aServerThread->Init(); } -//============================================================================= /*! - * Destruction des classes serveur dans l'ordre inverse de creation - */ -//============================================================================= - + Destruction des classes serveur dans l'ordre inverse de creation +*/ void Session_ServerLauncher::KillAll() { MESSAGE("Session_ServerLauncher::KillAll()"); diff --git a/src/Session/Session_ServerThread.cxx b/src/Session/Session_ServerThread.cxx index 8cec46993..9538b4de2 100755 --- a/src/Session/Session_ServerThread.cxx +++ b/src/Session/Session_ServerThread.cxx @@ -62,23 +62,17 @@ const char* Session_ServerThread::_serverTypes[NB_SRV_TYP] = {"Container", "SalomeAppEngine", "ContainerManager"}; -//============================================================================= /*! - * default constructor not for use - */ -//============================================================================= - + default constructor not for use +*/ Session_ServerThread::Session_ServerThread() { ASSERT(0); // must not be called } -//============================================================================= /*! - * constructor - */ -//============================================================================= - + constructor +*/ Session_ServerThread::Session_ServerThread(int argc, char ** argv, CORBA::ORB_ptr orb, @@ -94,24 +88,18 @@ Session_ServerThread::Session_ServerThread(int argc, // multi thread coherence problems } -//============================================================================= /*! - * destructor - */ -//============================================================================= - + destructor +*/ Session_ServerThread::~Session_ServerThread() { //MESSAGE("~Session_ServerThread "<< _argv[0]); } -//============================================================================= /*! - * run the thread : activate one servant, the servant type is given by - * argument _argv[0] - */ -//============================================================================= - + run the thread : activate one servant, the servant type is given by + argument _argv[0] +*/ void Session_ServerThread::Init() { MESSAGE("Session_ServerThread::Init "<< _argv[0]); @@ -184,12 +172,6 @@ void Session_ServerThread::Init() } } -//============================================================================= -/*! - * - */ -//============================================================================= - void Session_ServerThread::ActivateModuleCatalog(int argc, char ** argv) { @@ -229,12 +211,6 @@ void Session_ServerThread::ActivateModuleCatalog(int argc, } } -//============================================================================= -/*! - * - */ -//============================================================================= - void Session_ServerThread::ActivateSALOMEDS(int argc, char ** argv) { @@ -268,12 +244,6 @@ void Session_ServerThread::ActivateSALOMEDS(int argc, } } -//============================================================================= -/*! - * - */ -//============================================================================= - void Session_ServerThread::ActivateRegistry(int argc, char ** argv) { @@ -330,12 +300,6 @@ void Session_ServerThread::ActivateRegistry(int argc, } } -//============================================================================= -/*! - * - */ -//============================================================================= - void Session_ServerThread::ActivateContainerManager(int argc, char ** argv) { @@ -368,12 +332,6 @@ void Session_ServerThread::ActivateContainerManager(int argc, } } -//============================================================================= -/*! - * - */ -//============================================================================= - void Session_ServerThread::ActivateContainer(int argc, char ** argv) { @@ -458,12 +416,6 @@ void Session_ServerThread::ActivateContainer(int argc, } } -//============================================================================= -/*! - * - */ -//============================================================================= - void Session_ServerThread::ActivateEngine(int /*argc*/, char ** /*argv*/) { try @@ -491,18 +443,15 @@ void Session_ServerThread::ActivateEngine(int /*argc*/, char ** /*argv*/) } } -//============================================================================= -/*! - * - */ -//============================================================================= - void Session_ServerThread::ActivateSession(int argc, char ** argv) { MESSAGE("Session_ServerThread::ActivateSession() not implemented!"); } +/*! + constructor +*/ Session_SessionThread::Session_SessionThread(int argc, char** argv, CORBA::ORB_ptr orb, @@ -515,6 +464,9 @@ Session_SessionThread::Session_SessionThread(int argc, { } +/*! + destructor +*/ Session_SessionThread::~Session_SessionThread() { } diff --git a/src/Session/Session_Session_i.cxx b/src/Session/Session_Session_i.cxx index ebc51fd66..1e337b035 100755 --- a/src/Session/Session_Session_i.cxx +++ b/src/Session/Session_Session_i.cxx @@ -45,12 +45,9 @@ using namespace std; -//============================================================================= -/*! SALOME_Session_i - * constructor - */ -//============================================================================= - +/*! + constructor +*/ SALOME_Session_i::SALOME_Session_i(int argc, char ** argv, CORBA::ORB_ptr orb, @@ -69,12 +66,9 @@ SALOME_Session_i::SALOME_Session_i(int argc, //MESSAGE("constructor end"); } -//============================================================================= -/*! GetVisuComponent - * returns Visu component - */ -//============================================================================= - +/*! + returns Visu component +*/ Engines::Component_ptr SALOME_Session_i::GetComponent(const char* theLibraryName) { typedef Engines::Component_ptr TGetImpl(CORBA::ORB_ptr, @@ -87,24 +81,18 @@ Engines::Component_ptr SALOME_Session_i::GetComponent(const char* theLibraryName return Engines::Component::_nil(); } -//============================================================================= -/*! ~SALOME_Session_i - * destructor - */ -//============================================================================= - +/*! + destructor +*/ SALOME_Session_i::~SALOME_Session_i() { //MESSAGE("destructor end"); } -//============================================================================= -/*! NSregister - * tries to find the Corba Naming Service and to register the session, - * gives naming service interface to _IAPPThread - */ -//============================================================================= - +/*! + tries to find the Corba Naming Service and to register the session, + gives naming service interface to _IAPPThread +*/ void SALOME_Session_i::NSregister() { SALOME::Session_ptr pSession = SALOME::Session::_narrow(_this()); @@ -125,13 +113,10 @@ void SALOME_Session_i::NSregister() //MESSAGE("Session registered in Naming Service"); } -//============================================================================= -/*! GetInterface - * Launches the GUI if there is none. - * The Corba method is oneway (corba client does'nt wait for GUI completion) - */ -//============================================================================= - +/*! + Launches the GUI if there is none. + The Corba method is oneway (corba client does'nt wait for GUI completion) +*/ void SALOME_Session_i::GetInterface() { _GUIMutex->lock(); @@ -143,11 +128,9 @@ void SALOME_Session_i::GetInterface() } } -//============================================================================= -/*! StopSession - * Kills the session if there are no active studies nore GUI - */ -//============================================================================= +/*! + Kills the session if there are no active studies nore GUI +*/ class CloseEvent : public SALOME_Event { public: @@ -159,18 +142,18 @@ public: } }; +/*! + Processes event to close session +*/ void SALOME_Session_i::StopSession() { ProcessVoidEvent( new CloseEvent() ); } -//============================================================================= -/*! StatSession - * Send a SALOME::StatSession structure (see idl) to the client - * (number of running studies and presence of GUI) - */ -//============================================================================= - +/*! + Send a SALOME::StatSession structure (see idl) to the client + (number of running studies and presence of GUI) +*/ class QtLock { public: diff --git a/src/TOOLSGUI/ToolsGUI.cxx b/src/TOOLSGUI/ToolsGUI.cxx index ac2ca02a7..f83f45111 100755 --- a/src/TOOLSGUI/ToolsGUI.cxx +++ b/src/TOOLSGUI/ToolsGUI.cxx @@ -28,10 +28,9 @@ #include "ToolsGUI.h" -//======================================================================= -// name : GetVisibility -// Purpose : Verify whether object is visible or not -//======================================================================= +/*! + \return true if object is visible +*/ bool ToolsGUI::GetVisibility( _PTR(Study) theStudy, _PTR(SObject) theObj, void* theId ) @@ -46,10 +45,13 @@ bool ToolsGUI::GetVisibility( _PTR(Study) theStudy, return false; } -//======================================================================= -// name : SetVisibility -// Purpose : Set flag visibility of object -//======================================================================= +/*! + Set flag visibility of object + \param theStudy - study + \param theEntry - entry + \param theValue - flag visibility + \param theId - id +*/ bool ToolsGUI::SetVisibility( _PTR(Study) theStudy, const char* theEntry, const bool theValue, @@ -77,8 +79,3 @@ bool ToolsGUI::SetVisibility( _PTR(Study) theStudy, return false; } - - - - - diff --git a/src/TOOLSGUI/ToolsGUI_CatalogGeneratorDlg.cxx b/src/TOOLSGUI/ToolsGUI_CatalogGeneratorDlg.cxx index d06d2e0e3..4c93fa4da 100755 --- a/src/TOOLSGUI/ToolsGUI_CatalogGeneratorDlg.cxx +++ b/src/TOOLSGUI/ToolsGUI_CatalogGeneratorDlg.cxx @@ -59,10 +59,9 @@ using namespace std; #define MARGIN_SIZE 11 #define MIN_EDIT_SIZE 250 -//================================================================================= -// class : ToolsGUI_CatalogGeneratorDlg() -// purpose : Constructor -//================================================================================= +/*! + Constructor +*/ ToolsGUI_CatalogGeneratorDlg::ToolsGUI_CatalogGeneratorDlg( QWidget* parent, const char* name ) : QDialog( parent, name, TRUE, WStyle_Customize | WStyle_NormalBorder | WStyle_Title | WStyle_SysMenu ) { @@ -202,98 +201,88 @@ ToolsGUI_CatalogGeneratorDlg::ToolsGUI_CatalogGeneratorDlg( QWidget* parent, con updateButtonState(); } -//================================================================================= -// function : ~ToolsGUI_CatalogGeneratorDlg() -// purpose : destructor -//================================================================================= +/*! + destructor +*/ ToolsGUI_CatalogGeneratorDlg::~ToolsGUI_CatalogGeneratorDlg() { } -//================================================================================= -// function : getIdlFile() -// purpose : gets IDL file name entered -//================================================================================= +/*! + \return IDL file name entered +*/ QString ToolsGUI_CatalogGeneratorDlg::getIdlFile() { return myIdlEdit->text().stripWhiteSpace(); } -//================================================================================= -// function : getXmlFile() -// purpose : gets XML file name entered -//================================================================================= +/*! + \return XML file name entered +*/ QString ToolsGUI_CatalogGeneratorDlg::getXmlFile() { return myXmlEdit->text().stripWhiteSpace(); } -//================================================================================= -// function : getPngFile() -// purpose : gets PNG file name entered -//================================================================================= +/*! + \return PNG file name entered +*/ QString ToolsGUI_CatalogGeneratorDlg::getPngFile() { return myPngEdit->text().stripWhiteSpace(); } -//================================================================================= -// function : getAuthor() -// purpose : gets author -//================================================================================= +/*! + \return author +*/ QString ToolsGUI_CatalogGeneratorDlg::getAuthor() { return myAuthorEdit->text().stripWhiteSpace(); } -//================================================================================= -// function : getVersion() -// purpose : gets version number -//================================================================================= +/*! + \return version number +*/ QString ToolsGUI_CatalogGeneratorDlg::getVersion() { return myVersionEdit->text().stripWhiteSpace(); } -//================================================================================= -// function : getCompName() -// purpose : gets name of the component -//================================================================================= +/*! + \return name of the component +*/ QString ToolsGUI_CatalogGeneratorDlg::getCompName() { return myCompName->text().stripWhiteSpace(); } -//================================================================================= -// function : getCompUserName() -// purpose : gets username of the component -//================================================================================= +/*! + \return username of the component +*/ QString ToolsGUI_CatalogGeneratorDlg::getCompUserName() { return myCompUserName->text().stripWhiteSpace(); } -//================================================================================= -// function : getCompType() -// purpose : gets type of the component -//================================================================================= +/*! + \return type of the component +*/ QString ToolsGUI_CatalogGeneratorDlg::getCompMultiStd() { return myCompMultiStd->text().stripWhiteSpace(); } -//================================================================================= -// function : getComptype() -// purpose : gets type of the component -//================================================================================= + +/*! + \return type of the component +*/ QString ToolsGUI_CatalogGeneratorDlg::getCompType() { return myCompType->text().stripWhiteSpace(); } -//================================================================================= -// function : getIdlPath() -// purpose : gets IDL path of modules -//================================================================================= +/*! + \return IDL path of modules +*/ QString ToolsGUI_CatalogGeneratorDlg::getIdlPath() { cout << "QAD_Desktop::getCatalogue() is not implemented!!"; @@ -325,10 +314,9 @@ QString ToolsGUI_CatalogGeneratorDlg::getIdlPath() */ } -//================================================================================= -// function : onBrowseBtnClicked() -// purpose : <...> (Browse) buttons slot -//================================================================================= +/*! + SLOT: called on Browse button click +*/ void ToolsGUI_CatalogGeneratorDlg::onBrowseBtnClicked() { QPushButton* send = (QPushButton*)sender(); @@ -356,20 +344,18 @@ void ToolsGUI_CatalogGeneratorDlg::onBrowseBtnClicked() updateButtonState(); } -//================================================================================= -// function : updateButtonState() -// purpose : Updates button's state -//================================================================================= +/*! + Updates button's state +*/ void ToolsGUI_CatalogGeneratorDlg::updateButtonState() { myApplyBtn->setEnabled( !myIdlEdit->text().stripWhiteSpace().isEmpty() && !myXmlEdit->text().stripWhiteSpace().isEmpty() ); } -//================================================================================= -// function : onApply() -// purpose : button slot, performs IDL->XML conversion -//================================================================================= +/*! + button slot, performs IDL->XML conversion +*/ void ToolsGUI_CatalogGeneratorDlg::onApply() { QString IDLpath = getIdlPath(); diff --git a/src/TOOLSGUI/ToolsGUI_CatalogGeneratorDlg.h b/src/TOOLSGUI/ToolsGUI_CatalogGeneratorDlg.h index 5da0d5cc6..cf88f1417 100755 --- a/src/TOOLSGUI/ToolsGUI_CatalogGeneratorDlg.h +++ b/src/TOOLSGUI/ToolsGUI_CatalogGeneratorDlg.h @@ -36,10 +36,6 @@ class QLineEdit; class QPushButton; -//================================================================================= -// class : ToolsGUI_CatalogGeneratorDlg -// purpose : -//================================================================================= class Standard_EXPORT ToolsGUI_CatalogGeneratorDlg : public QDialog { Q_OBJECT diff --git a/src/TOOLSGUI/ToolsGUI_HelpWindow.cxx b/src/TOOLSGUI/ToolsGUI_HelpWindow.cxx index bd1ed427a..cb5ad63f5 100755 --- a/src/TOOLSGUI/ToolsGUI_HelpWindow.cxx +++ b/src/TOOLSGUI/ToolsGUI_HelpWindow.cxx @@ -36,6 +36,9 @@ using namespace std; +/*! + Constructor +*/ ToolsGUI_HelpWindow::ToolsGUI_HelpWindow(QWidget* parent, const char* name ) : QMainWindow( parent, name, WType_TopLevel | WDestructiveClose ) { diff --git a/src/TOOLSGUI/ToolsGUI_IntervalWindow.cxx b/src/TOOLSGUI/ToolsGUI_IntervalWindow.cxx index 04d96c00a..4e122af79 100755 --- a/src/TOOLSGUI/ToolsGUI_IntervalWindow.cxx +++ b/src/TOOLSGUI/ToolsGUI_IntervalWindow.cxx @@ -20,8 +20,11 @@ #define SPACING_SIZE 6 #define MIN_SPIN_WIDTH 100 +/*! + Constructor +*/ ToolsGUI_IntervalWindow::ToolsGUI_IntervalWindow ( QWidget* parent ) - : QDialog( parent, "ToolsGUI_IntervalWindow" , true, WStyle_Customize | WStyle_NormalBorder | WStyle_Title | WStyle_SysMenu | WDestructiveClose ) +: QDialog( parent, "ToolsGUI_IntervalWindow" , true, WStyle_Customize | WStyle_NormalBorder | WStyle_Title | WStyle_SysMenu | WDestructiveClose ) { BEGIN_OF("ToolsGUI_IntervalWindow constructor") setCaption( tr( "Refresh Interval" ) ); @@ -73,8 +76,13 @@ ToolsGUI_IntervalWindow::ToolsGUI_IntervalWindow ( QWidget* parent ) END_OF("ToolsGUI_IntervalWindow constructor") } + +/*! + Destructor +*/ ToolsGUI_IntervalWindow::~ToolsGUI_IntervalWindow() {} -/* + +/*! Sets start interval size */ void ToolsGUI_IntervalWindow::setValue(const int size) @@ -82,24 +90,24 @@ void ToolsGUI_IntervalWindow::setValue(const int size) mySpinBox->setValue(size); } -/* - Gets interval size +/*! + \return interval size */ int ToolsGUI_IntervalWindow::getValue() { return mySpinBox->value(); } -/* - gets a pointer to myButtonOk +/*! + \return a pointer to myButtonOk */ QPushButton* ToolsGUI_IntervalWindow::Ok() { return myButtonOk; } -/* - gets a pointer to myButtonCancel +/*! + \return a pointer to myButtonCancel */ QPushButton* ToolsGUI_IntervalWindow::Cancel() { diff --git a/src/TOOLSGUI/ToolsGUI_RegWidget.cxx b/src/TOOLSGUI/ToolsGUI_RegWidget.cxx index 481aa64a3..4692797f5 100755 --- a/src/TOOLSGUI/ToolsGUI_RegWidget.cxx +++ b/src/TOOLSGUI/ToolsGUI_RegWidget.cxx @@ -577,6 +577,9 @@ void ToolsGUI_RegWidget::slotSelectRefresh() END_OF("slotSelectRefresh"); } +/*! + SLOT: called when IntervalWindow's OK button is clicked +*/ void ToolsGUI_RegWidget::slotIntervalOk() { BEGIN_OF("slotIntervalOk"); diff --git a/src/VTKViewer/VTKViewer_Actor.cxx b/src/VTKViewer/VTKViewer_Actor.cxx index d171c8572..5181ccd07 100755 --- a/src/VTKViewer/VTKViewer_Actor.cxx +++ b/src/VTKViewer/VTKViewer_Actor.cxx @@ -60,11 +60,11 @@ int VTKViewer_POINT_SIZE = 5; int VTKViewer_LINE_WIDTH = 3; -//---------------------------------------------------------------------------- vtkStandardNewMacro(VTKViewer_Actor); - -//---------------------------------------------------------------------------- +/*! + Constructor +*/ VTKViewer_Actor ::VTKViewer_Actor(): myIsHighlighted(false), @@ -86,8 +86,9 @@ VTKViewer_Actor myPassFilter.push_back(VTKViewer_PassThroughFilter::New()); } - -//---------------------------------------------------------------------------- +/*! + Destructor +*/ VTKViewer_Actor ::~VTKViewer_Actor() { @@ -104,8 +105,9 @@ VTKViewer_Actor myProperty->Delete(); } - -//---------------------------------------------------------------------------- +/*! + \return name +*/ const char* VTKViewer_Actor ::getName() @@ -113,6 +115,10 @@ VTKViewer_Actor return myName.c_str(); } +/*! + Sets name + \param theName - new name +*/ void VTKViewer_Actor ::setName(const char* theName) @@ -120,8 +126,9 @@ VTKViewer_Actor myName = theName; } - -//---------------------------------------------------------------------------- +/*! + To publish the actor an all its internal devices +*/ void VTKViewer_Actor ::AddToRender(vtkRenderer* theRenderer) @@ -129,6 +136,9 @@ VTKViewer_Actor theRenderer->AddActor(this); } +/*! + To remove the actor an all its internal devices +*/ void VTKViewer_Actor ::RemoveFromRender(vtkRenderer* theRenderer) @@ -136,13 +146,18 @@ VTKViewer_Actor theRenderer->RemoveActor(this); } +/*! + Used to obtain all dependent actors +*/ void VTKViewer_Actor ::GetChildActors(vtkActorCollection*) {} - -//---------------------------------------------------------------------------- +/*! + Apply view transformation + \param theTransform - view transformation +*/ void VTKViewer_Actor ::SetTransform(VTKViewer_Transform* theTransform) @@ -151,6 +166,9 @@ VTKViewer_Actor } +/*! + To insert some additional filters and then sets the given #vtkMapper +*/ void VTKViewer_Actor ::SetMapper(vtkMapper* theMapper) @@ -158,6 +176,9 @@ VTKViewer_Actor InitPipeLine(theMapper); } +/*! + Initialization +*/ void VTKViewer_Actor ::InitPipeLine(vtkMapper* theMapper) @@ -192,8 +213,9 @@ VTKViewer_Actor Superclass::SetMapper(theMapper); } - -//---------------------------------------------------------------------------- +/*! + Renders actor +*/ void VTKViewer_Actor ::Render(vtkRenderer *ren, vtkMapper* m) @@ -222,7 +244,10 @@ VTKViewer_Actor } } - +/*! + Set ResolveCoincidentTopology flag + \param theIsResolve - new flag value +*/ void VTKViewer_Actor ::SetResolveCoincidentTopology(bool theIsResolve) @@ -230,6 +255,10 @@ VTKViewer_Actor myIsResolveCoincidentTopology = theIsResolve; } +/*! + Set polygon offset parameters + \param factor, units - Opengl polygon offset parameters +*/ void VTKViewer_Actor ::SetPolygonOffsetParameters(vtkFloatingPointType factor, @@ -239,6 +268,10 @@ VTKViewer_Actor myPolygonOffsetUnits = units; } +/*! + Get polygon offset parameters + \param factor, units - Opengl polygon offset parameters +*/ void VTKViewer_Actor ::GetPolygonOffsetParameters(vtkFloatingPointType& factor, @@ -248,8 +281,9 @@ VTKViewer_Actor units = myPolygonOffsetUnits; } - -//---------------------------------------------------------------------------- +/*! + \return shrink factor +*/ vtkFloatingPointType VTKViewer_Actor ::GetShrinkFactor() @@ -257,6 +291,9 @@ VTKViewer_Actor return 1.0; } +/*! + \return true if the actor is shrunkable +*/ bool VTKViewer_Actor ::IsShrunkable() @@ -264,6 +301,9 @@ VTKViewer_Actor return false; } +/*! + \return true if the actor is shrunk +*/ bool VTKViewer_Actor ::IsShrunk() @@ -271,18 +311,25 @@ VTKViewer_Actor return false; } +/*! + Insert shrink filter into pipeline +*/ void VTKViewer_Actor ::SetShrink() {} +/*! + Remove shrink filter from pipeline +*/ void VTKViewer_Actor ::UnShrink() {} - -//---------------------------------------------------------------------------- +/*! + Allows to get initial #vtkDataSet +*/ vtkDataSet* VTKViewer_Actor ::GetInput() @@ -290,7 +337,9 @@ VTKViewer_Actor return myPassFilter.front()->GetOutput(); } - +/*! + To calculatate last modified time +*/ unsigned long int VTKViewer_Actor ::GetMTime() @@ -305,8 +354,10 @@ VTKViewer_Actor return mTime; } - -//---------------------------------------------------------------------------- +/*! + Set representation (VTK_SURFACE, VTK_POINTS, VTK_WIREFRAME and so on) + param theMode - new mode +*/ void VTKViewer_Actor ::SetRepresentation(int theMode) @@ -360,6 +411,9 @@ VTKViewer_Actor myRepresentation = theMode; } +/*! + \return current representation mode +*/ int VTKViewer_Actor ::GetRepresentation() @@ -367,8 +421,9 @@ VTKViewer_Actor return myRepresentation; } - -//---------------------------------------------------------------------------- +/*! + Maps VTK index of a node to corresponding object index +*/ int VTKViewer_Actor ::GetNodeObjId(int theVtkID) @@ -376,6 +431,9 @@ VTKViewer_Actor return theVtkID; } +/*! + Get coordinates of a node for given object index +*/ vtkFloatingPointType* VTKViewer_Actor ::GetNodeCoord(int theObjID) @@ -383,6 +441,9 @@ VTKViewer_Actor return GetInput()->GetPoint(theObjID); } +/*! + Get corresponding #vtkCell for given object index +*/ vtkCell* VTKViewer_Actor ::GetElemCell(int theObjID) @@ -390,6 +451,9 @@ VTKViewer_Actor return GetInput()->GetCell(theObjID); } +/*! + Maps VTK index of a cell to corresponding object index +*/ int VTKViewer_Actor ::GetElemObjId(int theVtkID) @@ -398,11 +462,9 @@ VTKViewer_Actor } -//================================================================================= -// function : GetObjDimension -// purpose : Return object dimension. -// Virtual method shoulb be redifined by derived classes -//================================================================================= +/*! + \return object dimension. Virtual method should be redifined by derived classes +*/ int VTKViewer_Actor ::GetObjDimension( const int theObjId ) @@ -412,7 +474,10 @@ VTKViewer_Actor return 0; } - +/*! + Infinitive means actor without size (point for example), + which is not taken into account in calculation of boundaries of the scene +*/ void VTKViewer_Actor ::SetInfinitive(bool theIsInfinite) @@ -420,7 +485,9 @@ VTKViewer_Actor myIsInfinite = theIsInfinite; } - +/*! + \return infinive flag +*/ bool VTKViewer_Actor ::IsInfinitive() @@ -442,7 +509,9 @@ VTKViewer_Actor return false; } - +/*! + \return current bounding box +*/ vtkFloatingPointType* VTKViewer_Actor ::GetBounds() @@ -451,6 +520,9 @@ VTKViewer_Actor } +/*! + \return current bounding box +*/ void VTKViewer_Actor ::GetBounds(vtkFloatingPointType theBounds[6]) @@ -459,7 +531,6 @@ VTKViewer_Actor } -//---------------------------------------------------------------------------- bool VTKViewer_Actor ::IsSetCamera() const @@ -485,7 +556,7 @@ VTKViewer_Actor ::SetCamera( vtkCamera* ) {} -//---------------------------------------------------------------------------- + void VTKViewer_Actor ::SetOpacity(vtkFloatingPointType theOpacity) @@ -502,6 +573,9 @@ VTKViewer_Actor } +/*! + Change color +*/ void VTKViewer_Actor ::SetColor(vtkFloatingPointType r, @@ -511,6 +585,9 @@ VTKViewer_Actor GetProperty()->SetColor(r,g,b); } +/*! + Change color +*/ void VTKViewer_Actor ::SetColor(const vtkFloatingPointType theRGB[3]) @@ -518,6 +595,9 @@ VTKViewer_Actor SetColor(theRGB[0],theRGB[1],theRGB[2]); } +/*! + Get color +*/ void VTKViewer_Actor ::GetColor(vtkFloatingPointType& r, @@ -532,7 +612,9 @@ VTKViewer_Actor } -//---------------------------------------------------------------------------- +/*! + \return display mode +*/ int VTKViewer_Actor ::getDisplayMode() @@ -540,6 +622,9 @@ VTKViewer_Actor return myDisplayMode; } +/*! + Change display mode +*/ void VTKViewer_Actor ::setDisplayMode(int theMode) @@ -549,7 +634,9 @@ VTKViewer_Actor } -//---------------------------------------------------------------------------- +/*! + \return true if the descendant of the VTKViewer_Actor will implement its own highlight or not +*/ bool VTKViewer_Actor ::hasHighlight() @@ -557,6 +644,9 @@ VTKViewer_Actor return false; } +/*! + \return true if the VTKViewer_Actor is already highlighted +*/ bool VTKViewer_Actor ::isHighlighted() @@ -564,6 +654,9 @@ VTKViewer_Actor return myIsHighlighted; } +/*! + Set preselection mode +*/ void VTKViewer_Actor ::SetPreSelected(bool thePreselect) @@ -571,8 +664,9 @@ VTKViewer_Actor myIsPreselected = thePreselect; } - -//---------------------------------------------------------------- +/*! + Just to update visibility of the highlight devices +*/ void VTKViewer_Actor ::highlight(bool theIsHighlight) diff --git a/src/VTKViewer/VTKViewer_AppendFilter.cxx b/src/VTKViewer/VTKViewer_AppendFilter.cxx index 222d2f1ab..34967f086 100644 --- a/src/VTKViewer/VTKViewer_AppendFilter.cxx +++ b/src/VTKViewer/VTKViewer_AppendFilter.cxx @@ -109,10 +109,6 @@ VTKViewer_AppendFilter } -//================================================================== -// function: DoMapping -// purpose : -//================================================================== void VTKViewer_AppendFilter ::DoMapping() @@ -138,7 +134,6 @@ VTKViewer_AppendFilter } } -//--------------------------------------------------------------- namespace { inline @@ -170,7 +165,6 @@ VTKViewer_AppendFilter } -//--------------------------------------------------------------- vtkIdType VTKViewer_AppendFilter ::GetCellOutputID(vtkIdType theInputID, @@ -183,7 +177,6 @@ VTKViewer_AppendFilter } -//--------------------------------------------------------------- namespace { void @@ -238,7 +231,6 @@ VTKViewer_AppendFilter } -//--------------------------------------------------------------- void VTKViewer_AppendFilter ::GetCellInputID(vtkIdType theOutputID, @@ -254,7 +246,6 @@ VTKViewer_AppendFilter } -//--------------------------------------------------------------- void VTKViewer_AppendFilter ::MakeOutput() diff --git a/src/VTKViewer/VTKViewer_ConvexTool.cxx b/src/VTKViewer/VTKViewer_ConvexTool.cxx index a709d20c2..5e0ede055 100644 --- a/src/VTKViewer/VTKViewer_ConvexTool.cxx +++ b/src/VTKViewer/VTKViewer_ConvexTool.cxx @@ -44,7 +44,6 @@ #include #include -//---------------------------------------------------------------------------- namespace { typedef std::vector TConnectivities; @@ -72,7 +71,9 @@ namespace typedef std::vector TPolygons; } -//---------------------------------------------------------------------------- +/*! + Constructor +*/ VTKViewer_Triangulator ::VTKViewer_Triangulator(): myInput(NULL), @@ -84,7 +85,9 @@ VTKViewer_Triangulator {} -//---------------------------------------------------------------------------- +/*! + Destructor +*/ VTKViewer_Triangulator ::~VTKViewer_Triangulator() { @@ -92,7 +95,7 @@ VTKViewer_Triangulator } -//---------------------------------------------------------------------------- + bool VTKViewer_Triangulator ::Execute(vtkUnstructuredGrid *theInput, @@ -391,21 +394,23 @@ VTKViewer_Triangulator return true; } -//---------------------------------------------------------------------------- +/*! + Constructor +*/ VTKViewer_OrderedTriangulator ::VTKViewer_OrderedTriangulator(): myCell(vtkGenericCell::New()) {} - -//---------------------------------------------------------------------------- +/*! + Destructor +*/ VTKViewer_OrderedTriangulator ::~VTKViewer_OrderedTriangulator() { myCell->Delete(); } -//---------------------------------------------------------------------------- vtkPoints* VTKViewer_OrderedTriangulator ::InitPoints() @@ -466,7 +471,9 @@ VTKViewer_OrderedTriangulator return thePntId; } -//---------------------------------------------------------------------------- +/*! + Constructor +*/ VTKViewer_DelaunayTriangulator ::VTKViewer_DelaunayTriangulator(): myUnstructuredGrid(vtkUnstructuredGrid::New()), @@ -482,7 +489,10 @@ VTKViewer_DelaunayTriangulator } -//---------------------------------------------------------------------------- + +/*! + Destructor +*/ VTKViewer_DelaunayTriangulator ::~VTKViewer_DelaunayTriangulator() { @@ -494,7 +504,6 @@ VTKViewer_DelaunayTriangulator } -//---------------------------------------------------------------------------- vtkPoints* VTKViewer_DelaunayTriangulator ::InitPoints() diff --git a/src/VTKViewer/VTKViewer_ConvexTool.h b/src/VTKViewer/VTKViewer_ConvexTool.h index 02feafe41..356d5f623 100644 --- a/src/VTKViewer/VTKViewer_ConvexTool.h +++ b/src/VTKViewer/VTKViewer_ConvexTool.h @@ -37,7 +37,6 @@ class vtkPoints; class vtkIdList; class vtkCell; -//---------------------------------------------------------------------------- class VTKVIEWER_EXPORT VTKViewer_Triangulator { public: @@ -103,7 +102,6 @@ class VTKVIEWER_EXPORT VTKViewer_Triangulator }; -//---------------------------------------------------------------------------- class VTKVIEWER_EXPORT VTKViewer_OrderedTriangulator : public VTKViewer_Triangulator { public: @@ -150,7 +148,6 @@ class VTKVIEWER_EXPORT VTKViewer_OrderedTriangulator : public VTKViewer_Triangul }; -//---------------------------------------------------------------------------- class VTKVIEWER_EXPORT VTKViewer_DelaunayTriangulator : public VTKViewer_Triangulator { public: diff --git a/src/VTKViewer/VTKViewer_GeometryFilter.cxx b/src/VTKViewer/VTKViewer_GeometryFilter.cxx index fa43f9b39..5c8cbf1af 100755 --- a/src/VTKViewer/VTKViewer_GeometryFilter.cxx +++ b/src/VTKViewer/VTKViewer_GeometryFilter.cxx @@ -60,7 +60,6 @@ //#define USE_ROBUST_TRIANGULATION -//---------------------------------------------------------------------------- vtkCxxRevisionMacro(VTKViewer_GeometryFilter, "$Revision$"); vtkStandardNewMacro(VTKViewer_GeometryFilter); @@ -77,7 +76,6 @@ VTKViewer_GeometryFilter {} -//---------------------------------------------------------------------------- void VTKViewer_GeometryFilter ::Execute() @@ -98,7 +96,6 @@ VTKViewer_GeometryFilter } -//---------------------------------------------------------------------------- void VTKViewer_GeometryFilter ::UnstructuredGridExecute() @@ -759,7 +756,6 @@ VTKViewer_GeometryFilter } -//---------------------------------------------------------------------------- void VTKViewer_GeometryFilter ::SetInside(int theShowInside) @@ -779,7 +775,6 @@ VTKViewer_GeometryFilter } -//---------------------------------------------------------------------------- void VTKViewer_GeometryFilter ::SetWireframeMode(int theIsWireframeMode) @@ -799,7 +794,6 @@ VTKViewer_GeometryFilter } -//---------------------------------------------------------------------------- void VTKViewer_GeometryFilter ::SetStoreMapping(int theStoreMapping) @@ -819,7 +813,6 @@ VTKViewer_GeometryFilter } -//---------------------------------------------------------------------------- vtkIdType VTKViewer_GeometryFilter::GetElemObjId(int theVtkID){ if(myVTK2ObjIds.empty() || theVtkID > myVTK2ObjIds.size()) return -1; #if defined __GNUC_2__ diff --git a/src/VTKViewer/VTKViewer_InteractorStyle.cxx b/src/VTKViewer/VTKViewer_InteractorStyle.cxx index b4937f9e7..c40cf8d90 100644 --- a/src/VTKViewer/VTKViewer_InteractorStyle.cxx +++ b/src/VTKViewer/VTKViewer_InteractorStyle.cxx @@ -84,10 +84,10 @@ static int GetEdgeId(vtkPicker *thePicker, SALOME_Actor *theActor, int theObjId) return anEdgeId; } */ -//---------------------------------------------------------------------------- + vtkStandardNewMacro(VTKViewer_InteractorStyle); -//---------------------------------------------------------------------------- + /*!Constructor.*/ VTKViewer_InteractorStyle::VTKViewer_InteractorStyle() { @@ -106,14 +106,14 @@ VTKViewer_InteractorStyle::VTKViewer_InteractorStyle() OnSelectionModeChanged(); } -//---------------------------------------------------------------------------- + /*!Destructor.*/ VTKViewer_InteractorStyle::~VTKViewer_InteractorStyle() { m_ViewWnd->RemoveActor(myPreSelectionActor); } -//---------------------------------------------------------------------------- + /*!Set preselection properties. *\param theRed - red color. *\param theGreen - green color. @@ -130,7 +130,7 @@ void VTKViewer_InteractorStyle::setPreselectionProp(const double& theRed, const myPreSelectionActor->GetProperty()->SetPointSize(theWidth); } -//---------------------------------------------------------------------------- + /*!Set render window interactor *\param theInteractor - interactor. */ @@ -139,7 +139,7 @@ void VTKViewer_InteractorStyle::SetInteractor(vtkRenderWindowInteractor *theInte Superclass::SetInteractor(theInteractor); } -//---------------------------------------------------------------------------- + /*!Set view window. *\param theViewWnd - SALOME VTKViewer_ViewWindow */ @@ -149,7 +149,7 @@ void VTKViewer_InteractorStyle::setViewWnd(VTKViewer_ViewWindow* theViewWnd ){ myPreSelectionActor->Delete(); } -//---------------------------------------------------------------------------- + /*!Set GUI window. *\param theWindow - QWidget window. */ @@ -157,15 +157,14 @@ void VTKViewer_InteractorStyle::setGUIWindow(QWidget* theWindow){ myGUIWindow = theWindow; } -//---------------------------------------------------------------------------- -/*!Set triedron. + +/*!Set trihedron. *\param theTrihedron - SALOME VTKViewer_Trihedron */ void VTKViewer_InteractorStyle::setTriedron(VTKViewer_Trihedron* theTrihedron){ m_Trihedron = theTrihedron; } -//---------------------------------------------------------------------------- /*!Rotate camera. *\param dx - *\param dy - @@ -197,7 +196,6 @@ void VTKViewer_InteractorStyle::RotateXY(int dx, int dy) myGUIWindow->update(); } -//---------------------------------------------------------------------------- void VTKViewer_InteractorStyle::PanXY(int x, int y, int oldX, int oldY) { TranslateView(x, y, oldX, oldY); @@ -206,7 +204,6 @@ void VTKViewer_InteractorStyle::PanXY(int x, int y, int oldX, int oldY) } -//---------------------------------------------------------------------------- /*! Move the position of the camera along the direction of projection. (dx,dy)*/ void VTKViewer_InteractorStyle::DollyXY(int dx, int dy) { @@ -229,8 +226,6 @@ void VTKViewer_InteractorStyle::DollyXY(int dx, int dy) myGUIWindow->update(); } -//---------------------------------------------------------------------------- -/*!*/ void VTKViewer_InteractorStyle::SpinXY(int x, int y, int oldX, int oldY) { vtkCamera *cam; @@ -257,7 +252,6 @@ void VTKViewer_InteractorStyle::SpinXY(int x, int y, int oldX, int oldY) } -//---------------------------------------------------------------------------- /*!On mouse move event. *\param ctrl - CTRL (not used) *\param shift - SHIFT (on/off - integer 0/1) @@ -276,7 +270,6 @@ void VTKViewer_InteractorStyle::OnMouseMove(int vtkNotUsed(ctrl), } -//---------------------------------------------------------------------------- /*!On Left button down event. *\param ctrl - CTRL (on/off - integer 0/1) *\param shift - SHIFT (on/off - integer 0/1) @@ -313,7 +306,6 @@ void VTKViewer_InteractorStyle::OnLeftButtonDown(int ctrl, int shift, } -//---------------------------------------------------------------------------- /*!On left button up event. *\param ctrl - CTRL (not used) *\param shift - SHIFT (on/off - integer 0/1) @@ -334,7 +326,6 @@ void VTKViewer_InteractorStyle::OnLeftButtonUp(int vtkNotUsed(ctrl), } -//---------------------------------------------------------------------------- /*!On left button up event. *\param ctrl - CTRL (on/off - integer 0/1) *\param shift - SHIFT (on/off - integer 0/1) @@ -372,7 +363,6 @@ void VTKViewer_InteractorStyle::OnMiddleButtonDown(int ctrl, } -//---------------------------------------------------------------------------- /*!On middle button up event. *\param ctrl - CTRL (not used) *\param shift - SHIFT (on/off - integer 0/1) @@ -393,7 +383,6 @@ void VTKViewer_InteractorStyle::OnMiddleButtonUp(int vtkNotUsed(ctrl), } -//---------------------------------------------------------------------------- /*!On right button down event. *\param ctrl - CTRL (on/off - integer 0/1) *\param shift - SHIFT (on/off - integer 0/1) @@ -430,7 +419,6 @@ void VTKViewer_InteractorStyle::OnRightButtonDown(int ctrl, } } -//---------------------------------------------------------------------------- /*!On right button up event. *\param ctrl - CTRL (not used) *\param shift - SHIFT (on/off - integer 0/1) @@ -450,8 +438,7 @@ void VTKViewer_InteractorStyle::OnRightButtonUp(int vtkNotUsed(ctrl), } } -//---------------------------------------------------------------------------- -/** @name XPM - x pixmaps. */ +/*! @name XPM - x pixmaps. */ //@{ /*!Image Zoom cursor*/ const char* imageZoomCursor[] = { @@ -532,7 +519,6 @@ const char* imageRotateCursor[] = { "................................"}; //@} -//---------------------------------------------------------------------------- /*! Loads cursors for viewer operations - zoom, pan, etc...*/ void VTKViewer_InteractorStyle::loadCursors() { @@ -547,7 +533,6 @@ void VTKViewer_InteractorStyle::loadCursors() } -//---------------------------------------------------------------------------- /*! event filter - controls mouse and keyboard events during viewer operations*/ bool VTKViewer_InteractorStyle::eventFilter(QObject* object, QEvent* event) { @@ -561,7 +546,6 @@ bool VTKViewer_InteractorStyle::eventFilter(QObject* object, QEvent* event) } -//---------------------------------------------------------------------------- /*! starts Zoom operation (e.g. through menu command)*/ void VTKViewer_InteractorStyle::startZoom() { @@ -576,7 +560,6 @@ void VTKViewer_InteractorStyle::startZoom() } -//---------------------------------------------------------------------------- /*! starts Pan operation (e.g. through menu command)*/ void VTKViewer_InteractorStyle::startPan() { @@ -590,7 +573,6 @@ void VTKViewer_InteractorStyle::startPan() qApp->installEventFilter(this); } -//---------------------------------------------------------------------------- /*! starts Rotate operation (e.g. through menu command)*/ void VTKViewer_InteractorStyle::startRotate() { @@ -605,7 +587,6 @@ void VTKViewer_InteractorStyle::startRotate() } -//---------------------------------------------------------------------------- /*! starts Spin operation (e.g. through menu command)*/ void VTKViewer_InteractorStyle::startSpin() { @@ -621,7 +602,6 @@ void VTKViewer_InteractorStyle::startSpin() -//---------------------------------------------------------------------------- /*! starts Fit Area operation (e.g. through menu command)*/ void VTKViewer_InteractorStyle::startFitArea() { @@ -636,7 +616,6 @@ void VTKViewer_InteractorStyle::startFitArea() } -//---------------------------------------------------------------------------- /*!View fit all.*/ void VTKViewer_InteractorStyle::ViewFitAll() { int aTriedronWasVisible = false; @@ -658,7 +637,6 @@ void VTKViewer_InteractorStyle::ViewFitAll() { } -//---------------------------------------------------------------------------- /*! starts Global Panning operation (e.g. through menu command)*/ void VTKViewer_InteractorStyle::startGlobalPan() { @@ -682,7 +660,6 @@ void VTKViewer_InteractorStyle::startGlobalPan() } -//---------------------------------------------------------------------------- /*!\retval TRUE if needs redrawing*/ bool VTKViewer_InteractorStyle::needsRedrawing() { @@ -694,7 +671,6 @@ bool VTKViewer_InteractorStyle::needsRedrawing() } -//---------------------------------------------------------------------------- /*! fits viewer contents to rectangle *\param left - left side *\param top - top side @@ -733,7 +709,6 @@ void VTKViewer_InteractorStyle::fitRect(const int left, } -//---------------------------------------------------------------------------- /*! starts viewer operation (!internal usage!)*/ void VTKViewer_InteractorStyle::startOperation(int operation) { @@ -762,7 +737,6 @@ void VTKViewer_InteractorStyle::startOperation(int operation) } -//---------------------------------------------------------------------------- /*! sets proper cursor for window when viewer operation is activated*/ void VTKViewer_InteractorStyle::setCursor(const int operation) { @@ -803,7 +777,6 @@ void VTKViewer_InteractorStyle::setCursor(const int operation) } -//---------------------------------------------------------------------------- /*! called when viewer operation started (!put necessary initialization here!)*/ void VTKViewer_InteractorStyle::onStartOperation() { @@ -830,7 +803,6 @@ void VTKViewer_InteractorStyle::onStartOperation() } -//---------------------------------------------------------------------------- /*! called when viewer operation finished (!put necessary post-processing here!)*/ void VTKViewer_InteractorStyle::onFinishOperation() { diff --git a/src/VTKViewer/VTKViewer_RectPicker.cxx b/src/VTKViewer/VTKViewer_RectPicker.cxx index 698a54b3e..ed9c9d8d8 100755 --- a/src/VTKViewer/VTKViewer_RectPicker.cxx +++ b/src/VTKViewer/VTKViewer_RectPicker.cxx @@ -49,16 +49,16 @@ using namespace std; -//---------------------------------------------------------------------------- + vtkStandardNewMacro(VTKViewer_RectPicker); -//---------------------------------------------------------------------------- + /*!Constructor. Do nothing*/ VTKViewer_RectPicker::VTKViewer_RectPicker() { } -//---------------------------------------------------------------------------- + /*!Perform pick operation with selection rectangle provided. Normally the * first two values for the selection top-left and right-bottom points are * x-y pixel coordinate, and the third value is =0. @@ -428,7 +428,7 @@ char GetIntersectionPoint(const float start[3], const float end[3], return result; } -//---------------------------------------------------------------------------- + /*! Bounding box intersection with hexahedron. Origin[4][4] starts the ray from corner points, * dir[4][3] is the vector components of the ray in the x-y-z directions. * (Notes: the intersection ray dir[4][3] is NOT normalized.) @@ -725,7 +725,6 @@ char VTKViewer_RectPicker::HitBBox (float bounds[6], float origin[4][4], float d return inside; } -//---------------------------------------------------------------------------- /*! Position of point relative to hexahedron. p1[4][4] is the corner points of top face, * p2[4][4] is the corner points of bottom face. * \retval The method returns a non-zero value, if the point is inside. @@ -851,7 +850,6 @@ char VTKViewer_RectPicker::PointInside (float p[3], float p1[4][4], float p2[4][ return inside; } -//---------------------------------------------------------------------------- float VTKViewer_RectPicker::IntersectWithHex(float p1[4][4], float p2[4][4], float tol, vtkAssemblyPath *path, vtkProp3D *prop3D, vtkAbstractMapper3D *mapper) diff --git a/src/VTKViewer/VTKViewer_RenderWindowInteractor.cxx b/src/VTKViewer/VTKViewer_RenderWindowInteractor.cxx index dd97fad54..2c15afb72 100755 --- a/src/VTKViewer/VTKViewer_RenderWindowInteractor.cxx +++ b/src/VTKViewer/VTKViewer_RenderWindowInteractor.cxx @@ -118,6 +118,11 @@ VTKViewer_RenderWindowInteractor::~VTKViewer_RenderWindowInteractor() myPointPicker->Delete(); } +/*! + Print interactor to stream + \param os - stream + \param indent +*/ void VTKViewer_RenderWindowInteractor::PrintSelf(ostream& os, vtkIndent indent) { vtkRenderWindowInteractor::PrintSelf(os, indent) ; @@ -214,34 +219,6 @@ void VTKViewer_RenderWindowInteractor::SetInteractorStyle(vtkInteractorObserver vtkRenderWindowInteractor::SetInteractorStyle(theInteractor); } - -/* -void VTKViewer_RenderWindowInteractor::SetSelectionMode(Selection_Mode theMode) -{ - myCellActor->SetVisibility(false); - myEdgeActor->SetVisibility(false); - myPointActor->SetVisibility(false); - - switch(theMode){ - case ActorSelection: - this->SetPicker(myBasicPicker); - break; - case NodeSelection: - this->SetPicker(myPointPicker); - break; - case CellSelection: - case EdgeSelection: - case FaceSelection: - case VolumeSelection: - case EdgeOfCellSelection: - this->SetPicker(myCellPicker); - break; - } - - myInteractorStyle->OnSelectionModeChanged(); -} -*/ - /*!Sets selection properties. *\param theRed - red component of color *\param theGreen - green component of color @@ -351,8 +328,9 @@ int VTKViewer_RenderWindowInteractor::CreateTimer(int vtkNotUsed(timertype)) return 1 ; } -/**@see CreateTimer(int ) - *\retval 1 +/*! + \sa CreateTimer(int ) + \retval 1 */ int VTKViewer_RenderWindowInteractor::DestroyTimer(void) { @@ -623,6 +601,9 @@ void VTKViewer_RenderWindowInteractor::Display( VTKViewer_Actor* theActor, bool emit RenderWindowModified(); } +/*! + default key press event (empty implementation) +*/ void VTKViewer_RenderWindowInteractor::KeyPressed(QKeyEvent *event) { /// NOT_IMPLEMENTED diff --git a/src/VTKViewer/VTKViewer_Trihedron.cxx b/src/VTKViewer/VTKViewer_Trihedron.cxx index 0a61d395e..daf3997d5 100755 --- a/src/VTKViewer/VTKViewer_Trihedron.cxx +++ b/src/VTKViewer/VTKViewer_Trihedron.cxx @@ -44,6 +44,9 @@ VTKViewer_UnScaledActor::VTKViewer_UnScaledActor() Bounds[1] = Bounds[3] = Bounds[5] = -VTK_LARGE_FLOAT; } +/*! + \return bounding box +*/ vtkFloatingPointType* VTKViewer_UnScaledActor ::GetBounds() @@ -105,6 +108,9 @@ void VTKViewer_LineActor::Render(vtkRenderer *theRenderer) vtkFollower::Render(theRenderer); } +/*! + Constructor +*/ VTKViewer_Axis::VTKViewer_Axis() { /*! \li Initialize the Line pipe-line representation*/ @@ -153,6 +159,9 @@ VTKViewer_Axis::VTKViewer_Axis() myVisibility = VTKViewer_Trihedron::eOn; } +/*! + Destructor +*/ VTKViewer_Axis::~VTKViewer_Axis() { /*! \li Destroy of the Label pipe-line representation */ @@ -180,6 +189,9 @@ VTKViewer_Axis::~VTKViewer_Axis() myLineSource->Delete(); } +/*! Add to renderer + * \param theRenderer - vtkRenderer pointer + */ void VTKViewer_Axis::AddToRender(vtkRenderer* theRenderer){ /*! \li Order of the calls are important*/ theRenderer->AddActor(myLineActor); @@ -187,6 +199,9 @@ void VTKViewer_Axis::AddToRender(vtkRenderer* theRenderer){ theRenderer->AddActor(myArrowActor); } +/*! Remove actor of acis from \a theRenderer which are in myPresent. + * \param theRenderer - vtkRenderer pointer + */ void VTKViewer_Axis::RemoveFromRender(vtkRenderer* theRenderer){ /*! \li Order of the calls are important*/ theRenderer->RemoveActor(myLineActor); @@ -194,6 +209,7 @@ void VTKViewer_Axis::RemoveFromRender(vtkRenderer* theRenderer){ theRenderer->RemoveActor(myArrowActor); } +/*! Sets visibility for all Axis to \a theVis*/ void VTKViewer_Axis::SetVisibility(VTKViewer_Trihedron::TVisibility theVis) { switch(theVis){ @@ -214,17 +230,22 @@ void VTKViewer_Axis::SetVisibility(VTKViewer_Trihedron::TVisibility theVis) myVisibility = theVis; } -//**************************************************************** +/*! Set camera for myLabelActor + */ void VTKViewer_Axis::SetCamera(vtkCamera* theCamera){ myLabelActor->SetCamera(theCamera); } +/*! Sets \a theProperty for actors: myLineActor,myLabelActor,myArrowActor + */ void VTKViewer_Axis::SetProperty(vtkProperty* theProperty){ myLabelActor->SetProperty(theProperty); myArrowActor->SetProperty(theProperty); myLineActor->SetProperty(theProperty); } +/*! Set size of VTKViewer_Axis + */ void VTKViewer_Axis::SetSize(vtkFloatingPointType theSize) { vtkFloatingPointType aPosition[3] = {myDir[0]*theSize, myDir[1]*theSize, myDir[2]*theSize}; @@ -319,6 +340,9 @@ VTKViewer_ZAxis::VTKViewer_ZAxis() vtkStandardNewMacro(VTKViewer_Trihedron); +/*! + Constructor +*/ VTKViewer_Trihedron::VTKViewer_Trihedron() { myPresent = vtkActorCollection::New(); @@ -329,6 +353,9 @@ VTKViewer_Trihedron::VTKViewer_Trihedron() SetSize(aSize); } +/*! + Destructor +*/ VTKViewer_Trihedron::~VTKViewer_Trihedron() { myPresent->RemoveAllItems(); @@ -337,6 +364,8 @@ VTKViewer_Trihedron::~VTKViewer_Trihedron() myAxis[i]->Delete(); } +/*! Set size of axes + */ void VTKViewer_Trihedron::SetSize(vtkFloatingPointType theSize) { mySize = theSize; @@ -344,17 +373,25 @@ void VTKViewer_Trihedron::SetSize(vtkFloatingPointType theSize) myAxis[i]->SetSize(theSize); } +/*! Set visibility of axes + */ void VTKViewer_Trihedron::SetVisibility(TVisibility theVis) { for(int i = 0; i < 3; i++) myAxis[i]->SetVisibility(theVis); } +/*! + \return visibility of first axis +*/ VTKViewer_Trihedron::TVisibility VTKViewer_Trihedron::GetVisibility() { return myAxis[0]->GetVisibility(); } +/*! Add to render all Axis + * \param theRenderer - vtkRenderer pointer + */ void VTKViewer_Trihedron::AddToRender(vtkRenderer* theRenderer) { vtkCamera* aCamera = theRenderer->GetActiveCamera(); @@ -364,6 +401,9 @@ void VTKViewer_Trihedron::AddToRender(vtkRenderer* theRenderer) } } +/*! Remove all actors from \a theRenderer which are in myPresent. + * \param theRenderer - vtkRenderer pointer + */ void VTKViewer_Trihedron::RemoveFromRender(vtkRenderer* theRenderer) { myPresent->InitTraversal(); @@ -373,6 +413,9 @@ void VTKViewer_Trihedron::RemoveFromRender(vtkRenderer* theRenderer) myAxis[i]->RemoveFromRender(theRenderer); } +/*! Return count of visible actors. + * \param theRenderer - vtkRenderer pointer + */ int VTKViewer_Trihedron::GetVisibleActorCount(vtkRenderer* theRenderer) { //TVisibility aVis = GetVisibility(); diff --git a/src/VTKViewer/VTKViewer_Trihedron.h b/src/VTKViewer/VTKViewer_Trihedron.h index 56e790205..b92cf02f6 100755 --- a/src/VTKViewer/VTKViewer_Trihedron.h +++ b/src/VTKViewer/VTKViewer_Trihedron.h @@ -111,7 +111,6 @@ protected: VTKViewer_UnScaledActor* ArrowActor; }; -//**************************************************************** /*!This class provide support trihedron object in vtk viewer.*/ class VTKVIEWER_EXPORT VTKVIEWER_EXPORT VTKViewer_Trihedron : public vtkObject { @@ -185,7 +184,6 @@ protected: vtkFloatingPointType mySize; }; -//**************************************************************** /*!The base class for concreate Axis. * Its only duty is to give correct initialization and destruction * of its pipe-lines diff --git a/src/VTKViewer/VTKViewer_VectorText.cxx b/src/VTKViewer/VTKViewer_VectorText.cxx index b4e62266a..31ea54391 100755 --- a/src/VTKViewer/VTKViewer_VectorText.cxx +++ b/src/VTKViewer/VTKViewer_VectorText.cxx @@ -1751,6 +1751,11 @@ void VTKViewer_VectorText::Execute() newPolys->Delete(); } +/*! + Print text to stream + \param os - stream + \param indent +*/ void VTKViewer_VectorText::PrintSelf(ostream& os, vtkIndent indent) { this->Superclass::PrintSelf(os,indent); diff --git a/src/VTKViewer/VTKViewer_ViewWindow.cxx b/src/VTKViewer/VTKViewer_ViewWindow.cxx index b61b62cd7..44eef236b 100755 --- a/src/VTKViewer/VTKViewer_ViewWindow.cxx +++ b/src/VTKViewer/VTKViewer_ViewWindow.cxx @@ -580,7 +580,7 @@ QString VTKViewer_ViewWindow::getVisualParameters() return retStr; } -/* The method restors visual parameters of this view from a formated string +/*! The method restors visual parameters of this view from a formated string */ void VTKViewer_ViewWindow::setVisualParameters( const QString& parameters ) {