reporter.hpp

ncbi源码

/*
 * ===========================================================================
 * PRODUCTION $Log: reporter.hpp,v $
 * PRODUCTION Revision 1000.2  2004/06/01 19:51:15  gouriano
 * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.4
 * PRODUCTION
 * ===========================================================================
 */

#ifndef GUI_UTILS___REPORTER__HPP
#define GUI_UTILS___REPORTER__HPP

/*  $Id: reporter.hpp,v 1000.2 2004/06/01 19:51:15 gouriano Exp $
 * ===========================================================================
 *
 *                            PUBLIC DOMAIN NOTICE
 *               National Center for Biotechnology Information
 *
 *  This software/database is a "United States Government Work" under the
 *  terms of the United States Copyright Act.  It was written as part of
 *  the author's official duties as a United States Government employee and
 *  thus cannot be copyrighted.  This software/database is freely available
 *  to the public for use. The National Library of Medicine and the U.S.
 *  Government have not placed any restriction on its use or reproduction.
 *
 *  Although all reasonable efforts have been taken to ensure the accuracy
 *  and reliability of the software and data, the NLM and the U.S.
 *  Government do not and cannot warrant the performance or results that
 *  may be obtained by using this software or data. The NLM and the U.S.
 *  Government disclaim all warranties, express or implied, including
 *  warranties of performance, merchantability or fitness for any particular
 *  purpose.
 *
 *  Please cite the author in any work or product based on this material.
 *
 * ===========================================================================
 *
 * Authors:  Mike DiCuccio
 *
 * File Description:
 *
 */

#include <corelib/ncbistd.hpp>

/** @addtogroup GUI_UTILS
 *
 * @{
 */


BEGIN_NCBI_SCOPE


class IReporter
{
public:

    virtual ~IReporter() { }

    // set the current reporter message
    virtual void SetMessage(const string& msg) = 0;

    // set the current percent completed
    virtual void SetPctCompleted(int pct) = 0;

    // clear any cached messages
    virtual void Clear(void) = 0;

    // an asynchronous cancel mechanism
    virtual bool HasBeenCanceled(void) const { return false; }

};



END_NCBI_SCOPE

/* @} */


/*
 * ===========================================================================
 * $Log: reporter.hpp,v $
 * Revision 1000.2  2004/06/01 19:51:15  gouriano
 * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.4
 *
 * Revision 1.4  2004/05/28 19:13:30  johnson
 * Added asynchronous mechanism to poll for 'cancel' message.
 *
 * Revision 1.3  2004/04/16 14:27:17  dicuccio
 * Added doxygen module tag
 *
 * Revision 1.2  2004/04/14 20:57:22  johnson
 * added Clear() to IReporter interface
 *
 * Revision 1.1  2003/12/04 18:06:45  dicuccio
 * Initial revision
 *
 * ===========================================================================
 */

#endif  // GUI_UTILS___REPORTER__HPP