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