fix memory leak of FrameSite (see #3935)

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

diff --git a/include/wx/msw/mdi.h b/include/wx/msw/mdi.h
index b872359a2b58ce45eeaf8ecfe654cf4642abb94f..3aa1a566f09c73b9bffc94f1bf99ddd21bf084cc 100644 (file)
--- a/include/wx/msw/mdi.h
+++ b/include/wx/msw/mdi.h
@@ -2,28 +2,24 @@
 // Name:        wx/msw/mdi.h
 // Purpose:     MDI (Multiple Document Interface) classes
 // Author:      Julian Smart
-// Modified by:
+// Modified by: 2008-10-31 Vadim Zeitlin: derive from the base classes
 // Created:     01/02/97
 // RCS-ID:      $Id$
-// Copyright:   (c) Julian Smart
+// Copyright:   (c) 1997 Julian Smart
+//              (c) 2008 Vadim Zeitlin
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifndef _WX_MDI_H_
-#define _WX_MDI_H_
+#ifndef _WX_MSW_MDI_H_
+#define _WX_MSW_MDI_H_
 
 #include "wx/frame.h"
 
-extern WXDLLEXPORT_DATA(const wxChar) wxStatusLineNameStr[];
-
-class WXDLLEXPORT wxMDIClientWindow;
-class WXDLLEXPORT wxMDIChildFrame;
-
 // ---------------------------------------------------------------------------
 // wxMDIParentFrame
 // ---------------------------------------------------------------------------
 
-class WXDLLEXPORT wxMDIParentFrame : public wxFrame
+class WXDLLIMPEXP_CORE wxMDIParentFrame : public wxMDIParentFrameBase
 {
 public:
     wxMDIParentFrame();
@@ -38,7 +34,7 @@ public:
         Create(parent, id, title, pos, size, style, name);
     }
 
-    ~wxMDIParentFrame();
+    virtual ~wxMDIParentFrame();
 
     bool Create(wxWindow *parent,
                 wxWindowID id,
@@ -48,32 +44,38 @@ public:
                 long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
                 const wxString& name = wxFrameNameStr);
 
-    // accessors
-    // ---------
+    // override/implement base class [pure] virtual methods
+    // ----------------------------------------------------
 
-    // Get the active MDI child window (Windows only)
-    wxMDIChildFrame *GetActiveChild() const;
+    static bool IsTDI() { return false; }
 
-    // Get the client window
-    wxMDIClientWindow *GetClientWindow() const { return m_clientWindow; }
+    // we don't store the active child in m_currentChild so override this
+    // function to find it dynamically
+    virtual wxMDIChildFrame *GetActiveChild() const;
 
-    // Create the client window class (don't Create the window,
-    // just return a new class)
-    virtual wxMDIClientWindow *OnCreateClient(void);
-
-    // MDI windows menu
-    wxMenu* GetWindowMenu() const { return m_windowMenu; };
-    void SetWindowMenu(wxMenu* menu) ;
-    virtual void DoMenuUpdates(wxMenu* menu = NULL);
-
-    // MDI operations
-    // --------------
     virtual void Cascade();
     virtual void Tile(wxOrientation orient = wxHORIZONTAL);
     virtual void ArrangeIcons();
     virtual void ActivateNext();
     virtual void ActivatePrevious();
 
+#if wxUSE_MENUS
+    virtual void SetWindowMenu(wxMenu* menu);
+
+    virtual void DoMenuUpdates(wxMenu* menu = NULL);
+#endif // wxUSE_MENUS
+
+    // implementation only from now on
+
+    // MDI helpers
+    // -----------
+
+    // called by wxMDIChildFrame after it was successfully created
+    virtual void AddMDIChild(wxMDIChildFrame *child);
+
+    // called by wxMDIChildFrame just before it is destroyed
+    virtual void RemoveMDIChild(wxMDIChildFrame *child);
+
     // handlers
     // --------
 
@@ -92,6 +94,9 @@ public:
     virtual WXLRESULT MSWDefWindowProc(WXUINT, WXWPARAM, WXLPARAM);
     virtual bool MSWTranslateMessage(WXMSG* msg);
 
+    // override wxFrameBase function to also look in the active child menu bar
+    virtual const wxMenuItem *FindItemInMenuBar(int menuId) const;
+
 protected:
 #if wxUSE_MENUS_NATIVE
     virtual void InternalSetMenuBar();
@@ -103,15 +108,18 @@ protected:
     void UpdateClientSize();
 
 
-    wxMDIClientWindow *             m_clientWindow;
-    wxMDIChildFrame *               m_currentChild;
-    wxMenu*                         m_windowMenu;
-
     // true if MDI Frame is intercepting commands, not child
     bool m_parentFrameActive;
 
 private:
-    friend class WXDLLEXPORT wxMDIChildFrame;
+    // add/remove window menu if we have it (i.e. m_windowMenu != NULL)
+    void AddWindowMenu();
+    void RemoveWindowMenu();
+
+    // return the number of child frames we currently have (maybe 0)
+    int GetChildFramesCount() const;
+
+    friend class WXDLLIMPEXP_FWD_CORE wxMDIChildFrame;
 
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxMDIParentFrame)
@@ -122,7 +130,7 @@ private:
 // wxMDIChildFrame
 // ---------------------------------------------------------------------------
 
-class WXDLLEXPORT wxMDIChildFrame : public wxFrame
+class WXDLLIMPEXP_CORE wxMDIChildFrame : public wxMDIChildFrameBase
 {
 public:
     wxMDIChildFrame() { Init(); }
@@ -139,8 +147,6 @@ public:
         Create(parent, id, title, pos, size, style, name);
     }
 
-    ~wxMDIChildFrame();
-
     bool Create(wxMDIParentFrame *parent,
                 wxWindowID id,
                 const wxString& title,
@@ -149,12 +155,16 @@ public:
                 long style = wxDEFAULT_FRAME_STYLE,
                 const wxString& name = wxFrameNameStr);
 
-    virtual bool IsTopLevel() const { return false; }
+    virtual ~wxMDIChildFrame();
 
-    // MDI operations
+    // implement MDI operations
+    virtual void Activate();
+
+    // Override some frame operations too
     virtual void Maximize(bool maximize = true);
     virtual void Restore();
-    virtual void Activate();
+
+    virtual bool Show(bool show = true);
 
     // Implementation only from now on
     // -------------------------------
@@ -175,9 +185,8 @@ public:
 
     void OnIdle(wxIdleEvent& event);
 
-    virtual bool Show(bool show = true);
-
 protected:
+    virtual void DoGetScreenPosition(int *x, int *y) const;
     virtual void DoGetPosition(int *x, int *y) const;
     virtual void DoSetClientSize(int width, int height);
     virtual void InternalSetMenuBar();
@@ -201,16 +210,10 @@ private:
 // wxMDIClientWindow
 // ---------------------------------------------------------------------------
 
-class WXDLLEXPORT wxMDIClientWindow : public wxWindow
+class WXDLLIMPEXP_CORE wxMDIClientWindow : public wxMDIClientWindowBase
 {
 public:
     wxMDIClientWindow() { Init(); }
-    wxMDIClientWindow(wxMDIParentFrame *parent, long style = 0)
-    {
-        Init();
-
-        CreateClient(parent, style);
-    }
 
     // Note: this is virtual, to allow overridden behaviour.
     virtual bool CreateClient(wxMDIParentFrame *parent,
@@ -233,5 +236,4 @@ private:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxMDIClientWindow)
 };
 
-#endif
-    // _WX_MDI_H_
+#endif // _WX_MSW_MDI_H_