include/wx/stubs/menu.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        menu.h
   3 // Purpose:     wxMenu, wxMenuBar classes
   4 // Author:      AUTHOR
   5 // Modified by:
   6 // Created:     ??/??/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) AUTHOR
   9 // Licence:     wxWindows licence
  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);
  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 IsChecked(id); };
  64
  65   // Client data
  66   inline void SetClientData(void* clientData) { m_clientData = clientData; }
  67   inline void* GetClientData() const { return m_clientData; }
  68
  69   // item properties
  70     // title
  71   void SetTitle(const wxString& label);
  72   const wxString GetTitle() const;
  73     // label
  74   void SetLabel(int id, const wxString& label);
  75   wxString GetLabel(int id) const;
  76     // help string
  77   virtual void SetHelpString(int id, const wxString& helpString);
  78   virtual wxString GetHelpString(int id) const ;
  79
  80   // find item
  81     // Finds the item id matching the given string, -1 if not found.
  82   virtual int FindItem(const wxString& itemString) const ;
  83     // Find wxMenuItem by ID, and item's menu too if itemMenu is !NULL.
  84   wxMenuItem *FindItemForId(int itemId, wxMenu **itemMenu = NULL) const;
  85
  86   void ProcessCommand(wxCommandEvent& event);
  87   inline void Callback(const wxFunction func) { m_callback = func; }
  88
  89   virtual void SetParent(wxEvtHandler *parent) { m_parent = parent; }
  90   inline void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
  91   inline wxEvtHandler *GetEventHandler() { return m_eventHandler; }
  92
  93   inline wxList& GetItems() const { return (wxList&) m_menuItems; }
  94
  95 public:
  96   wxFunction        m_callback;
  97
  98   int               m_noItems;
  99   wxString          m_title;
 100   wxMenuBar *       m_menuBar;
 101   wxList            m_menuItems;
 102   wxEvtHandler *    m_parent;
 103   wxEvtHandler *    m_eventHandler;
 104   void*             m_clientData;
 105 };
 106
 107 // ----------------------------------------------------------------------------
 108 // Menu Bar (a la Windows)
 109 // ----------------------------------------------------------------------------
 110 class WXDLLEXPORT wxFrame;
 111 class WXDLLEXPORT wxMenuBar: public wxEvtHandler
 112 {
 113   DECLARE_DYNAMIC_CLASS(wxMenuBar)
 114
 115   wxMenuBar();
 116   wxMenuBar(int n, wxMenu *menus[], const wxString titles[]);
 117   ~wxMenuBar();
 118
 119   void Append(wxMenu *menu, const wxString& title);
 120   // Must only be used AFTER menu has been attached to frame,
 121   // otherwise use individual menus to enable/disable items
 122   void Enable(int Id, bool Flag);
 123   bool Enabled(int Id) const ;
 124   inline bool IsEnabled(int Id) const { return Enabled(Id); };
 125   void EnableTop(int pos, bool Flag);
 126   void Check(int id, bool Flag);
 127   bool Checked(int id) const ;
 128   inline bool IsChecked(int Id) const { return Checked(Id); };
 129   void SetLabel(int id, const wxString& label) ;
 130   wxString GetLabel(int id) const ;
 131   void SetLabelTop(int pos, const wxString& label) ;
 132   wxString GetLabelTop(int pos) const ;
 133   virtual void Delete(wxMenu *menu, int index = 0); /* Menu not destroyed */
 134   virtual bool OnAppend(wxMenu *menu, const char *title);
 135   virtual bool OnDelete(wxMenu *menu, int index);
 136
 137   virtual void SetHelpString(int Id, const wxString& helpString);
 138   virtual wxString GetHelpString(int Id) const ;
 139
 140   virtual int FindMenuItem(const wxString& menuString, const wxString& itemString) const ;
 141
 142   // Find wxMenuItem for item ID, and return item's
 143   // menu too if itemMenu is non-NULL.
 144   wxMenuItem *FindItemForId(int itemId, wxMenu **menuForItem = NULL) const ;
 145
 146   inline void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
 147   inline wxEvtHandler *GetEventHandler() { return m_eventHandler; }
 148
 149   inline int GetMenuCount() const { return m_menuCount; }
 150   inline wxMenu* GetMenu(int i) const { return m_menus[i]; }
 151
 152  public:
 153   wxEvtHandler *            m_eventHandler;
 154   int                       m_menuCount;
 155   wxMenu **                 m_menus;
 156   wxString *                m_titles;
 157   wxFrame *                 m_menuBarFrame;
 158 /* TODO: data that represents the actual menubar when created.
 159  */
 160 };
 161
 162 #endif // _WX_MENU_H_