1///////////////////////////////////////////////////////////////////////////////
2// Name:        menuitem.h
3// Purpose:     wxMenuItem class
4// Author:      Vadim Zeitlin
5// Modified by:
6// Created:     11.11.97
7// RCS-ID:      $Id: menuitem.h 48053 2007-08-13 17:07:01Z JS $
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"   // base class
21#endif
22
23// ----------------------------------------------------------------------------
24// wxMenuItem: an item in the menu, optionally implements owner-drawn behaviour
25// ----------------------------------------------------------------------------
26
27class WXDLLEXPORT wxMenuItem : public wxMenuItemBase
28#if wxUSE_OWNER_DRAWN
29                             , public wxOwnerDrawn
30#endif
31{
32public:
33    // ctor & dtor
34    wxMenuItem(wxMenu *parentMenu = (wxMenu *)NULL,
35               int id = wxID_SEPARATOR,
36               const wxString& name = wxEmptyString,
37               const wxString& help = wxEmptyString,
38               wxItemKind kind = wxITEM_NORMAL,
39               wxMenu *subMenu = (wxMenu *)NULL);
40    virtual ~wxMenuItem();
41
42    // override base class virtuals
43    virtual void SetText(const wxString& strName);
44    virtual void SetCheckable(bool checkable);
45
46    virtual void Enable(bool bDoEnable = true);
47    virtual void Check(bool bDoCheck = true);
48    virtual bool IsChecked() const;
49
50    // unfortunately needed to resolve ambiguity between
51    // wxMenuItemBase::IsCheckable() and wxOwnerDrawn::IsCheckable()
52    bool IsCheckable() const { return wxMenuItemBase::IsCheckable(); }
53
54    // the id for a popup menu is really its menu handle (as required by
55    // ::AppendMenu() API), so this function will return either the id or the
56    // menu handle depending on what we're
57    int GetRealId() const;
58
59    // mark item as belonging to the given radio group
60    void SetAsRadioGroupStart();
61    void SetRadioGroupStart(int start);
62    void SetRadioGroupEnd(int end);
63
64    // compatibility only, don't use in new code
65    wxMenuItem(wxMenu *parentMenu,
66               int id,
67               const wxString& text,
68               const wxString& help,
69               bool isCheckable,
70               wxMenu *subMenu = (wxMenu *)NULL);
71
72private:
73    // common part of all ctors
74    void Init();
75
76    // the positions of the first and last items of the radio group this item
77    // belongs to or -1: start is the radio group start and is valid for all
78    // but first radio group items (m_isRadioGroupStart == false), end is valid
79    // only for the first one
80    union
81    {
82        int start;
83        int end;
84    } m_radioGroup;
85
86    // does this item start a radio group?
87    bool m_isRadioGroupStart;
88
89    DECLARE_DYNAMIC_CLASS_NO_COPY(wxMenuItem)
90
91public:
92
93#if wxABI_VERSION >= 20805
94    // return the item label including any mnemonics and accelerators.
95    // This used to be called GetText.
96    wxString GetItemLabel() const { return GetText(); }
97#endif
98};
99
100#endif  //_MENUITEM_H
101