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 05a943f6f6a58d9396f7d6cce28116ee185111ad..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>
 // 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
 
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef   _MENUITEM_H
 #define   _MENUITEM_H
 

-#ifdef __GNUG__
-    #pragma interface "menuitem.h"
-#endif
-

 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------


@@ -28,7 +24,7 @@
 // wxMenuItem: an item in the menu, optionally implements owner-drawn behaviour
 // ----------------------------------------------------------------------------
 
 // 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
 #if wxUSE_OWNER_DRAWN
                              , public wxOwnerDrawn
 #endif


@@ -44,11 +40,11 @@ public:
     virtual ~wxMenuItem();
 
     // override base class virtuals
     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 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
     virtual bool IsChecked() const;
 
     // unfortunately needed to resolve ambiguity between


@@ -57,21 +53,28 @@ 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
 
     // 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 SetAsRadioGroupStart();
     void SetRadioGroupStart(int start);
     void SetRadioGroupEnd(int end);
 
 
     // mark item as belonging to the given radio group
     void SetAsRadioGroupStart();
     void SetRadioGroupStart(int start);
     void SetRadioGroupEnd(int end);
 

+#if WXWIN_COMPATIBILITY_2_8

     // compatibility only, don't use in new code
     // compatibility only, don't use in new code

+    wxDEPRECATED(

     wxMenuItem(wxMenu *parentMenu,
                int id,
                const wxString& text,
                const wxString& help,
                bool isCheckable,
     wxMenuItem(wxMenu *parentMenu,
                int id,
                const wxString& text,
                const wxString& help,
                bool isCheckable,

-               wxMenu *subMenu = (wxMenu *)NULL);
+               wxMenu *subMenu = NULL)
+    );
+#endif

 
 private:
     // common part of all ctors
 
 private:
     // common part of all ctors


@@ -79,7 +82,7 @@ private:
 
     // the positions of the first and last items of the radio group this item
     // belongs to or -1: start is the radio group start and is valid for all
 
     // the positions of the first and last items of the radio group this item
     // 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
+    // but first radio group items (m_isRadioGroupStart == false), end is valid

     // only for the first one
     union
     {
     // only for the first one
     union
     {


@@ -90,7 +93,7 @@ private:
     // does this item start a radio group?
     bool m_isRadioGroupStart;
 
     // does this item start a radio group?
     bool m_isRadioGroupStart;
 

-    DECLARE_DYNAMIC_CLASS(wxMenuItem)
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxMenuItem)

 };
 
 #endif  //_MENUITEM_H
 };
 
 #endif  //_MENUITEM_H