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         Enables you to set the global menubar on Mac, that is, the menubar displayed
 379         when the app is running without any frames open.
 380
 381         @param menubar
 382             The menubar to set.
 383
 384         @remarks Only exists on Mac, other platforms do not have this method.
 385     */
 386     static void MacSetCommonMenuBar(wxMenuBar* menubar);
 387
 388     /**
 389         Enables you to get the global menubar on Mac, that is, the menubar displayed
 390         when the app is running without any frames open.
 391
 392         @return The global menubar.
 393
 394         @remarks Only exists on Mac, other platforms do not have this method.
 395     */
 396     static wxMenuBar* MacGetCommonMenuBar();
 397
 398 };
 399
 400
 401
 402 /**
 403     @class wxMenu
 404
 405     A menu is a popup (or pull down) list of items, one of which may be
 406     selected before the menu goes away (clicking elsewhere dismisses the
 407     menu). Menus may be used to construct either menu bars or popup menus.
 408
 409     A menu item has an integer ID associated with it which can be used to
 410     identify the selection, or to change the menu item in some way. A menu item
 411     with a special identifier @e wxID_SEPARATOR is a separator item and doesn't
 412     have an associated command but just makes a separator line appear in the
 413     menu.
 414
 415     @note
 416     Please note that @e wxID_ABOUT and @e wxID_EXIT are predefined by wxWidgets
 417     and have a special meaning since entries using these IDs will be taken out
 418     of the normal menus under MacOS X and will be inserted into the system menu
 419     (following the appropriate MacOS X interface guideline).
 420     On PalmOS @e wxID_EXIT is disabled according to Palm OS Companion guidelines.
 421
 422     Menu items may be either @e normal items, @e check items or @e radio items.
 423     Normal items don't have any special properties while the check items have a
 424     boolean flag associated to them and they show a checkmark in the menu when
 425     the flag is set.
 426     wxWidgets automatically toggles the flag value when the item is clicked and its
 427     value may be retrieved using either wxMenu::IsChecked method of wxMenu or
 428     wxMenuBar itself or by using wxEvent::IsChecked when you get the menu
 429     notification for the item in question.
 430
 431     The radio items are similar to the check items except that all the other items
 432     in the same radio group are unchecked when a radio item is checked. The radio
 433     group is formed by a contiguous range of radio items, i.e. it starts at the
 434     first item of this kind and ends with the first item of a different kind (or
 435     the end of the menu). Notice that because the radio groups are defined in terms
 436     of the item positions inserting or removing the items in the menu containing
 437     the radio items risks to not work correctly.
 438
 439
 440     @section menu_allocation Allocation strategy
 441
 442     All menus must be created on the @b heap because all menus attached to a
 443     menubar or to another menu will be deleted by their parent when it is
 444     deleted. The only exception to this rule are the popup menus (i.e. menus
 445     used with wxWindow::PopupMenu()) as wxWidgets does not destroy them to
 446     allow reusing the same menu more than once. But the exception applies only
 447     to the menus themselves and not to any submenus of popup menus which are
 448     still destroyed by wxWidgets as usual and so must be heap-allocated.
 449
 450     As the frame menubar is deleted by the frame itself, it means that normally
 451     all menus used are deleted automatically.
 452
 453
 454     @section menu_eventhandling Event handling
 455
 456     If the menu is part of a menubar, then wxMenuBar event processing is used.
 457
 458     With a popup menu (see wxWindow::PopupMenu), there is a variety of ways to
 459     handle a menu selection event (@c wxEVT_COMMAND_MENU_SELECTED):
 460     - Provide @c EVT_MENU handlers in the window which pops up the menu, or in an
 461       ancestor of that window (the simplest method);
 462     - Derive a new class from wxMenu and define event table entries using the @c EVT_MENU macro;
 463     - Set a new event handler for wxMenu, through wxEvtHandler::SetNextHandler,
 464       specifying an object whose class has @c EVT_MENU entries;
 465
 466     Note that instead of static @c EVT_MENU macros you can also use dynamic
 467     connection; see @ref overview_events_bind.
 468
 469     @library{wxcore}
 470     @category{menus}
 471
 472     @see wxMenuBar, wxWindow::PopupMenu, @ref overview_events,
 473          @ref wxFileHistory "wxFileHistory (most recently used files menu)"
 474 */
 475 class wxMenu : public wxEvtHandler
 476 {
 477 public:
 478
 479     /**
 480         Constructs a wxMenu object.
 481     */
 482     wxMenu();
 483
 484     /**
 485         Constructs a wxMenu object.
 486
 487         @param style
 488             If set to wxMENU_TEAROFF, the menu will be detachable (wxGTK only).
 489     */
 490     wxMenu(long style);
 491
 492     /**
 493         Constructs a wxMenu object with a title.
 494
 495         @param title
 496             Title at the top of the menu (not always supported).
 497         @param style
 498             If set to wxMENU_TEAROFF, the menu will be detachable (wxGTK only).
 499     */
 500     wxMenu(const wxString& title, long style = 0);
 501
 502     /**
 503         Destructor, destroying the menu.
 504
 505         @note
 506             Under Motif, a popup menu must have a valid parent (the window
 507             it was last popped up on) when being destroyed. Therefore, make sure
 508             you delete or re-use the popup menu @e before destroying the parent
 509             window. Re-use in this context means popping up the menu on a different
 510             window from last time, which causes an implicit destruction and
 511             recreation of internal data structures.
 512     */
 513     virtual ~wxMenu();
 514
 515     /**
 516         Adds a menu item.
 517
 518         @param id
 519             The menu command identifier.
 520         @param item
 521             The string to appear on the menu item.
 522             See wxMenuItem::SetItemLabel() for more details.
 523         @param helpString
 524             An optional help string associated with the item.
 525             By default, the handler for the @c wxEVT_MENU_HIGHLIGHT event displays
 526             this string in the status line.
 527         @param kind
 528             May be @c wxITEM_SEPARATOR, @c wxITEM_NORMAL, @c wxITEM_CHECK or @c wxITEM_RADIO.
 529
 530         Example:
 531         @code
 532         m_pFileMenu->Append(ID_NEW_FILE, "&New file\tCTRL+N", "Creates a new XYZ document");
 533         @endcode
 534         or even better for stock menu items (see wxMenuItem::wxMenuItem):
 535         @code
 536         m_pFileMenu->Append(wxID_NEW, "", "Creates a new XYZ document");
 537         @endcode
 538
 539         @remarks
 540         This command can be used after the menu has been shown, as well as on
 541         initial creation of a menu or menubar.
 542
 543         @see AppendSeparator(), AppendCheckItem(), AppendRadioItem(),
 544              AppendSubMenu(), Insert(), SetLabel(), GetHelpString(),
 545              SetHelpString(), wxMenuItem
 546     */
 547     wxMenuItem* Append(int id, const wxString& item = wxEmptyString,
 548                        const wxString& helpString = wxEmptyString,
 549                        wxItemKind kind = wxITEM_NORMAL);
 550
 551     /**
 552         Adds a submenu.
 553
 554         @deprecated This function is deprecated, use AppendSubMenu() instead.
 555
 556         @param id
 557             The menu command identifier.
 558         @param item
 559             The string to appear on the menu item.
 560         @param subMenu
 561             Pull-right submenu.
 562         @param helpString
 563             An optional help string associated with the item.
 564             By default, the handler for the @c wxEVT_MENU_HIGHLIGHT event displays
 565             this string in the status line.
 566
 567         @see AppendSeparator(), AppendCheckItem(), AppendRadioItem(),
 568              AppendSubMenu(), Insert(), SetLabel(), GetHelpString(),
 569              SetHelpString(), wxMenuItem
 570     */
 571     wxMenuItem* Append(int id, const wxString& item, wxMenu* subMenu,
 572                        const wxString& helpString = wxEmptyString);
 573
 574     /**
 575         Adds a menu item object.
 576
 577         This is the most generic variant of Append() method because it may be
 578         used for both items (including separators) and submenus and because
 579         you can also specify various extra properties of a menu item this way,
 580         such as bitmaps and fonts.
 581
 582         @param menuItem
 583             A menuitem object. It will be owned by the wxMenu object after this
 584             function is called, so do not delete it yourself.
 585
 586         @remarks
 587             See the remarks for the other Append() overloads.
 588
 589         @see AppendSeparator(), AppendCheckItem(), AppendRadioItem(),
 590              AppendSubMenu(), Insert(), SetLabel(), GetHelpString(),
 591              SetHelpString(), wxMenuItem
 592     */
 593     wxMenuItem* Append(wxMenuItem* menuItem);
 594
 595     /**
 596         Adds a checkable item to the end of the menu.
 597
 598         @see Append(), InsertCheckItem()
 599     */
 600     wxMenuItem* AppendCheckItem(int id, const wxString& item,
 601                                 const wxString& help = wxEmptyString);
 602
 603     /**
 604         Adds a radio item to the end of the menu.
 605         All consequent radio items form a group and when an item in the group is
 606         checked, all the others are automatically unchecked.
 607
 608         @note Radio items are not supported under wxMotif.
 609
 610         @see Append(), InsertRadioItem()
 611     */
 612     wxMenuItem* AppendRadioItem(int id, const wxString& item,
 613                                 const wxString& help = wxEmptyString);
 614
 615     /**
 616         Adds a separator to the end of the menu.
 617
 618         @see Append(), InsertSeparator()
 619     */
 620     wxMenuItem* AppendSeparator();
 621
 622     /**
 623         Adds the given @a submenu to this menu. @a text is the text shown in the
 624         menu for it and @a help is the help string shown in the status bar when the
 625         submenu item is selected.
 626     */
 627     wxMenuItem* AppendSubMenu(wxMenu* submenu, const wxString& text,
 628                               const wxString& help = wxEmptyString);
 629
 630     /**
 631         Inserts a break in a menu, causing the next appended item to appear in
 632         a new column.
 633     */
 634     virtual void Break();
 635
 636     /**
 637         Checks or unchecks the menu item.
 638
 639         @param id
 640             The menu item identifier.
 641         @param check
 642             If @true, the item will be checked, otherwise it will be unchecked.
 643
 644         @see IsChecked()
 645     */
 646     void Check(int id, bool check);
 647
 648     /**
 649         Deletes the menu item from the menu. If the item is a submenu, it will
 650         @b not be deleted. Use Destroy() if you want to delete a submenu.
 651
 652         @param id
 653             Id of the menu item to be deleted.
 654
 655         @see FindItem(), Destroy(), Remove()
 656     */
 657     bool Delete(int id);
 658
 659     /**
 660         Deletes the menu item from the menu. If the item is a submenu, it will
 661         @b not be deleted. Use Destroy() if you want to delete a submenu.
 662
 663         @param item
 664             Menu item to be deleted.
 665
 666         @see FindItem(), Destroy(), Remove()
 667     */
 668     bool Delete(wxMenuItem* item);
 669
 670     /**
 671         Deletes the menu item from the menu. If the item is a submenu, it will
 672         be deleted. Use Remove() if you want to keep the submenu (for example,
 673         to reuse it later).
 674
 675         @param id
 676             Id of the menu item to be deleted.
 677
 678         @see FindItem(), Delete(), Remove()
 679     */
 680     bool Destroy(int id);
 681
 682     /**
 683         Deletes the menu item from the menu. If the item is a submenu, it will
 684         be deleted. Use Remove() if you want to keep the submenu (for example,
 685         to reuse it later).
 686
 687         @param item
 688             Menu item to be deleted.
 689
 690         @see FindItem(), Delete(), Remove()
 691     */
 692     bool Destroy(wxMenuItem* item);
 693
 694     /**
 695         Enables or disables (greys out) a menu item.
 696
 697         @param id
 698             The menu item identifier.
 699         @param enable
 700             @true to enable the menu item, @false to disable it.
 701
 702         @see IsEnabled()
 703     */
 704     void Enable(int id, bool enable);
 705
 706     /**
 707       Finds the menu item object associated with the given menu item identifier
 708       and, optionally, the position of the item in the menu.
 709
 710       Unlike FindItem(), this function doesn't recurse but only looks at the
 711       direct children of this menu.
 712
 713       @param id
 714           The identifier of the menu item to find.
 715       @param pos
 716           If the pointer is not @NULL, it is filled with the item's position if
 717           it was found or @c (size_t)wxNOT_FOUND otherwise.
 718       @return
 719         Menu item object or @NULL if not found.
 720      */
 721     wxMenuItem *FindChildItem(int id, size_t *pos = NULL) const;
 722
 723     /**
 724         Finds the menu id for a menu item string.
 725
 726         @param itemString
 727             Menu item string to find.
 728
 729         @return Menu item identifier, or wxNOT_FOUND if none is found.
 730
 731         @remarks Any special menu codes are stripped out of source and target
 732                  strings before matching.
 733     */
 734     virtual int FindItem(const wxString& itemString) const;
 735
 736     /**
 737         Finds the menu item object associated with the given menu item identifier and,
 738         optionally, the (sub)menu it belongs to.
 739
 740         @param id
 741             Menu item identifier.
 742         @param menu
 743             If the pointer is not @NULL, it will be filled with the item's
 744             parent menu (if the item was found)
 745
 746         @return Menu item object or NULL if none is found.
 747     */
 748     wxMenuItem* FindItem(int id, wxMenu** menu = NULL) const;
 749
 750     /**
 751         Returns the wxMenuItem given a position in the menu.
 752     */
 753     wxMenuItem* FindItemByPosition(size_t position) const;
 754
 755     /**
 756         Returns the help string associated with a menu item.
 757
 758         @param id
 759             The menu item identifier.
 760
 761         @return The help string, or the empty string if there is no help string
 762                 or the item was not found.
 763
 764         @see SetHelpString(), Append()
 765     */
 766     virtual wxString GetHelpString(int id) const;
 767
 768     /**
 769         Returns a menu item label.
 770
 771         @param id
 772             The menu item identifier.
 773
 774         @return The item label, or the empty string if the item was not found.
 775
 776         @see GetLabelText(), SetLabel()
 777     */
 778     wxString GetLabel(int id) const;
 779
 780     /**
 781         Returns a menu item label, without any of the original mnemonics and
 782         accelerators.
 783
 784         @param id
 785             The menu item identifier.
 786
 787         @return The item label, or the empty string if the item was not found.
 788
 789         @see GetLabel(), SetLabel()
 790     */
 791     wxString GetLabelText(int id) const;
 792
 793     /**
 794         Returns the number of items in the menu.
 795     */
 796     size_t GetMenuItemCount() const;
 797
 798     //@{
 799     /**
 800         Returns the list of items in the menu.
 801
 802         wxMenuItemList is a pseudo-template list class containing wxMenuItem
 803         pointers, see wxList.
 804     */
 805     wxMenuItemList& GetMenuItems() const;
 806     const wxMenuItemList& GetMenuItems() const;
 807     //@}
 808
 809     /**
 810         Returns the title of the menu.
 811
 812         @see SetTitle()
 813     */
 814     const wxString& GetTitle() const;
 815
 816     /**
 817         Inserts the given @a item before the position @a pos.
 818
 819         Inserting the item at position GetMenuItemCount() is the same
 820         as appending it.
 821
 822         @see Append(), Prepend()
 823     */
 824     wxMenuItem* Insert(size_t pos, wxMenuItem* menuItem);
 825
 826     /**
 827         Inserts the given @a item before the position @a pos.
 828
 829         Inserting the item at position GetMenuItemCount() is the same
 830         as appending it.
 831
 832         @see Append(), Prepend()
 833     */
 834     wxMenuItem* Insert(size_t pos, int id,
 835                        const wxString& item = wxEmptyString,
 836                        const wxString& helpString = wxEmptyString,
 837                        wxItemKind kind = wxITEM_NORMAL);
 838
 839     /**
 840         Inserts a checkable item at the given position.
 841
 842         @see Insert(), AppendCheckItem()
 843     */
 844     wxMenuItem* InsertCheckItem(size_t pos, int id, const wxString& item,
 845                                 const wxString& helpString = wxEmptyString);
 846
 847     /**
 848         Inserts a radio item at the given position.
 849
 850         @see Insert(), AppendRadioItem()
 851     */
 852     wxMenuItem* InsertRadioItem(size_t pos, int id, const wxString& item,
 853                                 const wxString& helpString = wxEmptyString);
 854
 855     /**
 856         Inserts a separator at the given position.
 857
 858         @see Insert(), AppendSeparator()
 859     */
 860     wxMenuItem* InsertSeparator(size_t pos);
 861
 862     /**
 863         Determines whether a menu item is checked.
 864
 865         @param id
 866             The menu item identifier.
 867
 868         @return @true if the menu item is checked, @false otherwise.
 869
 870         @see Check()
 871     */
 872     bool IsChecked(int id) const;
 873
 874     /**
 875         Determines whether a menu item is enabled.
 876
 877         @param id
 878             The menu item identifier.
 879
 880         @return @true if the menu item is enabled, @false otherwise.
 881
 882         @see Enable()
 883     */
 884     bool IsEnabled(int id) const;
 885
 886     /**
 887         Inserts the given @a item at position 0, i.e. before all the other
 888         existing items.
 889
 890         @see Append(), Insert()
 891     */
 892     wxMenuItem* Prepend(wxMenuItem* item);
 893
 894     /**
 895         Inserts the given @a item at position 0, i.e. before all the other
 896         existing items.
 897
 898         @see Append(), Insert()
 899     */
 900     wxMenuItem* Prepend(int id, const wxString& item = wxEmptyString,
 901                         const wxString& helpString = wxEmptyString,
 902                         wxItemKind kind = wxITEM_NORMAL);
 903
 904     /**
 905         Inserts a checkable item at position 0.
 906
 907         @see Prepend(), AppendCheckItem()
 908     */
 909     wxMenuItem* PrependCheckItem(int id, const wxString& item,
 910                                  const wxString& helpString = wxEmptyString);
 911
 912     /**
 913         Inserts a radio item at position 0.
 914
 915         @see Prepend(), AppendRadioItem()
 916     */
 917     wxMenuItem* PrependRadioItem(int id, const wxString& item,
 918                                  const wxString& helpString = wxEmptyString);
 919
 920     /**
 921         Inserts a separator at position 0.
 922
 923         @see Prepend(), AppendSeparator()
 924     */
 925     wxMenuItem* PrependSeparator();
 926
 927     /**
 928         Removes the menu item from the menu but doesn't delete the associated C++
 929         object. This allows you to reuse the same item later by adding it back to
 930         the menu (especially useful with submenus).
 931
 932         @param id
 933             The identifier of the menu item to remove.
 934
 935         @return A pointer to the item which was detached from the menu.
 936     */
 937     wxMenuItem* Remove(int id);
 938
 939     /**
 940         Removes the menu item from the menu but doesn't delete the associated C++
 941         object. This allows you to reuse the same item later by adding it back to
 942         the menu (especially useful with submenus).
 943
 944         @param item
 945             The menu item to remove.
 946
 947         @return A pointer to the item which was detached from the menu.
 948     */
 949     wxMenuItem* Remove(wxMenuItem* item);
 950
 951     /**
 952         Sets an item's help string.
 953
 954         @param id
 955             The menu item identifier.
 956         @param helpString
 957             The help string to set.
 958
 959         @see GetHelpString()
 960     */
 961     virtual void SetHelpString(int id, const wxString& helpString);
 962
 963     /**
 964         Sets the label of a menu item.
 965
 966         @param id
 967             The menu item identifier.
 968         @param label
 969             The menu item label to set.
 970
 971         @see Append(), GetLabel()
 972     */
 973     void SetLabel(int id, const wxString& label);
 974
 975     /**
 976         Sets the title of the menu.
 977
 978         @param title
 979             The title to set.
 980
 981         @remarks Notice that you can only call this method directly for the
 982             popup menus, to change the title of a menu that is part of a menu
 983             bar you need to use wxMenuBar::SetLabelTop().
 984
 985         @see GetTitle()
 986     */
 987     virtual void SetTitle(const wxString& title);
 988
 989     /**
 990         Sends events to @a source (or owning window if @NULL) to update the
 991         menu UI.
 992
 993         This is called just before the menu is popped up with wxWindow::PopupMenu,
 994         but the application may call it at other times if required.
 995     */
 996     void UpdateUI(wxEvtHandler* source = NULL);
 997 };
 998