non-osx methods bracketed

[wxWidgets.git] / include / wx / menu.h

diff --git a/include/wx/menu.h b/include/wx/menu.h
index ee33335e21285ecc9501f81af5b415e4c690548b..f23b6ac400d5f06e9df868b65faac04c4f5f86a1 100644 (file)
--- 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
 // 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_
 
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_MENU_H_BASE_
 #define _WX_MENU_H_BASE_
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

     #pragma interface "menubase.h"
 #endif
 
     #pragma interface "menubase.h"
 #endif
 

+#include "wx/defs.h"
+

 #if wxUSE_MENUS
 
 // ----------------------------------------------------------------------------
 #if wxUSE_MENUS
 
 // ----------------------------------------------------------------------------


@@ -38,21 +40,6 @@ class WXDLLEXPORT wxMenuItem;
 WX_DECLARE_EXPORTED_LIST(wxMenu, wxMenuList);
 WX_DECLARE_EXPORTED_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
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxMenu
 // ----------------------------------------------------------------------------


@@ -75,103 +62,158 @@ public:
     // menu construction
     // -----------------
 
     // 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,
+                       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
     }
 
     // append a separator to the menu

-    void AppendSeparator() { Append(wxID_SEPARATOR, wxEmptyString); }
+    wxMenuItem* AppendSeparator() { return Append(wxID_SEPARATOR, wxEmptyString); }
+
+    // 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
 
     // append a submenu

-    void Append(int id,
-                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, id, text, help, FALSE, submenu));
+        return DoAppend(wxMenuItem::New((wxMenu *)this, itemid, text, help,
+                                        wxITEM_NORMAL, submenu));

     }
 
     // the most generic form of Append() - append anything
     }
 
     // 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
 
     // 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);
-    void Insert(size_t pos,
-                int id,
-                const wxString& text,
-                const wxString& help = wxEmptyString,
-                bool isCheckable = FALSE)
+    wxMenuItem* Insert(size_t pos, wxMenuItem *item);
+
+    // insert an item before given position
+    wxMenuItem* Insert(size_t pos,
+                       int itemid,
+                       const wxString& text,
+                       const wxString& help = wxEmptyString,
+                       wxItemKind kind = wxITEM_NORMAL)

     {
     {

-        Insert(pos, wxMenuItem::New((wxMenu *)this, id, text, help, isCheckable));
+        return Insert(pos, wxMenuItem::New((wxMenu *)this, itemid, text, help, kind));

     }
 
     // insert a separator
     }
 
     // insert a separator

-    void InsertSeparator(size_t pos)
+    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)

     {
     {

-        Insert(pos, wxMenuItem::New((wxMenu *)this));
+        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
     }
 
     // insert a submenu

-    void Insert(size_t pos,
-                int id,
-                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, id, text, help, FALSE, submenu));
+        return Insert(pos, wxMenuItem::New((wxMenu *)this, itemid, text, help,
+                                           wxITEM_NORMAL, submenu));

     }
 
     // prepend an item to the menu
     }
 
     // prepend an item to the menu

-    void Prepend(wxMenuItem *item)
+    wxMenuItem* Prepend(wxMenuItem *item)

     {
     {

-        Insert(0u, item);
+        return Insert(0u, item);

     }
 
     }
 

-    void Prepend(int id,
-                 const wxString& text,
-                 const wxString& help = wxEmptyString,
-                 bool isCheckable = FALSE)
+    // prepend any item to the menu
+    wxMenuItem* Prepend(int itemid,
+                        const wxString& text,
+                        const wxString& help = wxEmptyString,
+                        wxItemKind kind = wxITEM_NORMAL)

     {
     {

-        Insert(0u, id, text, help, isCheckable);
+        return Insert(0u, itemid, text, help, kind);

     }
 
     }
 

-    // insert a separator
-    void PrependSeparator()
+    // prepend a separator
+    wxMenuItem* PrependSeparator()

     {
     {

-        InsertSeparator(0u);
+        return InsertSeparator(0u);

     }
 
     }
 

-    // insert a submenu
-    void Prepend(int id,
-                 const wxString& text,
-                 wxMenu *submenu,
-                 const wxString& help = wxEmptyString)
+    // 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)

     {
     {

-        Insert(0u, id, text, submenu, help);
+        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!)
     }
 
     // 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)
     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 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
     bool Destroy(wxMenuItem *item);
 
     // menu items access


@@ -185,20 +227,23 @@ public:
 
     // search
     virtual int FindItem(const wxString& item) const;
 
     // 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
 
     // 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
     // --------------
 
     // misc accessors
     // --------------


@@ -207,10 +252,6 @@ public:
     virtual void SetTitle(const wxString& title) { m_title = title; }
     const wxString GetTitle() const { return m_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; }
-

     // event handler
     void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
     wxEvtHandler *GetEventHandler() const { return m_eventHandler; }
     // event handler
     void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
     wxEvtHandler *GetEventHandler() const { return m_eventHandler; }


@@ -231,56 +272,75 @@ public:
     void UpdateUI(wxEvtHandler* source = (wxEvtHandler*)NULL);
 
     // get the menu bar this menu is attached to (may be NULL, always NULL for
     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)?
 
     // 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; }
 
 
     // set/get the parent of this menu
     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
-    // 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
 
     // 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
 
     // 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);
+    }
+
+    static void LockAccels(bool locked)
+    {
+        ms_locked = locked;
+    }
+    

 protected:
     // virtuals to override in derived classes
     // ---------------------------------------
 
 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);
 
     virtual wxMenuItem *DoRemove(wxMenuItem *item);
     virtual bool DoDelete(wxMenuItem *item);


@@ -302,11 +362,14 @@ protected:
     wxMenuItemList m_items;             // the list of menu items
 
     wxWindow      *m_invokingWindow;    // for popup menus
     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
 
     long           m_style;             // combination of wxMENU_XXX flags
 
     wxEvtHandler  *m_eventHandler;      // a pluggable in event handler

+
+    static bool      ms_locked;
+    
+    DECLARE_NO_COPY_CLASS(wxMenuBase)

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -353,7 +416,7 @@ public:
     virtual void EnableTop(size_t pos, bool enable) = 0;
 
     // is the menu enabled?
     virtual void EnableTop(size_t pos, bool enable) = 0;
 
     // is the menu enabled?

-    virtual bool IsEnabledTop(size_t 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;
 
     // get or change the label of the menu at given position
     virtual void SetLabelTop(size_t pos, const wxString& label) = 0;


@@ -369,7 +432,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
     // 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;
 
     // find menu by its caption, return wxNOT_FOUND on failure
     int FindMenu(const wxString& title) const;


@@ -383,16 +446,16 @@ public:
     // NB: under MSW, these methods can only be used after the menubar had
     //     been attached to the frame
 
     // 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
 
 
     // implementation helpers
 


@@ -416,24 +479,14 @@ public:
     // don't want menu bars to accept the focus by tabbing to them
     virtual bool AcceptsFocusFromKeyboard() const { return FALSE; }
 
     // 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 id) const { return IsEnabled(id); }
-    bool Checked(int id) const { return IsChecked(id); }
-
-    wxMenuItem* FindMenuItemById(int id) const
-        { return FindItem(id); }
-    wxMenuItem* FindItemForId(int id, wxMenu **menu = NULL) const
-        { return FindItem(id, menu); }
-#endif // WXWIN_COMPATIBILITY
-

 protected:
     // the list of all our menus
     wxMenuList m_menus;
 
     // the frame we are attached to (may be NULL)
     wxFrame *m_menuBarFrame;
 protected:
     // the list of all our menus
     wxMenuList m_menus;
 
     // the frame we are attached to (may be NULL)
     wxFrame *m_menuBarFrame;

+
+    DECLARE_NO_COPY_CLASS(wxMenuBarBase)

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -451,14 +504,12 @@ protected:
     #include "wx/motif/menu.h"
 #elif defined(__WXGTK__)
     #include "wx/gtk/menu.h"
     #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(__WXMAC__)
     #include "wx/mac/menu.h"

+#elif defined(__WXCOCOA__)
+    #include "wx/cocoa/menu.h"

 #elif defined(__WXPM__)
     #include "wx/os2/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
 #endif // wxUSE_BASE_CLASSES_ONLY/!wxUSE_BASE_CLASSES_ONLY