X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/bd582574c2b98f7ba8049821a1241516396daecf..86b79b93fbbb0c2e90e6595f7fea0f979b80881c:/include/wx/menu.h diff --git a/include/wx/menu.h b/include/wx/menu.h index 77633a7814..f23b6ac400 100644 --- a/include/wx/menu.h +++ b/include/wx/menu.h @@ -12,10 +12,12 @@ #ifndef _WX_MENU_H_BASE_ #define _WX_MENU_H_BASE_ -#if defined(__GNUG__) && !defined(__APPLE__) +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma interface "menubase.h" #endif +#include "wx/defs.h" + #if wxUSE_MENUS // ---------------------------------------------------------------------------- @@ -38,21 +40,6 @@ class WXDLLEXPORT wxMenuItem; WX_DECLARE_EXPORTED_LIST(wxMenu, wxMenuList); WX_DECLARE_EXPORTED_LIST(wxMenuItem, wxMenuItemList); -// ---------------------------------------------------------------------------- -// conditional compilation -// ---------------------------------------------------------------------------- - -// having callbacks in menus is a wxWin 1.6x feature which should be replaced -// with event tables in wxWin 2.xx code - however provide it because many -// people like it a lot by default -#ifndef wxUSE_MENU_CALLBACK - #if WXWIN_COMPATIBILITY_2 - #define wxUSE_MENU_CALLBACK 1 - #else - #define wxUSE_MENU_CALLBACK 0 - #endif // WXWIN_COMPATIBILITY_2 -#endif // !defined(wxUSE_MENU_CALLBACK) - // ---------------------------------------------------------------------------- // wxMenu // ---------------------------------------------------------------------------- @@ -76,142 +63,142 @@ public: // ----------------- // append any kind of item (normal/check/radio/separator) - void Append(int itemid, - const wxString& text, - const wxString& help = wxEmptyString, - wxItemKind kind = wxITEM_NORMAL) + wxMenuItem* Append(int itemid, + const wxString& text, + const wxString& help = wxEmptyString, + wxItemKind kind = wxITEM_NORMAL) { - DoAppend(wxMenuItem::New((wxMenu *)this, itemid, text, help, kind)); + return DoAppend(wxMenuItem::New((wxMenu *)this, itemid, text, help, kind)); } // append a separator to the menu - void AppendSeparator() { Append(wxID_SEPARATOR, wxEmptyString); } + wxMenuItem* AppendSeparator() { return Append(wxID_SEPARATOR, wxEmptyString); } // append a check item - void AppendCheckItem(int itemid, - const wxString& text, - const wxString& help = wxEmptyString) + wxMenuItem* AppendCheckItem(int itemid, + const wxString& text, + const wxString& help = wxEmptyString) { - Append(itemid, text, help, wxITEM_CHECK); + return Append(itemid, text, help, wxITEM_CHECK); } // append a radio item - void AppendRadioItem(int itemid, - const wxString& text, - const wxString& help = wxEmptyString) + wxMenuItem* AppendRadioItem(int itemid, + const wxString& text, + const wxString& help = wxEmptyString) { - Append(itemid, text, help, wxITEM_RADIO); + return Append(itemid, text, help, wxITEM_RADIO); } // append a submenu - void Append(int itemid, - const wxString& text, - wxMenu *submenu, - const wxString& help = wxEmptyString) + wxMenuItem* Append(int itemid, + const wxString& text, + wxMenu *submenu, + const wxString& help = wxEmptyString) { - DoAppend(wxMenuItem::New((wxMenu *)this, itemid, text, help, - wxITEM_NORMAL, submenu)); + return DoAppend(wxMenuItem::New((wxMenu *)this, itemid, text, help, + wxITEM_NORMAL, submenu)); } // the most generic form of Append() - append anything - void Append(wxMenuItem *item) { DoAppend(item); } + wxMenuItem* Append(wxMenuItem *item) { return DoAppend(item); } // insert a break in the menu (only works when appending the items, not // inserting them) virtual void Break() { } // insert an item before given position - bool Insert(size_t pos, wxMenuItem *item); + wxMenuItem* Insert(size_t pos, wxMenuItem *item); // insert an item before given position - void Insert(size_t pos, - int itemid, - const wxString& text, - const wxString& help = wxEmptyString, - wxItemKind kind = wxITEM_NORMAL) + wxMenuItem* Insert(size_t pos, + int itemid, + const wxString& text, + const wxString& help = wxEmptyString, + wxItemKind kind = wxITEM_NORMAL) { - Insert(pos, wxMenuItem::New((wxMenu *)this, itemid, text, help, kind)); + return Insert(pos, wxMenuItem::New((wxMenu *)this, itemid, text, help, kind)); } // insert a separator - void InsertSeparator(size_t pos) + wxMenuItem* InsertSeparator(size_t pos) { - Insert(pos, wxMenuItem::New((wxMenu *)this)); + return Insert(pos, wxMenuItem::New((wxMenu *)this, wxID_SEPARATOR)); } // insert a check item - void InsertCheckItem(size_t pos, - int itemid, - const wxString& text, - const wxString& help = wxEmptyString) + wxMenuItem* InsertCheckItem(size_t pos, + int itemid, + const wxString& text, + const wxString& help = wxEmptyString) { - Insert(pos, itemid, text, help, wxITEM_CHECK); + return Insert(pos, itemid, text, help, wxITEM_CHECK); } // insert a radio item - void InsertRadioItem(size_t pos, - int itemid, - const wxString& text, - const wxString& help = wxEmptyString) + wxMenuItem* InsertRadioItem(size_t pos, + int itemid, + const wxString& text, + const wxString& help = wxEmptyString) { - Insert(pos, itemid, text, help, wxITEM_RADIO); + return Insert(pos, itemid, text, help, wxITEM_RADIO); } // insert a submenu - void Insert(size_t pos, - int itemid, - const wxString& text, - wxMenu *submenu, - const wxString& help = wxEmptyString) + wxMenuItem* Insert(size_t pos, + int itemid, + const wxString& text, + wxMenu *submenu, + const wxString& help = wxEmptyString) { - Insert(pos, wxMenuItem::New((wxMenu *)this, itemid, text, help, - wxITEM_NORMAL, submenu)); + return Insert(pos, wxMenuItem::New((wxMenu *)this, itemid, text, help, + wxITEM_NORMAL, submenu)); } // prepend an item to the menu - void Prepend(wxMenuItem *item) + wxMenuItem* Prepend(wxMenuItem *item) { - Insert(0u, item); + return Insert(0u, item); } // prepend any item to the menu - void Prepend(int itemid, - const wxString& text, - const wxString& help = wxEmptyString, - wxItemKind kind = wxITEM_NORMAL) + wxMenuItem* Prepend(int itemid, + const wxString& text, + const wxString& help = wxEmptyString, + wxItemKind kind = wxITEM_NORMAL) { - Insert(0u, itemid, text, help, kind); + return Insert(0u, itemid, text, help, kind); } // prepend a separator - void PrependSeparator() + wxMenuItem* PrependSeparator() { - InsertSeparator(0u); + return InsertSeparator(0u); } // prepend a check item - void PrependCheckItem(int itemid, - const wxString& text, - const wxString& help = wxEmptyString) + wxMenuItem* PrependCheckItem(int itemid, + const wxString& text, + const wxString& help = wxEmptyString) { - InsertCheckItem(0u, itemid, text, help); + return InsertCheckItem(0u, itemid, text, help); } // prepend a radio item - void PrependRadioItem(int itemid, - const wxString& text, - const wxString& help = wxEmptyString) + wxMenuItem* PrependRadioItem(int itemid, + const wxString& text, + const wxString& help = wxEmptyString) { - InsertRadioItem(0u, itemid, text, help); + return InsertRadioItem(0u, itemid, text, help); } // prepend a submenu - void Prepend(int itemid, - const wxString& text, - wxMenu *submenu, - const wxString& help = wxEmptyString) + wxMenuItem* Prepend(int itemid, + const wxString& text, + wxMenu *submenu, + const wxString& help = wxEmptyString) { - Insert(0u, itemid, text, submenu, help); + return Insert(0u, itemid, text, submenu, help); } // detach an item from the menu, but don't delete it so that it can be @@ -285,15 +272,15 @@ public: void UpdateUI(wxEvtHandler* source = (wxEvtHandler*)NULL); // get the menu bar this menu is attached to (may be NULL, always NULL for - // popup menus) - wxMenuBar *GetMenuBar() const { return m_menuBar; } + // popup menus). Traverse up the menu hierarchy to find it. + wxMenuBar *GetMenuBar() const; // called when the menu is attached/detached to/from a menu bar virtual void Attach(wxMenuBarBase *menubar); virtual void Detach(); // is the menu attached to a menu bar (or is it a popup one)? - bool IsAttached() const { return m_menuBar != NULL; } + bool IsAttached() const { return GetMenuBar() != NULL; } // set/get the parent of this menu void SetParent(wxMenu *parent) { m_menuParent = parent; } @@ -343,30 +330,17 @@ public: Insert(0u, itemid, text, help, isCheckable); } -#if WXWIN_COMPATIBILITY - bool Enabled(int itemid) const { return IsEnabled(itemid); } - bool Checked(int itemid) const { return IsChecked(itemid); } - - wxMenuItem* FindItemForId(int itemId, wxMenu **itemMenu) const - { return FindItem(itemId, itemMenu); } - - wxList& GetItems() const { return (wxList &)m_items; } -#endif // WXWIN_COMPATIBILITY - -#if wxUSE_MENU_CALLBACK || defined(__WXMOTIF__) - // wxWin 1.6x compatible menu event handling - wxFunction GetCallback() const { return m_callback; } - void Callback(const wxFunction func) { m_callback = func; } - - wxFunction m_callback; -#endif // wxUSE_MENU_CALLBACK - + static void LockAccels(bool locked) + { + ms_locked = locked; + } + protected: // virtuals to override in derived classes // --------------------------------------- - virtual bool DoAppend(wxMenuItem *item); - virtual bool DoInsert(size_t pos, wxMenuItem *item); + virtual wxMenuItem* DoAppend(wxMenuItem *item); + virtual wxMenuItem* DoInsert(size_t pos, wxMenuItem *item); virtual wxMenuItem *DoRemove(wxMenuItem *item); virtual bool DoDelete(wxMenuItem *item); @@ -393,6 +367,8 @@ protected: wxEvtHandler *m_eventHandler; // a pluggable in event handler + static bool ms_locked; + DECLARE_NO_COPY_CLASS(wxMenuBase) }; @@ -503,18 +479,6 @@ public: // don't want menu bars to accept the focus by tabbing to them virtual bool AcceptsFocusFromKeyboard() const { return FALSE; } - // compatibility only: these functions are deprecated, use the new ones - // instead -#if WXWIN_COMPATIBILITY - bool Enabled(int itemid) const { return IsEnabled(itemid); } - bool Checked(int itemid) const { return IsChecked(itemid); } - - wxMenuItem* FindMenuItemById(int itemid) const - { return FindItem(itemid); } - wxMenuItem* FindItemForId(int itemid, wxMenu **menu = NULL) const - { return FindItem(itemid, menu); } -#endif // WXWIN_COMPATIBILITY - protected: // the list of all our menus wxMenuList m_menus;