X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ad9bb75ff2c6a1734c24742c5f39ed8be197e16d..5a224901b8ede55e1db9980f0fcaf7d2cb49285f:/include/wx/msw/menu.h diff --git a/include/wx/msw/menu.h b/include/wx/msw/menu.h index 84746929c6..310586e498 100644 --- a/include/wx/msw/menu.h +++ b/include/wx/msw/menu.h @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// 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) @@ -16,179 +16,101 @@ #pragma interface "menu.h" #endif -#include "wx/defs.h" -#include "wx/event.h" -#include "wx/dynarray.h" -#include "wx/string.h" - #if wxUSE_ACCEL #include "wx/accel.h" + #include "wx/dynarray.h" + + WX_DEFINE_EXPORTED_ARRAY(wxAcceleratorEntry *, wxAcceleratorArray); #endif // wxUSE_ACCEL -class WXDLLEXPORT wxMenuItem; -class WXDLLEXPORT wxMenuBar; -class WXDLLEXPORT wxMenu; class WXDLLEXPORT wxFrame; -WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString; - -WX_DEFINE_ARRAY(wxAcceleratorEntry *, wxAcceleratorArray); - // ---------------------------------------------------------------------------- // Menu // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxMenu : public wxEvtHandler +class WXDLLEXPORT wxMenu : public wxMenuBase { - DECLARE_DYNAMIC_CLASS(wxMenu) - public: // ctors & dtor - wxMenu(const wxString& title, - const wxFunction func) - { - Init(title, func); - } + wxMenu(const wxString& title, long style = 0) + : wxMenuBase(title, style) { Init(); } - wxMenu( long WXUNUSED(style) ) - { - Init( wxEmptyString ); - } + wxMenu(long style = 0) : wxMenuBase(style) { Init(); } - wxMenu(const wxString& title = wxEmptyString, long WXUNUSED(style) = 0) + 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(title); + Init(); + + Callback(func); } +#endif // wxUSE_MENU_CALLBACK - virtual ~wxMenu(); + // implementation only from now on + // ------------------------------- - // construct menu - // append a separator to the menu - void AppendSeparator(); - // append a normal item to the menu - void Append(int id, const wxString& label, - const wxString& helpString = wxEmptyString, - bool checkable = FALSE); - // append a submenu - void Append(int id, const wxString& label, - wxMenu *submenu, - const wxString& helpString = wxEmptyString); - // append anything (create wxMenuItem first) - void Append(wxMenuItem *pItem); - - // insert a break in the menu - void Break(); - - // delete an item - // If it's a submenu, menu is not destroyed. - // VZ: why? shouldn't it return "wxMenu *" then? - void Delete(int id); - - // client data - void SetClientData(void* clientData) { m_clientData = clientData; } - void* GetClientData() const { return m_clientData; } - - // menu item control - // enable/disable item - void Enable(int id, bool enable); - // TRUE if enabled - bool IsEnabled(int id) const; - - // check/uncheck item - only for checkable items, of course - void Check(int id, bool check); - // TRUE if checked - bool IsChecked(int id) const; - - // other properties - // the menu title - void SetTitle(const wxString& label); - const wxString GetTitle() const; - // the item label - void SetLabel(int id, const wxString& label); - wxString GetLabel(int id) const; - // help string - virtual void SetHelpString(int id, const wxString& helpString); - virtual wxString GetHelpString(int id) const; - - // get the list of items - wxList& GetItems() const { return (wxList &)m_menuItems; } - - // find item - // returns id of the item matching the given string or wxNOT_FOUND - virtual int FindItem(const wxString& itemString) const; - // returns NULL if not found - wxMenuItem* FindItem(int id) const { return FindItemForId(id); } - // find wxMenuItem by ID, and item's menu too if itemMenu is !NULL - 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); - - bool ProcessCommand(wxCommandEvent& event); + virtual void Attach(wxMenuBarBase *menubar); - void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; } - wxEvtHandler *GetEventHandler() const { return m_eventHandler; } - - // IMPLEMENTATION bool MSWCommand(WXUINT param, 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; - - // only for wxMenuBar - void Attach(wxMenuBar *menubar); - void Detach(); + 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; -#endif // wxUSE_ACCEL - wxFunction GetCallback() const { return m_callback; } - void Callback(const wxFunction func) { m_callback = func; } - wxFunction m_callback; - -#ifdef WXWIN_COMPATIBILITY - // compatibility: these functions are deprecated - bool Enabled(int id) const { return IsEnabled(id); } - bool Checked(int id) const { return IsChecked(id); } + // called by wxMenuItem when its accels changes + void UpdateAccel(wxMenuItem *item); -#endif // WXWIN_COMPATIBILITY + // helper used by wxMenu itself (returns the index in m_accels) + int FindAccel(int id) const; +#endif // wxUSE_ACCEL private: // common part of all ctors - void Init(const wxString& title, const wxFunction func = NULL ); - - bool m_doBreak; - - // 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; - - int m_noItems; - wxString m_title; - wxMenu * m_topLevelMenu; - wxMenuBar * m_menuBar; - wxList m_menuItems; - wxEvtHandler * m_eventHandler; - wxWindow *m_pInvokingWindow; - void* m_clientData; + void Init(); + + // 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) }; // ---------------------------------------------------------------------------- @@ -213,16 +135,12 @@ public: virtual wxMenu *Replace(size_t pos, wxMenu *menu, const wxString& title); virtual wxMenu *Remove(size_t pos); - virtual int FindMenuItem(const wxString& menuString, - const wxString& itemString) const; - virtual wxMenuItem* FindItem( int id, wxMenu **menu = NULL ) const; - 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 -#ifdef WXWIN_COMPATIBILITY +#if WXWIN_COMPATIBILITY void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; } wxEvtHandler *GetEventHandler() { return m_eventHandler; } @@ -232,19 +150,15 @@ public: // implementation from now on WXHMENU Create(); - int FindMenu(const wxString& title); - void Detach(); - - // returns TRUE if we're attached to a frame - bool IsAttached() const { return m_menuBarFrame != NULL; } - // get the frame we live in - wxFrame *GetFrame() const { return m_menuBarFrame; } - // attach to a frame - void Attach(wxFrame *frame); + virtual void Detach(); + virtual void Attach(wxFrame *frame); #if wxUSE_ACCEL - // get the accel table for the menus + // 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 @@ -258,13 +172,12 @@ protected: // common part of all ctors void Init(); -#ifdef WXWIN_COMPATIBILITY +#if WXWIN_COMPATIBILITY wxEvtHandler *m_eventHandler; #endif // WXWIN_COMPATIBILITY wxArrayString m_titles; - wxFrame *m_menuBarFrame; WXHMENU m_hMenu; #if wxUSE_ACCEL