added wxGetMultiChoice() (which refuses to work for some reason - will fix

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

diff --git a/include/wx/menuitem.h b/include/wx/menuitem.h
index f1dacef380115952082efa1a60002bfaaa11d434..a16e4211716f8225f5cc0373e8a110915f8e8482 100644 (file)
--- a/include/wx/menuitem.h
+++ b/include/wx/menuitem.h
@@ -18,21 +18,11 @@
 
 #include "wx/object.h"  // base class
 
 
 #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
 // ----------------------------------------------------------------------------
 

+class WXDLLEXPORT wxAcceleratorEntry;

 class WXDLLEXPORT wxMenuItem;
 class WXDLLEXPORT wxMenu;
 
 class WXDLLEXPORT wxMenuItem;
 class WXDLLEXPORT wxMenu;
 


@@ -52,6 +42,9 @@ public:
                            bool isCheckable = FALSE,
                            wxMenu *subMenu = (wxMenu *)NULL);
 
                            bool isCheckable = FALSE,
                            wxMenu *subMenu = (wxMenu *)NULL);
 

+    // destruction: wxMenuItem will delete its submenu
+    virtual ~wxMenuItemBase();
+

     // the menu we're in
     wxMenu *GetMenu() const { return m_parentMenu; }
 
     // the menu we're in
     wxMenu *GetMenu() const { return m_parentMenu; }
 


@@ -60,10 +53,19 @@ public:
     int  GetId() const { return m_id; }
     bool IsSeparator() const { return m_id == wxID_SEPARATOR; }
 
     int  GetId() const { return m_id; }
     bool IsSeparator() const { return m_id == wxID_SEPARATOR; }
 

-    // the item's text (or name, or label...)
+    // the item's text (or name)
+    //
+    // NB: the item's text 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) { m_text = str; }
     virtual void SetText(const wxString& str) { m_text = str; }

+    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
     virtual void SetCheckable(bool checkable) { m_isCheckable = checkable; }
     bool IsCheckable() const { return m_isCheckable; }
     // what kind of menu item we are
     virtual void SetCheckable(bool checkable) { m_isCheckable = checkable; }
     bool IsCheckable() const { return m_isCheckable; }


@@ -75,13 +77,24 @@ public:
     // state
     virtual void Enable(bool enable = TRUE) { m_isEnabled = enable; }
     virtual bool IsEnabled() const { return m_isEnabled; }
     // state
     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 bool IsChecked() const { return m_isChecked; }
     virtual void Check(bool check = TRUE) { m_isChecked = check; }
     virtual bool IsChecked() const { return m_isChecked; }

+    void Toggle() { Check(!m_isChecked); }

 
     // help string (displayed in the status bar by default)
     void SetHelp(const wxString& str) { m_help = str; }
     const wxString& GetHelp() const { return m_help; }
 
 
     // help string (displayed in the status bar by default)
     void SetHelp(const wxString& str) { m_help = str; }
     const wxString& GetHelp() const { return m_help; }
 

+#if wxUSE_ACCEL
+    // get our accelerator or NULL (caller must delete the pointer)
+    virtual wxAcceleratorEntry *GetAccel() const { return NULL; }
+
+    // set the accel for this item - this may also be done indirectly with
+    // SetText()
+    virtual void SetAccel(wxAcceleratorEntry *accel);
+#endif // wxUSE_ACCEL
+

     // compatibility only, use new functions in the new code
     void SetName(const wxString& str) { SetText(str); }
     const wxString& GetName() const { return GetText(); }
     // compatibility only, use new functions in the new code
     void SetName(const wxString& str) { SetText(str); }
     const wxString& GetName() const { return GetText(); }


@@ -95,6 +108,15 @@ protected:
     bool          m_isCheckable;    // can be checked?
     bool          m_isChecked;      // is checked?
     bool          m_isEnabled;      // is enabled?
     bool          m_isCheckable;    // can be checked?
     bool          m_isChecked;      // is checked?
     bool          m_isEnabled;      // is enabled?

+
+    // some compilers need a default constructor here, do not remove
+    wxMenuItemBase() { }
+
+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);

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