NCBI C++ ToolKit
reporter.hpp
Go to the documentation of this file.

Go to the SVN repository for this file.

1 #ifndef GUI_UTILS___REPORTER__HPP
2 #define GUI_UTILS___REPORTER__HPP
3 
4 /* $Id: reporter.hpp 14562 2007-05-18 11:48:21Z dicuccio $
5  * ===========================================================================
6  *
7  * PUBLIC DOMAIN NOTICE
8  * National Center for Biotechnology Information
9  *
10  * This software/database is a "United States Government Work" under the
11  * terms of the United States Copyright Act. It was written as part of
12  * the author's official duties as a United States Government employee and
13  * thus cannot be copyrighted. This software/database is freely available
14  * to the public for use. The National Library of Medicine and the U.S.
15  * Government have not placed any restriction on its use or reproduction.
16  *
17  * Although all reasonable efforts have been taken to ensure the accuracy
18  * and reliability of the software and data, the NLM and the U.S.
19  * Government do not and cannot warrant the performance or results that
20  * may be obtained by using this software or data. The NLM and the U.S.
21  * Government disclaim all warranties, express or implied, including
22  * warranties of performance, merchantability or fitness for any particular
23  * purpose.
24  *
25  * Please cite the author in any work or product based on this material.
26  *
27  * ===========================================================================
28  *
29  * Authors: Mike DiCuccio
30  *
31  * File Description:
32  *
33  */
34 
35 #include <corelib/ncbistd.hpp>
36 
37 /** @addtogroup GUI_UTILS
38  *
39  * @{
40  */
41 
42 
44 
45 
46 class IReporter
47 {
48 public:
49 
50  virtual ~IReporter() { }
51 
52  // set the current reporter message
53  virtual void SetMessage(const string& msg) = 0;
54 
55  // set the current percent completed
56  virtual void SetPctCompleted(int pct) = 0;
57 
58  // clear any cached messages
59  virtual void Clear(void) = 0;
60 
61  // an asynchronous cancel mechanism
62  virtual bool HasBeenCanceled(void) const { return false; }
63 
64 };
65 
66 
67 
69 
70 /* @} */
71 
72 #endif // GUI_UTILS___REPORTER__HPP
Include a standard set of the NCBI C++ Toolkit most basic headers.
virtual void Clear(void)=0
virtual void SetMessage(const string &msg)=0
virtual ~IReporter()
Definition: reporter.hpp:50
virtual bool HasBeenCanceled(void) const
Definition: reporter.hpp:62
virtual void SetPctCompleted(int pct)=0
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition: ncbistl.hpp:103
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition: ncbistl.hpp:100
Modified on Sun Apr 14 05:25:37 2024 by modify_doxy.py rev. 669887