config_mediator.hpp

ncbi源码

/*
 * ===========================================================================
 * PRODUCTION $Log: config_mediator.hpp,v $
 * PRODUCTION Revision 1000.0  2004/04/12 18:18:00  gouriano
 * PRODUCTION PRODUCTION: IMPORTED [CATCHUP_003] Dev-tree R1.1
 * PRODUCTION
 * ===========================================================================
 */

#ifndef GUI_DIALOGS_CONFIG___CONFIG_MEDIATOR__HPP
#define GUI_DIALOGS_CONFIG___CONFIG_MEDIATOR__HPP

/*  $Id: config_mediator.hpp,v 1000.0 2004/04/12 18:18:00 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:  Robert Smith
 *
 * File Description:
 *  Configuration Panel Interpreter default implementation.
 *  The is the default implementation of those methods of the IConfigMediator
 *  interface that any such mediator should have in common. 
 *
 *  Derived classes with this interface & implementation mediate between IConfigPanel's
 *  and classes with the CSettingsSet base class, in the context of a
 *  CConfigDlg.
 */

#include <gui/dialogs/config/iconfig_mediator.hpp> // base class

BEGIN_NCBI_SCOPE

class CSettingsSet;
class IConfigPanel;


class NCBI_GUIDIALOGS_EXPORT CConfigMediator : public IConfigMediator
{
public:
    CConfigMediator(CSettingsSet& data, IConfigPanel& widget_group);
    virtual ~CConfigMediator();
    
    /// return the object that can give us our Fl_Widget.
    IConfigPanel&       GetPanel(void);
    
    /// return all the states this dialog knows about
    /// These constitute the valid arguments to the other methods taking 
    /// 'state' parameters.
    list<string>        GetStates(void) const;
    
    /// return the data's current state.
    /// This is the state that Load and Save will operate on.
    /// Used by the dialog only at startup.
    string              GetCurrentState(void) const;

/*  // The following must be defined in the sub class.
    /// What should we title the dialog window?
    virtual string              GetWindowTitle(void) const = 0;
    /// Load data into that panel
    void                Load(const string& state) = 0;
    /// Load 'factory default' data into that panel.
    void                LoadDefault(void) = 0;
    /// Save the panel's data.
    void                Save(const string& state) = 0;
    /// Has the data represented by the panel's widgets been modified?
    bool                Modified(void) const;
*/
    
    /// If the following methods return true the list of states has changed.
    /// and the dialog should do GetStates to repopulate and redisplay the list of states.
    /// if they return false the method failed and no changes to the states were done.
    /// If succesful new_state is the name of the state just added.
    bool                AddState(string& new_state);
    bool                DuplicateState(const string& state, string& new_state);
    bool                RenameState(const string& state, 
                                            const string& req_state, 
                                            string& new_state);
    bool                DeleteState(const string& state);
    bool                CanRenameState(const string& state);

protected:
    CRef<CSettingsSet>      m_DataSet;
    CRef<IConfigPanel>      m_ConfigPanel;
};


END_NCBI_SCOPE

/*
 * ===========================================================================
 * $Log: config_mediator.hpp,v $
 * Revision 1000.0  2004/04/12 18:18:00  gouriano
 * PRODUCTION: IMPORTED [CATCHUP_003] Dev-tree R1.1
 *
 * Revision 1.1  2003/12/30 14:08:55  dicuccio
 * Initial check-in - moved from gui/config
 *
 * Revision 1.3  2003/11/20 13:16:58  dicuccio
 * Minor formatting change
 *
 * Revision 1.2  2003/10/10 19:35:31  dicuccio
 * Added export specifiers
 *
 * Revision 1.1  2003/10/10 17:41:43  rsmith
 * moved from gui/core to gui/config
 *
 * Revision 1.1  2003/09/26 18:13:16  rsmith
 * plugin configuration data and dialogs.
 *
 * ===========================================================================
 */

#endif  /* GUI_DIALOGS_CONFIG___CONFIG_MEDIATOR__HPP */