X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d699f48ba33c96c24f7ab3764ad98ded0633c1c5..609533d54db83ee9d85fe7ad9589521fcf3f6be1:/include/wx/menu.h diff --git a/include/wx/menu.h b/include/wx/menu.h index 0ffe2447a9..ba839faa69 100644 --- a/include/wx/menu.h +++ b/include/wx/menu.h @@ -6,16 +6,18 @@ // Created: 26.10.99 // RCS-ID: $Id$ // Copyright: (c) wxWindows team -// Licence: wxWindows license +// Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// #ifndef _WX_MENU_H_BASE_ #define _WX_MENU_H_BASE_ -#ifdef __GNUG__ +#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 // ---------------------------------------------------------------------------- @@ -75,25 +62,42 @@ public: // menu construction // ----------------- - // append a normal item to the menu - void Append(int id, + // append any kind of item (normal/check/radio/separator) + void Append(int itemid, const wxString& text, const wxString& help = wxEmptyString, - bool isCheckable = FALSE) + wxItemKind kind = wxITEM_NORMAL) { - DoAppend(wxMenuItem::New((wxMenu *)this, id, text, help, isCheckable)); + DoAppend(wxMenuItem::New((wxMenu *)this, itemid, text, help, kind)); } // append a separator to the menu void AppendSeparator() { Append(wxID_SEPARATOR, wxEmptyString); } + // append a check item + void AppendCheckItem(int itemid, + const wxString& text, + const wxString& help = wxEmptyString) + { + Append(itemid, text, help, wxITEM_CHECK); + } + + // append a radio item + void AppendRadioItem(int itemid, + const wxString& text, + const wxString& help = wxEmptyString) + { + Append(itemid, text, help, wxITEM_RADIO); + } + // append a submenu - void Append(int id, + void Append(int itemid, const wxString& text, wxMenu *submenu, const wxString& help = wxEmptyString) { - DoAppend(wxMenuItem::New((wxMenu *)this, id, text, help, FALSE, submenu)); + DoAppend(wxMenuItem::New((wxMenu *)this, itemid, text, help, + wxITEM_NORMAL, submenu)); } // the most generic form of Append() - append anything @@ -105,13 +109,15 @@ public: // insert an item before given position bool Insert(size_t pos, wxMenuItem *item); + + // insert an item before given position void Insert(size_t pos, - int id, + int itemid, const wxString& text, const wxString& help = wxEmptyString, - bool isCheckable = FALSE) + wxItemKind kind = wxITEM_NORMAL) { - Insert(pos, wxMenuItem::New((wxMenu *)this, id, text, help, isCheckable)); + Insert(pos, wxMenuItem::New((wxMenu *)this, itemid, text, help, kind)); } // insert a separator @@ -120,14 +126,33 @@ public: Insert(pos, wxMenuItem::New((wxMenu *)this)); } + // insert a check item + void InsertCheckItem(size_t pos, + int itemid, + const wxString& text, + const wxString& help = wxEmptyString) + { + 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) + { + Insert(pos, itemid, text, help, wxITEM_RADIO); + } + // insert a submenu void Insert(size_t pos, - int id, + int itemid, const wxString& text, wxMenu *submenu, const wxString& help = wxEmptyString) { - Insert(pos, wxMenuItem::New((wxMenu *)this, id, text, help, FALSE, submenu)); + Insert(pos, wxMenuItem::New((wxMenu *)this, itemid, text, help, + wxITEM_NORMAL, submenu)); } // prepend an item to the menu @@ -136,42 +161,59 @@ public: Insert(0u, item); } - void Prepend(int id, + // prepend any item to the menu + void Prepend(int itemid, const wxString& text, const wxString& help = wxEmptyString, - bool isCheckable = FALSE) + wxItemKind kind = wxITEM_NORMAL) { - Insert(0u, id, text, help, isCheckable); + Insert(0u, itemid, text, help, kind); } - // insert a separator + // prepend a separator void PrependSeparator() { InsertSeparator(0u); } - // insert a submenu - void Prepend(int id, + // prepend a check item + void PrependCheckItem(int itemid, + const wxString& text, + const wxString& help = wxEmptyString) + { + InsertCheckItem(0u, itemid, text, help); + } + + // prepend a radio item + void PrependRadioItem(int itemid, + const wxString& text, + const wxString& help = wxEmptyString) + { + InsertRadioItem(0u, itemid, text, help); + } + + // prepend a submenu + void Prepend(int itemid, const wxString& text, wxMenu *submenu, const wxString& help = wxEmptyString) { - Insert(0u, id, text, submenu, help); + 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 @@ -185,20 +227,23 @@ public: // search virtual int FindItem(const wxString& item) const; - wxMenuItem* FindItem(int id, wxMenu **menu = NULL) 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 id, bool check); - bool IsChecked(int id) const; + void Check(int itemid, bool check); + bool IsChecked(int itemid) const; - void SetLabel(int id, const wxString& label); - wxString GetLabel(int id) const; + void SetLabel(int itemid, const wxString& label); + wxString GetLabel(int itemid) const; - 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 // -------------- @@ -207,10 +252,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; } @@ -245,35 +286,59 @@ public: void SetParent(wxMenu *parent) { m_menuParent = parent; } wxMenu *GetParent() const { return m_menuParent; } -#if WXWIN_COMPATIBILITY - // 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); } - - 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 + // 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 id, size_t *pos = NULL) const; + 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 id, int checked = -1); + bool SendEvent(int itemid, int checked = -1); + + // compatibility: these functions are deprecated, use the new ones instead + // ----------------------------------------------------------------------- + + // 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); + } + + 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); + } + + void Prepend(int itemid, + const wxString& text, + const wxString& help, + bool isCheckable) + { + 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 protected: // virtuals to override in derived classes @@ -302,11 +367,12 @@ 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 + + DECLARE_NO_COPY_CLASS(wxMenuBase) }; // ---------------------------------------------------------------------------- @@ -369,7 +435,7 @@ public: // 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; + 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; @@ -383,16 +449,16 @@ 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; - 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 @@ -419,13 +485,13 @@ public: // 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); } + bool Enabled(int itemid) const { return IsEnabled(itemid); } + bool Checked(int itemid) const { return IsChecked(itemid); } - wxMenuItem* FindMenuItemById(int id) const - { return FindItem(id); } - wxMenuItem* FindItemForId(int id, wxMenu **menu = NULL) const - { return FindItem(id, menu); } + wxMenuItem* FindMenuItemById(int itemid) const + { return FindItem(itemid); } + wxMenuItem* FindItemForId(int itemid, wxMenu **menu = NULL) const + { return FindItem(itemid, menu); } #endif // WXWIN_COMPATIBILITY protected: @@ -434,6 +500,8 @@ protected: // the frame we are attached to (may be NULL) wxFrame *m_menuBarFrame; + + DECLARE_NO_COPY_CLASS(wxMenuBarBase) }; // ---------------------------------------------------------------------------- @@ -451,14 +519,12 @@ protected: #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(__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