include/wx/menuitem.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/menuitem.h
   3 // Purpose:     wxMenuItem class
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     25.10.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1999 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
   9 // Licence:     wxWindows license
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_MENUITEM_H_BASE_
  13 #define _WX_MENUITEM_H_BASE_
  14
  15 #if wxUSE_MENUS
  16
  17 // ----------------------------------------------------------------------------
  18 // headers
  19 // ----------------------------------------------------------------------------
  20
  21 #include "wx/object.h"  // base class
  22
  23 // ----------------------------------------------------------------------------
  24 // forward declarations
  25 // ----------------------------------------------------------------------------
  26
  27 class WXDLLEXPORT wxAcceleratorEntry;
  28 class WXDLLEXPORT wxMenuItem;
  29 class WXDLLEXPORT wxMenu;
  30
  31 // ----------------------------------------------------------------------------
  32 // wxMenuItem is an item in the menu which may be either a normal item, a sub
  33 // menu or a separator
  34 // ----------------------------------------------------------------------------
  35
  36 class WXDLLEXPORT wxMenuItemBase : public wxObject
  37 {
  38 public:
  39     // creation
  40     static wxMenuItem *New(wxMenu *parentMenu = (wxMenu *)NULL,
  41                            int id = wxID_SEPARATOR,
  42                            const wxString& text = wxEmptyString,
  43                            const wxString& help = wxEmptyString,
  44                            wxItemKind kind = wxItem_Normal,
  45                            wxMenu *subMenu = (wxMenu *)NULL);
  46
  47     // destruction: wxMenuItem will delete its submenu
  48     virtual ~wxMenuItemBase();
  49
  50     // the menu we're in
  51     wxMenu *GetMenu() const { return m_parentMenu; }
  52
  53     // get/set id
  54     void SetId(int id) { m_id = id; }
  55     int  GetId() const { return m_id; }
  56     bool IsSeparator() const { return m_id == wxID_SEPARATOR; }
  57
  58     // the item's text (or name)
  59     //
  60     // NB: the item's text includes the accelerators and mnemonics info (if
  61     //     any), i.e. it may contain '&' or '_' or "\t..." and thus is
  62     //     different from the item's label which only contains the text shown
  63     //     in the menu
  64     virtual void SetText(const wxString& str) { m_text = str; }
  65     wxString GetLabel() const { return GetLabelFromText(m_text); }
  66     const wxString& GetText() const { return m_text; }
  67
  68     // get the label from text (implemented in platform-specific code)
  69     static wxString GetLabelFromText(const wxString& text);
  70
  71     // what kind of menu item we are
  72     wxItemKind GetKind() const { return m_kind; }
  73
  74     virtual void SetCheckable(bool checkable) { m_kind = wxItem_Check; }
  75     bool IsCheckable() const { return m_kind == wxItem_Check; }
  76
  77     bool IsSubMenu() const { return m_subMenu != NULL; }
  78     void SetSubMenu(wxMenu *menu) { m_subMenu = menu; }
  79     wxMenu *GetSubMenu() const { return m_subMenu; }
  80
  81     // state
  82     virtual void Enable(bool enable = TRUE) { m_isEnabled = enable; }
  83     virtual bool IsEnabled() const { return m_isEnabled; }
  84
  85     virtual void Check(bool check = TRUE) { m_isChecked = check; }
  86     virtual bool IsChecked() const { return m_isChecked; }
  87     void Toggle() { Check(!m_isChecked); }
  88
  89     // help string (displayed in the status bar by default)
  90     void SetHelp(const wxString& str) { m_help = str; }
  91     const wxString& GetHelp() const { return m_help; }
  92
  93 #if wxUSE_ACCEL
  94     // extract the accelerator from the given menu string, return NULL if none
  95     // found
  96     static wxAcceleratorEntry *GetAccelFromString(const wxString& label);
  97
  98     // get our accelerator or NULL (caller must delete the pointer)
  99     virtual wxAcceleratorEntry *GetAccel() const;
 100
 101     // set the accel for this item - this may also be done indirectly with
 102     // SetText()
 103     virtual void SetAccel(wxAcceleratorEntry *accel);
 104 #endif // wxUSE_ACCEL
 105
 106     // compatibility only, use new functions in the new code
 107     void SetName(const wxString& str) { SetText(str); }
 108     const wxString& GetName() const { return GetText(); }
 109
 110     static wxMenuItem *New(wxMenu *parentMenu,
 111                            int id,
 112                            const wxString& text,
 113                            const wxString& help,
 114                            bool isCheckable,
 115                            wxMenu *subMenu = (wxMenu *)NULL)
 116     {
 117         return New(parentMenu, id, text, help,
 118                    isCheckable ? wxItem_Check : wxItem_Normal, subMenu);
 119     }
 120
 121 protected:
 122     int           m_id;             // numeric id of the item >= 0 or -1
 123     wxMenu       *m_parentMenu,     // the menu we belong to
 124                  *m_subMenu;        // our sub menu or NULL
 125     wxString      m_text,           // label of the item
 126                   m_help;           // the help string for the item
 127     wxItemKind    m_kind;           // seperator/normal/check/radio item?
 128     bool          m_isChecked;      // is checked?
 129     bool          m_isEnabled;      // is enabled?
 130
 131     // this ctor is for the derived classes only, we're never created directly
 132     wxMenuItemBase(wxMenu *parentMenu = (wxMenu *)NULL,
 133                    int id = wxID_SEPARATOR,
 134                    const wxString& text = wxEmptyString,
 135                    const wxString& help = wxEmptyString,
 136                    wxItemKind kind = wxItem_Normal,
 137                    wxMenu *subMenu = (wxMenu *)NULL);
 138
 139 private:
 140     // and, if we have one ctor, compiler won't generate a default copy one, so
 141     // declare them ourselves - but don't implement as they shouldn't be used
 142     wxMenuItemBase(const wxMenuItemBase& item);
 143     wxMenuItemBase& operator=(const wxMenuItemBase& item);
 144 };
 145
 146 // ----------------------------------------------------------------------------
 147 // include the real class declaration
 148 // ----------------------------------------------------------------------------
 149
 150 #ifdef wxUSE_BASE_CLASSES_ONLY
 151     #define wxMenuItem wxMenuItemBase
 152 #else // !wxUSE_BASE_CLASSES_ONLY
 153 #if defined(__WXUNIVERSAL__)
 154     #include "wx/univ/menuitem.h"
 155 #elif defined(__WXMSW__)
 156     #include "wx/msw/menuitem.h"
 157 #elif defined(__WXMOTIF__)
 158     #include "wx/motif/menuitem.h"
 159 #elif defined(__WXGTK__)
 160     #include "wx/gtk/menuitem.h"
 161 #elif defined(__WXMAC__)
 162     #include "wx/mac/menuitem.h"
 163 #elif defined(__WXPM__)
 164     #include "wx/os2/menuitem.h"
 165 #elif defined(__WXSTUBS__)
 166     #include "wx/stubs/menuitem.h"
 167 #endif
 168 #endif // wxUSE_BASE_CLASSES_ONLY/!wxUSE_BASE_CLASSES_ONLY
 169
 170 #endif // wxUSE_MENUS
 171
 172 #endif
 173     // _WX_MENUITEM_H_BASE_