jsmenu.hpp

ncbi源码

/*
 * ===========================================================================
 * PRODUCTION $Log: jsmenu.hpp,v $
 * PRODUCTION Revision 1000.5  2004/06/01 19:15:17  gouriano
 * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.19
 * PRODUCTION
 * ===========================================================================
 */

#ifndef HTML___JSMENU__HPP
#define HTML___JSMENU__HPP

/*  $Id: jsmenu.hpp,v 1000.5 2004/06/01 19:15:17 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.
 *
 * ===========================================================================
 *
 * Author:  Vladimir Ivanov
 *
 */

/// @file jsmenu.hpp 
/// JavaScript popup menu support.


#include <corelib/ncbistd.hpp>
#include <html/node.hpp>


/** @addtogroup HTMLcomp
 *
 * @{
 */


BEGIN_NCBI_SCOPE


/// Popup menu attribute.
///
/// If attribute not define for menu with function SetAttribute(), 
/// then it have some default value dependent on menu type.
/// All attributes have effect only for specified menu type, otherwise it
/// will be ignored.
///
/// NOTE: See documentation for detail attribute description.

enum EHTML_PM_Attribute {
    //
    //  Old menu attributes
    //  (used for compatibility with previous version only).
    //

    //                               Using by       Value example
    //
    //                               S  - eSmith 
    //                               K  - eKurdin 
    //                               KC - eKurdinConf
    //                               KS - eKurdinSide
    
    eHTML_PM_enableTracker,          // S           "true"
    eHTML_PM_disableHide,            // S      KS   "false"
    eHTML_PM_menuWidth,              //        KS   "100"
    eHTML_PM_peepOffset,             //        KS   "20"
    eHTML_PM_topOffset,              //        KS   "10"

    eHTML_PM_fontSize,               // S           "14"
    eHTML_PM_fontWeigh,              // S           "plain"
    eHTML_PM_fontFamily,             // S           "arial,helvetica"
    eHTML_PM_fontColor,              // S           "black"
    eHTML_PM_fontColorHilite,        // S           "#ffffff"
    eHTML_PM_menuBorder,             // S           "1"
    eHTML_PM_menuItemBorder,         // S           "0"
    eHTML_PM_menuItemBgColor,        // S           "#cccccc"
    eHTML_PM_menuLiteBgColor,        // S           "white"
    eHTML_PM_menuBorderBgColor,      // S           "#777777"
    eHTML_PM_menuHiliteBgColor,      // S           "#000084"
    eHTML_PM_menuContainerBgColor,   // S           "#cccccc"
    eHTML_PM_childMenuIcon,          // S           "images/arrows.gif"
    eHTML_PM_childMenuIconHilite,    // S           "images/arrows2.gif"
    eHTML_PM_bgColor,                // S K         "#555555"
    eHTML_PM_titleColor,             //   K         "#FFFFFF"
    eHTML_PM_borderColor,            //   K         "black"
    eHTML_PM_alignH,                 //   K         "left" or "right"
    eHTML_PM_alignV,                 //   K         "bottom" or "top"


    //
    //  New menu attributes.
    //

    // View

    eHTML_PM_ColorTheme,               //     KC      Name of theme
    eHTML_PM_ShowTitle,                //     KC      "yes" / "no"
    eHTML_PM_ShowCloseIcon,            //             "yes" / "no"
    eHTML_PM_HelpURL,                  //     KC      URL or JS code
    eHTML_PM_HideTime,                 //     KC      Number of milliseconds
    eHTML_PM_FreeText,                 //     KC      Some text or html
/*
    eHTML_PM_DisableHide,              //             
    eHTML_PM_MenuWidth,                //             
    eHTML_PM_PeepOffset,               //             
    eHTML_PM_TopOffset,                //             
*/
    // Menu colors

    eHTML_PM_BorderColor,              //     KC      Standard web color
    eHTML_PM_BackgroundColor,          //   K KC      Standard web color

    // Position
    
    eHTML_PM_AlignLR,                  //   K KC      "left" / "right"
    eHTML_PM_AlignTB,                  //   K KC      "bottom" / "top"
    eHTML_PM_AlignCenter,              //     KC      "yes" / "no"

    // Title

    eHTML_PM_TitleText,                //     KC      Title text
    eHTML_PM_TitleColor,               //   K KC      Standard web color
    eHTML_PM_TitleSize,                //     KC      "11" / "11px" / "11em"
    eHTML_PM_TitleFont,                //     KC      Web fonts name(s)
    eHTML_PM_TitleBackgroundColor,     //             Standard web color
    eHTML_PM_TitleBackgroundImage,     //     KC      Path to image file

    // Items

    eHTML_PM_ItemColor,                //     KC      Standard web color
    eHTML_PM_ItemColorActive,          //             Standard web color
    eHTML_PM_ItemBackgroundColorActive,//     KC      Standard web color
    eHTML_PM_ItemSize,                 //     KC      "11" / "11px" / "11em"
    eHTML_PM_ItemFont,                 //     KC      Web fonts name(s)
    eHTML_PM_ItemBulletImage,          //     KC      Path to image file
    eHTML_PM_ItemBulletImageActive,    //             Path to image file
    eHTML_PM_SeparatorColor            //     KC      Standard web color
};


/////////////////////////////////////////////////////////////////////////////
///
/// CHTMLPopupMenu --
///
/// Define for support JavaScript popup menues.
///
/// For successful work menu in HTML pages next steps required:
///    - File with popup menu JavaScript library -- "*.js".
///      By default using menu with URL, defined in constant
///      kJSMenuDefaultURL*, defined in the jsmenu.cpp.
///    - Define menues and add it to HTML page (AppendChild()).
///    - Call EnablePopupMenu() (member function of CHTML_html and CHTMLPage).
/// 
/// NOTE: We must add menues to a BODY only, otherwise menu not will be work.
/// NOTE: Menues of eKurdinSide type must be added (using AppendChild) only
///       to a HEAD node. And menu of this type must be only one on the page!

class NCBI_XHTML_EXPORT CHTMLPopupMenu : public CNCBINode
{
    typedef CNCBINode CParent;
    friend class CHTMLPage;
    friend class CHTMLNode;
public:

    /// Popup menu type.
    enum EType {
        eSmith,             ///< Smith's menu (ncbi_menu*.js)
        eKurdin,            ///< Sergey Kurdin's popup menu (popupmenu2*.js)
        eKurdinConf,        ///< Sergey Kurdin's popup menu with configurations
                            ///< (popupmenu2*.js, v2.5 and above)
        eKurdinSide,        ///< Sergey Kurdin's side menu (sidemenu*.js)

        ePMFirst = eSmith,
        ePMLast  = eKurdinSide
    };
    /// Menu attribute type.
    typedef map<EHTML_PM_Attribute, string> TAttributes;

    /// Constructor.
    ///
    /// Construct menu with name "name" (JavaScript variable name).
    CHTMLPopupMenu(const string& name, EType type = eSmith);

    /// Destructor.
    virtual ~CHTMLPopupMenu(void);

    /// Get menu name.
    string GetName(void) const;
    /// Get menu type.
    EType  GetType(void) const;


    /// Add new item to current menu.
    ///
    /// NOTE: action - can be also URL type like "http://...".
    /// NOTE: Parameters have some restrictions according to menu type:
    ///       title  - can be text or HTML-code (for eSmith menu type only);
    ///       color  - will be ignored for eKurdin menu type.

    void AddItem(const string& title,                  ///< Text or HTML-code