// Created: 01/02/97
// RCS-ID: $Id$
// Copyright: (c) Julian Smart and Markus Holzem
-// Licence: wxWindows license
+// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
-#ifndef __MENUH__
-#define __MENUH__
+#ifndef _WX_MENU_H_
+#define _WX_MENU_H_
#ifdef __GNUG__
#pragma interface "menu.h"
#include "wx/defs.h"
#include "wx/event.h"
-class wxMenuItem;
-class wxMenuBar;
-class wxMenu;
+class WXDLLEXPORT wxMenuItem;
+class WXDLLEXPORT wxMenuBar;
+class WXDLLEXPORT wxMenu;
WXDLLEXPORT_DATA(extern const char*) wxEmptyString;
void Append(int id, const wxString& Label, const wxString& helpString = wxEmptyString,
bool checkable = FALSE);
// a submenu
- void Append(int id, const wxString& Label, wxMenu *SubMenu,
+ void Append(int id, const wxString& Label, wxMenu *SubMenu,
const wxString& helpString = wxEmptyString);
// the most generic form (create wxMenuItem first and use it's functions)
void Append(wxMenuItem *pItem);
// delete an item
void Delete(int id); /* If it's a submenu, menu is not destroyed. VZ: why? */
+ // Client data
+ inline void SetClientData(void* clientData) { m_clientData = clientData; }
+ inline void* GetClientData() const { return m_clientData; }
+
// menu item control
void Enable(int id, bool Flag);
bool Enabled(int id) const;
inline bool IsEnabled(int id) const { return Enabled(id); };
void Check(int id, bool Flag);
bool Checked(int id) const;
- inline bool IsChecked(int id) const { return IsChecked(id); };
+ inline bool IsChecked(int id) const { return Checked(id); };
// item properties
// title
void SetTitle(const wxString& label);
- const wxString& GetTitle() const;
+ const wxString GetTitle() const;
// label
void SetLabel(int id, const wxString& label);
wxString GetLabel(int id) const;
// help string
- virtual void SetHelpString(const int id, const wxString& helpString);
- virtual wxString GetHelpString(const int id) const ;
+ virtual void SetHelpString(int id, const wxString& helpString);
+ virtual wxString GetHelpString(int id) const ;
// find item
- // Finds the item id matching the given string, NOT_FOUND if not found.
+ // Finds the item id matching the given string, wxNOT_FOUND if not found.
virtual int FindItem(const wxString& itemString) const ;
// Find wxMenuItem by ID, and item's menu too if itemMenu is !NULL.
- wxMenuItem *FindItemForId(const int itemId, wxMenu **itemMenu = NULL) const;
+ wxMenuItem *FindItemForId(int itemId, wxMenu **itemMenu = NULL) const;
+
+ // Updates the UI for a menu and all submenus recursively.
+ // source is the object that has the update event handlers
+ // defined for it. If NULL, the menu or associated window
+ // will be used.
+ void UpdateUI(wxEvtHandler* source = (wxEvtHandler*) NULL);
void ProcessCommand(wxCommandEvent& event);
inline void Callback(const wxFunction func) { m_callback = func; }
virtual void SetParent(wxEvtHandler *parent) { m_parent = parent; }
inline void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
- inline wxEvtHandler *GetEventHandler(void) { return m_eventHandler; }
+ inline wxEvtHandler *GetEventHandler() { return m_eventHandler; }
+
+ inline wxList& GetItems() const { return (wxList&) m_menuItems; }
// IMPLEMENTATION
- bool MSWCommand(const WXUINT param, const WXWORD id);
+ bool MSWCommand(WXUINT param, WXWORD id);
void SetInvokingWindow(wxWindow *pWin) { m_pInvokingWindow = pWin; }
wxWindow *GetInvokingWindow() const { return m_pInvokingWindow; }
wxEvtHandler * m_parent;
wxEvtHandler * m_eventHandler;
wxWindow *m_pInvokingWindow;
+ void* m_clientData;
};
// ----------------------------------------------------------------------------
// Menu Bar (a la Windows)
// ----------------------------------------------------------------------------
-class wxFrame;
+class WXDLLEXPORT wxFrame;
class WXDLLEXPORT wxMenuBar: public wxEvtHandler
{
DECLARE_DYNAMIC_CLASS(wxMenuBar)
- wxMenuBar(void);
- wxMenuBar(const int n, wxMenu *menus[], const wxString titles[]);
- ~wxMenuBar(void);
+public:
+ wxMenuBar();
+ wxMenuBar( long style );
+ wxMenuBar(int n, wxMenu *menus[], const wxString titles[]);
+ ~wxMenuBar();
void Append(wxMenu *menu, const wxString& title);
// Must only be used AFTER menu has been attached to frame,
// otherwise use individual menus to enable/disable items
- void Enable(const int Id, const bool Flag);
- bool Enabled(const int Id) const ;
- inline bool IsEnabled(const int Id) const { return Enabled(Id); };
- void EnableTop(const int pos, const bool Flag);
- void Check(const int id, const bool Flag);
- bool Checked(const int id) const ;
- inline bool IsChecked(const int Id) const { return Checked(Id); };
- void SetLabel(const int id, const wxString& label) ;
- wxString GetLabel(const int id) const ;
- void SetLabelTop(const int pos, const wxString& label) ;
- wxString GetLabelTop(const int pos) const ;
- virtual void Delete(wxMenu *menu, const int index = 0); /* Menu not destroyed */
+ void Enable(int Id, bool Flag);
+ bool Enabled(int Id) const ;
+ inline bool IsEnabled(int Id) const { return Enabled(Id); };
+ void EnableTop(int pos, bool Flag);
+ void Check(int id, bool Flag);
+ bool Checked(int id) const ;
+ inline bool IsChecked(int Id) const { return Checked(Id); };
+ void SetLabel(int id, const wxString& label) ;
+ wxString GetLabel(int id) const ;
+ void SetLabelTop(int pos, const wxString& label) ;
+ wxString GetLabelTop(int pos) const ;
+ virtual void Delete(wxMenu *menu, int index = 0); /* Menu not destroyed */
virtual bool OnAppend(wxMenu *menu, const char *title);
- virtual bool OnDelete(wxMenu *menu, const int index);
+ virtual bool OnDelete(wxMenu *menu, int index);
- virtual void SetHelpString(const int Id, const wxString& helpString);
- virtual wxString GetHelpString(const int Id) const ;
+ virtual void SetHelpString(int Id, const wxString& helpString);
+ virtual wxString GetHelpString(int Id) const ;
virtual int FindMenuItem(const wxString& menuString, const wxString& itemString) const ;
// Find wxMenuItem for item ID, and return item's
// menu too if itemMenu is non-NULL.
- wxMenuItem *FindItemForId(const int itemId, wxMenu **menuForItem = NULL) const ;
+ wxMenuItem *FindItemForId(int itemId, wxMenu **menuForItem = NULL) const ;
inline void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
- inline wxEvtHandler *GetEventHandler(void) { return m_eventHandler; }
+ inline wxEvtHandler *GetEventHandler() { return m_eventHandler; }
+
+ inline int GetMenuCount() const { return m_menuCount; }
+ inline wxMenu* GetMenu(int i) const { return m_menus[i]; }
public:
wxEvtHandler * m_eventHandler;
WXHMENU m_hMenu;
};
-#endif // __MENUH__
+#endif // _WX_MENU_H_