menu_bar.h

Go to the documentation of this file.

//                                               _                   _                  //
//           _ __ ___    ___  _ __   _   _      | |__    __ _  _ __ | |_                //
//          | '_ ` _ \  / _ \| '_ \ | | | |     | '_ \  / _` || '__|| '_ \              //
//          | | | | | ||  __/| | | || |_| |     | |_) || (_| || | _ | | | |             //
//          |_| |_| |_| \___||_| |_| \__,_|_____|_.__/  \__,_||_|(_)|_| |_|             //
//                                        |_____|                                       //
//                                                                                      //
//                        generic menu bar 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

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

#ifndef MENU_BAR_H_INCLUDED
#define MENU_BAR_H_INCLUDED

#include "menu.h"

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


#define MENU_WINDOW_TAG (*((const unsigned int *)"MWMW"))

typedef struct tagWBMenuBarWindow
{
  unsigned int ulTag; 
  Window wSelf;       
  Window wOwner;      

  WBMenu *pMenu;      

  int iX;             
  int iY;             
  int iWidth;         
  int iHeight;        
  int iSelected;      
  int iPrevSel;       
  int iFlags;         

} WBMenuBarWindow;


// Initialization, global objects, and default objects

int MBInitGlobal(void);

extern XColor clrMenuFG;               
extern XColor clrMenuBG;               
extern XColor clrMenuActiveFG;         
extern XColor clrMenuActiveBG;         
extern XColor clrMenuBorder1;          
extern XColor clrMenuBorder2;          
extern XColor clrMenuBorder3;          
extern XColor clrMenuDisabledFG;       
extern XColor clrMenuActiveDisabledFG; 

// these are documented in menu_bar.c
extern Atom aMENU_RESIZE;              
extern Atom aMENU_DISPLAY_POPUP;       
extern Atom aMENU_ACTIVATE;            


WB_FONTC MBGetDefaultMenuFont(void);

// menu bar window info

static __inline__ WBMenuBarWindow *MBGetMenuBarWindowStruct(Window wID)  // for frame windows, returns the frame window struct
{
  WBMenuBarWindow *pRval = (WBMenuBarWindow *)WBGetWindowData(wID, 0);  // offset 0 for window-specific structs

  if(pRval && pRval->ulTag == MENU_WINDOW_TAG)
  {
    return(pRval);
  }

  return(NULL);
}

WBMenuBarWindow *MBCreateMenuBarWindow(Window wIDParent, const char *pszResource, int iFlags);

WBMenuBarWindow *MBFindMenuBarWindow(WBMenu *pMenu);  // find first (active) window that uses 'pMenu'


void MBReCalcMenuBarWindow(WBMenuBarWindow *pMenuBar);


void MBDestroyMenuBarWindow(WBMenuBarWindow *pMenuBar);  // destroy by using struct pointer


static __inline__ WBMenu * MBGetMenuBarMenu(WBMenuBarWindow *pMenuBar)
{
  if(!pMenuBar || pMenuBar->ulTag != MENU_WINDOW_TAG)
  {
    return NULL;
  }

  return pMenuBar->pMenu;
}

static __inline__ WBMenu * MBSetMenuBarMenu(WBMenuBarWindow *pMenuBar, WBMenu *pMenu)
{
WBMenu *pRval;

  if(!pMenuBar || pMenuBar->ulTag != MENU_WINDOW_TAG)
  {
    return NULL;
  }

  pRval = pMenuBar->pMenu;
  pMenuBar->pMenu = pMenu; // TODO:  reference counting?
  pMenuBar->iSelected = -1;
  pMenuBar->iPrevSel = -1;

  MBReCalcMenuBarWindow(pMenuBar);

  return pRval; // the old menu
}

void MBSetMenuBarMenuResource(WBMenuBarWindow *pMenuBar, const char *pszMenuResource);


#ifdef __cplusplus
};
#endif // __cplusplus


#endif // MENU_BAR_H_INCLUDED