]> git.saurik.com Git - wxWidgets.git/blame - include/wx/menu.h
derive wxConfig classes from wxObject and add wxRTTI macros to them (patch 1587607)
[wxWidgets.git] / include / wx / menu.h
CommitLineData
3dfac970
VZ
1///////////////////////////////////////////////////////////////////////////////
2// Name: wx/menu.h
3// Purpose: wxMenu and wxMenuBar classes
4// Author: Vadim Zeitlin
5// Modified by:
6// Created: 26.10.99
7// RCS-ID: $Id$
77ffb593 8// Copyright: (c) wxWidgets team
65571936 9// Licence: wxWindows licence
3dfac970
VZ
10///////////////////////////////////////////////////////////////////////////////
11
34138703
JS
12#ifndef _WX_MENU_H_BASE_
13#define _WX_MENU_H_BASE_
c801d85f 14
997176a3
VZ
15#include "wx/defs.h"
16
1e6feb95
VZ
17#if wxUSE_MENUS
18
3dfac970
VZ
19// ----------------------------------------------------------------------------
20// headers
21// ----------------------------------------------------------------------------
22
717a57c2 23#include "wx/list.h" // for "template" list classes
3dfac970
VZ
24#include "wx/window.h" // base class for wxMenuBar
25
717a57c2
VZ
26// also include this one to ensure compatibility with old code which only
27// included wx/menu.h
28#include "wx/menuitem.h"
29
3dfac970 30class WXDLLEXPORT wxMenu;
1e6feb95 31class WXDLLEXPORT wxMenuBarBase;
3dfac970
VZ
32class WXDLLEXPORT wxMenuBar;
33class WXDLLEXPORT wxMenuItem;
34
717a57c2 35// pseudo template list classes
f6bcfd97
BP
36WX_DECLARE_EXPORTED_LIST(wxMenu, wxMenuList);
37WX_DECLARE_EXPORTED_LIST(wxMenuItem, wxMenuItemList);
717a57c2 38
3dfac970
VZ
39// ----------------------------------------------------------------------------
40// wxMenu
41// ----------------------------------------------------------------------------
42
717a57c2
VZ
43class WXDLLEXPORT wxMenuBase : public wxEvtHandler
44{
45public:
46 // create a menu
47 static wxMenu *New(const wxString& title = wxEmptyString, long style = 0);
48
49 // ctors
50 wxMenuBase(const wxString& title, long style = 0) : m_title(title)
51 { Init(style); }
52 wxMenuBase(long style = 0)
53 { Init(style); }
54
55 // dtor deletes all the menu items we own
56 virtual ~wxMenuBase();
57
58 // menu construction
59 // -----------------
60
d65c269b 61 // append any kind of item (normal/check/radio/separator)
9add9367 62 wxMenuItem* Append(int itemid,
ee0a94cf 63 const wxString& text = wxEmptyString,
9add9367
RD
64 const wxString& help = wxEmptyString,
65 wxItemKind kind = wxITEM_NORMAL)
717a57c2 66 {
9add9367 67 return DoAppend(wxMenuItem::New((wxMenu *)this, itemid, text, help, kind));
717a57c2
VZ
68 }
69
0e528b99 70 // append a separator to the menu
9add9367 71 wxMenuItem* AppendSeparator() { return Append(wxID_SEPARATOR, wxEmptyString); }
0e528b99 72
d65c269b 73 // append a check item
9add9367
RD
74 wxMenuItem* AppendCheckItem(int itemid,
75 const wxString& text,
76 const wxString& help = wxEmptyString)
d65c269b 77 {
9add9367 78 return Append(itemid, text, help, wxITEM_CHECK);
d65c269b
VZ
79 }
80
81 // append a radio item
9add9367
RD
82 wxMenuItem* AppendRadioItem(int itemid,
83 const wxString& text,
84 const wxString& help = wxEmptyString)
d65c269b 85 {
9add9367 86 return Append(itemid, text, help, wxITEM_RADIO);
d65c269b
VZ
87 }
88
717a57c2 89 // append a submenu
3786c8b5
VZ
90 wxMenuItem* AppendSubMenu(wxMenu *submenu,
91 const wxString& text,
92 const wxString& help = wxEmptyString)
717a57c2 93 {
3786c8b5 94 return DoAppend(wxMenuItem::New((wxMenu *)this, wxID_ANY, text, help,
9add9367 95 wxITEM_NORMAL, submenu));
717a57c2
VZ
96 }
97
98 // the most generic form of Append() - append anything
9add9367 99 wxMenuItem* Append(wxMenuItem *item) { return DoAppend(item); }
717a57c2
VZ
100
101 // insert a break in the menu (only works when appending the items, not
102 // inserting them)
103 virtual void Break() { }
104
105 // insert an item before given position
9add9367 106 wxMenuItem* Insert(size_t pos, wxMenuItem *item);
d65c269b
VZ
107
108 // insert an item before given position
9add9367
RD
109 wxMenuItem* Insert(size_t pos,
110 int itemid,
ee0a94cf 111 const wxString& text = wxEmptyString,
9add9367
RD
112 const wxString& help = wxEmptyString,
113 wxItemKind kind = wxITEM_NORMAL)
f6bcfd97 114 {
9add9367 115 return Insert(pos, wxMenuItem::New((wxMenu *)this, itemid, text, help, kind));
f6bcfd97
BP
116 }
117
118 // insert a separator
9add9367 119 wxMenuItem* InsertSeparator(size_t pos)
f6bcfd97 120 {
9add9367 121 return Insert(pos, wxMenuItem::New((wxMenu *)this, wxID_SEPARATOR));
f6bcfd97
BP
122 }
123
d65c269b 124 // insert a check item
9add9367
RD
125 wxMenuItem* InsertCheckItem(size_t pos,
126 int itemid,
127 const wxString& text,
128 const wxString& help = wxEmptyString)
d65c269b 129 {
9add9367 130 return Insert(pos, itemid, text, help, wxITEM_CHECK);
d65c269b
VZ
131 }
132
133 // insert a radio item
9add9367
RD
134 wxMenuItem* InsertRadioItem(size_t pos,
135 int itemid,
136 const wxString& text,
137 const wxString& help = wxEmptyString)
d65c269b 138 {
9add9367 139 return Insert(pos, itemid, text, help, wxITEM_RADIO);
d65c269b
VZ
140 }
141
f6bcfd97 142 // insert a submenu
9add9367
RD
143 wxMenuItem* Insert(size_t pos,
144 int itemid,
145 const wxString& text,
146 wxMenu *submenu,
147 const wxString& help = wxEmptyString)
f6bcfd97 148 {
9add9367
RD
149 return Insert(pos, wxMenuItem::New((wxMenu *)this, itemid, text, help,
150 wxITEM_NORMAL, submenu));
f6bcfd97
BP
151 }
152
153 // prepend an item to the menu
9add9367 154 wxMenuItem* Prepend(wxMenuItem *item)
f6bcfd97 155 {
9add9367 156 return Insert(0u, item);
f6bcfd97
BP
157 }
158
d65c269b 159 // prepend any item to the menu
9add9367 160 wxMenuItem* Prepend(int itemid,
ee0a94cf 161 const wxString& text = wxEmptyString,
9add9367
RD
162 const wxString& help = wxEmptyString,
163 wxItemKind kind = wxITEM_NORMAL)
f6bcfd97 164 {
9add9367 165 return Insert(0u, itemid, text, help, kind);
f6bcfd97
BP
166 }
167
d65c269b 168 // prepend a separator
9add9367 169 wxMenuItem* PrependSeparator()
f6bcfd97 170 {
9add9367 171 return InsertSeparator(0u);
f6bcfd97
BP
172 }
173
d65c269b 174 // prepend a check item
9add9367
RD
175 wxMenuItem* PrependCheckItem(int itemid,
176 const wxString& text,
177 const wxString& help = wxEmptyString)
d65c269b 178 {
9add9367 179 return InsertCheckItem(0u, itemid, text, help);
d65c269b
VZ
180 }
181
182 // prepend a radio item
9add9367
RD
183 wxMenuItem* PrependRadioItem(int itemid,
184 const wxString& text,
185 const wxString& help = wxEmptyString)
d65c269b 186 {
9add9367 187 return InsertRadioItem(0u, itemid, text, help);
d65c269b
VZ
188 }
189
190 // prepend a submenu
9add9367
RD
191 wxMenuItem* Prepend(int itemid,
192 const wxString& text,
193 wxMenu *submenu,
194 const wxString& help = wxEmptyString)
f6bcfd97 195 {
9add9367 196 return Insert(0u, itemid, text, submenu, help);
f6bcfd97 197 }
717a57c2
VZ
198
199 // detach an item from the menu, but don't delete it so that it can be
200 // added back later (but if it's not, the caller is responsible for
201 // deleting it!)
d9e2e4c2 202 wxMenuItem *Remove(int itemid) { return Remove(FindChildItem(itemid)); }
717a57c2
VZ
203 wxMenuItem *Remove(wxMenuItem *item);
204
205 // delete an item from the menu (submenus are not destroyed by this
206 // function, see Destroy)
d9e2e4c2 207 bool Delete(int itemid) { return Delete(FindChildItem(itemid)); }
717a57c2
VZ
208 bool Delete(wxMenuItem *item);
209
210 // delete the item from menu and destroy it (if it's a submenu)
d9e2e4c2 211 bool Destroy(int itemid) { return Destroy(FindChildItem(itemid)); }
717a57c2
VZ
212 bool Destroy(wxMenuItem *item);
213
214 // menu items access
215 // -----------------
216
217 // get the items
218 size_t GetMenuItemCount() const { return m_items.GetCount(); }
219
220 const wxMenuItemList& GetMenuItems() const { return m_items; }
221 wxMenuItemList& GetMenuItems() { return m_items; }
222
223 // search
1e6feb95 224 virtual int FindItem(const wxString& item) const;
d9e2e4c2 225 wxMenuItem* FindItem(int itemid, wxMenu **menu = NULL) const;
717a57c2 226
bd582574
JS
227 // find by position
228 wxMenuItem* FindItemByPosition(size_t position) const;
229
717a57c2 230 // get/set items attributes
d9e2e4c2
DE
231 void Enable(int itemid, bool enable);
232 bool IsEnabled(int itemid) const;
3dfac970 233
d9e2e4c2
DE
234 void Check(int itemid, bool check);
235 bool IsChecked(int itemid) const;
717a57c2 236
d9e2e4c2
DE
237 void SetLabel(int itemid, const wxString& label);
238 wxString GetLabel(int itemid) const;
717a57c2 239
d9e2e4c2
DE
240 virtual void SetHelpString(int itemid, const wxString& helpString);
241 virtual wxString GetHelpString(int itemid) const;
717a57c2
VZ
242
243 // misc accessors
244 // --------------
245
246 // the title
247 virtual void SetTitle(const wxString& title) { m_title = title; }
248 const wxString GetTitle() const { return m_title; }
249
717a57c2
VZ
250 // event handler
251 void SetEventHandler(wxEvtHandler *handler) { m_eventHandler = handler; }
252 wxEvtHandler *GetEventHandler() const { return m_eventHandler; }
253
254 // invoking window
255 void SetInvokingWindow(wxWindow *win) { m_invokingWindow = win; }
256 wxWindow *GetInvokingWindow() const { return m_invokingWindow; }
257
258 // style
259 long GetStyle() const { return m_style; }
260
261 // implementation helpers
262 // ----------------------
263
264 // Updates the UI for a menu and all submenus recursively. source is the
265 // object that has the update event handlers defined for it. If NULL, the
266 // menu or associated window will be used.
267 void UpdateUI(wxEvtHandler* source = (wxEvtHandler*)NULL);
268
1e6feb95 269 // get the menu bar this menu is attached to (may be NULL, always NULL for
dbdf9a17
DE
270 // popup menus). Traverse up the menu hierarchy to find it.
271 wxMenuBar *GetMenuBar() const;
1e6feb95
VZ
272
273 // called when the menu is attached/detached to/from a menu bar
274 virtual void Attach(wxMenuBarBase *menubar);
275 virtual void Detach();
276
717a57c2 277 // is the menu attached to a menu bar (or is it a popup one)?
dbdf9a17 278 bool IsAttached() const { return GetMenuBar() != NULL; }
717a57c2
VZ
279
280 // set/get the parent of this menu
281 void SetParent(wxMenu *parent) { m_menuParent = parent; }
282 wxMenu *GetParent() const { return m_menuParent; }
283
d65c269b
VZ
284 // implementation only from now on
285 // -------------------------------
286
287 // unlike FindItem(), this function doesn't recurse but only looks through
288 // our direct children and also may return the index of the found child if
289 // pos != NULL
d9e2e4c2 290 wxMenuItem *FindChildItem(int itemid, size_t *pos = NULL) const;
d65c269b 291
4e32eea1
WS
292 // called to generate a wxCommandEvent, return true if it was processed,
293 // false otherwise
d65c269b
VZ
294 //
295 // the checked parameter may have boolean value or -1 for uncheckable items
d9e2e4c2 296 bool SendEvent(int itemid, int checked = -1);
d65c269b 297
717a57c2 298 // compatibility: these functions are deprecated, use the new ones instead
d65c269b
VZ
299 // -----------------------------------------------------------------------
300
301 // use the versions taking wxItem_XXX now instead, they're more readable
302 // and allow adding the radio items as well
d9e2e4c2 303 void Append(int itemid,
d65c269b
VZ
304 const wxString& text,
305 const wxString& help,
306 bool isCheckable)
307 {
d9e2e4c2 308 Append(itemid, text, help, isCheckable ? wxITEM_CHECK : wxITEM_NORMAL);
d65c269b
VZ
309 }
310
3786c8b5
VZ
311 // use more readable and not requiring unused itemid AppendSubMenu() instead
312 wxMenuItem* Append(int itemid,
313 const wxString& text,
314 wxMenu *submenu,
315 const wxString& help = wxEmptyString)
316 {
317 return DoAppend(wxMenuItem::New((wxMenu *)this, itemid, text, help,
318 wxITEM_NORMAL, submenu));
319 }
320
d65c269b 321 void Insert(size_t pos,
d9e2e4c2 322 int itemid,
d65c269b
VZ
323 const wxString& text,
324 const wxString& help,
325 bool isCheckable)
326 {
d9e2e4c2 327 Insert(pos, itemid, text, help, isCheckable ? wxITEM_CHECK : wxITEM_NORMAL);
d65c269b
VZ
328 }
329
d9e2e4c2 330 void Prepend(int itemid,
d65c269b
VZ
331 const wxString& text,
332 const wxString& help,
333 bool isCheckable)
334 {
d9e2e4c2 335 Insert(0u, itemid, text, help, isCheckable);
d65c269b
VZ
336 }
337
6d971354
RR
338 static void LockAccels(bool locked)
339 {
340 ms_locked = locked;
341 }
4e32eea1 342
717a57c2
VZ
343protected:
344 // virtuals to override in derived classes
345 // ---------------------------------------
346
9add9367
RD
347 virtual wxMenuItem* DoAppend(wxMenuItem *item);
348 virtual wxMenuItem* DoInsert(size_t pos, wxMenuItem *item);
717a57c2
VZ
349
350 virtual wxMenuItem *DoRemove(wxMenuItem *item);
351 virtual bool DoDelete(wxMenuItem *item);
352 virtual bool DoDestroy(wxMenuItem *item);
353
354 // helpers
355 // -------
356
357 // common part of all ctors
358 void Init(long style);
359
1e6feb95
VZ
360 // associate the submenu with this menu
361 void AddSubMenu(wxMenu *submenu);
362
717a57c2
VZ
363 wxMenuBar *m_menuBar; // menubar we belong to or NULL
364 wxMenu *m_menuParent; // parent menu or NULL
365
366 wxString m_title; // the menu title or label
367 wxMenuItemList m_items; // the list of menu items
368
369 wxWindow *m_invokingWindow; // for popup menus
717a57c2
VZ
370
371 long m_style; // combination of wxMENU_XXX flags
372
373 wxEvtHandler *m_eventHandler; // a pluggable in event handler
22f3361e 374
6d971354 375 static bool ms_locked;
4e32eea1 376
22f3361e 377 DECLARE_NO_COPY_CLASS(wxMenuBase)
717a57c2 378};
3dfac970
VZ
379
380// ----------------------------------------------------------------------------
381// wxMenuBar
382// ----------------------------------------------------------------------------
383
384class WXDLLEXPORT wxMenuBarBase : public wxWindow
385{
386public:
387 // default ctor
388 wxMenuBarBase();
389
390 // dtor will delete all menus we own
391 virtual ~wxMenuBarBase();
392
393 // menu bar construction
394 // ---------------------
395
4e32eea1 396 // append a menu to the end of menubar, return true if ok
3dfac970
VZ
397 virtual bool Append(wxMenu *menu, const wxString& title);
398
4e32eea1 399 // insert a menu before the given position into the menubar, return true
3dfac970
VZ
400 // if inserted ok
401 virtual bool Insert(size_t pos, wxMenu *menu, const wxString& title);
402
403 // menu bar items access
404 // ---------------------
405
406 // get the number of menus in the menu bar
407 size_t GetMenuCount() const { return m_menus.GetCount(); }
408
409 // get the menu at given position
410 wxMenu *GetMenu(size_t pos) const;
411
412 // replace the menu at given position with another one, returns the
413 // previous menu (which should be deleted by the caller)
414 virtual wxMenu *Replace(size_t pos, wxMenu *menu, const wxString& title);
415
416 // delete the menu at given position from the menu bar, return the pointer
417 // to the menu (which should be deleted by the caller)
418 virtual wxMenu *Remove(size_t pos);
419
420 // enable or disable a submenu
421 virtual void EnableTop(size_t pos, bool enable) = 0;
422
1e6feb95 423 // is the menu enabled?
4e32eea1 424 virtual bool IsEnabledTop(size_t WXUNUSED(pos)) const { return true; }
1e6feb95 425
3dfac970
VZ
426 // get or change the label of the menu at given position
427 virtual void SetLabelTop(size_t pos, const wxString& label) = 0;
428 virtual wxString GetLabelTop(size_t pos) const = 0;
429
430 // item search
431 // -----------
432
433 // by menu and item names, returns wxNOT_FOUND if not found or id of the
434 // found item
1e6feb95 435 virtual int FindMenuItem(const wxString& menu, const wxString& item) const;
3dfac970
VZ
436
437 // find item by id (in any menu), returns NULL if not found
438 //
439 // if menu is !NULL, it will be filled with wxMenu this item belongs to
d9e2e4c2 440 virtual wxMenuItem* FindItem(int itemid, wxMenu **menu = NULL) const;
3dfac970 441
52130557 442 // find menu by its caption, return wxNOT_FOUND on failure
270e8b6a 443 int FindMenu(const wxString& title) const;
52130557 444
3dfac970
VZ
445 // item access
446 // -----------
447
448 // all these functions just use FindItem() and then call an appropriate
449 // method on it
450 //
451 // NB: under MSW, these methods can only be used after the menubar had
452 // been attached to the frame
453
d9e2e4c2
DE
454 void Enable(int itemid, bool enable);
455 void Check(int itemid, bool check);
456 bool IsChecked(int itemid) const;
457 bool IsEnabled(int itemid) const;
b1c741f8 458 virtual bool IsEnabled() const { return wxWindow::IsEnabled(); }
3dfac970 459
d9e2e4c2
DE
460 void SetLabel(int itemid, const wxString &label);
461 wxString GetLabel(int itemid) const;
3dfac970 462
d9e2e4c2
DE
463 void SetHelpString(int itemid, const wxString& helpString);
464 wxString GetHelpString(int itemid) const;
3dfac970 465
1e6feb95
VZ
466 // implementation helpers
467
468 // get the frame we are attached to (may return NULL)
469 wxFrame *GetFrame() const { return m_menuBarFrame; }
470
4e32eea1 471 // returns true if we're attached to a frame
1e6feb95
VZ
472 bool IsAttached() const { return GetFrame() != NULL; }
473
474 // associate the menubar with the frame
475 virtual void Attach(wxFrame *frame);
476
477 // called before deleting the menubar normally
478 virtual void Detach();
479
9874b4ee 480 // need to override these ones to avoid virtual function hiding
4e32eea1 481 virtual bool Enable(bool enable = true) { return wxWindow::Enable(enable); }
9874b4ee 482 virtual void SetLabel(const wxString& s) { wxWindow::SetLabel(s); }
3dfac970
VZ
483 virtual wxString GetLabel() const { return wxWindow::GetLabel(); }
484
1e6feb95 485 // don't want menu bars to accept the focus by tabbing to them
4e32eea1 486 virtual bool AcceptsFocusFromKeyboard() const { return false; }
1e6feb95 487
4d538595
DS
488 // update all menu item states in all menus
489 virtual void UpdateMenus();
490
c04c7a3d
VS
491 virtual bool CanBeOutsideClientArea() const { return true; }
492
3dfac970
VZ
493protected:
494 // the list of all our menus
495 wxMenuList m_menus;
1e6feb95
VZ
496
497 // the frame we are attached to (may be NULL)
498 wxFrame *m_menuBarFrame;
22f3361e
VZ
499
500 DECLARE_NO_COPY_CLASS(wxMenuBarBase)
3dfac970
VZ
501};
502
503// ----------------------------------------------------------------------------
504// include the real class declaration
505// ----------------------------------------------------------------------------
506
507#ifdef wxUSE_BASE_CLASSES_ONLY
508 #define wxMenuItem wxMenuItemBase
509#else // !wxUSE_BASE_CLASSES_ONLY
1e6feb95
VZ
510#if defined(__WXUNIVERSAL__)
511 #include "wx/univ/menu.h"
4055ed82 512#elif defined(__WXPALMOS__)
ffecfa5a 513 #include "wx/palmos/menu.h"
1e6feb95 514#elif defined(__WXMSW__)
3dfac970 515 #include "wx/msw/menu.h"
2049ba38 516#elif defined(__WXMOTIF__)
3dfac970 517 #include "wx/motif/menu.h"
1be7a35c 518#elif defined(__WXGTK20__)
3dfac970 519 #include "wx/gtk/menu.h"
1be7a35c
MR
520#elif defined(__WXGTK__)
521 #include "wx/gtk1/menu.h"
34138703 522#elif defined(__WXMAC__)
3dfac970 523 #include "wx/mac/menu.h"
e64df9bc
DE
524#elif defined(__WXCOCOA__)
525 #include "wx/cocoa/menu.h"
1777b9bb 526#elif defined(__WXPM__)
3dfac970 527 #include "wx/os2/menu.h"
c801d85f 528#endif
3dfac970
VZ
529#endif // wxUSE_BASE_CLASSES_ONLY/!wxUSE_BASE_CLASSES_ONLY
530
1e6feb95
VZ
531#endif // wxUSE_MENUS
532
c801d85f 533#endif
34138703 534 // _WX_MENU_H_BASE_