include/wx/msw/menu.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/menu.h
   3 // Purpose:     wxMenu, wxMenuBar classes
   4 // Author:      Julian Smart
   5 // Modified by: Vadim Zeitlin (wxMenuItem is now in separate file)
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_MENU_H_
  13 #define _WX_MENU_H_
  14
  15 #ifdef __GNUG__
  16     #pragma interface "menu.h"
  17 #endif
  18
  19 #if wxUSE_ACCEL
  20     #include "wx/accel.h"
  21     #include "wx/dynarray.h"
  22
  23     WX_DEFINE_EXPORTED_ARRAY(wxAcceleratorEntry *, wxAcceleratorArray);
  24 #endif // wxUSE_ACCEL
  25
  26 class WXDLLEXPORT wxFrame;
  27
  28 // ----------------------------------------------------------------------------
  29 // Menu
  30 // ----------------------------------------------------------------------------
  31
  32 class WXDLLEXPORT wxMenu : public wxMenuBase
  33 {
  34 public:
  35     // ctors & dtor
  36     wxMenu(const wxString& title, long style = 0)
  37         : wxMenuBase(title, style) { Init(); }
  38
  39     wxMenu(long style = 0) : wxMenuBase(style) { Init(); }
  40
  41     virtual ~wxMenu();
  42
  43     // implement base class virtuals
  44     virtual bool DoAppend(wxMenuItem *item);
  45     virtual bool DoInsert(size_t pos, wxMenuItem *item);
  46     virtual wxMenuItem *DoRemove(wxMenuItem *item);
  47
  48     virtual void Break();
  49
  50     virtual void SetTitle(const wxString& title);
  51
  52     // implementation only from now on
  53     // -------------------------------
  54
  55     virtual void Attach(wxMenuBarBase *menubar);
  56
  57     bool MSWCommand(WXUINT param, WXWORD id);
  58
  59     // semi-private accessors
  60         // get the window which contains this menu
  61     wxWindow *GetWindow() const;
  62         // get the menu handle
  63     WXHMENU GetHMenu() const { return m_hMenu; }
  64
  65 #if wxUSE_ACCEL
  66     // called by wxMenuBar to build its accel table from the accels of all menus
  67     bool HasAccels() const { return !m_accels.IsEmpty(); }
  68     size_t GetAccelCount() const { return m_accels.GetCount(); }
  69     size_t CopyAccels(wxAcceleratorEntry *accels) const;
  70
  71     // called by wxMenuItem when its accels changes
  72     void UpdateAccel(wxMenuItem *item);
  73
  74     // helper used by wxMenu itself (returns the index in m_accels)
  75     int FindAccel(int id) const;
  76 #endif // wxUSE_ACCEL
  77
  78 private:
  79     // common part of all ctors
  80     void Init();
  81
  82     // common part of Append/Insert (behaves as Append is pos == (size_t)-1)
  83     bool DoInsertOrAppend(wxMenuItem *item, size_t pos = (size_t)-1);
  84
  85     // terminate the current radio group, if any
  86     void EndRadioGroup();
  87
  88     // if TRUE, insert a breal before appending the next item
  89     bool m_doBreak;
  90
  91     // the position of the first item in the current radio group or -1
  92     int m_startRadioGroup;
  93
  94     // the menu handle of this menu
  95     WXHMENU m_hMenu;
  96
  97 #if wxUSE_ACCEL
  98     // the accelerators for our menu items
  99     wxAcceleratorArray m_accels;
 100 #endif // wxUSE_ACCEL
 101
 102     DECLARE_DYNAMIC_CLASS(wxMenu)
 103 };
 104
 105 // ----------------------------------------------------------------------------
 106 // Menu Bar (a la Windows)
 107 // ----------------------------------------------------------------------------
 108
 109 class WXDLLEXPORT wxMenuBar : public wxMenuBarBase
 110 {
 111 public:
 112     // ctors & dtor
 113         // default constructor
 114     wxMenuBar();
 115         // unused under MSW
 116     wxMenuBar(long style);
 117         // menubar takes ownership of the menus arrays but copies the titles
 118     wxMenuBar(int n, wxMenu *menus[], const wxString titles[]);
 119     virtual ~wxMenuBar();
 120
 121     // menubar construction
 122     virtual bool Append( wxMenu *menu, const wxString &title );
 123     virtual bool Insert(size_t pos, wxMenu *menu, const wxString& title);
 124     virtual wxMenu *Replace(size_t pos, wxMenu *menu, const wxString& title);
 125     virtual wxMenu *Remove(size_t pos);
 126
 127     virtual void EnableTop( size_t pos, bool flag );
 128     virtual void SetLabelTop( size_t pos, const wxString& label );
 129     virtual wxString GetLabelTop( size_t pos ) const;
 130
 131     // compatibility: these functions are deprecated
 132 #if WXWIN_COMPATIBILITY
 133     void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
 134     wxEvtHandler *GetEventHandler() { return m_eventHandler; }
 135
 136     bool Enabled(int id) const { return IsEnabled(id); }
 137     bool Checked(int id) const { return IsChecked(id); }
 138 #endif // WXWIN_COMPATIBILITY
 139
 140     // implementation from now on
 141     WXHMENU Create();
 142     virtual void Detach();
 143     virtual void Attach(wxFrame *frame);
 144
 145 #if wxUSE_ACCEL
 146     // get the accel table for all the menus
 147     const wxAcceleratorTable& GetAccelTable() const { return m_accelTable; }
 148
 149     // update the accel table (must be called after adding/deletign a menu)
 150     void RebuildAccelTable();
 151 #endif // wxUSE_ACCEL
 152
 153         // get the menu handle
 154     WXHMENU GetHMenu() const { return m_hMenu; }
 155
 156     // if the menubar is modified, the display is not updated automatically,
 157     // call this function to update it (m_menuBarFrame should be !NULL)
 158     void Refresh();
 159
 160     // To avoid compile warning
 161     void Refresh( bool eraseBackground = TRUE,
 162                           const wxRect *rect = (const wxRect *) NULL ) { wxWindow::Refresh(eraseBackground, rect); }
 163
 164 protected:
 165     // common part of all ctors
 166     void Init();
 167
 168 #if WXWIN_COMPATIBILITY
 169     wxEvtHandler *m_eventHandler;
 170 #endif // WXWIN_COMPATIBILITY
 171
 172     wxArrayString m_titles;
 173
 174     WXHMENU       m_hMenu;
 175
 176 #if wxUSE_ACCEL
 177     // the accelerator table for all accelerators in all our menus
 178     wxAcceleratorTable m_accelTable;
 179 #endif // wxUSE_ACCEL
 180
 181 private:
 182     DECLARE_DYNAMIC_CLASS(wxMenuBar)
 183 };
 184
 185 #endif // _WX_MENU_H_