Fix missing documentation for several GDI functions.

[wxWidgets.git] / include / wx / mdi.h

diff --git a/include/wx/mdi.h b/include/wx/mdi.h
index 2a7bbc2cfa4391b9ff64c7e1f3803a5353a884ed..78c2f4c3e47c65f37a05dc153684dd0dcfe38310 100644 (file)
--- a/include/wx/mdi.h
+++ b/include/wx/mdi.h
@@ -81,15 +81,18 @@ public:
 #if wxUSE_MENUS
     // return the pointer to the current window menu or NULL if we don't have
     // because of wxFRAME_NO_WINDOW_MENU style
 #if wxUSE_MENUS
     // return the pointer to the current window menu or NULL if we don't have
     // because of wxFRAME_NO_WINDOW_MENU style

-    wxMenu* GetWindowMenu() const { return m_windowMenu; };
+    wxMenu* GetWindowMenu() const { return m_windowMenu; }

 
     // use the given menu instead of the default window menu
     //
     // menu can be NULL to disable the window menu completely
     virtual void SetWindowMenu(wxMenu *menu)
     {
 
     // use the given menu instead of the default window menu
     //
     // menu can be NULL to disable the window menu completely
     virtual void SetWindowMenu(wxMenu *menu)
     {

-        delete m_windowMenu;
-        m_windowMenu = menu;
+        if ( menu != m_windowMenu )
+        {
+            delete m_windowMenu;
+            m_windowMenu = menu;
+        }

     }
 #endif // wxUSE_MENUS
 
     }
 #endif // wxUSE_MENUS
 


@@ -120,6 +123,10 @@ public:
     virtual wxMDIClientWindow *OnCreateClient();
 
 protected:
     virtual wxMDIClientWindow *OnCreateClient();
 
 protected:

+    // Override to pass menu/toolbar events to the active child first.
+    virtual bool TryBefore(wxEvent& event);
+
+

     // This is wxMDIClientWindow for all the native implementations but not for
     // the generic MDI version which has its own wxGenericMDIClientWindow and
     // so we store it as just a base class pointer because we don't need its
     // This is wxMDIClientWindow for all the native implementations but not for
     // the generic MDI version which has its own wxGenericMDIClientWindow and
     // so we store it as just a base class pointer because we don't need its


@@ -173,6 +180,16 @@ public:
     // level windows too
     virtual bool IsTopLevel() const { return false; }
 
     // level windows too
     virtual bool IsTopLevel() const { return false; }
 

+    // In all ports keyboard navigation must stop at MDI child frame level and
+    // can't cross its boundary. Indicate this by overriding this function to
+    // return true.
+    virtual bool IsTopNavigationDomain() const { return true; }
+
+    // Raising any frame is supposed to show it but wxFrame Raise()
+    // implementation doesn't work for MDI child frames in most forms so
+    // forward this to Activate() which serves the same purpose by default.
+    virtual void Raise() { Activate(); }
+

 protected:
     wxMDIParentFrame *m_mdiParent;
 };
 protected:
     wxMDIParentFrame *m_mdiParent;
 };


@@ -356,6 +373,21 @@ inline wxMDIClientWindow *wxMDIParentFrameBase::OnCreateClient()
     return new wxMDIClientWindow;
 }
 
     return new wxMDIClientWindow;
 }
 

+inline bool wxMDIParentFrameBase::TryBefore(wxEvent& event)
+{
+    // Menu (and toolbar) events should be sent to the active child frame
+    // first, if any.
+    if ( event.GetEventType() == wxEVT_MENU ||
+            event.GetEventType() == wxEVT_UPDATE_UI )
+    {
+        wxMDIChildFrame * const child = GetActiveChild();
+        if ( child && child->ProcessWindowEventLocally(event) )
+            return true;
+    }
+
+    return wxFrame::TryBefore(event);
+}
+

 #endif // wxUSE_MDI
 
 #endif // _WX_MDI_H_BASE_
 #endif // wxUSE_MDI
 
 #endif // _WX_MDI_H_BASE_