Added (and documented) GetTraceMasks so userspace can probe the currently

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

diff --git a/include/wx/menuitem.h b/include/wx/menuitem.h
index 22bfd7c36b639625323c5b85d3e7decb768858c5..b8d23c5eddb5c074a0263962070fc9d0f8eceea1 100644 (file)
--- a/include/wx/menuitem.h
+++ b/include/wx/menuitem.h
@@ -12,23 +12,14 @@
 #ifndef _WX_MENUITEM_H_BASE_
 #define _WX_MENUITEM_H_BASE_
 
 #ifndef _WX_MENUITEM_H_BASE_
 #define _WX_MENUITEM_H_BASE_
 

+#if wxUSE_MENUS
+

 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 
 #include "wx/object.h"  // base class
 
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 
 #include "wx/object.h"  // base class
 

-// ----------------------------------------------------------------------------
-// constants
-// ----------------------------------------------------------------------------
-
-// id for a separator line in the menu (invalid for normal item)
-#define wxID_SEPARATOR (-1)
-
-#ifndef ID_SEPARATOR    // for compatibility only, don't use in new code
-    #define ID_SEPARATOR    wxID_SEPARATOR
-#endif
-

 // ----------------------------------------------------------------------------
 // forward declarations
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // forward declarations
 // ----------------------------------------------------------------------------


@@ -45,16 +36,12 @@ class WXDLLEXPORT wxMenu;
 class WXDLLEXPORT wxMenuItemBase : public wxObject
 {
 public:
 class WXDLLEXPORT wxMenuItemBase : public wxObject
 {
 public:

-    // some compilers need a default constructor here, do not use
-    wxMenuItemBase() 
-        { wxFAIL_MSG( wxT("illegal call") ); }
-

     // creation
     static wxMenuItem *New(wxMenu *parentMenu = (wxMenu *)NULL,
                            int id = wxID_SEPARATOR,
                            const wxString& text = wxEmptyString,
                            const wxString& help = wxEmptyString,
     // creation
     static wxMenuItem *New(wxMenu *parentMenu = (wxMenu *)NULL,
                            int id = 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
                            wxMenu *subMenu = (wxMenu *)NULL);
 
     // destruction: wxMenuItem will delete its submenu


@@ -75,12 +62,18 @@ public:
     //     different from the item's label which only contains the text shown
     //     in the menu
     virtual void SetText(const wxString& str) { m_text = str; }
     //     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 wxString GetLabel() const { return m_text; }
+    wxString GetLabel() const { return GetLabelFromText(m_text); }

     const wxString& GetText() const { return m_text; }
 
     const wxString& GetText() const { return m_text; }
 

+    // get the label from text (implemented in platform-specific code)
+    static wxString GetLabelFromText(const wxString& text);
+

     // what kind of menu item we are
     // 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; }
+
+    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; }
 
     bool IsSubMenu() const { return m_subMenu != NULL; }
     void SetSubMenu(wxMenu *menu) { m_subMenu = menu; }


@@ -99,8 +92,12 @@ public:
     const wxString& GetHelp() const { return m_help; }
 
 #if wxUSE_ACCEL
     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)
     // 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()
 
     // set the accel for this item - this may also be done indirectly with
     // SetText()


@@ -111,15 +108,40 @@ public:
     void SetName(const wxString& str) { SetText(str); }
     const wxString& GetName() const { return GetText(); }
 
     void SetName(const wxString& str) { SetText(str); }
     const wxString& GetName() const { return GetText(); }
 

+    static wxMenuItem *New(wxMenu *parentMenu,
+                           int id,
+                           const wxString& text,
+                           const wxString& help,
+                           bool isCheckable,
+                           wxMenu *subMenu = (wxMenu *)NULL)
+    {
+        return New(parentMenu, id, text, help,
+                   isCheckable ? wxITEM_CHECK : wxITEM_NORMAL, subMenu);
+    }
+

 protected:
     int           m_id;             // numeric id of the item >= 0 or -1
     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
 protected:
     int           m_id;             // numeric id of the item >= 0 or -1
     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?
     bool          m_isChecked;      // is checked?
     bool          m_isEnabled;      // is enabled?

+
+    // this ctor is for the derived classes only, we're never created directly
+    wxMenuItemBase(wxMenu *parentMenu = (wxMenu *)NULL,
+                   int id = 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);

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -129,14 +151,14 @@ protected:
 #ifdef wxUSE_BASE_CLASSES_ONLY
     #define wxMenuItem wxMenuItemBase
 #else // !wxUSE_BASE_CLASSES_ONLY
 #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(__WXMSW__)

     #include "wx/msw/menuitem.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/menuitem.h"
 #elif defined(__WXGTK__)
     #include "wx/gtk/menuitem.h"
     #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(__WXPM__)
 #elif defined(__WXMAC__)
     #include "wx/mac/menuitem.h"
 #elif defined(__WXPM__)


@@ -146,5 +168,7 @@ protected:
 #endif
 #endif // wxUSE_BASE_CLASSES_ONLY/!wxUSE_BASE_CLASSES_ONLY
 
 #endif
 #endif // wxUSE_BASE_CLASSES_ONLY/!wxUSE_BASE_CLASSES_ONLY
 

+#endif // wxUSE_MENUS
+

 #endif
     // _WX_MENUITEM_H_BASE_
 #endif
     // _WX_MENUITEM_H_BASE_