Update version to 3.2.0a1

[modules/gui.git] / src / GLViewer / GLViewer_ViewPort.h

diff --git a/src/GLViewer/GLViewer_ViewPort.h b/src/GLViewer/GLViewer_ViewPort.h
index 397a84326f1ce41c131f6e63941638930fc26378..02ef4edaf21a7867e8c2282f98173387d32b9f0d 100644 (file)
--- a/src/GLViewer/GLViewer_ViewPort.h
+++ b/src/GLViewer/GLViewer_ViewPort.h
@@ -1,13 +1,31 @@
+//  Copyright (C) 2005 OPEN CASCADE
+//
+//  This library is free software; you can redistribute it and/or
+//  modify it under the terms of the GNU Lesser General Public
+//  License as published by the Free Software Foundation; either
+//  version 2.1 of the License.
+//
+//  This library is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+//  Lesser General Public License for more details.
+//
+//  You should have received a copy of the GNU Lesser General Public
+//  License along with this library; if not, write to the Free Software
+//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+//  See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
+//
+//  Author : OPEN CASCADE
+//
+
 // File:      GLViewer_ViewPort.h
 // Created:   November, 2004
-// Author:    OCC team
-// Copyright (C) CEA 2004
 
 /***************************************************************************
 **  Class:   GLViewer_ViewPort
-**  Descr:   Visualisation canvas of QAD-based application
-**  Module:  QAD
-**  Created: UI team, 05.09.00
+**  Descr:   Visualisation canvas of GLViewer
+**  Created: UI team, 05.09.04
 ****************************************************************************/
 #ifndef GLVIEWER_VIEWPORT_H
 #define GLVIEWER_VIEWPORT_H
@@ -39,7 +57,11 @@ enum BlockStatus
     BS_Dragging         = 0x0004
 };
 
-class GLVIEWER_EXPORT GLViewer_ViewPort: public QWidget//, public QAD_PopupServer
+/*! 
+ * Class GLViewer_ViewPort
+ * Visualisation canvas of GLViewer
+ */
+class GLVIEWER_API GLViewer_ViewPort: public QWidget
 {
     Q_OBJECT
     friend class GLViewer_ViewSketcher;
@@ -50,18 +72,27 @@ public:
     ~GLViewer_ViewPort();
 
 public:
+    //! Activates/deactivates sketching
     void                             setSketchingEnabled( bool );
+    //! Checks active status of sketcher
     bool                             isSketchingEnabled() const;
+    //! Activates/deactivates transformer
     void                             setTransformEnabled( bool );
+    //! Checks active status of transformer
     bool                             isTransformEnabled() const;
 
+    //! Returns background color
     virtual QColor                   backgroundColor() const;
+    //! Sets background color
     virtual void                     setBackgroundColor( const QColor& );
 
+    //! Redraw external pa inters
     void                             redrawPainters();
 
+    //! Updates view
     virtual void                     onUpdate();
 
+    //! Returns blocking status for current started operations
     virtual BlockStatus              currentBlock(){ return BS_NoBlock; }
 
 protected:
@@ -71,7 +102,7 @@ protected:
     virtual QPaintDevice*            getPaintDevice() { return this; }
     virtual void                     contextMenuEvent( QContextMenuEvent * e );
 
-// STATICS
+//! STATICS
     static void                      createCursors();
     static void                      destroyCursors();
     static QCursor*                  getHandCursor() { return handCursor; }
@@ -92,7 +123,7 @@ public://ouv
     static void                      setSketchCursor( const QCursor& newCursor );
 
 protected:
-// EVENTS
+//! EVENTS
     virtual void                     paintEvent( QPaintEvent *);
     virtual void                     mouseMoveEvent( QMouseEvent *);
     virtual void                     mouseReleaseEvent( QMouseEvent *);
@@ -102,7 +133,7 @@ protected:
     virtual void                     keyReleaseEvent( QKeyEvent *);
     virtual void                     wheelEvent( QWheelEvent *);
 
-// TO BE REDEFINED
+//! TO BE REDEFINED
     virtual void                     reset() = 0;
     virtual void                     pan( int, int ) = 0;
     virtual void                     setCenter( int, int ) = 0;    
@@ -111,11 +142,6 @@ protected:
     virtual void                     fitSelect() = 0;
     virtual void                     fitAll( bool keepScale = false, bool withZ = true ) = 0;
 
-// POPUP
-    virtual void                     onCreatePopup() {}
-    virtual void                     onCreatePopup( QPopupMenu* );
-    virtual void                     onDestroyPopup( QPopupMenu* );
-
 protected slots:
     virtual void                     onChangeBgColor();
 
@@ -124,7 +150,8 @@ signals:
     void                             vpMouseEvent( QMouseEvent* );
     void                             vpWheelEvent( QWheelEvent* );
     void                             vpDrawExternal( QPainter* );
-    void                             contextMenuRequested( QContextMenuEvent *e );
+
+    void                             contextMenuRequested( QContextMenuEvent* );
 
 private:
     void                             initialize();