include/wx/menu.h

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