include/EDoc/StdErrFunctionProgress.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_STDERRFUNCTIONPROGRESS_H
#define EDOC_STDERRFUNCTIONPROGRESS_H

#include "EDoc/ProgressIFace.h"

namespace EDoc
{
   //===========================================================================
   /** \brief Displays a progress indication for functions being processed to
    * stderr.
    *
    * This will display the progress to stderr in a format like:
    *
    * xxx/yyy : FunctionName
    *
    */
   class StdErrFunctionProgress : public FunctionProgressIFace
   {
   public:

      //------------------------------------------------------------------------
      /** \brief See ProgressIFace::Start()
       */
      virtual void Start(size_t total);

      //------------------------------------------------------------------------
      /** \brief See ProgressIFace::Progress()
       */
      virtual void Progress(Function* data);

      //------------------------------------------------------------------------

   public:
   
      size_t current;
      size_t total;
   };
   //===========================================================================
}

#endif // EDOC_STDERRFUNCTIONPROGRESS_H

---