include/wx/msw/menuitem.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/menuitem.h
   3 // Purpose:     wxMenuItem class
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     11.11.97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef   _MENUITEM_H
  13 #define   _MENUITEM_H
  14
  15 // ----------------------------------------------------------------------------
  16 // headers
  17 // ----------------------------------------------------------------------------
  18
  19 #if wxUSE_OWNER_DRAWN
  20     #include "wx/ownerdrw.h"
  21     #include "wx/bitmap.h"
  22
  23     struct tagRECT;
  24 #endif
  25
  26 // ----------------------------------------------------------------------------
  27 // wxMenuItem: an item in the menu, optionally implements owner-drawn behaviour
  28 // ----------------------------------------------------------------------------
  29
  30 class WXDLLIMPEXP_CORE wxMenuItem : public wxMenuItemBase
  31 #if wxUSE_OWNER_DRAWN
  32                              , public wxOwnerDrawn
  33 #endif
  34 {
  35 public:
  36     // ctor & dtor
  37     wxMenuItem(wxMenu *parentMenu = NULL,
  38                int id = wxID_SEPARATOR,
  39                const wxString& name = wxEmptyString,
  40                const wxString& help = wxEmptyString,
  41                wxItemKind kind = wxITEM_NORMAL,
  42                wxMenu *subMenu = NULL);
  43     virtual ~wxMenuItem();
  44
  45     // override base class virtuals
  46     virtual void SetItemLabel(const wxString& strName);
  47
  48     virtual void Enable(bool bDoEnable = true);
  49     virtual void Check(bool bDoCheck = true);
  50     virtual bool IsChecked() const;
  51
  52     // unfortunately needed to resolve ambiguity between
  53     // wxMenuItemBase::IsCheckable() and wxOwnerDrawn::IsCheckable()
  54     bool IsCheckable() const { return wxMenuItemBase::IsCheckable(); }
  55
  56     // the id for a popup menu is really its menu handle (as required by
  57     // ::AppendMenu() API), so this function will return either the id or the
  58     // menu handle depending on what we are
  59     //
  60     // notice that it also returns the id as an unsigned int, as required by
  61     // Win32 API
  62     WXWPARAM GetMSWId() const;
  63
  64 #if WXWIN_COMPATIBILITY_2_8
  65     // compatibility only, don't use in new code
  66     wxDEPRECATED(
  67     wxMenuItem(wxMenu *parentMenu,
  68                int id,
  69                const wxString& text,
  70                const wxString& help,
  71                bool isCheckable,
  72                wxMenu *subMenu = NULL)
  73     );
  74 #endif
  75
  76 #if wxUSE_OWNER_DRAWN
  77
  78     void SetBitmaps(const wxBitmap& bmpChecked,
  79                     const wxBitmap& bmpUnchecked = wxNullBitmap)
  80     {
  81         m_bmpChecked = bmpChecked;
  82         m_bmpUnchecked = bmpUnchecked;
  83         SetOwnerDrawn(true);
  84     }
  85
  86     void SetBitmap(const wxBitmap& bmp, bool bChecked = true)
  87     {
  88         if ( bChecked )
  89             m_bmpChecked = bmp;
  90         else
  91             m_bmpUnchecked = bmp;
  92         SetOwnerDrawn(true);
  93     }
  94
  95     void SetDisabledBitmap(const wxBitmap& bmpDisabled)
  96     {
  97         m_bmpDisabled = bmpDisabled;
  98         SetOwnerDrawn(true);
  99     }
 100
 101     const wxBitmap& GetBitmap(bool bChecked = true) const
 102         { return (bChecked ? m_bmpChecked : m_bmpUnchecked); }
 103
 104     const wxBitmap& GetDisabledBitmap() const
 105         { return m_bmpDisabled; }
 106
 107     int MeasureAccelWidth() const;
 108
 109     // override wxOwnerDrawn base class virtuals
 110     virtual wxString GetName() const;
 111     virtual bool OnMeasureItem(size_t *pwidth, size_t *pheight);
 112     virtual bool OnDrawItem(wxDC& dc, const wxRect& rc, wxODAction act, wxODStatus stat);
 113
 114 protected:
 115     virtual void GetFontToUse(wxFont& font) const;
 116     virtual void GetColourToUse(wxODStatus stat, wxColour& colText, wxColour& colBack) const;
 117
 118 private:
 119     // helper function for draw std menu check mark
 120     void DrawStdCheckMark(WXHDC hdc, const tagRECT* rc, wxODStatus stat);
 121
 122 #else // !wxUSE_OWNER_DRAWN
 123     // Provide stubs for the public functions above to ensure that the code
 124     // still compiles without wxUSE_OWNER_DRAWN -- it makes sense to just drop
 125     // the bitmaps then instead of failing compilation.
 126     void SetBitmaps(const wxBitmap& WXUNUSED(bmpChecked),
 127                     const wxBitmap& WXUNUSED(bmpUnchecked) = wxNullBitmap) { }
 128     void SetBitmap(const wxBitmap& WXUNUSED(bmp),
 129                    bool WXUNUSED(bChecked) = true) { }
 130     const wxBitmap& GetBitmap() const { return wxNullBitmap; }
 131 #endif // wxUSE_OWNER_DRAWN/!wxUSE_OWNER_DRAWN
 132
 133 private:
 134     // common part of all ctors
 135     void Init();
 136
 137
 138 #if wxUSE_OWNER_DRAWN
 139     // item bitmaps
 140     wxBitmap m_bmpChecked,     // bitmap to put near the item
 141              m_bmpUnchecked,   // (checked is used also for 'uncheckable' items)
 142              m_bmpDisabled;
 143 #endif // wxUSE_OWNER_DRAWN
 144
 145     DECLARE_DYNAMIC_CLASS_NO_COPY(wxMenuItem)
 146 };
 147
 148 #endif  //_MENUITEM_H