]> git.saurik.com Git - wxWidgets.git/blame - include/wx/msw/menu.h
Added calendar contributed by Lorne White
[wxWidgets.git] / include / wx / msw / menu.h
CommitLineData
2bda0e17
KB
1/////////////////////////////////////////////////////////////////////////////
2// Name: 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 and Markus Holzem
a3622daa 9// Licence: wxWindows license
2bda0e17
KB
10/////////////////////////////////////////////////////////////////////////////
11
bbcdf8bc
JS
12#ifndef _WX_MENU_H_
13#define _WX_MENU_H_
2bda0e17
KB
14
15#ifdef __GNUG__
c626a8b7 16 #pragma interface "menu.h"
2bda0e17
KB
17#endif
18
3f3cec48 19#if wxUSE_ACCEL
974e8d94 20 #include "wx/accel.h"
717a57c2
VZ
21 #include "wx/dynarray.h"
22
23 WX_DEFINE_EXPORTED_ARRAY(wxAcceleratorEntry *, wxAcceleratorArray);
3f3cec48 24#endif // wxUSE_ACCEL
2bda0e17 25
c626a8b7 26class WXDLLEXPORT wxFrame;
2bda0e17 27
2bda0e17
KB
28// ----------------------------------------------------------------------------
29// Menu
30// ----------------------------------------------------------------------------
c626a8b7 31
717a57c2 32class WXDLLEXPORT wxMenu : public wxMenuBase
2bda0e17 33{
2bda0e17 34public:
b908d224 35 // ctors & dtor
717a57c2
VZ
36 wxMenu(const wxString& title, long style = 0)
37 : wxMenuBase(title, style) { Init(); }
33961d59 38
717a57c2 39 wxMenu(long style = 0) : wxMenuBase(style) { Init(); }
b908d224 40
c626a8b7
VZ
41 virtual ~wxMenu();
42
717a57c2
VZ
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);
c626a8b7 51
717a57c2 52 // MSW-specific
42e69d6b 53 bool ProcessCommand(wxCommandEvent& event);
c626a8b7 54
600ea9da 55#if WXWIN_COMPATIBILITY
717a57c2
VZ
56 wxMenu(const wxString& title, const wxFunction func)
57 : wxMenuBase(title)
58 {
59 Callback(func);
60 }
61#endif // WXWIN_COMPATIBILITY
c626a8b7 62
717a57c2
VZ
63 // implementation only from now on
64 // -------------------------------
c626a8b7 65
717a57c2 66 bool MSWCommand(WXUINT param, WXWORD id);
c626a8b7
VZ
67
68 // semi-private accessors
69 // get the window which contains this menu
70 wxWindow *GetWindow() const;
71 // get the menu handle
717a57c2 72 WXHMENU GetHMenu() const { return m_hMenu; }
2bda0e17 73
717a57c2 74 // attach/detach menu to/from wxMenuBar
c2dcfdef
VZ
75 void Attach(wxMenuBar *menubar);
76 void Detach();
77
d427503c 78#if wxUSE_ACCEL
717a57c2
VZ
79 // called by wxMenuBar to build its accel table from the accels of all menus
80 bool HasAccels() const { return !m_accels.IsEmpty(); }
974e8d94 81 size_t GetAccelCount() const { return m_accels.GetCount(); }
42e69d6b
VZ
82 size_t CopyAccels(wxAcceleratorEntry *accels) const;
83
717a57c2
VZ
84 // called by wxMenuItem when its accels changes
85 void UpdateAccel(wxMenuItem *item);
42e69d6b 86
717a57c2
VZ
87 // helper used by wxMenu itself (returns the index in m_accels)
88 int FindAccel(int id) const;
89#endif // wxUSE_ACCEL
42e69d6b 90
2bda0e17 91private:
b908d224 92 // common part of all ctors
717a57c2
VZ
93 void Init();
94
95 // common part of Append/Insert (behaves as Append is pos == (size_t)-1)
96 bool DoInsertOrAppend(wxMenuItem *item, size_t pos = (size_t)-1);
97
98 // if TRUE, insert a breal before appending the next item
99 bool m_doBreak;
100
101 // the menu handle of this menu
102 WXHMENU m_hMenu;
42e69d6b 103
d427503c 104#if wxUSE_ACCEL
974e8d94
VZ
105 // the accelerators for our menu items
106 wxAcceleratorArray m_accels;
d427503c 107#endif // wxUSE_ACCEL
717a57c2
VZ
108
109 DECLARE_DYNAMIC_CLASS(wxMenu)
2bda0e17
KB
110};
111
112// ----------------------------------------------------------------------------
113// Menu Bar (a la Windows)
114// ----------------------------------------------------------------------------
c626a8b7 115
a8cfd0cb 116class WXDLLEXPORT wxMenuBar : public wxMenuBarBase
2bda0e17 117{
c626a8b7
VZ
118public:
119 // ctors & dtor
c2dcfdef 120 // default constructor
c626a8b7 121 wxMenuBar();
c2dcfdef 122 // unused under MSW
c626a8b7 123 wxMenuBar(long style);
c2dcfdef 124 // menubar takes ownership of the menus arrays but copies the titles
c626a8b7
VZ
125 wxMenuBar(int n, wxMenu *menus[], const wxString titles[]);
126 virtual ~wxMenuBar();
127
128 // menubar construction
a8cfd0cb
VZ
129 virtual bool Append( wxMenu *menu, const wxString &title );
130 virtual bool Insert(size_t pos, wxMenu *menu, const wxString& title);
131 virtual wxMenu *Replace(size_t pos, wxMenu *menu, const wxString& title);
132 virtual wxMenu *Remove(size_t pos);
c626a8b7 133
a8cfd0cb
VZ
134 virtual int FindMenuItem(const wxString& menuString,
135 const wxString& itemString) const;
136 virtual wxMenuItem* FindItem( int id, wxMenu **menu = NULL ) const;
c626a8b7 137
a8cfd0cb
VZ
138 virtual void EnableTop( size_t pos, bool flag );
139 virtual void SetLabelTop( size_t pos, const wxString& label );
140 virtual wxString GetLabelTop( size_t pos ) const;
c626a8b7 141
a8cfd0cb 142 // compatibility: these functions are deprecated
600ea9da 143#if WXWIN_COMPATIBILITY
c626a8b7
VZ
144 void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
145 wxEvtHandler *GetEventHandler() { return m_eventHandler; }
146
c626a8b7
VZ
147 bool Enabled(int id) const { return IsEnabled(id); }
148 bool Checked(int id) const { return IsChecked(id); }
149#endif // WXWIN_COMPATIBILITY
2bda0e17 150
a8cfd0cb
VZ
151 // implementation from now on
152 WXHMENU Create();
153 int FindMenu(const wxString& title);
154 void Detach();
155
c2dcfdef
VZ
156 // returns TRUE if we're attached to a frame
157 bool IsAttached() const { return m_menuBarFrame != NULL; }
158 // get the frame we live in
159 wxFrame *GetFrame() const { return m_menuBarFrame; }
160 // attach to a frame
42e69d6b 161 void Attach(wxFrame *frame);
c2dcfdef 162
d427503c 163#if wxUSE_ACCEL
717a57c2 164 // get the accel table for all the menus
42e69d6b 165 const wxAcceleratorTable& GetAccelTable() const { return m_accelTable; }
717a57c2
VZ
166
167 // update the accel table (must be called after adding/deletign a menu)
168 void RebuildAccelTable();
d427503c
VZ
169#endif // wxUSE_ACCEL
170
c2dcfdef
VZ
171 // get the menu handle
172 WXHMENU GetHMenu() const { return m_hMenu; }
173
c2dcfdef
VZ
174 // if the menubar is modified, the display is not updated automatically,
175 // call this function to update it (m_menuBarFrame should be !NULL)
176 void Refresh();
177
fbb90f7f
PA
178protected:
179 // common part of all ctors
180 void Init();
181
600ea9da 182#if WXWIN_COMPATIBILITY
c2dcfdef 183 wxEvtHandler *m_eventHandler;
a8cfd0cb
VZ
184#endif // WXWIN_COMPATIBILITY
185
186 wxArrayString m_titles;
187
c2dcfdef
VZ
188 wxFrame *m_menuBarFrame;
189 WXHMENU m_hMenu;
42e69d6b 190
d427503c 191#if wxUSE_ACCEL
42e69d6b
VZ
192 // the accelerator table for all accelerators in all our menus
193 wxAcceleratorTable m_accelTable;
d427503c 194#endif // wxUSE_ACCEL
a8cfd0cb
VZ
195
196private:
197 DECLARE_DYNAMIC_CLASS(wxMenuBar)
2bda0e17
KB
198};
199
bbcdf8bc 200#endif // _WX_MENU_H_