include/wx/gtk/menuitem.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        menuitem.h
   3 // Purpose:     wxMenuItem class
   4 // Author:      Robert Roebling
   5 // RCS-ID:      $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 ///////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef _WX_GTKMENUITEM_H_
  11 #define _WX_GTKMENUITEM_H_
  12
  13 #include "wx/bitmap.h"
  14
  15 //-----------------------------------------------------------------------------
  16 // wxMenuItem
  17 //-----------------------------------------------------------------------------
  18
  19 class WXDLLIMPEXP_CORE wxMenuItem : public wxMenuItemBase
  20 {
  21 public:
  22     wxMenuItem(wxMenu *parentMenu = (wxMenu *)NULL,
  23                int id = wxID_SEPARATOR,
  24                const wxString& text = wxEmptyString,
  25                const wxString& help = wxEmptyString,
  26                wxItemKind kind = wxITEM_NORMAL,
  27                wxMenu *subMenu = (wxMenu *)NULL);
  28     virtual ~wxMenuItem();
  29
  30     // implement base class virtuals
  31     virtual void SetItemLabel( const wxString& str );
  32     virtual wxString GetItemLabel() const;
  33     virtual void Enable( bool enable = true );
  34     virtual void Check( bool check = true );
  35     virtual bool IsChecked() const;
  36     virtual void SetBitmap(const wxBitmap& bitmap) { m_bitmap = bitmap; }
  37     virtual const wxBitmap& GetBitmap() const { return m_bitmap; }
  38
  39 #if wxUSE_ACCEL
  40     virtual wxAcceleratorEntry *GetAccel() const;
  41 #endif // wxUSE_ACCEL
  42
  43     // implementation
  44     void SetMenuItem(GtkWidget *menuItem) { m_menuItem = menuItem; }
  45     GtkWidget *GetMenuItem() const { return m_menuItem; }
  46
  47     // splits given string in the label, doing & => _ translation, which is returned,
  48     // and in the hotkey which is used to set given pointer
  49     static wxString GTKProcessMenuItemLabel(const wxString& str, wxString *hotKey);
  50
  51 #if WXWIN_COMPATIBILITY_2_8
  52     // compatibility only, don't use in new code
  53     wxDEPRECATED(
  54     wxMenuItem(wxMenu *parentMenu,
  55                int id,
  56                const wxString& text,
  57                const wxString& help,
  58                bool isCheckable,
  59                wxMenu *subMenu = NULL)
  60     );
  61 #endif
  62
  63 private:
  64     // common part of all ctors
  65     void Init(const wxString& text);
  66
  67     // DoSetText() transforms the accel mnemonics in our label from MSW/wxWin
  68     // style to GTK+ and is called from ctor and SetText()
  69     void DoSetText(const wxString& text);
  70
  71     wxString  m_hotKey;
  72     wxBitmap  m_bitmap; // Bitmap for menuitem, if any
  73
  74     GtkWidget *m_menuItem;  // GtkMenuItem
  75
  76     DECLARE_DYNAMIC_CLASS(wxMenuItem)
  77 };
  78
  79 #endif // _WX_GTKMENUITEM_H_