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