label.hpp

ncbi源码

/*
 * ===========================================================================
 * PRODUCTION $Log: label.hpp,v $
 * PRODUCTION Revision 1000.0  2004/06/01 19:55:22  gouriano
 * PRODUCTION PRODUCTION: IMPORTED [GCC34_MSVC7] Dev-tree R1.2
 * PRODUCTION
 * ===========================================================================
 */

#ifndef GUI_UTILS___LABEL__HPP
#define GUI_UTILS___LABEL__HPP

/*  $Id: label.hpp,v 1000.0 2004/06/01 19:55:22 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/ncbiobj.hpp>
#include <serial/serialdef.hpp>
#include <objmgr/scope.hpp>
#include <gui/gui.hpp>

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


BEGIN_NCBI_SCOPE


class ILabelHandler;

class NCBI_GUIOBJUTILS_EXPORT CLabel
{
public:
    enum ELabelType {
        eType,
        eContent,
        eBoth,
        eTooltipBrief,
        eTooltipDetailed,

        eDefault = eContent
    };

    // retrieve a label for an object
    static void GetLabel(const CObject& obj, string* label,
                         ELabelType type = eDefault,
                         objects::CScope* scope = NULL);

    // register handler classes that will be called when this interface
    // is presented with an object for which a label is requested
    static void RegisterLabelHandler(const string& type,
                                     ILabelHandler& handler);
    static void RegisterLabelHandler(const CTypeInfo& type,
                                     ILabelHandler& handler);

private:

    typedef map<string, CRef<ILabelHandler> > TLabelMap;
    static TLabelMap sm_LabelMap;
};




class ILabelHandler: public CObject
{
public:

    virtual void GetLabel(const CObject& obj, string* str,
                          CLabel::ELabelType type,
                          objects::CScope* scope) const = 0;
};



END_NCBI_SCOPE


/* @} */

/*
 * ===========================================================================
 * $Log: label.hpp,v $
 * Revision 1000.0  2004/06/01 19:55:22  gouriano
 * PRODUCTION: IMPORTED [GCC34_MSVC7] Dev-tree R1.2
 *
 * Revision 1.2  2004/05/03 12:41:35  dicuccio
 * Fixed #includes and export specifiers
 *
 * Revision 1.1  2004/04/30 11:52:53  dicuccio
 * Split out from gui/utils
 *
 * Revision 1.1  2004/04/20 19:18:24  dicuccio
 * Initial revision
 *
 * ===========================================================================
 */

#endif  // GUI_UTILS___LABEL__HPP