rename the ID parameter

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

diff --git a/include/wx/menuitem.h b/include/wx/menuitem.h
index 9a74c6e07e81ee61fa2f5233ac636c26829fcb17..2a619da62330dcb4feb8cd3e7ca01018370ce7ad 100644 (file)
--- a/include/wx/menuitem.h
+++ b/include/wx/menuitem.h
@@ -6,12 +6,14 @@
 // Created:     25.10.99
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_MENUITEM_H_BASE_
 #define _WX_MENUITEM_H_BASE_
 
+#include "wx/defs.h"
+
 #if wxUSE_MENUS
 
 // ----------------------------------------------------------------------------
@@ -38,10 +40,10 @@ class WXDLLEXPORT wxMenuItemBase : public wxObject
 public:
     // creation
     static wxMenuItem *New(wxMenu *parentMenu = (wxMenu *)NULL,
-                           int id = wxID_SEPARATOR,
+                           int itemid = wxID_SEPARATOR,
                            const wxString& text = wxEmptyString,
                            const wxString& help = wxEmptyString,
-                           bool isCheckable = FALSE,
+                           wxItemKind kind = wxITEM_NORMAL,
                            wxMenu *subMenu = (wxMenu *)NULL);
 
     // destruction: wxMenuItem will delete its submenu
@@ -49,9 +51,10 @@ public:
 
     // the menu we're in
     wxMenu *GetMenu() const { return m_parentMenu; }
+    void SetMenu(wxMenu* menu) { m_parentMenu = menu; }
 
     // get/set id
-    void SetId(int id) { m_id = id; }
+    void SetId(int itemid) { m_id = itemid; }
     int  GetId() const { return m_id; }
     bool IsSeparator() const { return m_id == wxID_SEPARATOR; }
 
@@ -61,7 +64,7 @@ public:
     //     any), i.e. it may contain '&' or '_' or "\t..." and thus is
     //     different from the item's label which only contains the text shown
     //     in the menu
-    virtual void SetText(const wxString& str) { m_text = str; }
+    virtual void SetText(const wxString& str);
     wxString GetLabel() const { return GetLabelFromText(m_text); }
     const wxString& GetText() const { return m_text; }
 
@@ -69,23 +72,27 @@ public:
     static wxString GetLabelFromText(const wxString& text);
 
     // what kind of menu item we are
-    virtual void SetCheckable(bool checkable) { m_isCheckable = checkable; }
-    bool IsCheckable() const { return m_isCheckable; }
+    wxItemKind GetKind() const { return m_kind; }
+    void SetKind(wxItemKind kind) { m_kind = kind; }
+
+    virtual void SetCheckable(bool checkable) { m_kind = checkable ? wxITEM_CHECK : wxITEM_NORMAL; }
+    bool IsCheckable() const
+        { return m_kind == wxITEM_CHECK || m_kind == wxITEM_RADIO; }
 
     bool IsSubMenu() const { return m_subMenu != NULL; }
     void SetSubMenu(wxMenu *menu) { m_subMenu = menu; }
     wxMenu *GetSubMenu() const { return m_subMenu; }
 
     // state
-    virtual void Enable(bool enable = TRUE) { m_isEnabled = enable; }
+    virtual void Enable(bool enable = true) { m_isEnabled = enable; }
     virtual bool IsEnabled() const { return m_isEnabled; }
 
-    virtual void Check(bool check = TRUE) { m_isChecked = check; }
+    virtual void Check(bool check = true) { m_isChecked = check; }
     virtual bool IsChecked() const { return m_isChecked; }
     void Toggle() { Check(!m_isChecked); }
 
     // help string (displayed in the status bar by default)
-    void SetHelp(const wxString& str) { m_help = str; }
+    void SetHelp(const wxString& str);
     const wxString& GetHelp() const { return m_help; }
 
 #if wxUSE_ACCEL
@@ -105,18 +112,34 @@ public:
     void SetName(const wxString& str) { SetText(str); }
     const wxString& GetName() const { return GetText(); }
 
+    static wxMenuItem *New(wxMenu *parentMenu,
+                           int itemid,
+                           const wxString& text,
+                           const wxString& help,
+                           bool isCheckable,
+                           wxMenu *subMenu = (wxMenu *)NULL)
+    {
+        return New(parentMenu, itemid, text, help,
+                   isCheckable ? wxITEM_CHECK : wxITEM_NORMAL, subMenu);
+    }
+
 protected:
-    int           m_id;             // numeric id of the item >= 0 or -1
+    int           m_id;             // numeric id of the item >= 0 or wxID_ANY or wxID_SEPARATOR
     wxMenu       *m_parentMenu,     // the menu we belong to
                  *m_subMenu;        // our sub menu or NULL
     wxString      m_text,           // label of the item
                   m_help;           // the help string for the item
-    bool          m_isCheckable;    // can be checked?
+    wxItemKind    m_kind;           // separator/normal/check/radio item?
     bool          m_isChecked;      // is checked?
     bool          m_isEnabled;      // is enabled?
 
-    // some compilers need a default constructor here, do not remove
-    wxMenuItemBase() { }
+    // this ctor is for the derived classes only, we're never created directly
+    wxMenuItemBase(wxMenu *parentMenu = (wxMenu *)NULL,
+                   int itemid = wxID_SEPARATOR,
+                   const wxString& text = wxEmptyString,
+                   const wxString& help = wxEmptyString,
+                   wxItemKind kind = wxITEM_NORMAL,
+                   wxMenu *subMenu = (wxMenu *)NULL);
 
 private:
     // and, if we have one ctor, compiler won't generate a default copy one, so
@@ -134,18 +157,22 @@ private:
 #else // !wxUSE_BASE_CLASSES_ONLY
 #if defined(__WXUNIVERSAL__)
     #include "wx/univ/menuitem.h"
+#elif defined(__WXPALMOS__)
+    #include "wx/palmos/menuitem.h"
 #elif defined(__WXMSW__)
     #include "wx/msw/menuitem.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/menuitem.h"
-#elif defined(__WXGTK__)
+#elif defined(__WXGTK20__)
     #include "wx/gtk/menuitem.h"
+#elif defined(__WXGTK__)
+    #include "wx/gtk1/menuitem.h"
 #elif defined(__WXMAC__)
     #include "wx/mac/menuitem.h"
+#elif defined(__WXCOCOA__)
+    #include "wx/cocoa/menuitem.h"
 #elif defined(__WXPM__)
     #include "wx/os2/menuitem.h"
-#elif defined(__WXSTUBS__)
-    #include "wx/stubs/menuitem.h"
 #endif
 #endif // wxUSE_BASE_CLASSES_ONLY/!wxUSE_BASE_CLASSES_ONLY