Branch data     Line data    Source code

       1                 :            : //- Class: ProgressTool
       2                 :            : //- Description: interface for displaying progress on a process
       3                 :            : //- Created: 11/6/01
       4                 :            : //- Checked By:
       5                 :            : //- Version:
       6                 :            : 
       7                 :            : #ifndef PROGRESSTOOL_HPP
       8                 :            : #define PROGRESSTOOL_HPP
       9                 :            : 
      10                 :            : #include "CubitDefines.h"
      11                 :            : #include "CGMUtilConfigure.h"
      12                 :            : 
      13                 :        874 : class CUBIT_UTIL_EXPORT ProgressTool
      14                 :            : {
      15                 :            : public:
      16         [ #  # ]:          0 :   virtual ~ProgressTool() {}
      17                 :            : 
      18                 :            :   virtual void start(int nLower, int nUpper,
      19                 :            :                const char* title = NULL,
      20                 :            :                const char* info_string = NULL,
      21                 :            :                CubitBoolean bSmooth = CUBIT_TRUE,
      22                 :            :                CubitBoolean bHasCancelButton = CUBIT_FALSE) = 0;
      23                 :            : 
      24                 :            :   virtual void end() = 0;
      25                 :            : 
      26                 :            :   virtual void step() = 0;
      27                 :            :   // move the control bar one integer step based on nLower and nUpper
      28                 :            : 
      29                 :            :   virtual void percent( double pcnt ) = 0;
      30                 :            :   // move the control bar to a specified percent
      31                 :            :   // pcnt should be between 0 and 1
      32                 :            : 
      33                 :            :   virtual void check_interrupt() = 0;
      34                 :            :   // callback to allow the progress tool to check for interrupt
      35                 :            : };
      36                 :            : 
      37                 :            : #endif
      38                 :            : 
      39                 :            : //EOF
      40                 :            :