extracted wxWrapSizer in separate files and somewhat improved it (heavily modified...

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

diff --git a/include/wx/menu.h b/include/wx/menu.h
index 490932a9996e14517c9464ccf155f9f9897ed678..8cae2e12557e263a25e76c9ac3af98785ed3deab 100644 (file)
--- a/include/wx/menu.h
+++ b/include/wx/menu.h
@@ -6,16 +6,12 @@
 // Created:     26.10.99
 // RCS-ID:      $Id$
 // Copyright:   (c) wxWidgets team
-// Licence:     wxWidgets licence
+// 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
@@ -64,7 +60,7 @@ public:
 
     // append any kind of item (normal/check/radio/separator)
     wxMenuItem* Append(int itemid,
-                       const wxString& text,
+                       const wxString& text = wxEmptyString,
                        const wxString& help = wxEmptyString,
                        wxItemKind kind = wxITEM_NORMAL)
     {
@@ -72,7 +68,7 @@ public:
     }
 
     // append a separator to the menu
-    wxMenuItem* AppendSeparator() { return Append(wxID_SEPARATOR, wxEmptyString); }
+    wxMenuItem* AppendSeparator() { return Append(wxID_SEPARATOR); }
 
     // append a check item
     wxMenuItem* AppendCheckItem(int itemid,
@@ -91,12 +87,11 @@ public:
     }
 
     // append a submenu
-    wxMenuItem* Append(int itemid,
-                       const wxString& text,
-                       wxMenu *submenu,
-                       const wxString& help = wxEmptyString)
+    wxMenuItem* AppendSubMenu(wxMenu *submenu,
+                              const wxString& text,
+                              const wxString& help = wxEmptyString)
     {
-        return DoAppend(wxMenuItem::New((wxMenu *)this, itemid, text, help,
+        return DoAppend(wxMenuItem::New((wxMenu *)this, wxID_ANY, text, help,
                                         wxITEM_NORMAL, submenu));
     }
 
@@ -113,7 +108,7 @@ public:
     // insert an item before given position
     wxMenuItem* Insert(size_t pos,
                        int itemid,
-                       const wxString& text,
+                       const wxString& text = wxEmptyString,
                        const wxString& help = wxEmptyString,
                        wxItemKind kind = wxITEM_NORMAL)
     {
@@ -163,7 +158,7 @@ public:
 
     // prepend any item to the menu
     wxMenuItem* Prepend(int itemid,
-                        const wxString& text,
+                        const wxString& text = wxEmptyString,
                         const wxString& help = wxEmptyString,
                         wxItemKind kind = wxITEM_NORMAL)
     {
@@ -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;
 
@@ -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,
@@ -334,7 +342,7 @@ public:
     {
         ms_locked = locked;
     }
-    
+
 protected:
     // virtuals to override in derived classes
     // ---------------------------------------
@@ -368,7 +376,7 @@ protected:
     wxEvtHandler  *m_eventHandler;      // a pluggable in event handler
 
     static bool      ms_locked;
-    
+
     DECLARE_NO_COPY_CLASS(wxMenuBase)
 };
 
@@ -376,7 +384,7 @@ protected:
 // wxMenuBar
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxMenuBarBase : public wxWindow
+class WXDLLIMPEXP_CORE wxMenuBarBase : public wxWindow
 {
 public:
     // default ctor
@@ -388,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);
 
@@ -416,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
     // -----------
@@ -450,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;
@@ -462,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
@@ -472,12 +484,23 @@ 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; }
+
+    // update all menu item states in all menus
+    virtual void UpdateMenus();
+
+    virtual bool CanBeOutsideClientArea() const { return true; }
+
+#if WXWIN_COMPATIBILITY_2_8
+    // get or change the label of the menu at given position
+    wxDEPRECATED( void SetLabelTop(size_t pos, const wxString& label) );
+    wxDEPRECATED( wxString GetLabelTop(size_t pos) const );
+#endif
 
 protected:
     // the list of all our menus
@@ -498,12 +521,16 @@ 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"
 #elif defined(__WXCOCOA__)