X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2bda0e173844e8e0f8acf4e8ad8b5c26e5c6fe5d..5a224901b8ede55e1db9980f0fcaf7d2cb49285f:/include/wx/msw/menu.h diff --git a/include/wx/msw/menu.h b/include/wx/msw/menu.h index 0a9f3642c7..310586e498 100644 --- a/include/wx/msw/menu.h +++ b/include/wx/msw/menu.h @@ -1,174 +1,192 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: menu.h +// Name: wx/msw/menu.h // Purpose: wxMenu, wxMenuBar classes // Author: Julian Smart // Modified by: Vadim Zeitlin (wxMenuItem is now in separate file) // 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" + #pragma interface "menu.h" #endif -#include "wx/defs.h" -#include "wx/event.h" +#if wxUSE_ACCEL + #include "wx/accel.h" + #include "wx/dynarray.h" -class wxMenuItem; -class wxMenuBar; -class wxMenu; + WX_DEFINE_EXPORTED_ARRAY(wxAcceleratorEntry *, wxAcceleratorArray); +#endif // wxUSE_ACCEL -WXDLLEXPORT_DATA(extern const char*) wxEmptyString; +class WXDLLEXPORT wxFrame; // ---------------------------------------------------------------------------- // Menu // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxMenu: public wxEvtHandler -{ - DECLARE_DYNAMIC_CLASS(wxMenu) +class WXDLLEXPORT wxMenu : public wxMenuBase +{ public: - // ctor & dtor - wxMenu(const wxString& title = wxEmptyString, const wxFunction func = NULL); - ~wxMenu(); - - // construct menu - // append items to the menu - // separator line - void AppendSeparator(); - // normal item - 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, - const wxString& helpString = wxEmptyString); - // the most generic form (create wxMenuItem first and use it's functions) - void Append(wxMenuItem *pItem); - // insert a break in the menu - void Break(); - // delete an item - void Delete(int id); /* If it's a submenu, menu is not destroyed. VZ: why? */ - - // 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); }; - - // item properties - // title - void SetTitle(const wxString& label); - 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 ; - - // find item - // Finds the item id matching the given string, NOT_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; - - 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; } - - // IMPLEMENTATION - bool MSWCommand(const WXUINT param, const WXWORD id); - - void SetInvokingWindow(wxWindow *pWin) { m_pInvokingWindow = pWin; } - wxWindow *GetInvokingWindow() const { return m_pInvokingWindow; } - - // semi-private accessors - // get the window which contains this menu - wxWindow *GetWindow() const; - // get the menu handle - WXHMENU GetHMenu() const; + // ctors & dtor + wxMenu(const wxString& title, long style = 0) + : wxMenuBase(title, style) { Init(); } + + wxMenu(long style = 0) : wxMenuBase(style) { Init(); } + + virtual ~wxMenu(); + + // implement base class virtuals + virtual bool DoAppend(wxMenuItem *item); + virtual bool DoInsert(size_t pos, wxMenuItem *item); + virtual wxMenuItem *DoRemove(wxMenuItem *item); + + virtual void Break(); + + virtual void SetTitle(const wxString& title); + + // deprecated functions +#if wxUSE_MENU_CALLBACK + wxMenu(const wxString& title, const wxFunction func) + : wxMenuBase(title) + { + Init(); + + Callback(func); + } +#endif // wxUSE_MENU_CALLBACK + + // implementation only from now on + // ------------------------------- + + virtual void Attach(wxMenuBarBase *menubar); + + bool MSWCommand(WXUINT param, WXWORD id); + + // semi-private accessors + // get the window which contains this menu + wxWindow *GetWindow() const; + // get the menu handle + WXHMENU GetHMenu() const { return m_hMenu; } + +#if wxUSE_ACCEL + // called by wxMenuBar to build its accel table from the accels of all menus + bool HasAccels() const { return !m_accels.IsEmpty(); } + size_t GetAccelCount() const { return m_accels.GetCount(); } + size_t CopyAccels(wxAcceleratorEntry *accels) const; + + // called by wxMenuItem when its accels changes + void UpdateAccel(wxMenuItem *item); + + // helper used by wxMenu itself (returns the index in m_accels) + int FindAccel(int id) const; +#endif // wxUSE_ACCEL private: - bool m_doBreak ; + // common part of all ctors + void Init(); -public: - // This is used when m_hMenu is NULL because we don't want to - // delete it in ~wxMenu (it's been added to a parent menu). - // But we'll still need the handle for other purposes. - // Might be better to have a flag saying whether it's deleteable or not. - WXHMENU m_savehMenu ; // Used for Enable() on popup - WXHMENU m_hMenu; - wxFunction m_callback; - - int m_noItems; - wxString m_title; - wxMenu * m_topLevelMenu; - wxMenuBar * m_menuBar; - wxList m_menuItems; - wxEvtHandler * m_parent; - wxEvtHandler * m_eventHandler; - wxWindow *m_pInvokingWindow; + // common part of Append/Insert (behaves as Append is pos == (size_t)-1) + bool DoInsertOrAppend(wxMenuItem *item, size_t pos = (size_t)-1); + + // terminate the current radio group, if any + void EndRadioGroup(); + + // if TRUE, insert a breal before appending the next item + bool m_doBreak; + + // the position of the first item in the current radio group or -1 + int m_startRadioGroup; + + // the menu handle of this menu + WXHMENU m_hMenu; + +#if wxUSE_ACCEL + // the accelerators for our menu items + wxAcceleratorArray m_accels; +#endif // wxUSE_ACCEL + + DECLARE_DYNAMIC_CLASS(wxMenu) }; // ---------------------------------------------------------------------------- // Menu Bar (a la Windows) // ---------------------------------------------------------------------------- -class wxFrame; -class WXDLLEXPORT wxMenuBar: public wxEvtHandler + +class WXDLLEXPORT wxMenuBar : public wxMenuBarBase { - DECLARE_DYNAMIC_CLASS(wxMenuBar) - - wxMenuBar(void); - wxMenuBar(const int n, wxMenu *menus[], const wxString titles[]); - ~wxMenuBar(void); - - 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 */ - virtual bool OnAppend(wxMenu *menu, const char *title); - virtual bool OnDelete(wxMenu *menu, const int index); - - virtual void SetHelpString(const int Id, const wxString& helpString); - virtual wxString GetHelpString(const 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 ; - - inline void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; } - inline wxEvtHandler *GetEventHandler(void) { return m_eventHandler; } - - public: - wxEvtHandler * m_eventHandler; - int m_menuCount; - wxMenu ** m_menus; - wxString * m_titles; - wxFrame * m_menuBarFrame; - WXHMENU m_hMenu; +public: + // ctors & dtor + // default constructor + wxMenuBar(); + // unused under MSW + wxMenuBar(long style); + // menubar takes ownership of the menus arrays but copies the titles + wxMenuBar(int n, wxMenu *menus[], const wxString titles[]); + virtual ~wxMenuBar(); + + // menubar construction + virtual bool Append( wxMenu *menu, const wxString &title ); + virtual bool Insert(size_t pos, wxMenu *menu, const wxString& title); + virtual wxMenu *Replace(size_t pos, wxMenu *menu, const wxString& title); + virtual wxMenu *Remove(size_t pos); + + virtual void EnableTop( size_t pos, bool flag ); + virtual void SetLabelTop( size_t pos, const wxString& label ); + virtual wxString GetLabelTop( size_t pos ) const; + + // compatibility: these functions are deprecated +#if WXWIN_COMPATIBILITY + void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; } + wxEvtHandler *GetEventHandler() { return m_eventHandler; } + + bool Enabled(int id) const { return IsEnabled(id); } + bool Checked(int id) const { return IsChecked(id); } +#endif // WXWIN_COMPATIBILITY + + // implementation from now on + WXHMENU Create(); + virtual void Detach(); + virtual void Attach(wxFrame *frame); + +#if wxUSE_ACCEL + // get the accel table for all the menus + const wxAcceleratorTable& GetAccelTable() const { return m_accelTable; } + + // update the accel table (must be called after adding/deletign a menu) + void RebuildAccelTable(); +#endif // wxUSE_ACCEL + + // get the menu handle + WXHMENU GetHMenu() const { return m_hMenu; } + + // if the menubar is modified, the display is not updated automatically, + // call this function to update it (m_menuBarFrame should be !NULL) + void Refresh(); + +protected: + // common part of all ctors + void Init(); + +#if WXWIN_COMPATIBILITY + wxEvtHandler *m_eventHandler; +#endif // WXWIN_COMPATIBILITY + + wxArrayString m_titles; + + WXHMENU m_hMenu; + +#if wxUSE_ACCEL + // the accelerator table for all accelerators in all our menus + wxAcceleratorTable m_accelTable; +#endif // wxUSE_ACCEL + +private: + DECLARE_DYNAMIC_CLASS(wxMenuBar) }; -#endif // __MENUH__ +#endif // _WX_MENU_H_