fix the incoherence pointed out by ifacecheck between wx docs, that documents usage...

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

diff --git a/include/wx/msw/menuitem.h b/include/wx/msw/menuitem.h
index 99d7cda1a1a07ca79e24f67ec72957d03d307d9f..4518daf143f4fdf88e1bdc2ee95b597cec335f63 100644 (file)
--- a/include/wx/msw/menuitem.h
+++ b/include/wx/msw/menuitem.h
@@ -6,16 +6,12 @@
 // Created:     11.11.97
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef   _MENUITEM_H
 #define   _MENUITEM_H
 
-#ifdef __GNUG__
-    #pragma interface "menuitem.h"
-#endif
-
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
@@ -28,7 +24,7 @@
 // wxMenuItem: an item in the menu, optionally implements owner-drawn behaviour
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxMenuItem : public wxMenuItemBase
+class WXDLLIMPEXP_CORE wxMenuItem : public wxMenuItemBase
 #if wxUSE_OWNER_DRAWN
                              , public wxOwnerDrawn
 #endif
@@ -44,11 +40,11 @@ public:
     virtual ~wxMenuItem();
 
     // override base class virtuals
-    virtual void SetText(const wxString& strName);
+    virtual void SetItemLabel(const wxString& strName);
     virtual void SetCheckable(bool checkable);
 
-    virtual void Enable(bool bDoEnable = TRUE);
-    virtual void Check(bool bDoCheck = TRUE);
+    virtual void Enable(bool bDoEnable = true);
+    virtual void Check(bool bDoCheck = true);
     virtual bool IsChecked() const;
 
     // unfortunately needed to resolve ambiguity between
@@ -57,23 +53,47 @@ public:
 
     // the id for a popup menu is really its menu handle (as required by
     // ::AppendMenu() API), so this function will return either the id or the
-    // menu handle depending on what we're
-    int GetRealId() const;
+    // menu handle depending on what we are
+    //
+    // notice that it also returns the id as an unsigned int, as required by
+    // Win32 API
+    WXWPARAM GetMSWId() const;
 
     // mark item as belonging to the given radio group
-    void SetRadioGroup(int start, int end)
-    {
-        m_startRadioGroup = start;
-        m_endRadioGroup = end;
-    }
+    void SetAsRadioGroupStart();
+    void SetRadioGroupStart(int start);
+    void SetRadioGroupEnd(int end);
+
+#if WXWIN_COMPATIBILITY_2_8
+    // compatibility only, don't use in new code
+    wxDEPRECATED(
+    wxMenuItem(wxMenu *parentMenu,
+               int id,
+               const wxString& text,
+               const wxString& help,
+               bool isCheckable,
+               wxMenu *subMenu = NULL)
+    );
+#endif
 
 private:
+    // common part of all ctors
+    void Init();
+
     // the positions of the first and last items of the radio group this item
-    // belongs to or -1
-    int m_startRadioGroup,
-        m_endRadioGroup;
+    // belongs to or -1: start is the radio group start and is valid for all
+    // but first radio group items (m_isRadioGroupStart == false), end is valid
+    // only for the first one
+    union
+    {
+        int start;
+        int end;
+    } m_radioGroup;
+
+    // does this item start a radio group?
+    bool m_isRadioGroupStart;
 
-    DECLARE_DYNAMIC_CLASS(wxMenuItem)
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxMenuItem)
 };
 
 #endif  //_MENUITEM_H