include/EDoc/ProgressIFace.h

Go to the documentation of this file.

/*******************************************************************************

   Copyright (C) 2007 by Brendon Costa

   This library is free software; you can redistribute it and/or modify 
   it under the terms of the "LGPL Like" License defined in the file COPYING 
   that should have been distributed along with this source.

   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.  

   You should have received a copy of the "LGPL Like" License 
   along with this library; see the file COPYING. if not, it can be 
   obtained from the EDoc++ website: 
   http://edoc.sourceforge.net/license.html

*******************************************************************************/
#ifndef EDOC_PROGRESSIFACE_H
#define EDOC_PROGRESSIFACE_H

#include "EDoc/stdint.h"

namespace EDoc
{
   //===========================================================================
   /** \brief Interface used for giving progress indication on a task.
    */
   template <typename T>
   class ProgressIFace
   {
   public:

      //------------------------------------------------------------------------
      /** \brief Destructor.
       */
      virtual ~ProgressIFace() {}

      //------------------------------------------------------------------------
      /** \brief Called to start the progress indication.
       *
       * \param total indicates the total number of times that the 
       * Progress() function will be called to reach 100% progress.
       */
      virtual void Start(size_t total) = 0;

      //------------------------------------------------------------------------
      /** \brief Called each time some progress is made that is to be 
       * shown to the user.
       *
       * Note: This must be called exactly total number of times, where
       * total is the value passed to the Start() function.
       */
      virtual void Progress(T* data) = 0;

      //------------------------------------------------------------------------
   };
   //===========================================================================
   class Function;
   typedef ProgressIFace<Function> FunctionProgressIFace;
   typedef FunctionProgressIFace* FunctionProgressIFacePtr;
}

#endif // EDOC_PROGRESSIFACE_H

---