Warning fix for wxOS2 night build.

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

diff --git a/include/wx/menu.h b/include/wx/menu.h
index ba839faa69c60fb2f3518a392dccc8d3a72c553e..23cf0efa5b41109a1395123e11c672882a055f81 100644 (file)
--- a/include/wx/menu.h
+++ b/include/wx/menu.h
@@ -5,17 +5,13 @@
 // Modified by:
 // Created:     26.10.99
 // RCS-ID:      $Id$
 // 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_
 
 // 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
 #include "wx/defs.h"
 
 #if wxUSE_MENUS


@@ -63,142 +59,142 @@ public:
     // -----------------
 
     // append any kind of item (normal/check/radio/separator)
     // -----------------
 
     // 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,
+                       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
     }
 
     // append a separator to the menu

-    void AppendSeparator() { Append(wxID_SEPARATOR, wxEmptyString); }
+    wxMenuItem* AppendSeparator() { return Append(wxID_SEPARATOR, wxEmptyString); }

 
     // append a check item
 
     // 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
     }
 
     // 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
     }
 
     // append a submenu

-    void Append(int itemid,
-                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, itemid, text, help,
-                                 wxITEM_NORMAL, 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);
+    wxMenuItem* Insert(size_t pos, wxMenuItem *item);

 
     // insert an item before given position
 
     // 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,
+                       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
     }
 
     // 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
     }
 
     // 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
     }
 
     // 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
     }
 
     // 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
     }
 
     // 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
     }
 
     // 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,
+                        const wxString& help = wxEmptyString,
+                        wxItemKind kind = wxITEM_NORMAL)

     {
     {

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

     }
 
     // prepend a separator
     }
 
     // prepend a separator

-    void PrependSeparator()
+    wxMenuItem* PrependSeparator()

     {
     {

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

     }
 
     // prepend a check item
     }
 
     // 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
     }
 
     // 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
     }
 
     // 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
     }
 
     // detach an item from the menu, but don't delete it so that it can be


@@ -272,15 +268,15 @@ 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; }
 
     // set/get the parent of this menu
     void SetParent(wxMenu *parent) { m_menuParent = parent; }


@@ -294,8 +290,8 @@ public:
     // pos != NULL
     wxMenuItem *FindChildItem(int itemid, size_t *pos = NULL) const;
 
     // 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);
     //
     // the checked parameter may have boolean value or -1 for uncheckable items
     bool SendEvent(int itemid, int checked = -1);


@@ -330,22 +326,17 @@ public:
         Insert(0u, itemid, text, help, 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
+    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);


@@ -372,6 +363,8 @@ protected:
 
     wxEvtHandler  *m_eventHandler;      // a pluggable in event handler
 
 
     wxEvtHandler  *m_eventHandler;      // a pluggable in event handler
 

+    static bool      ms_locked;
+

     DECLARE_NO_COPY_CLASS(wxMenuBase)
 };
 
     DECLARE_NO_COPY_CLASS(wxMenuBase)
 };
 


@@ -391,10 +384,10 @@ public:
     // menu bar construction
     // ---------------------
 
     // 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);
 
     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);
 
     // if inserted ok
     virtual bool Insert(size_t pos, wxMenu *menu, const wxString& title);
 


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


@@ -453,6 +446,7 @@ public:
     void Check(int itemid, bool check);
     bool IsChecked(int itemid) const;
     bool IsEnabled(int itemid) const;
     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;
 
     void SetLabel(int itemid, const wxString &label);
     wxString GetLabel(int itemid) const;


@@ -465,7 +459,7 @@ public:
     // get the frame we are attached to (may return NULL)
     wxFrame *GetFrame() const { return m_menuBarFrame; }
 
     // 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
     bool IsAttached() const { return GetFrame() != NULL; }
 
     // associate the menubar with the frame


@@ -475,24 +469,15 @@ public:
     virtual void Detach();
 
     // need to override these ones to avoid virtual function hiding
     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 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); }
-
-    wxMenuItem* FindMenuItemById(int itemid) const
-        { return FindItem(itemid); }
-    wxMenuItem* FindItemForId(int itemid, wxMenu **menu = NULL) const
-        { return FindItem(itemid, menu); }
-#endif // WXWIN_COMPATIBILITY
+    // update all menu item states in all menus
+    virtual void UpdateMenus();

 
 protected:
     // the list of all our menus
 
 protected:
     // the list of all our menus


@@ -513,12 +498,16 @@ protected:
 #else // !wxUSE_BASE_CLASSES_ONLY
 #if defined(__WXUNIVERSAL__)
     #include "wx/univ/menu.h"
 #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(__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"
     #include "wx/gtk/menu.h"

+#elif defined(__WXGTK__)
+    #include "wx/gtk1/menu.h"

 #elif defined(__WXMAC__)
     #include "wx/mac/menu.h"
 #elif defined(__WXCOCOA__)
 #elif defined(__WXMAC__)
     #include "wx/mac/menu.h"
 #elif defined(__WXCOCOA__)