ivaria/pmeter.h Source File (Crystal Space 2.0 Public API Reference)

| ## Public API Reference

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

ivaria/pmeter.h
Go to the documentation of this 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 __CS_IVARIA_PMETER_H__
    00020 #define __CS_IVARIA_PMETER_H__
    00021
    00026 #include "csutil/scf_interface.h"
    00027
    00033 struct iProgressMeter : public virtual iBase
    00034 {
    00035   SCF_INTERFACE(iProgressMeter, 2,0,0);
    00041   virtual void SetProgressDescription (const char* id,
    00042         const char* description, ...) CS_GNUC_PRINTF (3, 4) = 0;
    00043
    00049   virtual void SetProgressDescriptionV (const char* id,
    00050         const char* description, va_list) = 0;
    00051
    00056   virtual void Step (unsigned int n = 1) = 0;
    00058   virtual void Reset () = 0;
    00060   virtual void Restart () = 0;
    00062   virtual void Abort () = 0;
    00064   virtual void Finalize () = 0;
    00065
    00067   virtual void SetTotal (int n) = 0;
    00069   virtual int GetTotal () const = 0;
    00071   virtual int GetCurrent () const = 0;
    00072
    00079   virtual void SetGranularity (int) = 0;
    00081   virtual int GetGranularity () const = 0;
    00082 };
    00083
    00084 #endif // __CS_IVARIA_PMETER_H__
    00085