]> git.saurik.com Git - wxWidgets.git/blame - include/wx/msw/menu.h
Use explicit wxPGPropertyFlags enum type with wxPGProperty::SetFlag() and similar...
[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 8// Copyright: (c) Julian Smart
65571936 9// Licence: wxWindows licence
2bda0e17
KB
10/////////////////////////////////////////////////////////////////////////////
11
bbcdf8bc
JS
12#ifndef _WX_MENU_H_
13#define _WX_MENU_H_
2bda0e17 14
3f3cec48 15#if wxUSE_ACCEL
974e8d94 16 #include "wx/accel.h"
717a57c2
VZ
17 #include "wx/dynarray.h"
18
d5d29b8a 19 WX_DEFINE_EXPORTED_ARRAY_PTR(wxAcceleratorEntry *, wxAcceleratorArray);
3f3cec48 20#endif // wxUSE_ACCEL
2bda0e17 21
b5dbe15d 22class WXDLLIMPEXP_FWD_CORE wxFrame;
2bda0e17 23
39d2f9a7 24#if defined(__WXWINCE__) && wxUSE_TOOLBAR
b5dbe15d 25class WXDLLIMPEXP_FWD_CORE wxToolBar;
39d2f9a7
JS
26#endif
27
b3900fb5
RR
28
29// Not using a combined wxToolBar/wxMenuBar? then use
30// a commandbar in WinCE .NET to implement the
31// menubar, since there is no ::SetMenu function.
32#if defined(__WXWINCE__)
33# if ((_WIN32_WCE >= 400) && !defined(__POCKETPC__) && !defined(__SMARTPHONE__)) || \
34 defined(__HANDHELDPC__)
35# define WINCE_WITH_COMMANDBAR
36# else
37# define WINCE_WITHOUT_COMMANDBAR
38# endif
39#endif
40
41
a381fd1c
MB
42#include "wx/arrstr.h"
43
2bda0e17
KB
44// ----------------------------------------------------------------------------
45// Menu
46// ----------------------------------------------------------------------------
c626a8b7 47
53a2db12 48class WXDLLIMPEXP_CORE wxMenu : public wxMenuBase
2bda0e17 49{
2bda0e17 50public:
b908d224 51 // ctors & dtor
717a57c2
VZ
52 wxMenu(const wxString& title, long style = 0)
53 : wxMenuBase(title, style) { Init(); }
33961d59 54
717a57c2 55 wxMenu(long style = 0) : wxMenuBase(style) { Init(); }
b908d224 56
c626a8b7
VZ
57 virtual ~wxMenu();
58
717a57c2
VZ
59 virtual void Break();
60
61 virtual void SetTitle(const wxString& title);
c626a8b7 62
717a57c2
VZ
63 // implementation only from now on
64 // -------------------------------
c626a8b7 65
0472ece7
VZ
66 virtual void Attach(wxMenuBarBase *menubar);
67
717a57c2 68 bool MSWCommand(WXUINT param, WXWORD id);
c626a8b7
VZ
69
70 // semi-private accessors
71 // get the window which contains this menu
72 wxWindow *GetWindow() const;
73 // get the menu handle
717a57c2 74 WXHMENU GetHMenu() const { return m_hMenu; }
2bda0e17 75
d427503c 76#if wxUSE_ACCEL
717a57c2 77 // called by wxMenuBar to build its accel table from the accels of all menus
67fdb6f9
VZ
78 bool HasAccels() const { return !m_accels.empty(); }
79 size_t GetAccelCount() const { return m_accels.size(); }
42e69d6b
VZ
80 size_t CopyAccels(wxAcceleratorEntry *accels) const;
81
717a57c2
VZ
82 // called by wxMenuItem when its accels changes
83 void UpdateAccel(wxMenuItem *item);
42e69d6b 84
717a57c2
VZ
85 // helper used by wxMenu itself (returns the index in m_accels)
86 int FindAccel(int id) const;
67fdb6f9
VZ
87
88 // used only by wxMDIParentFrame currently but could be useful elsewhere:
89 // returns a new accelerator table with accelerators for just this menu
90 // (shouldn't be called if we don't have any accelerators)
91 wxAcceleratorTable *CreateAccelTable() const;
717a57c2 92#endif // wxUSE_ACCEL
42e69d6b 93
9c32ed26
VZ
94#if wxUSE_OWNER_DRAWN
95
96 int GetMaxAccelWidth()
97 {
98 if (m_maxAccelWidth == -1)
99 CalculateMaxAccelWidth();
100 return m_maxAccelWidth;
101 }
102
103 void ResetMaxAccelWidth()
104 {
105 m_maxAccelWidth = -1;
106 }
107
108private:
109 void CalculateMaxAccelWidth();
110
111#endif // wxUSE_OWNER_DRAWN
112
6f02a879
VZ
113protected:
114 virtual wxMenuItem* DoAppend(wxMenuItem *item);
115 virtual wxMenuItem* DoInsert(size_t pos, wxMenuItem *item);
116 virtual wxMenuItem* DoRemove(wxMenuItem *item);
117
2bda0e17 118private:
b908d224 119 // common part of all ctors
717a57c2
VZ
120 void Init();
121
122 // common part of Append/Insert (behaves as Append is pos == (size_t)-1)
123 bool DoInsertOrAppend(wxMenuItem *item, size_t pos = (size_t)-1);
124
0472ece7
VZ
125 // terminate the current radio group, if any
126 void EndRadioGroup();
127
598ddd96 128 // if true, insert a breal before appending the next item
717a57c2
VZ
129 bool m_doBreak;
130
0472ece7
VZ
131 // the position of the first item in the current radio group or -1
132 int m_startRadioGroup;
133
717a57c2
VZ
134 // the menu handle of this menu
135 WXHMENU m_hMenu;
42e69d6b 136
d427503c 137#if wxUSE_ACCEL
974e8d94
VZ
138 // the accelerators for our menu items
139 wxAcceleratorArray m_accels;
d427503c 140#endif // wxUSE_ACCEL
717a57c2 141
d08504df
VZ
142#if wxUSE_OWNER_DRAWN
143 // true if the menu has any ownerdrawn items
144 bool m_ownerDrawn;
145
146 // the max width of menu items bitmaps
147 int m_maxBitmapWidth;
9c32ed26
VZ
148
149 // the max width of menu items accels
150 int m_maxAccelWidth;
d08504df
VZ
151#endif // wxUSE_OWNER_DRAWN
152
fc7a2a60 153 DECLARE_DYNAMIC_CLASS_NO_COPY(wxMenu)
2bda0e17
KB
154};
155
156// ----------------------------------------------------------------------------
157// Menu Bar (a la Windows)
158// ----------------------------------------------------------------------------
c626a8b7 159
53a2db12 160class WXDLLIMPEXP_CORE wxMenuInfo : public wxObject
6c7a1f82
SC
161{
162public :
3839f37e 163 wxMenuInfo() { m_menu = NULL; }
6c7a1f82
SC
164 virtual ~wxMenuInfo() { }
165
598ddd96 166 void Create( wxMenu *menu , const wxString &title )
3839f37e
VZ
167 { m_menu = menu; m_title = title; }
168 wxMenu* GetMenu() const { return m_menu; }
169 wxString GetTitle() const { return m_title; }
6c7a1f82 170private :
3839f37e
VZ
171 wxMenu *m_menu;
172 wxString m_title;
6c7a1f82 173
3839f37e
VZ
174 DECLARE_DYNAMIC_CLASS(wxMenuInfo)
175};
6c7a1f82
SC
176
177WX_DECLARE_EXPORTED_LIST(wxMenuInfo, wxMenuInfoList );
178
53a2db12 179class WXDLLIMPEXP_CORE wxMenuBar : public wxMenuBarBase
2bda0e17 180{
c626a8b7 181public:
598ddd96 182 // ctors & dtor
c2dcfdef 183 // default constructor
c626a8b7 184 wxMenuBar();
c2dcfdef 185 // unused under MSW
c626a8b7 186 wxMenuBar(long style);
c2dcfdef 187 // menubar takes ownership of the menus arrays but copies the titles
294ea16d 188 wxMenuBar(size_t n, wxMenu *menus[], const wxString titles[], long style = 0);
c626a8b7
VZ
189 virtual ~wxMenuBar();
190
191 // menubar construction
3839f37e
VZ
192 bool Append( wxMenuInfo *info ) { return Append( info->GetMenu() , info->GetTitle() ); }
193 const wxMenuInfoList& GetMenuInfos() const;
6c7a1f82 194
a8cfd0cb
VZ
195 virtual bool Append( wxMenu *menu, const wxString &title );
196 virtual bool Insert(size_t pos, wxMenu *menu, const wxString& title);
197 virtual wxMenu *Replace(size_t pos, wxMenu *menu, const wxString& title);
198 virtual wxMenu *Remove(size_t pos);
c626a8b7 199
a8cfd0cb 200 virtual void EnableTop( size_t pos, bool flag );
52af3158
JS
201 virtual void SetMenuLabel( size_t pos, const wxString& label );
202 virtual wxString GetMenuLabel( size_t pos ) const;
c626a8b7 203
a8cfd0cb
VZ
204 // implementation from now on
205 WXHMENU Create();
1e6feb95
VZ
206 virtual void Detach();
207 virtual void Attach(wxFrame *frame);
c2dcfdef 208
b3900fb5 209#if defined(__WXWINCE__) && wxUSE_TOOLBAR
39d2f9a7
JS
210 // Under WinCE, a menubar is owned by the frame's toolbar
211 void SetToolBar(wxToolBar* toolBar) { m_toolBar = toolBar; }
212 wxToolBar* GetToolBar() const { return m_toolBar; }
213#endif
214
b3900fb5 215#ifdef WINCE_WITH_COMMANDBAR
45f27284 216 WXHWND GetCommandBar() const { return m_commandBar; }
a9928e9d 217 bool AddAdornments(long style);
45f27284
JS
218#endif
219
d427503c 220#if wxUSE_ACCEL
3103e8a9 221 // update the accel table (must be called after adding/deleting a menu)
717a57c2 222 void RebuildAccelTable();
d427503c
VZ
223#endif // wxUSE_ACCEL
224
c2dcfdef
VZ
225 // get the menu handle
226 WXHMENU GetHMenu() const { return m_hMenu; }
227
c2dcfdef
VZ
228 // if the menubar is modified, the display is not updated automatically,
229 // call this function to update it (m_menuBarFrame should be !NULL)
230 void Refresh();
231
b85b77ae 232 // To avoid compile warning
39428534 233 void Refresh( bool eraseBackground,
b85b77ae
JS
234 const wxRect *rect = (const wxRect *) NULL ) { wxWindow::Refresh(eraseBackground, rect); }
235
fbb90f7f
PA
236protected:
237 // common part of all ctors
238 void Init();
239
3839f37e 240 wxArrayString m_titles;
6c7a1f82 241 wxMenuInfoList m_menuInfos;
a8cfd0cb 242
c2dcfdef 243 WXHMENU m_hMenu;
42e69d6b 244
b2c5f143 245 // Return the MSW position for a wxMenu which is sometimes different from
77ffb593 246 // the wxWidgets position.
b2c5f143 247 int MSWPositionForWxMenu(wxMenu *menu, int wxpos);
a8cfd0cb 248
39d2f9a7
JS
249#if defined(__WXWINCE__) && wxUSE_TOOLBAR
250 wxToolBar* m_toolBar;
251#endif
b3900fb5
RR
252
253#ifdef WINCE_WITH_COMMANDBAR
a96b4743 254 WXHWND m_commandBar;
a9928e9d 255 bool m_adornmentsAdded;
a96b4743 256#endif
39d2f9a7 257
a8cfd0cb 258private:
fc7a2a60 259 DECLARE_DYNAMIC_CLASS_NO_COPY(wxMenuBar)
2bda0e17
KB
260};
261
bbcdf8bc 262#endif // _WX_MENU_H_