feat_decorate.hpp

ncbi源码

/*
 * ===========================================================================
 * PRODUCTION $Log: feat_decorate.hpp,v $
 * PRODUCTION Revision 1000.1  2004/06/01 19:46:27  gouriano
 * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.2
 * PRODUCTION
 * ===========================================================================
 */

#ifndef GUI_CONFIG___FEAT_DECORATE__HPP
#define GUI_CONFIG___FEAT_DECORATE__HPP

/*  $Id: feat_decorate.hpp,v 1000.1 2004/06/01 19:46:27 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 feat_decorate.hpp


#include <corelib/ncbistd.hpp>
#include <gui/config/feat_config_inherited.hpp>
#include <gui/config/settings_set.hpp>


/** @addtogroup GUI_CONFIG
 *
 * @{
 */


BEGIN_NCBI_SCOPE

///
/// CFeatConfigDecorate - class to hold a decoration structure for features.
///
/// Associates a set of values with each feature type/subtype, which values
/// can be inherited from those associated with 'master' feature types.
/// The values specify how to display the feature, what 'decorations' to 
/// to use (arrows, lines, etc.)


class CFeatDecorations {
public:
    CFeatDecorations() {}
    explicit CFeatDecorations(const string& s) {}
    string  ToString() const {return kEmptyStr; }
};

class NCBI_GUICONFIG_EXPORT CFeatConfigDecorate : public CSettingsSet {
public:
    CFeatConfigDecorate(objects::CPluginConfigCache* config_cache, 
                    const string& typedesc = "Decorations");
    /// use the following cstr when inheriting from this class.
    CFeatConfigDecorate(objects::CPluginConfigCache* config_cache, 
                 const string& type,
                 const AutoPtr<IFactoryDefaultSettings>& fds,
                 const string& typedesc = ""
                 );

    
    /// Must define
    virtual bool LoadCurrentSettings(ELoadValueSource src);
    virtual bool SaveCurrentSettings(void);
    
    CFeatDecorations        GetDecorate(int type, int subtype) const;
    void        SetDecorate(int type, int subtype, CFeatDecorations decoration);
    void        SetDecorateInherited(int type, int subtype, bool inherited);
    void        ClearDecorates();
        
private:
    CFeatConfigValues<CFeatDecorations>     m_FeatDecorates;
};



class NCBI_GUICONFIG_EXPORT CFeatDecorateFactoryDefaults : public IFactoryDefaultSettings {
public:
    virtual string   Get(const string& key) const;
};


END_NCBI_SCOPE


/* @} */


/*
 * ===========================================================================
 *
 * $Log: feat_decorate.hpp,v $
 * Revision 1000.1  2004/06/01 19:46:27  gouriano
 * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.2
 *
 * Revision 1.2  2004/05/11 18:55:53  dicuccio
 * Changed doxygen modules - use GUI_CONFIG instead of PluginConfiguration
 *
 * Revision 1.1  2004/02/05 16:03:36  rsmith
 * initial checkin
 *
 *
 * ===========================================================================
 */

#endif  /* GUI_CONFIG___FEAT_DECORATE__HPP */