synchronize GTK2 minimum version in docs

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

diff --git a/interface/wx/menu.h b/interface/wx/menu.h
index 623f3c8911c6a9b4a4fb2130186bf6c782e5078a..823253c4d2abab393dbe07afaea3f7f5d57df137 100644 (file)
--- a/interface/wx/menu.h
+++ b/interface/wx/menu.h
@@ -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();
+

 };
 
 
 };
 
 


@@ -395,7 +436,6 @@ public:
     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).
     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


@@ -453,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.
 


@@ -533,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(),


@@ -774,16 +820,13 @@ public:
         wxMenuItemList is a pseudo-template list class containing wxMenuItem
         pointers, see wxList.
     */
         wxMenuItemList is a pseudo-template list class containing wxMenuItem
         pointers, see wxList.
     */

-    wxMenuItemList& GetMenuItems() const;
+    wxMenuItemList& GetMenuItems();

     const wxMenuItemList& GetMenuItems() const;
     //@}
 
     /**
         Returns the title of the menu.
 
     const wxMenuItemList& GetMenuItems() const;
     //@}
 
     /**
         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;


@@ -796,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.


@@ -953,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()
     */


@@ -968,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;
+

 };
 
 };