X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0e528b997e87057723d1b823dd86e3f69ebb672b..66c2bf7b1d9326fb650acfaae22ec50528cfbf7c:/include/wx/menu.h?ds=sidebyside diff --git a/include/wx/menu.h b/include/wx/menu.h index 83576de1cf..e4dedcf2dd 100644 --- a/include/wx/menu.h +++ b/include/wx/menu.h @@ -4,17 +4,16 @@ // Author: Vadim Zeitlin // Modified by: // Created: 26.10.99 -// RCS-ID: $Id$ -// Copyright: (c) wxWindows team -// Licence: wxWindows license +// Copyright: (c) wxWidgets team +// Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// #ifndef _WX_MENU_H_BASE_ #define _WX_MENU_H_BASE_ -#ifdef __GNUG__ - #pragma interface "menubase.h" -#endif +#include "wx/defs.h" + +#if wxUSE_MENUS // ---------------------------------------------------------------------------- // headers @@ -27,19 +26,21 @@ // included wx/menu.h #include "wx/menuitem.h" -class WXDLLEXPORT wxMenu; -class WXDLLEXPORT wxMenuBar; -class WXDLLEXPORT wxMenuItem; +class WXDLLIMPEXP_FWD_CORE wxFrame; +class WXDLLIMPEXP_FWD_CORE wxMenu; +class WXDLLIMPEXP_FWD_CORE wxMenuBarBase; +class WXDLLIMPEXP_FWD_CORE wxMenuBar; +class WXDLLIMPEXP_FWD_CORE wxMenuItem; // pseudo template list classes -WX_DECLARE_LIST(wxMenu, wxMenuList); -WX_DECLARE_LIST(wxMenuItem, wxMenuItemList); +WX_DECLARE_EXPORTED_LIST(wxMenu, wxMenuList); +WX_DECLARE_EXPORTED_LIST(wxMenuItem, wxMenuItemList); // ---------------------------------------------------------------------------- // wxMenu // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxMenuBase : public wxEvtHandler +class WXDLLIMPEXP_CORE wxMenuBase : public wxEvtHandler { public: // create a menu @@ -57,50 +58,157 @@ public: // menu construction // ----------------- - // append a normal item to the menu - void Append(int id, - const wxString& text, - const wxString& help = wxEmptyString, - bool isCheckable = FALSE) + // append any kind of item (normal/check/radio/separator) + wxMenuItem* Append(int itemid, + const wxString& text = wxEmptyString, + const wxString& help = wxEmptyString, + wxItemKind kind = wxITEM_NORMAL) { - DoAppend(wxMenuItem::New((wxMenu *)this, id, text, help, isCheckable)); + 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); } + + // append a check item + wxMenuItem* AppendCheckItem(int itemid, + const wxString& text, + const wxString& help = wxEmptyString) + { + return Append(itemid, text, help, wxITEM_CHECK); + } + + // append a radio item + wxMenuItem* AppendRadioItem(int itemid, + const wxString& text, + const wxString& help = wxEmptyString) + { + return Append(itemid, text, help, wxITEM_RADIO); + } // append a submenu - void Append(int id, - const wxString& text, - wxMenu *submenu, - const wxString& help = wxEmptyString) + wxMenuItem* AppendSubMenu(wxMenu *submenu, + const wxString& text, + const wxString& help = wxEmptyString) { - DoAppend(wxMenuItem::New((wxMenu *)this, id, text, help, FALSE, submenu)); + return DoAppend(wxMenuItem::New((wxMenu *)this, wxID_ANY, 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 + wxMenuItem* Insert(size_t pos, + int itemid, + const wxString& text = wxEmptyString, + const wxString& help = wxEmptyString, + wxItemKind kind = wxITEM_NORMAL) + { + return Insert(pos, wxMenuItem::New((wxMenu *)this, itemid, text, help, kind)); + } + + // insert a separator + wxMenuItem* InsertSeparator(size_t pos) + { + return Insert(pos, wxMenuItem::New((wxMenu *)this, wxID_SEPARATOR)); + } + + // insert a check item + wxMenuItem* InsertCheckItem(size_t pos, + int itemid, + const wxString& text, + const wxString& help = wxEmptyString) + { + return Insert(pos, itemid, text, help, wxITEM_CHECK); + } + + // insert a radio item + wxMenuItem* InsertRadioItem(size_t pos, + int itemid, + const wxString& text, + const wxString& help = wxEmptyString) + { + return Insert(pos, itemid, text, help, wxITEM_RADIO); + } + + // insert a submenu + wxMenuItem* Insert(size_t pos, + int itemid, + const wxString& text, + wxMenu *submenu, + const wxString& help = wxEmptyString) + { + return Insert(pos, wxMenuItem::New((wxMenu *)this, itemid, text, help, + wxITEM_NORMAL, submenu)); + } + + // prepend an item to the menu + wxMenuItem* Prepend(wxMenuItem *item) + { + return Insert(0u, item); + } + + // prepend any item to the menu + wxMenuItem* Prepend(int itemid, + const wxString& text = wxEmptyString, + const wxString& help = wxEmptyString, + wxItemKind kind = wxITEM_NORMAL) + { + return Insert(0u, itemid, text, help, kind); + } + + // prepend a separator + wxMenuItem* PrependSeparator() + { + return InsertSeparator(0u); + } + + // prepend a check item + wxMenuItem* PrependCheckItem(int itemid, + const wxString& text, + const wxString& help = wxEmptyString) + { + return InsertCheckItem(0u, itemid, text, help); + } + + // prepend a radio item + wxMenuItem* PrependRadioItem(int itemid, + const wxString& text, + const wxString& help = wxEmptyString) + { + return InsertRadioItem(0u, itemid, text, help); + } + + // prepend a submenu + wxMenuItem* Prepend(int itemid, + const wxString& text, + wxMenu *submenu, + const wxString& help = wxEmptyString) + { + return Insert(0u, itemid, text, submenu, help); + } // detach an item from the menu, but don't delete it so that it can be // added back later (but if it's not, the caller is responsible for // deleting it!) - wxMenuItem *Remove(int id) { return Remove(FindChildItem(id)); } + wxMenuItem *Remove(int itemid) { return Remove(FindChildItem(itemid)); } wxMenuItem *Remove(wxMenuItem *item); // delete an item from the menu (submenus are not destroyed by this // function, see Destroy) - bool Delete(int id) { return Delete(FindChildItem(id)); } + bool Delete(int itemid) { return Delete(FindChildItem(itemid)); } bool Delete(wxMenuItem *item); // delete the item from menu and destroy it (if it's a submenu) - bool Destroy(int id) { return Destroy(FindChildItem(id)); } + bool Destroy(int itemid) { return Destroy(FindChildItem(itemid)); } bool Destroy(wxMenuItem *item); // menu items access @@ -113,41 +221,54 @@ public: wxMenuItemList& GetMenuItems() { return m_items; } // search - virtual int FindItem(const wxString& itemString) const; - wxMenuItem* FindItem(int id, wxMenu **menu = NULL) const; + virtual int FindItem(const wxString& item) const; + wxMenuItem* FindItem(int itemid, wxMenu **menu = NULL) const; + + // find by position + wxMenuItem* FindItemByPosition(size_t position) const; // get/set items attributes - void Enable(int id, bool enable); - bool IsEnabled(int id) const; + void Enable(int itemid, bool enable); + bool IsEnabled(int itemid) const; + + void Check(int itemid, bool check); + bool IsChecked(int itemid) const; - void Check(int id, bool check); - bool IsChecked(int id) const; + void SetLabel(int itemid, const wxString& label); + wxString GetLabel(int itemid) const; - void SetLabel(int id, const wxString& label); - wxString GetLabel(int id) const; + // Returns the stripped label + wxString GetLabelText(int itemid) const { return wxMenuItem::GetLabelText(GetLabel(itemid)); } - virtual void SetHelpString(int id, const wxString& helpString); - virtual wxString GetHelpString(int id) const; + virtual void SetHelpString(int itemid, const wxString& helpString); + virtual wxString GetHelpString(int itemid) const; // misc accessors // -------------- // the title virtual void SetTitle(const wxString& title) { m_title = title; } - const wxString GetTitle() const { return m_title; } - - // client data - void SetClientData(void* clientData) { m_clientData = clientData; } - void* GetClientData() const { return m_clientData; } + const wxString& GetTitle() const { return m_title; } // event handler void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; } wxEvtHandler *GetEventHandler() const { return m_eventHandler; } - // invoking window - void SetInvokingWindow(wxWindow *win) { m_invokingWindow = win; } + // Invoking window: this is set by wxWindow::PopupMenu() before showing a + // popup menu and reset after it's hidden. Notice that you probably want to + // use GetWindow() below instead of GetInvokingWindow() as the latter only + // returns non-NULL for the top level menus + // + // NB: avoid calling SetInvokingWindow() directly if possible, use + // wxMenuInvokingWindowSetter class below instead + void SetInvokingWindow(wxWindow *win); wxWindow *GetInvokingWindow() const { return m_invokingWindow; } + // the window associated with this menu: this is the invoking window for + // popup menus or the top level window to which the menu bar is attached + // for menus which are part of a menu bar + wxWindow *GetWindow() const; + // style long GetStyle() const { return m_style; } @@ -157,42 +278,88 @@ public: // 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 UpdateUI(wxEvtHandler* source = NULL); + + // get the menu bar this menu is attached to (may be NULL, always NULL for + // 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; } wxMenu *GetParent() const { return m_menuParent; } -#if WXWIN_COMPATIBILITY + // implementation only from now on + // ------------------------------- + + // unlike FindItem(), this function doesn't recurse but only looks through + // our direct children and also may return the index of the found child if + // pos != NULL + wxMenuItem *FindChildItem(int itemid, size_t *pos = NULL) const; + + // called to generate a wxCommandEvent, return true if it was processed, + // false otherwise + // + // the checked parameter may have boolean value or -1 for uncheckable items + bool SendEvent(int itemid, int checked = -1); + // compatibility: these functions are deprecated, use the new ones instead - bool Enabled(int id) const { return IsEnabled(id); } - bool Checked(int id) const { return IsChecked(id); } + // ----------------------------------------------------------------------- - wxMenuItem* FindItemForId(int itemId, wxMenu **itemMenu) const - { return FindItem(itemId, itemMenu); } + // use the versions taking wxItem_XXX now instead, they're more readable + // and allow adding the radio items as well + void Append(int itemid, + const wxString& text, + const wxString& help, + bool isCheckable) + { + Append(itemid, text, help, isCheckable ? wxITEM_CHECK : wxITEM_NORMAL); + } + + // use more readable and not requiring unused itemid AppendSubMenu() instead + wxMenuItem* Append(int itemid, + const wxString& text, + wxMenu *submenu, + const wxString& help = wxEmptyString) + { + return DoAppend(wxMenuItem::New((wxMenu *)this, itemid, text, help, + wxITEM_NORMAL, submenu)); + } - wxList& GetItems() const { return (wxList &)m_items; } + void Insert(size_t pos, + int itemid, + const wxString& text, + const wxString& help, + bool isCheckable) + { + Insert(pos, itemid, text, help, isCheckable ? wxITEM_CHECK : wxITEM_NORMAL); + } - // 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 // WXWIN_COMPATIBILITY + void Prepend(int itemid, + const wxString& text, + const wxString& help, + bool isCheckable) + { + Insert(0u, itemid, text, help, isCheckable); + } - // unlike FindItem(), this function doesn't recurse but only looks through - // our direct children and also may return the index of the found child if - // pos != NULL - wxMenuItem *FindChildItem(int id, size_t *pos = NULL) const; + 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); @@ -204,7 +371,9 @@ protected: // common part of all ctors void Init(long style); -protected: + // associate the submenu with this menu + void AddSubMenu(wxMenu *submenu); + wxMenuBar *m_menuBar; // menubar we belong to or NULL wxMenu *m_menuParent; // parent menu or NULL @@ -212,18 +381,54 @@ protected: wxMenuItemList m_items; // the list of menu items wxWindow *m_invokingWindow; // for popup menus - void *m_clientData; // associated with the menu long m_style; // combination of wxMENU_XXX flags wxEvtHandler *m_eventHandler; // a pluggable in event handler + + static bool ms_locked; + + wxDECLARE_NO_COPY_CLASS(wxMenuBase); +}; + +#if wxUSE_EXTENDED_RTTI + +// ---------------------------------------------------------------------------- +// XTI accessor +// ---------------------------------------------------------------------------- + +class WXDLLEXPORT wxMenuInfoHelper : public wxObject +{ +public: + wxMenuInfoHelper() { m_menu = NULL; } + virtual ~wxMenuInfoHelper() { } + + bool Create( wxMenu *menu, const wxString &title ) + { + m_menu = menu; + m_title = title; + return true; + } + + wxMenu* GetMenu() const { return m_menu; } + wxString GetTitle() const { return m_title; } + +private: + wxMenu *m_menu; + wxString m_title; + + DECLARE_DYNAMIC_CLASS(wxMenuInfoHelper) }; +WX_DECLARE_EXPORTED_LIST(wxMenuInfoHelper, wxMenuInfoHelperList ); + +#endif + // ---------------------------------------------------------------------------- // wxMenuBar // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxMenuBarBase : public wxWindow +class WXDLLIMPEXP_CORE wxMenuBarBase : public wxWindow { public: // default ctor @@ -235,10 +440,10 @@ public: // menu bar construction // --------------------- - // append a menu to the end of menubar, return TRUE if ok + // append a menu to the end of menubar, return true if ok virtual bool Append(wxMenu *menu, const wxString& title); - // insert a menu before the given position into the menubar, return TRUE + // insert a menu before the given position into the menubar, return true // if inserted ok virtual bool Insert(size_t pos, wxMenu *menu, const wxString& title); @@ -262,22 +467,30 @@ public: // enable or disable a submenu virtual void EnableTop(size_t pos, bool enable) = 0; + // is the menu enabled? + virtual bool IsEnabledTop(size_t WXUNUSED(pos)) const { return true; } + // get or change the label of the menu at given position - virtual void SetLabelTop(size_t pos, const wxString& label) = 0; - virtual wxString GetLabelTop(size_t pos) const = 0; + virtual void SetMenuLabel(size_t pos, const wxString& label) = 0; + virtual wxString GetMenuLabel(size_t pos) const = 0; + + // get the stripped label of the menu at given position + virtual wxString GetMenuLabelText(size_t pos) const { return wxMenuItem::GetLabelText(GetMenuLabel(pos)); } // item search // ----------- // by menu and item names, returns wxNOT_FOUND if not found or id of the // found item - virtual int FindMenuItem(const wxString& menuString, - const wxString& itemString) const = 0; + virtual int FindMenuItem(const wxString& menu, const wxString& item) const; // find item by id (in any menu), returns NULL if not found // // if menu is !NULL, it will be filled with wxMenu this item belongs to - virtual wxMenuItem* FindItem(int id, wxMenu **menu = NULL) const = 0; + virtual wxMenuItem* FindItem(int itemid, wxMenu **menu = NULL) const; + + // find menu by its caption, return wxNOT_FOUND on failure + int FindMenu(const wxString& title) const; // item access // ----------- @@ -288,37 +501,73 @@ public: // NB: under MSW, these methods can only be used after the menubar had // been attached to the frame - void Enable(int id, bool enable); - void Check(int id, bool check); - bool IsChecked(int id) const; - bool IsEnabled(int id) const; + void Enable(int itemid, bool enable); + void Check(int itemid, bool check); + bool IsChecked(int itemid) const; + bool IsEnabled(int itemid) const; + virtual bool IsEnabled() const { return wxWindow::IsEnabled(); } - void SetLabel(int id, const wxString &label); - wxString GetLabel(int id) const; + void SetLabel(int itemid, const wxString &label); + wxString GetLabel(int itemid) const; - void SetHelpString(int id, const wxString& helpString); - wxString GetHelpString(int id) const; + void SetHelpString(int itemid, const wxString& helpString); + wxString GetHelpString(int itemid) const; + + // implementation helpers + + // get the frame we are attached to (may return NULL) + wxFrame *GetFrame() const { return m_menuBarFrame; } + + // returns true if we're attached to a frame + bool IsAttached() const { return GetFrame() != NULL; } + + // associate the menubar with the frame + virtual void Attach(wxFrame *frame); + + // called before deleting the menubar normally + virtual void Detach(); // need to override these ones to avoid virtual function hiding - virtual bool Enable(bool enable = TRUE) { return wxWindow::Enable(enable); } + virtual bool Enable(bool enable = true) { return wxWindow::Enable(enable); } virtual void SetLabel(const wxString& s) { wxWindow::SetLabel(s); } virtual wxString GetLabel() const { return wxWindow::GetLabel(); } - // compatibility only: these functions are deprecated, use the new ones - // instead -#if WXWIN_COMPATIBILITY - bool Enabled(int id) const { return IsEnabled(id); } - bool Checked(int id) const { return IsChecked(id); } + // don't want menu bars to accept the focus by tabbing to them + virtual bool AcceptsFocusFromKeyboard() const { return false; } - wxMenuItem* FindMenuItemById(int id) const - { return FindItem(id); } - wxMenuItem* FindItemForId(int id, wxMenu **menu = NULL) const - { return FindItem(id, menu); } -#endif // WXWIN_COMPATIBILITY + // update all menu item states in all menus + virtual void UpdateMenus(); + + virtual bool CanBeOutsideClientArea() const { return true; } + +#if wxUSE_EXTENDED_RTTI + // XTI helpers: + bool AppendMenuInfo( const wxMenuInfoHelper *info ) + { return Append( info->GetMenu(), info->GetTitle() ); } + const wxMenuInfoHelperList& GetMenuInfos() const; +#endif + +#if WXWIN_COMPATIBILITY_2_8 + // get or change the label of the menu at given position + // Deprecated in favour of SetMenuLabel + wxDEPRECATED( void SetLabelTop(size_t pos, const wxString& label) ); + // Deprecated in favour of GetMenuLabelText + wxDEPRECATED( wxString GetLabelTop(size_t pos) const ); +#endif protected: // the list of all our menus wxMenuList m_menus; + +#if wxUSE_EXTENDED_RTTI + // used by XTI + wxMenuInfoHelperList m_menuInfos; +#endif + + // the frame we are attached to (may be NULL) + wxFrame *m_menuBarFrame; + + wxDECLARE_NO_COPY_CLASS(wxMenuBarBase); }; // ---------------------------------------------------------------------------- @@ -328,22 +577,54 @@ protected: #ifdef wxUSE_BASE_CLASSES_ONLY #define wxMenuItem wxMenuItemBase #else // !wxUSE_BASE_CLASSES_ONLY -#if defined(__WXMSW__) +#if defined(__WXUNIVERSAL__) + #include "wx/univ/menu.h" +#elif defined(__WXMSW__) #include "wx/msw/menu.h" #elif defined(__WXMOTIF__) #include "wx/motif/menu.h" -#elif defined(__WXGTK__) +#elif defined(__WXGTK20__) #include "wx/gtk/menu.h" -#elif defined(__WXQT__) - #include "wx/qt/menu.h" +#elif defined(__WXGTK__) + #include "wx/gtk1/menu.h" #elif defined(__WXMAC__) - #include "wx/mac/menu.h" + #include "wx/osx/menu.h" +#elif defined(__WXCOCOA__) + #include "wx/cocoa/menu.h" #elif defined(__WXPM__) #include "wx/os2/menu.h" -#elif defined(__WXSTUBS__) - #include "wx/stubs/menu.h" #endif #endif // wxUSE_BASE_CLASSES_ONLY/!wxUSE_BASE_CLASSES_ONLY -#endif - // _WX_MENU_H_BASE_ +// ---------------------------------------------------------------------------- +// Helper class used in the implementation only: sets the invoking window of +// the given menu in its ctor and resets it in dtor. +// ---------------------------------------------------------------------------- + +class wxMenuInvokingWindowSetter +{ +public: + // Ctor sets the invoking window for the given menu. + // + // The menu lifetime must be greater than that of this class. + wxMenuInvokingWindowSetter(wxMenu& menu, wxWindow *win) + : m_menu(menu) + { + menu.SetInvokingWindow(win); + } + + // Dtor resets the invoking window. + ~wxMenuInvokingWindowSetter() + { + m_menu.SetInvokingWindow(NULL); + } + +private: + wxMenu& m_menu; + + wxDECLARE_NO_COPY_CLASS(wxMenuInvokingWindowSetter); +}; + +#endif // wxUSE_MENUS + +#endif // _WX_MENU_H_BASE_