DFCH: ManualPaint + imageUndoRedo: Undo/Redo functionality its now working =) =)

[creaMaracasVisu.git] / lib / maracasVisuLib / src / interface / wxWindows / widgets / imageUndoRedo / imageDequeUR.h

diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/imageDequeUR.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/imageDequeUR.h
index ee8e7e8b3f8efb0572666976b2207f2dceb737e5..69cf80a435b1dc37f49bf7058d8905b36dcf3129 100755 (executable)
--- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/imageDequeUR.h
+++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/imageUndoRedo/imageDequeUR.h
@@ -1,8 +1,9 @@
-/*
- * ImageDeque.h
- *
- *  Created on: Sep 22, 2011
- *      Author: caceres
+/*!
+ * @file       imageDequeUR.h
+ * @brief      This file contains the Image3DDequeUR class. -- Abstract class
+ * @author     Info-Dev
+ * @author     Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
+ * @date       2011-11-15
  */
 
 #ifndef IMAGEDEQUE_H_
@@ -11,27 +12,83 @@
 #include <iostream>
 #include <string>
 #include <deque>
-//EED-11/11/2011  comment for windows compilation//   #include <unistd.h>
 #include <vtkImageData.h>
 #include <vtkSmartPointer.h>
 #include "imageInfoUR.h"
 #include "imageModificationManager.h"
 
+/*! @class ImageDequeUR imageDequeUR.h "imageDequeUR.cxx"
+ *     @brief This class contains the management of the undo/redo - Abstract Class
+ */
 class ImageDequeUR {
 public:
-       typedef std::deque<ImageInfoUR*> ImageInfoDeque;
+       //typedef definition
+       // ----------------------------------------------------------------------------------
+       /*!     @typedef vtkSmartPointer<vtkImageData> VTKImageDataPointerType;
+        *      @brief Defines the pointer of vtkImageDate type.
+        */
        typedef vtkSmartPointer<vtkImageData> VTKImageDataPointerType;
+       // ----------------------------------------------------------------------------------
+       /*!     @typedef std::string StringType;
+        *      @brief Redefinition of the string type.
+        */
        typedef std::string StringType;
+       // ----------------------------------------------------------------------------------
+       /*!     @typedef ImageMManager ImageMManagerType;
+        *      @brief Definition of the ImageMManager type.
+        */
        typedef ImageMManager ImageMManagerType;
+       // ----------------------------------------------------------------------------------
 public:
+       // ----------------------------------------------------------------------------------
+       /*! @fn ImageDequeUR();
+        * @brief This is the default constructor.
+        */
        ImageDequeUR();
+       // ----------------------------------------------------------------------------------
+       /*! @fn virtual ~ImageDequeUR();
+        * @brief This is the destructor.
+        */
        virtual ~ImageDequeUR();
+       // ----------------------------------------------------------------------------------
+       /*! @fn virtual void AddImagesToURContainer(VTKImageDataPointerType imgUndo,
+        VTKImageDataPointerType imgRedo, ImageMManager* imMManager);
+        * @brief This method adds the images for undo and redo in a container
+        * @param imgUndo The undoImage cropped.
+        * @param imgRedo The redoImage cropped.
+        * @param imManager The image manager.
+        */
        virtual void AddImagesToURContainer(VTKImageDataPointerType imgUndo,
                        VTKImageDataPointerType imgRedo, ImageMManager* imMManager);
+       // ----------------------------------------------------------------------------------
+       /*! @fn virtual void CleanURContainerFromIndex(const int& index);
+        * @brief This method allows to clean the container from a given index.
+        * @param index The index.
+        */
        virtual void CleanURContainerFromIndex(const int& index);
+       // ----------------------------------------------------------------------------------
+       /*! @fn virtual void ManageMemory();
+        * @brief This method cleans the memory.
+        * @details This method cleans the principal memory when the images are not in use.
+        */
        virtual void ManageMemory();
+       // ----------------------------------------------------------------------------------
+       /*! @fn virtual ImageInfoUR* Undo();
+        * @brief This method is the undo action.
+        * @return
+        */
        virtual ImageInfoUR* Undo();
+       // ----------------------------------------------------------------------------------
+       /*! @fn virtual ImageInfoUR* Redo();
+        * @brief This method is the redo action.
+        * @return
+        */
        virtual ImageInfoUR* Redo();
+       // ----------------------------------------------------------------------------------
+       /*! @fn void SetGlobalPath(const StringType& globalPath);
+        * @brief This method sets the global path where the temporary files will be stored.
+        * @param globalPath The String with the path.
+        */
 };
 
 #endif /* IMAGEDEQUE_H_ */