X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1987af7e9f5685198b0c19e2326eebf7e56b7834..af01f1ba0d697c07173f436ab661b4c833258a91:/include/wx/menu.h?ds=sidebyside diff --git a/include/wx/menu.h b/include/wx/menu.h index 599326cb18..932d2ab152 100644 --- a/include/wx/menu.h +++ b/include/wx/menu.h @@ -16,6 +16,8 @@ #pragma interface "menubase.h" #endif +#if wxUSE_MENUS + // ---------------------------------------------------------------------------- // headers // ---------------------------------------------------------------------------- @@ -28,12 +30,28 @@ #include "wx/menuitem.h" class WXDLLEXPORT wxMenu; +class WXDLLEXPORT wxMenuBarBase; class WXDLLEXPORT wxMenuBar; class WXDLLEXPORT 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); + +// ---------------------------------------------------------------------------- +// 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 @@ -57,9 +75,6 @@ public: // menu construction // ----------------- - // append a separator to the menu - void AppendSeparator() { Append(wxID_SEPARATOR, wxEmptyString); } - // append a normal item to the menu void Append(int id, const wxString& text, @@ -69,6 +84,9 @@ public: DoAppend(wxMenuItem::New((wxMenu *)this, id, text, help, isCheckable)); } + // append a separator to the menu + void AppendSeparator() { Append(wxID_SEPARATOR, wxEmptyString); } + // append a submenu void Append(int id, const wxString& text, @@ -87,6 +105,59 @@ public: // insert an item before given position bool Insert(size_t pos, wxMenuItem *item); + void Insert(size_t pos, + int id, + const wxString& text, + const wxString& help = wxEmptyString, + bool isCheckable = FALSE) + { + Insert(pos, wxMenuItem::New((wxMenu *)this, id, text, help, isCheckable)); + } + + // insert a separator + void InsertSeparator(size_t pos) + { + Insert(pos, wxMenuItem::New((wxMenu *)this)); + } + + // insert a submenu + void Insert(size_t pos, + int id, + const wxString& text, + wxMenu *submenu, + const wxString& help = wxEmptyString) + { + Insert(pos, wxMenuItem::New((wxMenu *)this, id, text, help, FALSE, submenu)); + } + + // prepend an item to the menu + void Prepend(wxMenuItem *item) + { + Insert(0u, item); + } + + void Prepend(int id, + const wxString& text, + const wxString& help = wxEmptyString, + bool isCheckable = FALSE) + { + Insert(0u, id, text, help, isCheckable); + } + + // insert a separator + void PrependSeparator() + { + InsertSeparator(0u); + } + + // insert a submenu + void Prepend(int id, + const wxString& text, + wxMenu *submenu, + const wxString& help = wxEmptyString) + { + Insert(0u, id, 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 @@ -113,7 +184,7 @@ public: wxMenuItemList& GetMenuItems() { return m_items; } // search - virtual int FindItem(const wxString& itemString) const; + virtual int FindItem(const wxString& item) const; wxMenuItem* FindItem(int id, wxMenu **menu = NULL) const; // get/set items attributes @@ -136,10 +207,6 @@ public: 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; } - // event handler void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; } wxEvtHandler *GetEventHandler() const { return m_eventHandler; } @@ -159,6 +226,14 @@ public: // menu or associated window will be used. 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; } + + // 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; } @@ -175,18 +250,27 @@ public: { 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 // WXWIN_COMPATIBILITY +#endif // wxUSE_MENU_CALLBACK // 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; + // 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 id, int checked = -1); + protected: // virtuals to override in derived classes // --------------------------------------- @@ -204,7 +288,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,7 +298,6 @@ 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 @@ -262,6 +347,9 @@ 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; @@ -271,13 +359,15 @@ public: // 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 id, wxMenu **menu = NULL) const; + + // find menu by its caption, return wxNOT_FOUND on failure + int FindMenu(const wxString& title) const; // item access // ----------- @@ -299,11 +389,28 @@ public: void SetHelpString(int id, const wxString& helpString); wxString GetHelpString(int id) 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 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; } + // compatibility only: these functions are deprecated, use the new ones // instead #if WXWIN_COMPATIBILITY @@ -319,6 +426,9 @@ public: protected: // the list of all our menus wxMenuList m_menus; + + // the frame we are attached to (may be NULL) + wxFrame *m_menuBarFrame; }; // ---------------------------------------------------------------------------- @@ -328,14 +438,14 @@ 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__) #include "wx/gtk/menu.h" -#elif defined(__WXQT__) - #include "wx/qt/menu.h" #elif defined(__WXMAC__) #include "wx/mac/menu.h" #elif defined(__WXPM__) @@ -345,5 +455,7 @@ protected: #endif #endif // wxUSE_BASE_CLASSES_ONLY/!wxUSE_BASE_CLASSES_ONLY +#endif // wxUSE_MENUS + #endif // _WX_MENU_H_BASE_