A sample of how to insert links into the main doc page to files, classes, functions...

[modules/paravis.git] / src / PVGUI / PVGUI_Module.h

diff --git a/src/PVGUI/PVGUI_Module.h b/src/PVGUI/PVGUI_Module.h
index 56efb877f24cf28845ae7eb38c0201bcdaab4e91..ba573470fde78904e49d7844728f40932247b4fa 100644 (file)
--- a/src/PVGUI/PVGUI_Module.h
+++ b/src/PVGUI/PVGUI_Module.h
@@ -23,12 +23,44 @@
 // Author : Sergey ANIKIN
 //
 
+/*!
+  \mainpage
+
+  Insert the content of introduction page here.
+
+  A link to the file documentation PVGUI_Module_actions.cxx
+
+  A link to the file documentation PVGUI_Module_impl.h
+
+  A link to the class documentation PVGUI_Module
+
+  The class name as a text (not a link to its documentation) %PVGUI_Module
+
+  A link to the constructor of the class PVGUI_ViewWindow#PVGUI_ViewWindow or PVGUI_Module::PVGUI_Module()
+
+  A link to the destructor of the class PVGUI_ViewWindow#~PVGUI_ViewWindow
+
+  A link to the member function PVGUI_ViewWindow::getVisualParameters or PVGUI_ViewWindow#getVisualParameters
+
+  Arguments of a function should be specified only for the overloaded functions PVGUI_Module::initialize(CAM_Application*)
+
+  A link to some enumeration values PVGUI_Module::OpenFileId and PVGUI_Module::CreateLookmarkId
+
+  A link to a protected member variable of the class PVGUI_ViewWindow#myModel
+
+  A link to a variable \link PVGUI_ViewWindow#myModel using another text\endlink as a link
+
+*/
+
 #ifndef PVGUI_Module_H
 #define PVGUI_Module_H
 
 #include <LightApp_Module.h>
 
+#include <ostream.h>
+
 class QMenu;
+class QDockWidget;
 class LightApp_Selection;
 class LightApp_SelectionMgr;
 class PVGUI_ProcessModuleHelper;
@@ -164,6 +196,12 @@ public:
 
   pqViewManager*         getMultiViewManager() const;
 
+  virtual bool           eventFilter( QObject*, QEvent* );
+
+  //! Compares the contents of the window with the given reference image, returns true if they "match" within some tolerance
+  bool                   compareView( const QString& ReferenceImage, double Threshold,
+                                     ostream& Output, const QString& TempDirectory );
+
 protected:
   //virtual CAM_DataModel* createDataModel();
 
@@ -174,7 +212,6 @@ private:
   static void            pvShutdown();   
  
   //! Create actions for ParaView GUI operations
-  //! duplicating menus and toolbars in pqMainWindow ParaView class
   void                   pvCreateActions();
 
   //! Create menus for ParaView GUI operations
@@ -191,6 +228,12 @@ private:
   //! Create dock widgets context menus
   void                   setupDockWidgetsContextMenu();
 
+  //! Save states of dockable ParaView widgets
+  void                   saveDockWidgetsState();
+
+  //! Restore states of dockable ParaView widgets
+  void                   restoreDockWidgetsState();
+
   //! Shows or hides ParaView view window
   void                   showView( bool );    
 
@@ -235,6 +278,10 @@ private:
   pqImplementation*      Implementation;
 
   int                    mySelectionControlsTb;
+  int                    mySourcesMenuId;
+  int                    myFiltersMenuId;
+
+  QList<QDockWidget*>    myDockWidgets;
 };
 
 #endif // PVGUI_Module_H