unifying redraw and scrolling calls between compositing and non-compositing modes

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

diff --git a/include/wx/menuitem.h b/include/wx/menuitem.h
index 20f143ed225d02cfd17a37e8fd659d99d711f435..c2607a04def68fa4b9120991e87d5c1fe7574faf 100644 (file)
--- a/include/wx/menuitem.h
+++ b/include/wx/menuitem.h
@@ -6,12 +6,16 @@
 // 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
+
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
@@ -36,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
@@ -47,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; }
 
@@ -67,18 +72,22 @@ 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); }
 
@@ -87,8 +96,12 @@ public:
     const wxString& GetHelp() const { return m_help; }
 
 #if wxUSE_ACCEL
+    // extract the accelerator from the given menu string, return NULL if none
+    // found
+    static wxAcceleratorEntry *GetAccelFromString(const wxString& label);
+
     // get our accelerator or NULL (caller must delete the pointer)
-    virtual wxAcceleratorEntry *GetAccel() const { return NULL; }
+    virtual wxAcceleratorEntry *GetAccel() const;
 
     // set the accel for this item - this may also be done indirectly with
     // SetText()
@@ -99,18 +112,40 @@ 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;           // seperator/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
+    // declare them ourselves - but don't implement as they shouldn't be used
+    wxMenuItemBase(const wxMenuItemBase& item);
+    wxMenuItemBase& operator=(const wxMenuItemBase& item);
 };
 
 // ----------------------------------------------------------------------------
@@ -120,22 +155,26 @@ protected:
 #ifdef wxUSE_BASE_CLASSES_ONLY
     #define wxMenuItem wxMenuItemBase
 #else // !wxUSE_BASE_CLASSES_ONLY
-#if defined(__WXMSW__)
+#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__)
     #include "wx/gtk/menuitem.h"
-#elif defined(__WXQT__)
-    #include "wx/qt/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
 
+#endif // wxUSE_MENUS
+
 #endif
     // _WX_MENUITEM_H_BASE_