include/wx/msw/menu.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        menu.h
   3 // Purpose:     wxMenu, wxMenuBar classes
   4 // Author:      Julian Smart
   5 // Modified by: Vadim Zeitlin (wxMenuItem is now in separate file)
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart and Markus Holzem
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_MENU_H_
  13 #define _WX_MENU_H_
  14
  15 #ifdef __GNUG__
  16 #pragma interface "menu.h"
  17 #endif
  18
  19 #include "wx/defs.h"
  20 #include "wx/event.h"
  21
  22 class WXDLLEXPORT wxMenuItem;
  23 class WXDLLEXPORT wxMenuBar;
  24 class WXDLLEXPORT wxMenu;
  25
  26 WXDLLEXPORT_DATA(extern const char*) wxEmptyString;
  27
  28 // ----------------------------------------------------------------------------
  29 // Menu
  30 // ----------------------------------------------------------------------------
  31 class WXDLLEXPORT wxMenu: public wxEvtHandler
  32 {
  33   DECLARE_DYNAMIC_CLASS(wxMenu)
  34
  35 public:
  36   // ctor & dtor
  37   wxMenu(const wxString& title = wxEmptyString, const wxFunction func = NULL);
  38   ~wxMenu();
  39
  40   // construct menu
  41     // append items to the menu
  42       // separator line
  43   void AppendSeparator();
  44       // normal item
  45   void Append(int id, const wxString& Label, const wxString& helpString = wxEmptyString,
  46               bool checkable = FALSE);
  47       // a submenu
  48   void Append(int id, const wxString& Label, wxMenu *SubMenu,
  49               const wxString& helpString = wxEmptyString);
  50       // the most generic form (create wxMenuItem first and use it's functions)
  51   void Append(wxMenuItem *pItem);
  52     // insert a break in the menu
  53   void Break();
  54     // delete an item
  55   void Delete(int id); /* If it's a submenu, menu is not destroyed. VZ: why? */
  56
  57   // menu item control
  58   void Enable(int id, bool Flag);
  59   bool Enabled(int id) const;
  60   inline bool IsEnabled(int id) const { return Enabled(id); };
  61   void Check(int id, bool Flag);
  62   bool Checked(int id) const;
  63   inline bool IsChecked(int id) const { return Checked(id); };
  64
  65   // item properties
  66     // title
  67   void SetTitle(const wxString& label);
  68   const wxString GetTitle() const;
  69     // label
  70   void SetLabel(int id, const wxString& label);
  71   wxString GetLabel(int id) const;
  72     // help string
  73   virtual void SetHelpString(int id, const wxString& helpString);
  74   virtual wxString GetHelpString(int id) const ;
  75
  76   // find item
  77     // Finds the item id matching the given string, NOT_FOUND if not found.
  78   virtual int FindItem(const wxString& itemString) const ;
  79     // Find wxMenuItem by ID, and item's menu too if itemMenu is !NULL.
  80   wxMenuItem *FindItemForId(int itemId, wxMenu **itemMenu = NULL) const;
  81
  82   void ProcessCommand(wxCommandEvent& event);
  83   inline void Callback(const wxFunction func) { m_callback = func; }
  84
  85   virtual void SetParent(wxEvtHandler *parent) { m_parent = parent; }
  86   inline void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
  87   inline wxEvtHandler *GetEventHandler() { return m_eventHandler; }
  88
  89   inline wxList& GetItems() const { return (wxList&) m_menuItems; }
  90
  91   // IMPLEMENTATION
  92   bool MSWCommand(WXUINT param, WXWORD id);
  93
  94   void      SetInvokingWindow(wxWindow *pWin) { m_pInvokingWindow = pWin; }
  95   wxWindow *GetInvokingWindow()         const { return m_pInvokingWindow; }
  96
  97   // semi-private accessors
  98     // get the window which contains this menu
  99   wxWindow *GetWindow() const;
 100     // get the menu handle
 101   WXHMENU GetHMenu() const;
 102
 103 private:
 104   bool              m_doBreak ;
 105
 106 public:
 107   // This is used when m_hMenu is NULL because we don't want to
 108   // delete it in ~wxMenu (it's been added to a parent menu).
 109   // But we'll still need the handle for other purposes.
 110   // Might be better to have a flag saying whether it's deleteable or not.
 111   WXHMENU           m_savehMenu ; // Used for Enable() on popup
 112   WXHMENU           m_hMenu;
 113   wxFunction        m_callback;
 114
 115   int               m_noItems;
 116   wxString          m_title;
 117   wxMenu *          m_topLevelMenu;
 118   wxMenuBar *       m_menuBar;
 119   wxList            m_menuItems;
 120   wxEvtHandler *    m_parent;
 121   wxEvtHandler *    m_eventHandler;
 122   wxWindow         *m_pInvokingWindow;
 123 };
 124
 125 // ----------------------------------------------------------------------------
 126 // Menu Bar (a la Windows)
 127 // ----------------------------------------------------------------------------
 128 class WXDLLEXPORT wxFrame;
 129 class WXDLLEXPORT wxMenuBar: public wxEvtHandler
 130 {
 131   DECLARE_DYNAMIC_CLASS(wxMenuBar)
 132
 133 public:
 134   wxMenuBar();
 135   wxMenuBar(int n, wxMenu *menus[], const wxString titles[]);
 136   ~wxMenuBar();
 137
 138   void Append(wxMenu *menu, const wxString& title);
 139   // Must only be used AFTER menu has been attached to frame,
 140   // otherwise use individual menus to enable/disable items
 141   void Enable(int Id, bool Flag);
 142   bool Enabled(int Id) const ;
 143   inline bool IsEnabled(int Id) const { return Enabled(Id); };
 144   void EnableTop(int pos, bool Flag);
 145   void Check(int id, bool Flag);
 146   bool Checked(int id) const ;
 147   inline bool IsChecked(int Id) const { return Checked(Id); };
 148   void SetLabel(int id, const wxString& label) ;
 149   wxString GetLabel(int id) const ;
 150   void SetLabelTop(int pos, const wxString& label) ;
 151   wxString GetLabelTop(int pos) const ;
 152   virtual void Delete(wxMenu *menu, int index = 0); /* Menu not destroyed */
 153   virtual bool OnAppend(wxMenu *menu, const char *title);
 154   virtual bool OnDelete(wxMenu *menu, int index);
 155
 156   virtual void SetHelpString(int Id, const wxString& helpString);
 157   virtual wxString GetHelpString(int Id) const ;
 158
 159   virtual int FindMenuItem(const wxString& menuString, const wxString& itemString) const ;
 160
 161   // Find wxMenuItem for item ID, and return item's
 162   // menu too if itemMenu is non-NULL.
 163   wxMenuItem *FindItemForId(int itemId, wxMenu **menuForItem = NULL) const ;
 164
 165   inline void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
 166   inline wxEvtHandler *GetEventHandler() { return m_eventHandler; }
 167
 168   inline int GetMenuCount() const { return m_menuCount; }
 169   inline wxMenu* GetMenu(int i) const { return m_menus[i]; }
 170
 171  public:
 172   wxEvtHandler *            m_eventHandler;
 173   int                       m_menuCount;
 174   wxMenu **                 m_menus;
 175   wxString *                m_titles;
 176   wxFrame *                 m_menuBarFrame;
 177   WXHMENU                   m_hMenu;
 178 };
 179
 180 #endif // _WX_MENU_H_