core/vgui/impl/mfc/vgui_mfc_utils.h

Go to the documentation of this file.

// This is core/vgui/impl/mfc/vgui_mfc_utils.h
#ifndef vgui_mfc_utils_h_
#define vgui_mfc_utils_h_
#ifdef VCL_NEEDS_PRAGMA_INTERFACE
#pragma interface
#endif
//:
// \file
// \brief   MFC support for menus.
// \author  Marko Bacic, Oxford RRG
// \date    4 August 2000
//
//  Contains class  vgui_mfc_utils
//
// \verbatim
//  Modifications
//   04-AUG-2000 Marko Bacic - Initial version.
//   14-AUG-2000 Marko Bacic - Added support for popup menus
//   16-MAR-2001 K.Y.McGaul - Added menu accelerators
//   22-AUG-2001 K.Y.McGaul - Added destructor to fix memory leak: all
//                            menus now deleted.
//   25-JUL-2006  A. Tamrakar Fixed the "Popup Menu timeout" bug.
// \endverbatim

#include <vgui/vgui_menu.h>
#include "StdAfx.h"
//: Note that the range 0x8000-0x8400 is reserved for dialog box callbacks
#define ID_MENU_ITEMS 0x8400
#define MAX_ITEM_COUNT 0x400 // (dec 1024)

typedef void (*fp)();

//: MFC support for menus.
//  Only one instance of the class is allowed
class vgui_mfc_utils
{
  //: Number of menu items.
  int item_count;

  //: List of commands to be called by menus.
  vcl_vector<vgui_command *> callbacks;

  //: List of menu accelerators.
  vcl_vector<ACCEL> accels;

  //: Add keyboard shortcut for this menu item to accelerator table (accels).
  void add_menu_accelerator(const vgui_menu_item item, const WORD function_id, vcl_string& the_menu_name);

 public:
  //: (Create if necessary and) return singleton instance of this class.
  static vgui_mfc_utils *instance();

  //: Constructor.
  vgui_mfc_utils() : item_count(0), first_popup(true) {}

  //: Destructor.
  ~vgui_mfc_utils();

  //: Create a MFC sub-menu from the given vgui_menu.
  HMENU add_submenu(const vgui_menu& menu);

  //: Sets the menu of the application window
  void set_menu(const vgui_menu& menu);

  //: Create popup menu.
  CMenu *set_popup_menu(const vgui_menu & menu);

  //: Delete the callback functions from the last popup menu.
  void delete_last_popup_menu_callbacks();

  //: Called within message service routine of vgui_mfc_mainfrm.
  virtual void menu_dispatcher(UINT nID);

  //: Menu accelerator table - this defines menu shortcuts
  HACCEL AccelTable;

 private:
  //: List of menus to be deleted when we are finished:
  vcl_vector<CMenu*> menus_to_be_deleted;

  //: first time a popup menu was created
  bool first_popup;

  //: last item_count before a popup menu is created
  int last_item_count;

};

#endif // vgui_mfc_utils_h_