]> git.saurik.com Git - wxWidgets.git/blame - include/wx/msw/menu.h
Moved wxToolBarSimple to deprecated library
[wxWidgets.git] / include / wx / msw / menu.h
CommitLineData
2bda0e17 1/////////////////////////////////////////////////////////////////////////////
0472ece7 2// Name: wx/msw/menu.h
2bda0e17
KB
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$
371a5b4e
JS
8// Copyright: (c) Julian Smart
9// Licence: wxWindows licence
2bda0e17
KB
10/////////////////////////////////////////////////////////////////////////////
11
bbcdf8bc
JS
12#ifndef _WX_MENU_H_
13#define _WX_MENU_H_
2bda0e17 14
12028905 15#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
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
6108e3fd 23 WX_DEFINE_EXPORTED_ARRAY_NO_PTR(wxAcceleratorEntry *, wxAcceleratorArray);
3f3cec48 24#endif // wxUSE_ACCEL
2bda0e17 25
c626a8b7 26class WXDLLEXPORT wxFrame;
2bda0e17 27
39d2f9a7
JS
28#if defined(__WXWINCE__) && wxUSE_TOOLBAR
29class WXDLLEXPORT wxToolBar;
30#endif
31
a381fd1c
MB
32#include "wx/arrstr.h"
33
2bda0e17
KB
34// ----------------------------------------------------------------------------
35// Menu
36// ----------------------------------------------------------------------------
c626a8b7 37
717a57c2 38class WXDLLEXPORT wxMenu : public wxMenuBase
2bda0e17 39{
2bda0e17 40public:
b908d224 41 // ctors & dtor
717a57c2
VZ
42 wxMenu(const wxString& title, long style = 0)
43 : wxMenuBase(title, style) { Init(); }
33961d59 44
717a57c2 45 wxMenu(long style = 0) : wxMenuBase(style) { Init(); }
b908d224 46
c626a8b7
VZ
47 virtual ~wxMenu();
48
717a57c2
VZ
49 // implement base class virtuals
50 virtual bool DoAppend(wxMenuItem *item);
51 virtual bool DoInsert(size_t pos, wxMenuItem *item);
52 virtual wxMenuItem *DoRemove(wxMenuItem *item);
53
54 virtual void Break();
55
56 virtual void SetTitle(const wxString& title);
c626a8b7 57
39428534
JS
58 // deprecated functions
59#if wxUSE_MENU_CALLBACK
60 wxMenu(const wxString& title, const wxFunction func)
61 : wxMenuBase(title)
62 {
63 Init();
64
65 Callback(func);
66 }
67#endif // wxUSE_MENU_CALLBACK
68
717a57c2
VZ
69 // implementation only from now on
70 // -------------------------------
c626a8b7 71
0472ece7
VZ
72 virtual void Attach(wxMenuBarBase *menubar);
73
717a57c2 74 bool MSWCommand(WXUINT param, WXWORD id);
c626a8b7
VZ
75
76 // semi-private accessors
77 // get the window which contains this menu
78 wxWindow *GetWindow() const;
79 // get the menu handle
717a57c2 80 WXHMENU GetHMenu() const { return m_hMenu; }
2bda0e17 81
d427503c 82#if wxUSE_ACCEL
717a57c2
VZ
83 // called by wxMenuBar to build its accel table from the accels of all menus
84 bool HasAccels() const { return !m_accels.IsEmpty(); }
974e8d94 85 size_t GetAccelCount() const { return m_accels.GetCount(); }
42e69d6b
VZ
86 size_t CopyAccels(wxAcceleratorEntry *accels) const;
87
717a57c2
VZ
88 // called by wxMenuItem when its accels changes
89 void UpdateAccel(wxMenuItem *item);
42e69d6b 90
717a57c2
VZ
91 // helper used by wxMenu itself (returns the index in m_accels)
92 int FindAccel(int id) const;
93#endif // wxUSE_ACCEL
42e69d6b 94
2bda0e17 95private:
b908d224 96 // common part of all ctors
717a57c2
VZ
97 void Init();
98
99 // common part of Append/Insert (behaves as Append is pos == (size_t)-1)
100 bool DoInsertOrAppend(wxMenuItem *item, size_t pos = (size_t)-1);
101
0472ece7
VZ
102 // terminate the current radio group, if any
103 void EndRadioGroup();
104
717a57c2
VZ
105 // if TRUE, insert a breal before appending the next item
106 bool m_doBreak;
107
0472ece7
VZ
108 // the position of the first item in the current radio group or -1
109 int m_startRadioGroup;
110
717a57c2
VZ
111 // the menu handle of this menu
112 WXHMENU m_hMenu;
42e69d6b 113
d427503c 114#if wxUSE_ACCEL
974e8d94
VZ
115 // the accelerators for our menu items
116 wxAcceleratorArray m_accels;
d427503c 117#endif // wxUSE_ACCEL
717a57c2 118
fc7a2a60 119 DECLARE_DYNAMIC_CLASS_NO_COPY(wxMenu)
2bda0e17
KB
120};
121
122// ----------------------------------------------------------------------------
123// Menu Bar (a la Windows)
124// ----------------------------------------------------------------------------
c626a8b7 125
a8cfd0cb 126class WXDLLEXPORT wxMenuBar : public wxMenuBarBase
2bda0e17 127{
c626a8b7
VZ
128public:
129 // ctors & dtor
c2dcfdef 130 // default constructor
c626a8b7 131 wxMenuBar();
c2dcfdef 132 // unused under MSW
c626a8b7 133 wxMenuBar(long style);
c2dcfdef 134 // menubar takes ownership of the menus arrays but copies the titles
c626a8b7
VZ
135 wxMenuBar(int n, wxMenu *menus[], const wxString titles[]);
136 virtual ~wxMenuBar();
137
138 // menubar construction
a8cfd0cb
VZ
139 virtual bool Append( wxMenu *menu, const wxString &title );
140 virtual bool Insert(size_t pos, wxMenu *menu, const wxString& title);
141 virtual wxMenu *Replace(size_t pos, wxMenu *menu, const wxString& title);
142 virtual wxMenu *Remove(size_t pos);
c626a8b7 143
a8cfd0cb
VZ
144 virtual void EnableTop( size_t pos, bool flag );
145 virtual void SetLabelTop( size_t pos, const wxString& label );
146 virtual wxString GetLabelTop( size_t pos ) const;
c626a8b7 147
a8cfd0cb 148 // compatibility: these functions are deprecated
600ea9da 149#if WXWIN_COMPATIBILITY
c626a8b7
VZ
150 void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
151 wxEvtHandler *GetEventHandler() { return m_eventHandler; }
152
c626a8b7
VZ
153 bool Enabled(int id) const { return IsEnabled(id); }
154 bool Checked(int id) const { return IsChecked(id); }
155#endif // WXWIN_COMPATIBILITY
2bda0e17 156
a8cfd0cb
VZ
157 // implementation from now on
158 WXHMENU Create();
1e6feb95
VZ
159 virtual void Detach();
160 virtual void Attach(wxFrame *frame);
c2dcfdef 161
39d2f9a7
JS
162#if defined(__WXWINCE__) && wxUSE_TOOLBAR
163 // Under WinCE, a menubar is owned by the frame's toolbar
164 void SetToolBar(wxToolBar* toolBar) { m_toolBar = toolBar; }
165 wxToolBar* GetToolBar() const { return m_toolBar; }
166#endif
167
d427503c 168#if wxUSE_ACCEL
717a57c2 169 // get the accel table for all the menus
42e69d6b 170 const wxAcceleratorTable& GetAccelTable() const { return m_accelTable; }
717a57c2
VZ
171
172 // update the accel table (must be called after adding/deletign a menu)
173 void RebuildAccelTable();
d427503c
VZ
174#endif // wxUSE_ACCEL
175
c2dcfdef
VZ
176 // get the menu handle
177 WXHMENU GetHMenu() const { return m_hMenu; }
178
c2dcfdef
VZ
179 // if the menubar is modified, the display is not updated automatically,
180 // call this function to update it (m_menuBarFrame should be !NULL)
181 void Refresh();
182
b85b77ae 183 // To avoid compile warning
39428534 184 void Refresh( bool eraseBackground,
b85b77ae
JS
185 const wxRect *rect = (const wxRect *) NULL ) { wxWindow::Refresh(eraseBackground, rect); }
186
fbb90f7f
PA
187protected:
188 // common part of all ctors
189 void Init();
190
600ea9da 191#if WXWIN_COMPATIBILITY
c2dcfdef 192 wxEvtHandler *m_eventHandler;
a8cfd0cb
VZ
193#endif // WXWIN_COMPATIBILITY
194
195 wxArrayString m_titles;
196
c2dcfdef 197 WXHMENU m_hMenu;
42e69d6b 198
d427503c 199#if wxUSE_ACCEL
42e69d6b
VZ
200 // the accelerator table for all accelerators in all our menus
201 wxAcceleratorTable m_accelTable;
d427503c 202#endif // wxUSE_ACCEL
a8cfd0cb 203
39d2f9a7
JS
204#if defined(__WXWINCE__) && wxUSE_TOOLBAR
205 wxToolBar* m_toolBar;
206#endif
207
a8cfd0cb 208private:
fc7a2a60 209 DECLARE_DYNAMIC_CLASS_NO_COPY(wxMenuBar)
2bda0e17
KB
210};
211
bbcdf8bc 212#endif // _WX_MENU_H_