interface/wx/menu.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        menu.h
   3 // Purpose:     interface of wxMenuBar
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows licence
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxMenuBar
  11
  12     A menu bar is a series of menus accessible from the top of a frame.
  13
  14     @remarks
  15     To respond to a menu selection, provide a handler for EVT_MENU, in the frame
  16     that contains the menu bar.
  17
  18     If you have a toolbar which uses the same identifiers as your EVT_MENU entries,
  19     events from the toolbar will also be processed by your EVT_MENU event handlers.
  20
  21     Tip: under Windows, if you discover that menu shortcuts (for example, Alt-F
  22     to show the file menu) are not working, check any EVT_CHAR events you are
  23     handling in child windows.
  24     If you are not calling event.Skip() for events that you don't process in
  25     these event handlers, menu shortcuts may cease to work.
  26
  27     @library{wxcore}
  28     @category{menus}
  29
  30     @see wxMenu, @ref overview_events
  31 */
  32 class wxMenuBar : public wxWindow
  33 {
  34 public:
  35     /**
  36         Construct an empty menu bar.
  37
  38         @param style
  39             If wxMB_DOCKABLE the menu bar can be detached (wxGTK only).
  40     */
  41     wxMenuBar(long style = 0);
  42
  43     /**
  44         Construct a menu bar from arrays of menus and titles.
  45
  46         @param n
  47             The number of menus.
  48         @param menus
  49             An array of menus. Do not use this array again - it now belongs to
  50             the menu bar.
  51         @param titles
  52             An array of title strings. Deallocate this array after creating
  53             the menu bar.
  54         @param style
  55             If wxMB_DOCKABLE the menu bar can be detached (wxGTK only).
  56
  57         @beginWxPerlOnly
  58         Not supported by wxPerl.
  59         @endWxPerlOnly
  60     */
  61     wxMenuBar(size_t n, wxMenu* menus[], const wxString titles[],
  62               long style = 0);
  63
  64     /**
  65         Destructor, destroying the menu bar and removing it from the parent
  66         frame (if any).
  67     */
  68     virtual ~wxMenuBar();
  69
  70     /**
  71         Adds the item to the end of the menu bar.
  72
  73         @param menu
  74             The menu to add. Do not deallocate this menu after calling Append().
  75         @param title
  76             The title of the menu, must be non-empty.
  77
  78         @return @true on success, @false if an error occurred.
  79
  80         @see Insert()
  81     */
  82     virtual bool Append(wxMenu* menu, const wxString& title);
  83
  84     /**
  85         Checks or unchecks a menu item.
  86
  87         @param id
  88             The menu item identifier.
  89         @param check
  90             If @true, checks the menu item, otherwise the item is unchecked.
  91
  92         @remarks Only use this when the menu bar has been associated with a
  93                  frame; otherwise, use the wxMenu equivalent call.
  94     */
  95     void Check(int id, bool check);
  96
  97     /**
  98         Enables or disables (greys out) a menu item.
  99
 100         @param id
 101             The menu item identifier.
 102         @param enable
 103             @true to enable the item, @false to disable it.
 104
 105         @remarks Only use this when the menu bar has been associated with a
 106                  frame; otherwise, use the wxMenu equivalent call.
 107     */
 108     void Enable(int id, bool enable);
 109
 110     /**
 111         Enables or disables a whole menu.
 112
 113         @param pos
 114             The position of the menu, starting from zero.
 115         @param enable
 116             @true to enable the menu, @false to disable it.
 117
 118         @remarks Only use this when the menu bar has been associated with a frame.
 119     */
 120     virtual void EnableTop(size_t pos, bool enable);
 121
 122     /**
 123         Finds the menu item object associated with the given menu item identifier.
 124
 125         @param id
 126             Menu item identifier.
 127         @param menu
 128             If not @NULL, menu will get set to the associated menu.
 129
 130         @return The found menu item object, or @NULL if one was not found.
 131
 132         @beginWxPerlOnly
 133         In wxPerl this method takes just the @a id parameter;
 134         in scalar context it returns the associated @c Wx::MenuItem, in list
 135         context it returns a 2-element list (item, submenu).
 136         @endWxPerlOnly
 137     */
 138     virtual wxMenuItem* FindItem(int id, wxMenu* menu = NULL) const;
 139
 140     /**
 141         Returns the index of the menu with the given @a title or @c wxNOT_FOUND if no
 142         such menu exists in this menubar.
 143
 144         The @a title parameter may specify either the menu title
 145         (with accelerator characters, i.e. @c "&File") or just the
 146         menu label (@c "File") indifferently.
 147     */
 148     int FindMenu(const wxString& title) const;
 149
 150     /**
 151         Finds the menu item id for a menu name/menu item string pair.
 152
 153         @param menuString
 154             Menu title to find.
 155         @param itemString
 156             Item to find.
 157
 158         @return The menu item identifier, or wxNOT_FOUND if none was found.
 159
 160         @remarks Any special menu codes are stripped out of source and target
 161                  strings before matching.
 162     */
 163     virtual int FindMenuItem(const wxString& menuString,
 164                              const wxString& itemString) const;
 165
 166     /**
 167         Gets the help string associated with the menu item identifier.
 168
 169         @param id
 170             The menu item identifier.
 171
 172         @return The help string, or the empty string if there was no help string
 173                 or the menu item was not found.
 174
 175         @see SetHelpString()
 176     */
 177     wxString GetHelpString(int id) const;
 178
 179     /**
 180         Gets the label associated with a menu item.
 181
 182         @param id
 183             The menu item identifier.
 184
 185         @return The menu item label, or the empty string if the item was not
 186                 found.
 187
 188         @remarks Use only after the menubar has been associated with a frame.
 189     */
 190     wxString GetLabel(int id) const;
 191
 192     /**
 193         Returns the label of a top-level menu. Note that the returned string does not
 194         include the accelerator characters which could have been specified in the menu
 195         title string during its construction.
 196
 197         @param pos
 198             Position of the menu on the menu bar, starting from zero.
 199
 200         @return The menu label, or the empty string if the menu was not found.
 201
 202         @remarks Use only after the menubar has been associated with a frame.
 203
 204         @deprecated
 205         This function is deprecated in favour of GetMenuLabel() and GetMenuLabelText().
 206
 207         @see SetLabelTop()
 208     */
 209     wxString GetLabelTop(size_t pos) const;
 210
 211     /**
 212         Returns the menu at @a menuIndex (zero-based).
 213     */
 214     wxMenu* GetMenu(size_t menuIndex) const;
 215
 216     /**
 217         Returns the number of menus in this menubar.
 218     */
 219     size_t GetMenuCount() const;
 220
 221     /**
 222         Returns the label of a top-level menu. Note that the returned string
 223         includes the accelerator characters that have been specified in the menu
 224         title string during its construction.
 225
 226         @param pos
 227             Position of the menu on the menu bar, starting from zero.
 228
 229         @return The menu label, or the empty string if the menu was not found.
 230
 231         @remarks Use only after the menubar has been associated with a frame.
 232
 233         @see GetMenuLabelText(), SetMenuLabel()
 234     */
 235     virtual wxString GetMenuLabel(size_t pos) const;
 236
 237     /**
 238         Returns the label of a top-level menu. Note that the returned string does not
 239         include any accelerator characters that may have been specified in the menu
 240         title string during its construction.
 241
 242         @param pos
 243             Position of the menu on the menu bar, starting from zero.
 244
 245         @return The menu label, or the empty string if the menu was not found.
 246
 247         @remarks Use only after the menubar has been associated with a frame.
 248
 249         @see GetMenuLabel(), SetMenuLabel()
 250     */
 251     virtual wxString GetMenuLabelText(size_t pos) const;
 252
 253     /**
 254         Inserts the menu at the given position into the menu bar. Inserting menu at
 255         position 0 will insert it in the very beginning of it, inserting at position
 256         GetMenuCount() is the same as calling Append().
 257
 258         @param pos
 259             The position of the new menu in the menu bar
 260         @param menu
 261             The menu to add. wxMenuBar owns the menu and will free it.
 262         @param title
 263             The title of the menu.
 264
 265         @return @true on success, @false if an error occurred.
 266
 267         @see Append()
 268     */
 269     virtual bool Insert(size_t pos, wxMenu* menu, const wxString& title);
 270
 271     /**
 272         Determines whether an item is checked.
 273
 274         @param id
 275             The menu item identifier.
 276
 277         @return @true if the item was found and is checked, @false otherwise.
 278     */
 279     bool IsChecked(int id) const;
 280
 281     /**
 282         Determines whether an item is enabled.
 283
 284         @param id
 285             The menu item identifier.
 286
 287         @return @true if the item was found and is enabled, @false otherwise.
 288     */
 289     bool IsEnabled(int id) const;
 290
 291     /**
 292         Redraw the menu bar
 293     */
 294     virtual void Refresh(bool eraseBackground = true, const wxRect* rect = NULL);
 295
 296     /**
 297         Removes the menu from the menu bar and returns the menu object - the caller
 298         is responsible for deleting it. This function may be used together with
 299         Insert() to change the menubar dynamically.
 300
 301         @see Replace()
 302     */
 303     virtual wxMenu* Remove(size_t pos);
 304
 305     /**
 306         Replaces the menu at the given position with another one.
 307
 308         @param pos
 309             The position of the new menu in the menu bar
 310         @param menu
 311             The menu to add.
 312         @param title
 313             The title of the menu.
 314
 315         @return The menu which was previously at position pos.
 316                 The caller is responsible for deleting it.
 317
 318         @see Insert(), Remove()
 319     */
 320     virtual wxMenu* Replace(size_t pos, wxMenu* menu, const wxString& title);
 321
 322     /**
 323         Sets the help string associated with a menu item.
 324
 325         @param id
 326             Menu item identifier.
 327         @param helpString
 328             Help string to associate with the menu item.
 329
 330         @see GetHelpString()
 331     */
 332     void SetHelpString(int id, const wxString& helpString);
 333
 334     /**
 335         Sets the label of a menu item.
 336
 337         @param id
 338             Menu item identifier.
 339         @param label
 340             Menu item label.
 341
 342         @remarks Use only after the menubar has been associated with a frame.
 343
 344         @see GetLabel()
 345     */
 346     void SetLabel(int id, const wxString& label);
 347
 348     /**
 349         Sets the label of a top-level menu.
 350
 351         @param pos
 352             The position of a menu on the menu bar, starting from zero.
 353         @param label
 354             The menu label.
 355
 356         @remarks Use only after the menubar has been associated with a frame.
 357
 358         @deprecated
 359         This function has been deprecated in favour of SetMenuLabel().
 360
 361         @see GetLabelTop()
 362     */
 363     void SetLabelTop(size_t pos, const wxString& label);
 364
 365     /**
 366         Sets the label of a top-level menu.
 367
 368         @param pos
 369             The position of a menu on the menu bar, starting from zero.
 370         @param label
 371             The menu label.
 372
 373         @remarks Use only after the menubar has been associated with a frame.
 374     */
 375     virtual void SetMenuLabel(size_t pos, const wxString& label);
 376 };
 377
 378
 379
 380 /**
 381     @class wxMenu
 382
 383     A menu is a popup (or pull down) list of items, one of which may be
 384     selected before the menu goes away (clicking elsewhere dismisses the
 385     menu). Menus may be used to construct either menu bars or popup menus.
 386
 387     A menu item has an integer ID associated with it which can be used to
 388     identify the selection, or to change the menu item in some way. A menu item
 389     with a special identifier @e wxID_SEPARATOR is a separator item and doesn't
 390     have an associated command but just makes a separator line appear in the
 391     menu.
 392
 393     @note
 394     Please note that @e wxID_ABOUT and @e wxID_EXIT are predefined by wxWidgets
 395     and have a special meaning since entries using these IDs will be taken out
 396     of the normal menus under MacOS X and will be inserted into the system menu
 397     (following the appropriate MacOS X interface guideline).
 398     On PalmOS @e wxID_EXIT is disabled according to Palm OS Companion guidelines.
 399
 400     Menu items may be either @e normal items, @e check items or @e radio items.
 401     Normal items don't have any special properties while the check items have a
 402     boolean flag associated to them and they show a checkmark in the menu when
 403     the flag is set.
 404     wxWidgets automatically toggles the flag value when the item is clicked and its
 405     value may be retrieved using either wxMenu::IsChecked method of wxMenu or
 406     wxMenuBar itself or by using wxEvent::IsChecked when you get the menu
 407     notification for the item in question.
 408
 409     The radio items are similar to the check items except that all the other items
 410     in the same radio group are unchecked when a radio item is checked. The radio
 411     group is formed by a contiguous range of radio items, i.e. it starts at the
 412     first item of this kind and ends with the first item of a different kind (or
 413     the end of the menu). Notice that because the radio groups are defined in terms
 414     of the item positions inserting or removing the items in the menu containing
 415     the radio items risks to not work correctly.
 416
 417
 418     @section menu_allocation Allocation strategy
 419
 420     All menus must be created on the @b heap because all menus attached to a
 421     menubar or to another menu will be deleted by their parent when it is
 422     deleted. The only exception to this rule are the popup menus (i.e. menus
 423     used with wxWindow::PopupMenu()) as wxWidgets does not destroy them to
 424     allow reusing the same menu more than once. But the exception applies only
 425     to the menus themselves and not to any submenus of popup menus which are
 426     still destroyed by wxWidgets as usual and so must be heap-allocated.
 427
 428     As the frame menubar is deleted by the frame itself, it means that normally
 429     all menus used are deleted automatically.
 430
 431
 432     @section menu_eventhandling Event handling
 433
 434     If the menu is part of a menubar, then wxMenuBar event processing is used.
 435
 436     With a popup menu (see wxWindow::PopupMenu), there is a variety of ways to
 437     handle a menu selection event (@c wxEVT_COMMAND_MENU_SELECTED):
 438     - Provide @c EVT_MENU handlers in the window which pops up the menu, or in an
 439       ancestor of that window (the simplest method);
 440     - Derive a new class from wxMenu and define event table entries using the @c EVT_MENU macro;
 441     - Set a new event handler for wxMenu, through wxEvtHandler::SetNextHandler,
 442       specifying an object whose class has @c EVT_MENU entries;
 443
 444     Note that instead of static @c EVT_MENU macros you can also use dynamic
 445     connection; see @ref overview_events_bind.
 446
 447     @library{wxcore}
 448     @category{menus}
 449
 450     @see wxMenuBar, wxWindow::PopupMenu, @ref overview_events,
 451          @ref wxFileHistory "wxFileHistory (most recently used files menu)"
 452 */
 453 class wxMenu : public wxEvtHandler
 454 {
 455 public:
 456     /**
 457         Constructs a wxMenu object.
 458
 459         @param style
 460             If set to wxMENU_TEAROFF, the menu will be detachable (wxGTK only).
 461     */
 462     wxMenu(long style);
 463
 464     /**
 465         Constructs a wxMenu object with a title.
 466
 467         @param title
 468             Title at the top of the menu (not always supported).
 469         @param style
 470             If set to wxMENU_TEAROFF, the menu will be detachable (wxGTK only).
 471     */
 472     wxMenu(const wxString& title, long style = 0);
 473
 474     /**
 475         Destructor, destroying the menu.
 476
 477         @note
 478             Under Motif, a popup menu must have a valid parent (the window
 479             it was last popped up on) when being destroyed. Therefore, make sure
 480             you delete or re-use the popup menu @e before destroying the parent
 481             window. Re-use in this context means popping up the menu on a different
 482             window from last time, which causes an implicit destruction and
 483             recreation of internal data structures.
 484     */
 485     virtual ~wxMenu();
 486
 487     /**
 488         Adds a menu item.
 489
 490         @param id
 491             The menu command identifier.
 492         @param item
 493             The string to appear on the menu item.
 494             See wxMenuItem::SetItemLabel() for more details.
 495         @param helpString
 496             An optional help string associated with the item.
 497             By default, the handler for the @c wxEVT_MENU_HIGHLIGHT event displays
 498             this string in the status line.
 499         @param kind
 500             May be @c wxITEM_SEPARATOR, @c wxITEM_NORMAL, @c wxITEM_CHECK or @c wxITEM_RADIO.
 501
 502         Example:
 503         @code
 504         m_pFileMenu->Append(ID_NEW_FILE, "&New file\tCTRL+N", "Creates a new XYZ document");
 505         @endcode
 506         or even better for stock menu items (see wxMenuItem::wxMenuItem):
 507         @code
 508         m_pFileMenu->Append(wxID_NEW, "", "Creates a new XYZ document");
 509         @endcode
 510
 511         @remarks
 512         This command can be used after the menu has been shown, as well as on
 513         initial creation of a menu or menubar.
 514
 515         @see AppendSeparator(), AppendCheckItem(), AppendRadioItem(),
 516              AppendSubMenu(), Insert(), SetLabel(), GetHelpString(),
 517              SetHelpString(), wxMenuItem
 518     */
 519     wxMenuItem* Append(int id, const wxString& item = wxEmptyString,
 520                        const wxString& helpString = wxEmptyString,
 521                        wxItemKind kind = wxITEM_NORMAL);
 522
 523     /**
 524         Adds a submenu.
 525
 526         @deprecated This function is deprecated, use AppendSubMenu() instead.
 527
 528         @param id
 529             The menu command identifier.
 530         @param item
 531             The string to appear on the menu item.
 532         @param subMenu
 533             Pull-right submenu.
 534         @param helpString
 535             An optional help string associated with the item.
 536             By default, the handler for the wxEVT_MENU_HIGHLIGHT event displays
 537             this string in the status line.
 538
 539         @see AppendSeparator(), AppendCheckItem(), AppendRadioItem(),
 540              AppendSubMenu(), Insert(), SetLabel(), GetHelpString(),
 541              SetHelpString(), wxMenuItem
 542     */
 543     wxMenuItem* Append(int id, const wxString& item, wxMenu* subMenu,
 544                        const wxString& helpString = wxEmptyString);
 545
 546     /**
 547         Adds a menu item object.
 548
 549         This is the most generic variant of Append() method because it may be
 550         used for both items (including separators) and submenus and because
 551         you can also specify various extra properties of a menu item this way,
 552         such as bitmaps and fonts.
 553
 554         @param menuItem
 555             A menuitem object. It will be owned by the wxMenu object after this
 556             function is called, so do not delete it yourself.
 557
 558         @remarks
 559             See the remarks for the other Append() overloads.
 560
 561         @see AppendSeparator(), AppendCheckItem(), AppendRadioItem(),
 562              AppendSubMenu(), Insert(), SetLabel(), GetHelpString(),
 563              SetHelpString(), wxMenuItem
 564     */
 565     wxMenuItem* Append(wxMenuItem* menuItem);
 566
 567     /**
 568         Adds a checkable item to the end of the menu.
 569
 570         @see Append(), InsertCheckItem()
 571     */
 572     wxMenuItem* AppendCheckItem(int id, const wxString& item,
 573                                 const wxString& help = wxEmptyString);
 574
 575     /**
 576         Adds a radio item to the end of the menu.
 577         All consequent radio items form a group and when an item in the group is
 578         checked, all the others are automatically unchecked.
 579
 580         @note Radio items are not supported under wxMotif.
 581
 582         @see Append(), InsertRadioItem()
 583     */
 584     wxMenuItem* AppendRadioItem(int id, const wxString& item,
 585                                 const wxString& help = wxEmptyString);
 586
 587     /**
 588         Adds a separator to the end of the menu.
 589
 590         @see Append(), InsertSeparator()
 591     */
 592     wxMenuItem* AppendSeparator();
 593
 594     /**
 595         Adds the given @a submenu to this menu. @a text is the text shown in the
 596         menu for it and @a help is the help string shown in the status bar when the
 597         submenu item is selected.
 598     */
 599     wxMenuItem* AppendSubMenu(wxMenu* submenu, const wxString& text,
 600                               const wxString& help = wxEmptyString);
 601
 602     /**
 603         Inserts a break in a menu, causing the next appended item to appear in
 604         a new column.
 605     */
 606     virtual void Break();
 607
 608     /**
 609         Checks or unchecks the menu item.
 610
 611         @param id
 612             The menu item identifier.
 613         @param check
 614             If @true, the item will be checked, otherwise it will be unchecked.
 615
 616         @see IsChecked()
 617     */
 618     void Check(int id, bool check);
 619
 620     /**
 621         Deletes the menu item from the menu. If the item is a submenu, it will
 622         @b not be deleted. Use Destroy() if you want to delete a submenu.
 623
 624         @param id
 625             Id of the menu item to be deleted.
 626
 627         @see FindItem(), Destroy(), Remove()
 628     */
 629     bool Delete(int id);
 630
 631     /**
 632         Deletes the menu item from the menu. If the item is a submenu, it will
 633         @b not be deleted. Use Destroy() if you want to delete a submenu.
 634
 635         @param item
 636             Menu item to be deleted.
 637
 638         @see FindItem(), Destroy(), Remove()
 639     */
 640     bool Delete(wxMenuItem* item);
 641
 642     /**
 643         Deletes the menu item from the menu. If the item is a submenu, it will
 644         be deleted. Use Remove() if you want to keep the submenu (for example,
 645         to reuse it later).
 646
 647         @param id
 648             Id of the menu item to be deleted.
 649
 650         @see FindItem(), Delete(), Remove()
 651     */
 652     bool Destroy(int id);
 653
 654     /**
 655         Deletes the menu item from the menu. If the item is a submenu, it will
 656         be deleted. Use Remove() if you want to keep the submenu (for example,
 657         to reuse it later).
 658
 659         @param item
 660             Menu item to be deleted.
 661
 662         @see FindItem(), Delete(), Remove()
 663     */
 664     bool Destroy(wxMenuItem* item);
 665
 666     /**
 667         Enables or disables (greys out) a menu item.
 668
 669         @param id
 670             The menu item identifier.
 671         @param enable
 672             @true to enable the menu item, @false to disable it.
 673
 674         @see IsEnabled()
 675     */
 676     void Enable(int id, bool enable);
 677
 678     /**
 679       Finds the menu item object associated with the given menu item identifier
 680       and, optionally, the position of the item in the menu.
 681
 682       Unlike FindItem(), this function doesn't recurse but only looks at the
 683       direct children of this menu.
 684
 685       @param id
 686           The identifier of the menu item to find.
 687       @param pos
 688           If the pointer is not @NULL, it is filled with the item's position if
 689           it was found or @c (size_t)wxNOT_FOUND otherwise.
 690       @return
 691         Menu item object or @NULL if not found.
 692      */
 693     wxMenuItem *FindChildItem(int id, size_t *pos = NULL) const;
 694
 695     /**
 696         Finds the menu id for a menu item string.
 697
 698         @param itemString
 699             Menu item string to find.
 700
 701         @return Menu item identifier, or wxNOT_FOUND if none is found.
 702
 703         @remarks Any special menu codes are stripped out of source and target
 704                  strings before matching.
 705     */
 706     virtual int FindItem(const wxString& itemString) const;
 707
 708     /**
 709         Finds the menu item object associated with the given menu item identifier and,
 710         optionally, the (sub)menu it belongs to.
 711
 712         @param id
 713             Menu item identifier.
 714         @param menu
 715             If the pointer is not @NULL, it will be filled with the item's
 716             parent menu (if the item was found)
 717
 718         @return Menu item object or NULL if none is found.
 719     */
 720     wxMenuItem* FindItem(int id, wxMenu** menu = NULL) const;
 721
 722     /**
 723         Returns the wxMenuItem given a position in the menu.
 724     */
 725     wxMenuItem* FindItemByPosition(size_t position) const;
 726
 727     /**
 728         Returns the help string associated with a menu item.
 729
 730         @param id
 731             The menu item identifier.
 732
 733         @return The help string, or the empty string if there is no help string
 734                 or the item was not found.
 735
 736         @see SetHelpString(), Append()
 737     */
 738     virtual wxString GetHelpString(int id) const;
 739
 740     /**
 741         Returns a menu item label.
 742
 743         @param id
 744             The menu item identifier.
 745
 746         @return The item label, or the empty string if the item was not found.
 747
 748         @see GetLabelText(), SetLabel()
 749     */
 750     wxString GetLabel(int id) const;
 751
 752     /**
 753         Returns a menu item label, without any of the original mnemonics and
 754         accelerators.
 755
 756         @param id
 757             The menu item identifier.
 758
 759         @return The item label, or the empty string if the item was not found.
 760
 761         @see GetLabel(), SetLabel()
 762     */
 763     wxString GetLabelText(int id) const;
 764
 765     /**
 766         Returns the number of items in the menu.
 767     */
 768     size_t GetMenuItemCount() const;
 769
 770     //@{
 771     /**
 772         Returns the list of items in the menu.
 773
 774         wxMenuItemList is a pseudo-template list class containing wxMenuItem
 775         pointers, see wxList.
 776     */
 777     wxMenuItemList& GetMenuItems() const;
 778     const wxMenuItemList& GetMenuItems() const;
 779     //@}
 780
 781     /**
 782         Returns the title of the menu.
 783
 784         @remarks This is relevant only to popup menus, use
 785                  wxMenuBar::GetMenuLabel for the menus in the menubar.
 786
 787         @see SetTitle()
 788     */
 789     const wxString& GetTitle() const;
 790
 791     /**
 792         Inserts the given @a item before the position @a pos.
 793
 794         Inserting the item at position GetMenuItemCount() is the same
 795         as appending it.
 796
 797         @see Append(), Prepend()
 798     */
 799     wxMenuItem* Insert(size_t pos, wxMenuItem* item);
 800
 801     /**
 802         Inserts the given @a item before the position @a pos.
 803
 804         Inserting the item at position GetMenuItemCount() is the same
 805         as appending it.
 806
 807         @see Append(), Prepend()
 808     */
 809     wxMenuItem* Insert(size_t pos, int id,
 810                        const wxString& item = wxEmptyString,
 811                        const wxString& helpString = wxEmptyString,
 812                        wxItemKind kind = wxITEM_NORMAL);
 813
 814     /**
 815         Inserts a checkable item at the given position.
 816
 817         @see Insert(), AppendCheckItem()
 818     */
 819     wxMenuItem* InsertCheckItem(size_t pos, int id, const wxString& item,
 820                                 const wxString& helpString = wxEmptyString);
 821
 822     /**
 823         Inserts a radio item at the given position.
 824
 825         @see Insert(), AppendRadioItem()
 826     */
 827     wxMenuItem* InsertRadioItem(size_t pos, int id, const wxString& item,
 828                                 const wxString& helpString = wxEmptyString);
 829
 830     /**
 831         Inserts a separator at the given position.
 832
 833         @see Insert(), AppendSeparator()
 834     */
 835     wxMenuItem* InsertSeparator(size_t pos);
 836
 837     /**
 838         Determines whether a menu item is checked.
 839
 840         @param id
 841             The menu item identifier.
 842
 843         @return @true if the menu item is checked, @false otherwise.
 844
 845         @see Check()
 846     */
 847     bool IsChecked(int id) const;
 848
 849     /**
 850         Determines whether a menu item is enabled.
 851
 852         @param id
 853             The menu item identifier.
 854
 855         @return @true if the menu item is enabled, @false otherwise.
 856
 857         @see Enable()
 858     */
 859     bool IsEnabled(int id) const;
 860
 861     /**
 862         Inserts the given @a item at position 0, i.e. before all the other
 863         existing items.
 864
 865         @see Append(), Insert()
 866     */
 867     wxMenuItem* Prepend(wxMenuItem* item);
 868
 869     /**
 870         Inserts the given @a item at position 0, i.e. before all the other
 871         existing items.
 872
 873         @see Append(), Insert()
 874     */
 875     wxMenuItem* Prepend(int id, const wxString& item = wxEmptyString,
 876                         const wxString& helpString = wxEmptyString,
 877                         wxItemKind kind = wxITEM_NORMAL);
 878
 879     /**
 880         Inserts a checkable item at position 0.
 881
 882         @see Prepend(), AppendCheckItem()
 883     */
 884     wxMenuItem* PrependCheckItem(int id, const wxString& item,
 885                                  const wxString& helpString = wxEmptyString);
 886
 887     /**
 888         Inserts a radio item at position 0.
 889
 890         @see Prepend(), AppendRadioItem()
 891     */
 892     wxMenuItem* PrependRadioItem(int id, const wxString& item,
 893                                  const wxString& helpString = wxEmptyString);
 894
 895     /**
 896         Inserts a separator at position 0.
 897
 898         @see Prepend(), AppendSeparator()
 899     */
 900     wxMenuItem* PrependSeparator();
 901
 902     /**
 903         Removes the menu item from the menu but doesn't delete the associated C++
 904         object. This allows you to reuse the same item later by adding it back to
 905         the menu (especially useful with submenus).
 906
 907         @param id
 908             The identifier of the menu item to remove.
 909
 910         @return A pointer to the item which was detached from the menu.
 911     */
 912     wxMenuItem* Remove(int id);
 913
 914     /**
 915         Removes the menu item from the menu but doesn't delete the associated C++
 916         object. This allows you to reuse the same item later by adding it back to
 917         the menu (especially useful with submenus).
 918
 919         @param item
 920             The menu item to remove.
 921
 922         @return A pointer to the item which was detached from the menu.
 923     */
 924     wxMenuItem* Remove(wxMenuItem* item);
 925
 926     /**
 927         Sets an item's help string.
 928
 929         @param id
 930             The menu item identifier.
 931         @param helpString
 932             The help string to set.
 933
 934         @see GetHelpString()
 935     */
 936     virtual void SetHelpString(int id, const wxString& helpString);
 937
 938     /**
 939         Sets the label of a menu item.
 940
 941         @param id
 942             The menu item identifier.
 943         @param label
 944             The menu item label to set.
 945
 946         @see Append(), GetLabel()
 947     */
 948     void SetLabel(int id, const wxString& label);
 949
 950     /**
 951         Sets the title of the menu.
 952
 953         @param title
 954             The title to set.
 955
 956         @remarks This is relevant only to popup menus, use
 957                  wxMenuBar::SetLabelTop for the menus in the menubar.
 958
 959         @see GetTitle()
 960     */
 961     virtual void SetTitle(const wxString& title);
 962
 963     /**
 964         Sends events to @a source (or owning window if @NULL) to update the
 965         menu UI.
 966
 967         This is called just before the menu is popped up with wxWindow::PopupMenu,
 968         but the application may call it at other times if required.
 969     */
 970     void UpdateUI(wxEvtHandler* source = NULL);
 971 };
 972