///////////////////////////////////////////////////////////////////////////////
-// Name: menuitem.h
+// Name: wx/msw/menuitem.h
// Purpose: wxMenuItem class
// Author: Vadim Zeitlin
-// Modified by:
+// Modified by:
// Created: 11.11.97
// RCS-ID: $Id$
// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence: wxWindows license
+// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
#ifndef _MENUITEM_H
#define _MENUITEM_H
-#ifdef __GNUG__
-#pragma interface "menuitem.h"
-#endif
-
// ----------------------------------------------------------------------------
// headers
// ----------------------------------------------------------------------------
-#include "wx/setup.h"
+#if wxUSE_OWNER_DRAWN
+ #include "wx/ownerdrw.h"
+ #include "wx/bitmap.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"
+ struct tagRECT;
#endif
-// ----------------------------------------------------------------------------
-// constants
-// ----------------------------------------------------------------------------
-
-// id for a separator line in the menu (invalid for normal item)
-#define ID_SEPARATOR (-1)
-
// ----------------------------------------------------------------------------
// wxMenuItem: an item in the menu, optionally implements owner-drawn behaviour
// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxMenuItem: public wxObject
-#if USE_OWNER_DRAWN
- , public wxOwnerDrawn
+
+class WXDLLIMPEXP_CORE wxMenuItem : public wxMenuItemBase
+#if wxUSE_OWNER_DRAWN
+ , public wxOwnerDrawn
#endif
{
-DECLARE_DYNAMIC_CLASS(wxMenuItem)
-
public:
- // ctor & dtor
- wxMenuItem(wxMenu *pParentMenu = NULL, int id = ID_SEPARATOR,
- const wxString& strName = "", const wxString& wxHelp = "",
- bool bCheckable = FALSE, wxMenu *pSubMenu = NULL);
- virtual ~wxMenuItem();
+ // ctor & dtor
+ wxMenuItem(wxMenu *parentMenu = NULL,
+ int id = wxID_SEPARATOR,
+ const wxString& name = wxEmptyString,
+ const wxString& help = wxEmptyString,
+ wxItemKind kind = wxITEM_NORMAL,
+ wxMenu *subMenu = NULL);
+ virtual ~wxMenuItem();
+
+ // override base class virtuals
+ virtual void SetItemLabel(const wxString& strName);
+
+ virtual void Enable(bool bDoEnable = true);
+ virtual void Check(bool bDoCheck = true);
+ virtual bool IsChecked() const;
+
+ // unfortunately needed to resolve ambiguity between
+ // wxMenuItemBase::IsCheckable() and wxOwnerDrawn::IsCheckable()
+ bool IsCheckable() const { return wxMenuItemBase::IsCheckable(); }
+
+ // the id for a popup menu is really its menu handle (as required by
+ // ::AppendMenu() API), so this function will return either the id or the
+ // menu handle depending on what we are
+ //
+ // notice that it also returns the id as an unsigned int, as required by
+ // Win32 API
+ WXWPARAM GetMSWId() const;
+
+#if WXWIN_COMPATIBILITY_2_8
+ // compatibility only, don't use in new code
+ wxDEPRECATED(
+ wxMenuItem(wxMenu *parentMenu,
+ int id,
+ const wxString& text,
+ const wxString& help,
+ bool isCheckable,
+ wxMenu *subMenu = NULL)
+ );
+#endif
+
+#if wxUSE_OWNER_DRAWN
+
+ void SetBitmaps(const wxBitmap& bmpChecked,
+ const wxBitmap& bmpUnchecked = wxNullBitmap)
+ {
+ m_bmpChecked = bmpChecked;
+ m_bmpUnchecked = bmpUnchecked;
+ SetOwnerDrawn(true);
+ }
+
+ void SetBitmap(const wxBitmap& bmp, bool bChecked = true)
+ {
+ if ( bChecked )
+ m_bmpChecked = bmp;
+ else
+ m_bmpUnchecked = bmp;
+ SetOwnerDrawn(true);
+ }
- // 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; }
+ void SetDisabledBitmap(const wxBitmap& bmpDisabled)
+ {
+ m_bmpDisabled = bmpDisabled;
+ SetOwnerDrawn(true);
+ }
- int GetId() const { return m_idItem; }
- const wxString& GetHelp() const { return m_strHelp; }
- wxMenu *GetSubMenu() const { return m_pSubMenu; }
+ const wxBitmap& GetBitmap(bool bChecked = true) const
+ { return (bChecked ? m_bmpChecked : m_bmpUnchecked); }
- // operations
- void SetName(const wxString& strName) { m_strName = strName; }
- void SetHelp(const wxString& strHelp) { m_strHelp = strHelp; }
+ const wxBitmap& GetDisabledBitmap() const
+ { return m_bmpDisabled; }
- void Enable(bool bDoEnable = TRUE);
- void Check(bool bDoCheck = TRUE);
+ int MeasureAccelWidth() const;
- void DeleteSubMenu();
+ // override wxOwnerDrawn base class virtuals
+ virtual wxString GetName() const;
+ virtual bool OnMeasureItem(size_t *pwidth, size_t *pheight);
+ virtual bool OnDrawItem(wxDC& dc, const wxRect& rc, wxODAction act, wxODStatus stat);
+
+protected:
+ virtual void GetFontToUse(wxFont& font) const;
+ virtual void GetColourToUse(wxODStatus stat, wxColour& colText, wxColour& colBack) const;
+
+private:
+ // helper function for draw std menu check mark
+ void DrawStdCheckMark(WXHDC hdc, const tagRECT* rc, wxODStatus stat);
+
+#else // !wxUSE_OWNER_DRAWN
+ // Provide stubs for the public functions above to ensure that the code
+ // still compiles without wxUSE_OWNER_DRAWN -- it makes sense to just drop
+ // the bitmaps then instead of failing compilation.
+ void SetBitmaps(const wxBitmap& WXUNUSED(bmpChecked),
+ const wxBitmap& WXUNUSED(bmpUnchecked) = wxNullBitmap) { }
+ void SetBitmap(const wxBitmap& WXUNUSED(bmp),
+ bool WXUNUSED(bChecked) = true) { }
+ const wxBitmap& GetBitmap() const { return wxNullBitmap; }
+#endif // wxUSE_OWNER_DRAWN/!wxUSE_OWNER_DRAWN
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)
+ // common part of all ctors
+ void Init();
-#if USE_OWNER_DRAWN
- // wxOwnerDrawn base class already has these variables - nothing to do
-#else //!owner drawn
- bool m_bCheckable; // can be checked?
- wxString m_strName; // name or label of the item
+#if wxUSE_OWNER_DRAWN
+ // item bitmaps
+ wxBitmap m_bmpChecked, // bitmap to put near the item
+ m_bmpUnchecked, // (checked is used also for 'uncheckable' items)
+ m_bmpDisabled;
+#endif // wxUSE_OWNER_DRAWN
-public:
- const wxString& GetName() const { return m_strName; }
- bool IsCheckable() const { return m_bCheckable; }
-#endif //owner drawn
+ DECLARE_DYNAMIC_CLASS_NO_COPY(wxMenuItem)
};
#endif //_MENUITEM_H
projects / wxWidgets.git / blobdiff