test complete :-)

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

diff --git a/include/wx/menuitem.h b/include/wx/menuitem.h
index ea5ac56053b7ef35fcdbb1ee0d256c801fa0b982..6fda4bd30dad28cdcb38582f506f2dcd4c1a8f3f 100644 (file)
--- a/include/wx/menuitem.h
+++ b/include/wx/menuitem.h
@@ -33,6 +33,7 @@
 // forward declarations
 // ----------------------------------------------------------------------------
 
 // forward declarations
 // ----------------------------------------------------------------------------
 

+class WXDLLEXPORT wxAcceleratorEntry;

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


@@ -44,6 +45,7 @@ class WXDLLEXPORT wxMenu;
 class WXDLLEXPORT wxMenuItemBase : public wxObject
 {
 public:
 class WXDLLEXPORT wxMenuItemBase : public wxObject
 {
 public:

+

     // creation
     static wxMenuItem *New(wxMenu *parentMenu = (wxMenu *)NULL,
                            int id = wxID_SEPARATOR,
     // creation
     static wxMenuItem *New(wxMenu *parentMenu = (wxMenu *)NULL,
                            int id = wxID_SEPARATOR,


@@ -52,13 +54,25 @@ 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; }
+

     // get/set id
     void SetId(int id) { m_id = id; }
     int  GetId() const { return m_id; }
     bool IsSeparator() const { return m_id == wxID_SEPARATOR; }
 
     // get/set id
     void SetId(int id) { m_id = id; }
     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; }

+    virtual wxString GetLabel() const { return m_text; }

     const wxString& GetText() const { return m_text; }
 
     // what kind of menu item we are
     const wxString& GetText() const { return m_text; }
 
     // what kind of menu item we are


@@ -72,13 +86,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(); }


@@ -92,6 +117,10 @@ 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 use
+    wxMenuItemBase() 
+        { }

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