X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/12028905135250524409f1e7b9bfa9c55e5ce16b..b0607dd221a6110cbd2a4a42e379b93e5f2d5334:/include/wx/menu.h diff --git a/include/wx/menu.h b/include/wx/menu.h index ba839faa69..876a72e162 100644 --- a/include/wx/menu.h +++ b/include/wx/menu.h @@ -5,17 +5,13 @@ // Modified by: // Created: 26.10.99 // RCS-ID: $Id$ -// Copyright: (c) wxWindows team +// Copyright: (c) wxWidgets team // Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// #ifndef _WX_MENU_H_BASE_ #define _WX_MENU_H_BASE_ -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) - #pragma interface "menubase.h" -#endif - #include "wx/defs.h" #if wxUSE_MENUS @@ -31,10 +27,10 @@ // included wx/menu.h #include "wx/menuitem.h" -class WXDLLEXPORT wxMenu; -class WXDLLEXPORT wxMenuBarBase; -class WXDLLEXPORT wxMenuBar; -class WXDLLEXPORT wxMenuItem; +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_EXPORTED_LIST(wxMenu, wxMenuList); @@ -44,7 +40,7 @@ WX_DECLARE_EXPORTED_LIST(wxMenuItem, wxMenuItemList); // wxMenu // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxMenuBase : public wxEvtHandler +class WXDLLIMPEXP_CORE wxMenuBase : public wxEvtHandler { public: // create a menu @@ -63,142 +59,141 @@ 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 = wxEmptyString, + 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); } // 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* AppendSubMenu(wxMenu *submenu, + const wxString& text, + const wxString& help = wxEmptyString) { - DoAppend(wxMenuItem::New((wxMenu *)this, itemid, text, help, - wxITEM_NORMAL, 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 - 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 = wxEmptyString, + 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 = wxEmptyString, + 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 @@ -242,6 +237,9 @@ public: void SetLabel(int itemid, const wxString& label); wxString GetLabel(int itemid) const; + // Returns the stripped label + wxString GetLabelText(int itemid) const { return wxMenuItem::GetLabelText(GetLabel(itemid)); } + virtual void SetHelpString(int itemid, const wxString& helpString); virtual wxString GetHelpString(int itemid) const; @@ -250,7 +248,7 @@ public: // the title virtual void SetTitle(const wxString& title) { m_title = title; } - const wxString GetTitle() const { return m_title; } + const wxString& GetTitle() const { return m_title; } // event handler void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; } @@ -269,18 +267,18 @@ 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) - 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; } @@ -294,8 +292,8 @@ public: // pos != NULL wxMenuItem *FindChildItem(int itemid, size_t *pos = NULL) const; - // called to generate a wxCommandEvent, return TRUE if it was processed, - // FALSE otherwise + // 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); @@ -313,6 +311,16 @@ public: 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)); + } + void Insert(size_t pos, int itemid, const wxString& text, @@ -330,22 +338,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 + 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); @@ -372,14 +375,16 @@ protected: wxEvtHandler *m_eventHandler; // a pluggable in event handler - DECLARE_NO_COPY_CLASS(wxMenuBase) + static bool ms_locked; + + wxDECLARE_NO_COPY_CLASS(wxMenuBase); }; // ---------------------------------------------------------------------------- // wxMenuBar // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxMenuBarBase : public wxWindow +class WXDLLIMPEXP_CORE wxMenuBarBase : public wxWindow { public: // default ctor @@ -391,10 +396,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); @@ -419,11 +424,14 @@ public: virtual void EnableTop(size_t pos, bool enable) = 0; // is the menu enabled? - virtual bool IsEnabledTop(size_t WXUNUSED(pos)) const { return TRUE; } + 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 // ----------- @@ -453,6 +461,7 @@ public: 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 itemid, const wxString &label); wxString GetLabel(int itemid) const; @@ -465,7 +474,7 @@ public: // 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 + // returns true if we're attached to a frame bool IsAttached() const { return GetFrame() != NULL; } // associate the menubar with the frame @@ -475,24 +484,25 @@ public: 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(); } // don't want menu bars to accept the focus by tabbing to them - virtual bool AcceptsFocusFromKeyboard() const { return FALSE; } + 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); } + // update all menu item states in all menus + virtual void UpdateMenus(); - wxMenuItem* FindMenuItemById(int itemid) const - { return FindItem(itemid); } - wxMenuItem* FindItemForId(int itemid, wxMenu **menu = NULL) const - { return FindItem(itemid, menu); } -#endif // WXWIN_COMPATIBILITY + virtual bool CanBeOutsideClientArea() const { return true; } + +#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 @@ -501,7 +511,7 @@ protected: // the frame we are attached to (may be NULL) wxFrame *m_menuBarFrame; - DECLARE_NO_COPY_CLASS(wxMenuBarBase) + wxDECLARE_NO_COPY_CLASS(wxMenuBarBase); }; // ---------------------------------------------------------------------------- @@ -513,14 +523,18 @@ protected: #else // !wxUSE_BASE_CLASSES_ONLY #if defined(__WXUNIVERSAL__) #include "wx/univ/menu.h" +#elif defined(__WXPALMOS__) + #include "wx/palmos/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(__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__)