menu.h

Go to the documentation of this file.

//                                                        _                             //
//                       _ __ ___    ___  _ __   _   _   | |__                          //
//                      | '_ ` _ \  / _ \| '_ \ | | | |  | '_ \                         //
//                      | | | | | ||  __/| | | || |_| | _| | | |                        //
//                      |_| |_| |_| \___||_| |_| \__,_|(_)_| |_|                        //
//                                                                                      //
//                        generic menu resource implementation                          //
//                                                                                      //

/*****************************************************************************

    X11workbench - X11 programmer's 'work bench' application and toolkit
    Copyright (c) 2010-2019 by Bob Frazier (aka 'Big Bad Bombastic Bob')


  DISCLAIMER:  The X11workbench application and toolkit software are supplied
               'as-is', with no warranties, either implied or explicit.
               Any claims to alleged functionality or features should be
               considered 'preliminary', and might not function as advertised.

  MIT-like license:

  There is no restriction as to what you can do with this software, so long
  as you include the above copyright notice and DISCLAIMER for any distributed
  work that is equal to or derived from this one, along with this paragraph
  that explains the terms of the license if the source is also being made
  available.  A "derived work" describes a work that uses a significant portion
  of the source files or algorithms that are included with this one.
  Specifically excluded from this are files that were generated by the software,
  or anything that is included with the software that is part of another package
  (such as files that were created or added during the 'configure' process).
  Specifically included is the use of part or all of any of the X11 workbench
  toolkit source or header files in your distributed application.  If you do not
  ship the source, the above copyright statement is still required to be placed
  in a reasonably prominent place, such as documentation, splash screens, and/or
  'about the application' dialog boxes.

  Use and distribution are in accordance with GPL, LGPL, and/or the above
  MIT-like license.  See COPYING and README files for more information.


  Additional information at http://sourceforge.net/projects/X11workbench

******************************************************************************/

// a menu bar is a window that contains one or more text menu items, displaying a popup menu
// whenever a text menu item is activated.  The popup menu is displayed as needed.

#ifndef MENU_H_INCLUDED
#define MENU_H_INCLUDED

#ifdef __cplusplus
extern "C" {
#endif // __cplusplus


#define WBMENU_RESERVE_DEFAULT (256 * sizeof(void *)) 
#define WBMENU_POPUP_HIGH_BIT 0x80000000    
#define WBMENU_DYNAMIC_HIGH_BIT 0x40000000  
#define WBMENU_POPUP_MASK 0x3fffffff        
#define WBMENU_SEPARATOR -1                 
typedef struct tagWBMenuItem__
{
  unsigned int uiTag;    

  // the following data members are offsets from 'data' for each component of the menu item
  // '-1' generically indicates "none"
  int iMenuItemText;     
  int iUnderscore;       
  int iTooltipText;      
  int iHotKey;           

  // the following data members are numeric properties (not offsets)
  int iAction;           
  int nHotKey;           
  int iTextWidth;        
  int iPosition;         

  int nDataSize;         
  char data[4];          

} WBMenuItem;


typedef struct tagWBMenu
{
    unsigned int uiTag;          

    int iMenuID;                 

    WBMenuItem **ppItems;        
    int nItems;                  
    int nMaxItems;               

    struct tagWBMenu **ppPopups; 
    int nPopups;                 
    int nMaxPopups;              

} WBMenu;

#define WBMENU_TAG     (*((const unsigned int *)"WBMM"))

#define WBMENUITEM_TAG (*((const unsigned int *)"WBMI"))


//------------------------------
// construction and destruction
//------------------------------

WBMenu *MBCreateMenu(int iID, int iPopup, const char *pszResource, int iReserveSpace);
  // pass in full menu resource 'pszResource' including any referenced popup menus. If a popup menu
  // isn't specified here it can be added later via 'MBAddPopupMenu'.  Specify '-1' for iID to
  // read ID (and popup specifier) from the menu resource.  'iPopup' is non-zero for popup, zero for bar

void MBDestroyMenu(WBMenu *pMenu);  // always destroy with this function

WBMenu *MBCopyMenu(const WBMenu *pMenu, int iReserveSpace);

int MBIsMenuValid(const WBMenu *pMenu);

//------------
// menu items
//------------

WBMenuItem *MBCreateMenuItem(const char **ppszResource);  // create single menu item, and point *ppszResource to next item in resource

void MBDestroyMenuItem(WBMenuItem *pMenuItem);

int MBIsMenuItemValid(const WBMenuItem *pMenuItem);

int MBAddMenuItem(WBMenu *pMenu, const WBMenuItem *pMenuItem, int iPos);

void MBRemoveMenuItem(WBMenu *pMenu, int iPos);  // deletes menu item - 'iPos' has same semantics as above

//-------------
// popup menus
//-------------

int MBAddPopupMenu(WBMenu *pMenu, const WBMenu *pPopupMenu); // use this when you add a popup menu item to add the actual popup menu

WBMenu *MBFindPopupMenu(WBMenu *pMenu, int idPopup);

void MBRemovePopupMenu(WBMenu *pMenu, int idPopup);


static __inline__ int MBMenuIsPopup(WBMenu *pMenu)
{
  return pMenu && (pMenu->iMenuID & WBMENU_POPUP_HIGH_BIT);
}

int MBMenuProcessHotKey(WBMenu *pMenu, XKeyEvent *pEvent); // menu owner calls this to check for menu-based hotkeys

#ifdef __cplusplus
};
#endif // __cplusplus

#endif // MENU_H_INCLUDED