Applied #14000 (wxRichTextXMLHandler interface fixes)

[wxWidgets.git] / interface / wx / menu.h

diff --git a/interface/wx/menu.h b/interface/wx/menu.h
index ad1044dc674d70f31719e466f1b0e4d18b978945..bdb33aa30ef5b18e33f777f19bcac216d2a3454c 100644 (file)
--- a/interface/wx/menu.h
+++ b/interface/wx/menu.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxMenuBar
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxMenuBar
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -73,7 +73,7 @@ public:
         @param menu
             The menu to add. Do not deallocate this menu after calling Append().
         @param title
         @param menu
             The menu to add. Do not deallocate this menu after calling Append().
         @param title

-            The title of the menu.
+            The title of the menu, must be non-empty.

 
         @return @true on success, @false if an error occurred.
 
 
         @return @true on success, @false if an error occurred.
 


@@ -107,6 +107,16 @@ public:
     */
     void Enable(int id, bool enable);
 
     */
     void Enable(int id, bool enable);
 

+    /**
+        Returns true if the menu with the given index is enabled.
+
+        @param pos
+            The menu position (0-based)
+
+        @since 2.9.4
+    */
+    bool IsEnabledTop(size_t pos) const;
+

     /**
         Enables or disables a whole menu.
 
     /**
         Enables or disables a whole menu.
 


@@ -135,7 +145,7 @@ public:
         context it returns a 2-element list (item, submenu).
         @endWxPerlOnly
     */
         context it returns a 2-element list (item, submenu).
         @endWxPerlOnly
     */

-    virtual wxMenuItem* FindItem(int id, wxMenu* menu = NULL) const;
+    virtual wxMenuItem* FindItem(int id, wxMenu** menu = NULL) const;

 
     /**
         Returns the index of the menu with the given @a title or @c wxNOT_FOUND if no
 
     /**
         Returns the index of the menu with the given @a title or @c wxNOT_FOUND if no


@@ -373,6 +383,37 @@ public:
         @remarks Use only after the menubar has been associated with a frame.
     */
     virtual void SetMenuLabel(size_t pos, const wxString& label);
         @remarks Use only after the menubar has been associated with a frame.
     */
     virtual void SetMenuLabel(size_t pos, const wxString& label);

+    
+    /**        
+        Enables you to set the global menubar on Mac, that is, the menubar displayed
+        when the app is running without any frames open.
+        
+        @param menubar
+            The menubar to set.
+            
+        @remarks Only exists on Mac, other platforms do not have this method. 
+
+        @onlyfor{wxosx}
+    */
+    static void MacSetCommonMenuBar(wxMenuBar* menubar);
+    
+    /**        
+        Enables you to get the global menubar on Mac, that is, the menubar displayed
+        when the app is running without any frames open.
+        
+        @return The global menubar.
+            
+        @remarks Only exists on Mac, other platforms do not have this method. 
+
+        @onlyfor{wxosx}
+    */
+    static wxMenuBar* MacGetCommonMenuBar();
+
+    wxFrame *GetFrame() const;
+    bool IsAttached() const;
+    virtual void Attach(wxFrame *frame);
+    virtual void Detach();
+

 };
 
 
 };
 
 


@@ -386,15 +427,15 @@ public:
 
     A menu item has an integer ID associated with it which can be used to
     identify the selection, or to change the menu item in some way. A menu item
 
     A menu item has an integer ID associated with it which can be used to
     identify the selection, or to change the menu item in some way. A menu item

-    with a special identifier -1 is a separator item and doesn't have an
-    associated command but just makes a separator line appear in the menu.
+    with a special identifier @e wxID_SEPARATOR is a separator item and doesn't
+    have an associated command but just makes a separator line appear in the
+    menu.

 
     @note
     Please note that @e wxID_ABOUT and @e wxID_EXIT are predefined by wxWidgets
     and have a special meaning since entries using these IDs will be taken out
     of the normal menus under MacOS X and will be inserted into the system menu
     (following the appropriate MacOS X interface guideline).
 
     @note
     Please note that @e wxID_ABOUT and @e wxID_EXIT are predefined by wxWidgets
     and have a special meaning since entries using these IDs will be taken out
     of the normal menus under MacOS X and will be inserted into the system menu
     (following the appropriate MacOS X interface guideline).

-    On PalmOS @e wxID_EXIT is disabled according to Palm OS Companion guidelines.

 
     Menu items may be either @e normal items, @e check items or @e radio items.
     Normal items don't have any special properties while the check items have a
 
     Menu items may be either @e normal items, @e check items or @e radio items.
     Normal items don't have any special properties while the check items have a


@@ -416,9 +457,13 @@ public:
 
     @section menu_allocation Allocation strategy
 
 
     @section menu_allocation Allocation strategy
 

-    All menus except the popup ones must be created on the @b heap.
-    All menus attached to a menubar or to another menu will be deleted by their
-    parent when it is deleted.
+    All menus must be created on the @b heap because all menus attached to a
+    menubar or to another menu will be deleted by their parent when it is
+    deleted. The only exception to this rule are the popup menus (i.e. menus
+    used with wxWindow::PopupMenu()) as wxWidgets does not destroy them to
+    allow reusing the same menu more than once. But the exception applies only
+    to the menus themselves and not to any submenus of popup menus which are
+    still destroyed by wxWidgets as usual and so must be heap-allocated.

 
     As the frame menubar is deleted by the frame itself, it means that normally
     all menus used are deleted automatically.
 
     As the frame menubar is deleted by the frame itself, it means that normally
     all menus used are deleted automatically.


@@ -448,6 +493,12 @@ public:
 class wxMenu : public wxEvtHandler
 {
 public:
 class wxMenu : public wxEvtHandler
 {
 public:

+
+    /**
+        Constructs a wxMenu object.
+    */
+    wxMenu();
+    

     /**
         Constructs a wxMenu object.
 
     /**
         Constructs a wxMenu object.
 


@@ -493,7 +544,7 @@ public:
             this string in the status line.
         @param kind
             May be @c wxITEM_SEPARATOR, @c wxITEM_NORMAL, @c wxITEM_CHECK or @c wxITEM_RADIO.
             this string in the status line.
         @param kind
             May be @c wxITEM_SEPARATOR, @c wxITEM_NORMAL, @c wxITEM_CHECK or @c wxITEM_RADIO.

-        
+

         Example:
         @code
         m_pFileMenu->Append(ID_NEW_FILE, "&New file\tCTRL+N", "Creates a new XYZ document");
         Example:
         @code
         m_pFileMenu->Append(ID_NEW_FILE, "&New file\tCTRL+N", "Creates a new XYZ document");


@@ -528,7 +579,7 @@ public:
             Pull-right submenu.
         @param helpString
             An optional help string associated with the item.
             Pull-right submenu.
         @param helpString
             An optional help string associated with the item.

-            By default, the handler for the wxEVT_MENU_HIGHLIGHT event displays
+            By default, the handler for the @c wxEVT_MENU_HIGHLIGHT event displays

             this string in the status line.
 
         @see AppendSeparator(), AppendCheckItem(), AppendRadioItem(),
             this string in the status line.
 
         @see AppendSeparator(), AppendCheckItem(), AppendRadioItem(),


@@ -642,7 +693,7 @@ public:
         @param id
             Id of the menu item to be deleted.
 
         @param id
             Id of the menu item to be deleted.
 

-        @see FindItem(), Deletes(), Remove()
+        @see FindItem(), Delete(), Remove()

     */
     bool Destroy(int id);
 
     */
     bool Destroy(int id);
 


@@ -654,7 +705,7 @@ public:
         @param item
             Menu item to be deleted.
 
         @param item
             Menu item to be deleted.
 

-        @see FindItem(), Deletes(), Remove()
+        @see FindItem(), Delete(), Remove()

     */
     bool Destroy(wxMenuItem* item);
 
     */
     bool Destroy(wxMenuItem* item);
 


@@ -776,9 +827,6 @@ public:
     /**
         Returns the title of the menu.
 
     /**
         Returns the title of the menu.
 

-        @remarks This is relevant only to popup menus, use
-                 wxMenuBar::GetMenuLabel for the menus in the menubar.
-

         @see SetTitle()
     */
     const wxString& GetTitle() const;
         @see SetTitle()
     */
     const wxString& GetTitle() const;


@@ -791,7 +839,7 @@ public:
 
         @see Append(), Prepend()
     */
 
         @see Append(), Prepend()
     */

-    wxMenuItem* Insert(size_t pos, wxMenuItem* item);
+    wxMenuItem* Insert(size_t pos, wxMenuItem* menuItem);

 
     /**
         Inserts the given @a item before the position @a pos.
 
     /**
         Inserts the given @a item before the position @a pos.


@@ -948,8 +996,9 @@ public:
         @param title
             The title to set.
 
         @param title
             The title to set.
 

-        @remarks This is relevant only to popup menus, use
-                 wxMenuBar::SetLabelTop for the menus in the menubar.
+        @remarks Notice that you can only call this method directly for the
+            popup menus, to change the title of a menu that is part of a menu
+            bar you need to use wxMenuBar::SetLabelTop().

 
         @see GetTitle()
     */
 
         @see GetTitle()
     */


@@ -963,5 +1012,18 @@ public:
         but the application may call it at other times if required.
     */
     void UpdateUI(wxEvtHandler* source = NULL);
         but the application may call it at other times if required.
     */
     void UpdateUI(wxEvtHandler* source = NULL);

+
+    
+    void SetInvokingWindow(wxWindow *win);
+    wxWindow *GetInvokingWindow() const;
+    wxWindow *GetWindow() const;
+    long GetStyle() const;
+    void SetParent(wxMenu *parent);
+    wxMenu *GetParent() const;
+
+    virtual void Attach(wxMenuBar *menubar);
+    virtual void Detach();
+    bool IsAttached() const;
+

 };
 
 };