///////////////////////////////////////////////////////////////////////////////
-// Name: menuitem.h
+// Name: wx/menuitem.h
// Purpose: wxMenuItem class
// Author: Vadim Zeitlin
-// Modified by:
-// Created: 11.11.97
+// Modified by:
+// Created: 25.10.99
// RCS-ID: $Id$
-// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence: wxWindows license
+// Copyright: (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
+// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
-#ifndef _MENUITEM_H
-#define _MENUITEM_H
+#ifndef _WX_MENUITEM_H_BASE_
+#define _WX_MENUITEM_H_BASE_
+
+#include "wx/defs.h"
+
+#if wxUSE_MENUS
// ----------------------------------------------------------------------------
// headers
// ----------------------------------------------------------------------------
-#include "wx/setup.h"
-
-// an exception to the general rule that a normal header doesn't include other
-// headers - only because ownerdrw.h is not always included and I don't want
-// to write #ifdef's everywhere...
-#if USE_OWNER_DRAWN
-#include "wx/ownerdrw.h"
-#endif
+#include "wx/object.h" // base class
// ----------------------------------------------------------------------------
-// constants
+// forward declarations
// ----------------------------------------------------------------------------
-// id for a separator line in the menu (invalid for normal item)
-#define ID_SEPARATOR (-1)
+class WXDLLIMPEXP_FWD_CORE wxAcceleratorEntry;
+class WXDLLIMPEXP_FWD_CORE wxMenuItem;
+class WXDLLIMPEXP_FWD_CORE wxMenu;
// ----------------------------------------------------------------------------
-// wxMenuItem: an item in the menu, optionally implements owner-drawn behaviour
+// wxMenuItem is an item in the menu which may be either a normal item, a sub
+// menu or a separator
// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxMenuItem: public wxObject
-#if USE_OWNER_DRAWN
- , public wxOwnerDrawn
-#endif
-{
-DECLARE_DYNAMIC_CLASS(wxMenuItem)
+class WXDLLIMPEXP_CORE wxMenuItemBase : public wxObject
+{
public:
- // ctor & dtor
- wxMenuItem(wxMenu *pParentMenu = NULL, int id = ID_SEPARATOR,
- const wxTString& strName = "", const wxTString& wxHelp = "",
- bool bCheckable = FALSE, wxMenu *pSubMenu = NULL);
- virtual ~wxMenuItem();
-
- // accessors (some more are inherited from wxOwnerDrawn or are below)
- bool IsSeparator() const { return m_idItem == ID_SEPARATOR; }
- bool IsEnabled() const { return m_bEnabled; }
- bool IsChecked() const { return m_bChecked; }
-
- int GetId() const { return m_idItem; }
- const wxString& GetHelp() const { return m_strHelp; }
- wxMenu *GetSubMenu() const { return m_pSubMenu; }
-
- // operations
- void SetName(const wxString& strName) { m_strName = strName; }
- void SetHelp(const wxString& strHelp) { m_strHelp = strHelp; }
-
- void Enable(bool bDoEnable = TRUE);
- void Check(bool bDoCheck = TRUE);
-
- void DeleteSubMenu();
+ // creation
+ static wxMenuItem *New(wxMenu *parentMenu = (wxMenu *)NULL,
+ int itemid = wxID_SEPARATOR,
+ const wxString& text = wxEmptyString,
+ const wxString& help = wxEmptyString,
+ wxItemKind kind = wxITEM_NORMAL,
+ wxMenu *subMenu = (wxMenu *)NULL);
+
+ // destruction: wxMenuItem will delete its submenu
+ virtual ~wxMenuItemBase();
+
+ // the menu we're in
+ wxMenu *GetMenu() const { return m_parentMenu; }
+ void SetMenu(wxMenu* menu) { m_parentMenu = menu; }
+
+ // get/set id
+ void SetId(int itemid) { m_id = itemid; }
+ int GetId() const { return m_id; }
+
+ // the item's text (or name)
+ //
+ // 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 text which only contains the text shown
+ // in the menu. This used to be called SetText.
+ virtual void SetItemLabel(const wxString& str);
+
+ // 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
+ { 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 bool IsEnabled() const { return m_isEnabled; }
+
+ 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);
+ 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;
+
+ // set the accel for this item - this may also be done indirectly with
+ // SetText()
+ virtual void SetAccel(wxAcceleratorEntry *accel);
+#endif // wxUSE_ACCEL
+
+#if WXWIN_COMPATIBILITY_2_8
+ // compatibility only, use new functions in the new code
+ wxDEPRECATED( void SetName(const wxString& str) );
+ 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,
+ 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:
+ 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
+ m_help; // the help string for the item
+ wxItemKind m_kind; // separator/normal/check/radio item?
+ 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 itemid = wxID_SEPARATOR,
+ const wxString& text = wxEmptyString,
+ const wxString& help = wxEmptyString,
+ wxItemKind kind = wxITEM_NORMAL,
+ wxMenu *subMenu = (wxMenu *)NULL);
private:
- int m_idItem; // numeric id of the item
- wxString m_strHelp; // associated help string
- wxMenu *m_pSubMenu, // may be NULL
- *m_pParentMenu; // menu this item is contained in
- bool m_bEnabled, // enabled or greyed?
- m_bChecked; // checked? (only if checkable)
+ // 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);
+};
-#if USE_OWNER_DRAWN
- // wxOwnerDrawn base class already has these variables - nothing to do
+#if WXWIN_COMPATIBILITY_2_8
+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
+
+// ----------------------------------------------------------------------------
+// include the real class declaration
+// ----------------------------------------------------------------------------
-#else //!owner drawn
- bool m_bCheckable; // can be checked?
- wxString m_strName; // name or label of the item
+#ifdef wxUSE_BASE_CLASSES_ONLY
+ #define wxMenuItem wxMenuItemBase
+#else // !wxUSE_BASE_CLASSES_ONLY
+#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(__WXGTK20__)
+ #include "wx/gtk/menuitem.h"
+#elif defined(__WXGTK__)
+ #include "wx/gtk1/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"
+#endif
+#endif // wxUSE_BASE_CLASSES_ONLY/!wxUSE_BASE_CLASSES_ONLY
-public:
- const wxString& GetName() const { return m_strName; }
- bool IsCheckable() const { return m_bCheckable; }
-#endif //owner drawn
-};
+#endif // wxUSE_MENUS
-#endif //_MENUITEM_H
\ No newline at end of file
+#endif
+ // _WX_MENUITEM_H_BASE_
projects / wxWidgets.git / blobdiff