iconfig_mediator.hpp
上传用户:yhdzpy8989
上传日期:2007-06-13
资源大小:13604k
文件大小:5k
源码类别:

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: iconfig_mediator.hpp,v $
  4.  * PRODUCTION Revision 1000.1  2004/06/01 19:47:27  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.2
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef GUI_DIALOGS_CONFIG___ICONFIG_MEDIATOR__HPP
  10. #define GUI_DIALOGS_CONFIG___ICONFIG_MEDIATOR__HPP
  11. /*  $Id: iconfig_mediator.hpp,v 1000.1 2004/06/01 19:47:27 gouriano Exp $
  12.  * ===========================================================================
  13.  *
  14.  *                            PUBLIC DOMAIN NOTICE
  15.  *               National Center for Biotechnology Information
  16.  *
  17.  *  This software/database is a "United States Government Work" under the
  18.  *  terms of the United States Copyright Act.  It was written as part of
  19.  *  the author's official duties as a United States Government employee and
  20.  *  thus cannot be copyrighted.  This software/database is freely available
  21.  *  to the public for use. The National Library of Medicine and the U.S.
  22.  *  Government have not placed any restriction on its use or reproduction.
  23.  *
  24.  *  Although all reasonable efforts have been taken to ensure the accuracy
  25.  *  and reliability of the software and data, the NLM and the U.S.
  26.  *  Government do not and cannot warrant the performance or results that
  27.  *  may be obtained by using this software or data. The NLM and the U.S.
  28.  *  Government disclaim all warranties, express or implied, including
  29.  *  warranties of performance, merchantability or fitness for any particular
  30.  *  purpose.
  31.  *
  32.  *  Please cite the author in any work or product based on this material.
  33.  *
  34.  * ===========================================================================
  35.  *
  36.  * Authors:  Robert Smith
  37.  *
  38.  * File Description:
  39.  *  Configuration Panel Interpreter interface.
  40.  *  The interface that any configuration/preference dialog uses
  41.  *  to modify its data and get its particular gui widges (IPanel).
  42.  *
  43.  *  Derived classes with this interface mediate between IConfigPanel 
  44.  *  and classes with the CSettingsSet base class, in the context of a
  45.  *  CConfigDlg.
  46.  */
  47. #include <corelib/ncbiobj.hpp>
  48. #include <gui/gui.hpp>
  49. #include <list>
  50. BEGIN_NCBI_SCOPE
  51. class IConfigPanel;
  52. class IConfigMediator : public CObject
  53. {
  54. public:
  55.     /// return all the states this dialog knows about
  56.     /// These constitute the valid arguments to the other methods taking 
  57.     /// 'state' parameters.
  58.     virtual list<string>        GetStates(void) const = 0;
  59.     /// Get the data's currently selected state.
  60.     /// Used by the dialog only at startup.
  61.     virtual string              GetCurrentState(void) const = 0;
  62.     
  63.     /// Get a widget with an IConfigPanel interface to display.
  64.     virtual IConfigPanel&       GetPanel(void) = 0;
  65.     /// What should we title the dialog window?
  66.     virtual string              GetWindowTitle(void) const = 0;
  67.     /// Load data into the panel
  68.     virtual void                Load(const string& state) = 0;
  69.     /// Load 'factory default' data into that panel.
  70.     virtual void                LoadDefault(void) = 0;
  71.     /// Save the panel's data.
  72.     virtual void                Save(const string& state) = 0;
  73.     /// Has the data represented by the panel's widgets been modified?
  74.     virtual bool                Modified(void) const = 0;
  75.     
  76.     /// If the following methods return true the list of states has changed.
  77.     /// and the dialog should do GetStates to repopulate and redisplay the list of states.
  78.     /// if they return false the method failed and no changes to the states were done.
  79.     /// If succesful new_state is the name of the state just added.
  80.     virtual bool                AddState(string& new_state) = 0;
  81.     virtual bool                DuplicateState(const string& state, string& new_state) = 0;
  82.     virtual bool                RenameState(const string& state, 
  83.                                             const string& req_state, 
  84.                                             string& new_state) = 0;
  85.     virtual bool                CanRenameState(const string& state) = 0;
  86.     virtual bool                DeleteState(const string& state) = 0;
  87.                      
  88. };
  89. END_NCBI_SCOPE
  90. /*
  91.  * ===========================================================================
  92.  * $Log: iconfig_mediator.hpp,v $
  93.  * Revision 1000.1  2004/06/01 19:47:27  gouriano
  94.  * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.2
  95.  *
  96.  * Revision 1.2  2004/05/03 12:42:46  dicuccio
  97.  * Added #include for gui/gui.hpp
  98.  *
  99.  * Revision 1.1  2003/12/30 14:08:56  dicuccio
  100.  * Initial check-in - moved from gui/config
  101.  *
  102.  * Revision 1.1  2003/10/10 17:41:43  rsmith
  103.  * moved from gui/core to gui/config
  104.  *
  105.  * Revision 1.1  2003/09/26 18:13:16  rsmith
  106.  * plugin configuration data and dialogs.
  107.  *
  108.  * ===========================================================================
  109.  */
  110. #endif  /* GUI_DIALOGS_CONFIG___ICONFIG_MEDIATOR__HPP */