CrystalSpace

Public API Reference

Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

pmeter.h

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 __CS_IVARIA_PMETER_H__
00020 #define __CS_IVARIA_PMETER_H__
00021 
00022 #include "csutil/scf.h"
00023 
00024 SCF_VERSION (iProgressMeter, 0, 1, 0);
00025 
00031 struct iProgressMeter : public iBase
00032 {
00038   virtual void SetProgressDescription (const char* id,
00039         const char* description, ...) CS_GNUC_PRINTF (3, 4) = 0;
00040 
00046   virtual void SetProgressDescriptionV (const char* id,
00047         const char* description, va_list) = 0;
00048 
00053   virtual void Step (unsigned int n = 1) = 0;
00055   virtual void Reset () = 0;
00057   virtual void Restart () = 0;
00059   virtual void Abort () = 0;
00061   virtual void Finalize () = 0;
00062 
00064   virtual void SetTotal (int n) = 0;
00066   virtual int GetTotal () const = 0;
00068   virtual int GetCurrent () const = 0;
00069 
00076   virtual void SetGranularity (int) = 0;
00078   virtual int GetGranularity () const = 0;
00079 };
00080 
00081 #endif // __CS_IVARIA_PMETER_H__
00082 

Generated for Crystal Space by doxygen 1.4.4