view_menu.hpp

ncbi源码

/*
 * ===========================================================================
 * PRODUCTION $Log: view_menu.hpp,v $
 * PRODUCTION Revision 1000.2  2004/04/16 17:49:09  gouriano
 * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.13
 * PRODUCTION
 * ===========================================================================
 */

#ifndef GUI_CORE___VIEW_MENU__HPP
#define GUI_CORE___VIEW_MENU__HPP

/*  $Id: view_menu.hpp,v 1000.2 2004/04/16 17:49:09 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:
 *
 *    IViewMenuData -- Class to hold callback information necessary to spawn a
 *                     view plugin from an FLTK callback
 *
 *    CViewMenuMgr  -- Manager for dynamic FLTK view plugin menu + callback
 *                     data
 *
 */


#include <gui/utils/fltk_utils.hpp>


BEGIN_NCBI_SCOPE

class IDocument;
class ISelection;
class CSelectionBuffer;


//
// abstract base class for our view menu data
// this is needed for the template definition below
//
class IViewMenuData : public CObject
{
public:
    virtual ~IViewMenuData() {}
    virtual void DoCallback() = 0;
};



//
// class CViewMenuMgr manages a dynamic menu for views
//
class NCBI_GUICORE_EXPORT CViewMenuMgr : public CFltkMenuMgrBase<IViewMenuData>
{
public:

    CViewMenuMgr(Fl_Menu_* menu, const string& base,
                 ISelection* sel_source,
                 const string& view_pool_name = "");

    // Clear our managed sub-menus
    void    Clear(void);

    // add a new views menu
    void    AddNewViews();

    // add an empty new views list - no documents
    void    AddEmptyNewViews(const string& message);

    // add an existing views menu for all documents
    void    AddActiveViews(void);

    // add existing views for a given document
    void    AddActiveViews(IDocument* doc);

    // add an empty active views list - no documents
    void    AddEmptyActiveViews(const string& message);

private:
    // the name of the pool in which our created views will live
    string m_PoolName;

    // the source of all or selections
    ISelection* m_SelSource;
};


END_NCBI_SCOPE

#endif  // GUI_CORE___VIEW_MENU__HPP

/*
 * ===========================================================================
 * $Log: view_menu.hpp,v $
 * Revision 1000.2  2004/04/16 17:49:09  gouriano
 * PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.13
 *
 * Revision 1.13  2004/04/16 14:32:30  dicuccio
 * Use ISelection as selection source rather than passing in selections
 *
 * Revision 1.12  2003/11/06 19:58:56  dicuccio
 * Added optional parameter to pass context name to view menu
 *
 * Revision 1.11  2003/09/16 14:04:24  dicuccio
 * Renamed menu data interface classes
 *
 * Revision 1.10  2003/09/04 14:00:26  dicuccio
 * Introduce IDocument and IView as abstract base classes.  Use IDocument instead
 * of CDocument.
 *
 * Revision 1.9  2003/07/21 19:20:42  dicuccio
 * Changed interface from Run() to DoCallback() -- more descriptive
 *
 * Revision 1.8  2003/06/25 16:59:41  dicuccio
 * Changed CPluginHandle into a pointer-to-implementation (the previous
 * implementation is now the pointer held).  Lots of #include file clean-ups.
 *
 * Revision 1.7  2003/05/05 12:40:55  dicuccio
 * Added new interfaces for creating view menus
 *
 * Revision 1.6  2003/03/21 16:58:03  dicuccio
 * Moved fltk_utils.hpp --> gui/utils
 *
 * Revision 1.5  2003/02/26 17:52:26  dicuccio
 * Cleaned up dynamic menus to make them resistant to refreshing the menu while
 * the menu callback is running
 *
 * Revision 1.4  2003/01/15 20:56:31  dicuccio
 * Added private static callback for view menu operations
 *
 * Revision 1.3  2003/01/13 13:11:42  dicuccio
 * Namespace clean-up.  Retired namespace gui -> converted to namespace ncbi.
 * Moved all FLUID-generated code into namespace ncbi.
 *
 * Revision 1.2  2002/12/26 14:19:55  dicuccio
 * Added Win32 export specifiers.
 *
 * Revision 1.1  2002/12/20 19:11:11  dicuccio
 * Initial revision.
 *
 * ===========================================================================
 */