Add wxDataViewCtrl::GTKPathToItem() function and use it.

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

diff --git a/include/wx/menuitem.h b/include/wx/menuitem.h
index 69e26570b8959ab6d8c8999a705ec032d30f988d..51ce402b49cb0516a898bbf3d550cfe197224abd 100644 (file)
--- a/include/wx/menuitem.h
+++ b/include/wx/menuitem.h
@@ -26,25 +26,25 @@
 // forward declarations
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxAcceleratorEntry;
-class WXDLLEXPORT wxMenuItem;
-class WXDLLEXPORT wxMenu;
+class WXDLLIMPEXP_FWD_CORE wxAcceleratorEntry;
+class WXDLLIMPEXP_FWD_CORE wxMenuItem;
+class WXDLLIMPEXP_FWD_CORE wxMenu;
 
 // ----------------------------------------------------------------------------
 // wxMenuItem is an item in the menu which may be either a normal item, a sub
 // menu or a separator
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxMenuItemBase : public wxObject
+class WXDLLIMPEXP_CORE wxMenuItemBase : public wxObject
 {
 public:
     // creation
-    static wxMenuItem *New(wxMenu *parentMenu = (wxMenu *)NULL,
+    static wxMenuItem *New(wxMenu *parentMenu = NULL,
                            int itemid = wxID_SEPARATOR,
                            const wxString& text = wxEmptyString,
                            const wxString& help = wxEmptyString,
                            wxItemKind kind = wxITEM_NORMAL,
-                           wxMenu *subMenu = (wxMenu *)NULL);
+                           wxMenu *subMenu = NULL);
 
     // destruction: wxMenuItem will delete its submenu
     virtual ~wxMenuItemBase();
@@ -56,24 +56,31 @@ public:
     // get/set id
     void SetId(int itemid) { m_id = itemid; }
     int  GetId() const { return m_id; }
-    bool IsSeparator() const { return m_id == wxID_SEPARATOR; }
 
     // the item's text (or name)
     //
-    // NB: the item's text includes the accelerators and mnemonics info (if
+    // NB: the item's label includes the accelerators and mnemonics info (if
     //     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);
-    wxString GetLabel() const { return GetLabelFromText(m_text); }
-    const wxString& GetText() const { return m_text; }
+    //     different from the item's text which only contains the text shown
+    //     in the menu. This used to be called SetText.
+    virtual void SetItemLabel(const wxString& str);
 
-    // get the label from text (implemented in platform-specific code)
-    static wxString GetLabelFromText(const wxString& text);
+    // return the item label including any mnemonics and accelerators.
+    // This used to be called GetText.
+    virtual wxString GetItemLabel() const { return m_text; }
+
+    // return just the text of the item label, without any mnemonics
+    // This used to be called GetLabel.
+    virtual wxString GetItemLabelText() const { return GetLabelText(m_text); }
+
+    // return just the text part of the given label (implemented in platform-specific code)
+    // This used to be called GetLabelFromText.
+    static wxString GetLabelText(const wxString& label);
 
     // what kind of menu item we are
     wxItemKind GetKind() const { return m_kind; }
     void SetKind(wxItemKind kind) { m_kind = kind; }
+    bool IsSeparator() const { return m_kind == wxITEM_SEPARATOR; }
 
     virtual void SetCheckable(bool checkable) { m_kind = checkable ? wxITEM_CHECK : wxITEM_NORMAL; }
     bool IsCheckable() const
@@ -111,7 +118,19 @@ public:
 #if WXWIN_COMPATIBILITY_2_8
     // compatibility only, use new functions in the new code
     wxDEPRECATED( void SetName(const wxString& str) );
-    wxDEPRECATED( const wxString& GetName() const );
+    wxDEPRECATED( wxString GetName() const );
+
+    // Now use GetItemLabelText
+    wxDEPRECATED( wxString GetLabel() const ) ;
+
+    // Now use GetItemLabel
+    wxDEPRECATED( const wxString& GetText() const );
+
+    // Now use GetLabelText to strip the accelerators
+    wxDEPRECATED( static wxString GetLabelFromText(const wxString& text) );
+
+    // Now use SetItemLabel
+    wxDEPRECATED( virtual void SetText(const wxString& str) );
 #endif // WXWIN_COMPATIBILITY_2_8
 
     static wxMenuItem *New(wxMenu *parentMenu,
@@ -119,14 +138,14 @@ public:
                            const wxString& text,
                            const wxString& help,
                            bool isCheckable,
-                           wxMenu *subMenu = (wxMenu *)NULL)
+                           wxMenu *subMenu = NULL)
     {
         return New(parentMenu, itemid, text, help,
                    isCheckable ? wxITEM_CHECK : wxITEM_NORMAL, subMenu);
     }
 
 protected:
-    int           m_id;             // numeric id of the item >= 0 or wxID_ANY or wxID_SEPARATOR
+    wxWindowIDRef 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
@@ -136,12 +155,12 @@ protected:
     bool          m_isEnabled;      // is enabled?
 
     // this ctor is for the derived classes only, we're never created directly
-    wxMenuItemBase(wxMenu *parentMenu = (wxMenu *)NULL,
+    wxMenuItemBase(wxMenu *parentMenu = NULL,
                    int itemid = wxID_SEPARATOR,
                    const wxString& text = wxEmptyString,
                    const wxString& help = wxEmptyString,
                    wxItemKind kind = wxITEM_NORMAL,
-                   wxMenu *subMenu = (wxMenu *)NULL);
+                   wxMenu *subMenu = NULL);
 
 private:
     // and, if we have one ctor, compiler won't generate a default copy one, so
@@ -151,10 +170,14 @@ private:
 };
 
 #if WXWIN_COMPATIBILITY_2_8
-void wxMenuItem::SetName(const wxString &str)
-    { SetText(str); }
-const wxString& wxMenuItem::GetName() const
-    { return GetText(); }
+inline void wxMenuItemBase::SetName(const wxString &str)
+    { SetItemLabel(str); }
+inline wxString wxMenuItemBase::GetName() const
+    { return GetItemLabel(); }
+inline wxString wxMenuItemBase::GetLabel() const
+    { return GetLabelText(m_text); }
+inline const wxString& wxMenuItemBase::GetText() const { return m_text; }
+inline void wxMenuItemBase::SetText(const wxString& text) { SetItemLabel(text); }
 #endif // WXWIN_COMPATIBILITY_2_8
 
 // ----------------------------------------------------------------------------
@@ -177,7 +200,7 @@ const wxString& wxMenuItem::GetName() const
 #elif defined(__WXGTK__)
     #include "wx/gtk1/menuitem.h"
 #elif defined(__WXMAC__)
-    #include "wx/mac/menuitem.h"
+    #include "wx/osx/menuitem.h"
 #elif defined(__WXCOCOA__)
     #include "wx/cocoa/menuitem.h"
 #elif defined(__WXPM__)