pmeter.h Source File

00001 /*
00002     Copyright (C) 2001 by Jorrit Tyberghein
00003 
00004     This library is free software; you can redistribute it and/or
00005     modify it under the terms of the GNU Library General Public
00006     License as published by the Free Software Foundation; either
00007     version 2 of the License, or (at your option) any later version.
00008 
00009     This library is distributed in the hope that it will be useful,
00010     but WITHOUT ANY WARRANTY; without even the implied warranty of
00011     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00012     Library General Public License for more details.
00013 
00014     You should have received a copy of the GNU Library General Public
00015     License along with this library; if not, write to the Free
00016     Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
00017 */
00018 
00019 #ifndef __IVARIA_PMETER_H__
00020 #define __IVARIA_PMETER_H__
00021 
00022 #include <stdarg.h>
00023 #include "csutil/scf.h"
00024 
00025 SCF_VERSION (iProgressMeter, 0, 0, 1);
00026 
00032 struct iProgressMeter : public iBase
00033 {
00038   virtual void SetProgressDescription (const char* id,
00039         const char* description, ...) CS_GNUC_PRINTF (3, 4) = 0;
00040 
00045   virtual void SetProgressDescriptionV (const char* id,
00046         const char* description, va_list) = 0;
00047 
00052   virtual void Step () = 0;
00054   virtual void Reset () = 0;
00056   virtual void Restart () = 0;
00058   virtual void Abort () = 0;
00060   virtual void Finalize () = 0;
00061 
00063   virtual void SetTotal (int n) = 0;
00065   virtual int GetTotal () const = 0;
00067   virtual int GetCurrent () const = 0;
00068 
00075   virtual void SetGranularity (int) = 0;
00077   virtual int GetGranularity () const = 0;
00078 };
00079 
00080 #endif // __IVARIA_PMETER_H__
00081