fix wxDEFINE_EVENT_REFERENCE in wxEVENTS_COMPATIBILITY_2_8 case

[wxWidgets.git] / include / wx / generic / mdig.h

diff --git a/include/wx/generic/mdig.h b/include/wx/generic/mdig.h
index 007ab2e4e48bcbb6637202f02e1998e0ff71ad72..d21366b3c5f0a3d83b3886192eebf676facda8f7 100644 (file)
--- a/include/wx/generic/mdig.h
+++ b/include/wx/generic/mdig.h
@@ -2,340 +2,260 @@
 // Name:        wx/generic/mdig.h
 // Purpose:     Generic MDI (Multiple Document Interface) classes
 // Author:      Hans Van Leemputten
 // Name:        wx/generic/mdig.h
 // Purpose:     Generic MDI (Multiple Document Interface) classes
 // Author:      Hans Van Leemputten

-// Modified by:
+// Modified by: 2008-10-31 Vadim Zeitlin: derive from the base classes

 // Created:     29/07/2002
 // RCS-ID:      $Id$
 // Created:     29/07/2002
 // RCS-ID:      $Id$

-// Copyright:   (c) Hans Van Leemputten
+// Copyright:   (c) 2002 Hans Van Leemputten
+//              (c) 2008 Vadim Zeitlin

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-#ifndef _WX_MDIG_H_
-#define _WX_MDIG_H_
-
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "mdig.h"
-#endif
+#ifndef _WX_GENERIC_MDIG_H_
+#define _WX_GENERIC_MDIG_H_

 
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 

-#include "wx/frame.h"

 #include "wx/panel.h"
 #include "wx/panel.h"

-#include "wx/notebook.h"
-
-WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr;
-WXDLLEXPORT_DATA(extern const wxChar*) wxStatusLineNameStr;
-

 
 

-//-----------------------------------------------------------------------------
-// classes
-//-----------------------------------------------------------------------------
+class WXDLLIMPEXP_FWD_CORE wxBookCtrlBase;
+class WXDLLIMPEXP_FWD_CORE wxBookCtrlEvent;
+class WXDLLIMPEXP_FWD_CORE wxIcon;
+class WXDLLIMPEXP_FWD_CORE wxIconBundle;
+class WXDLLIMPEXP_FWD_CORE wxNotebook;

 
 

-class WXDLLEXPORT wxGenericMDIParentFrame;
-class WXDLLEXPORT wxGenericMDIClientWindow;
-class WXDLLEXPORT wxGenericMDIChildFrame;
+#if wxUSE_GENERIC_MDI_AS_NATIVE
+    #define wxGenericMDIParentFrame wxMDIParentFrame
+    #define wxGenericMDIChildFrame wxMDIChildFrame
+    #define wxGenericMDIClientWindow wxMDIClientWindow
+#else // !wxUSE_GENERIC_MDI_AS_NATIVE
+    class WXDLLIMPEXP_FWD_CORE wxGenericMDIParentFrame;
+    class WXDLLIMPEXP_FWD_CORE wxGenericMDIChildFrame;
+    class WXDLLIMPEXP_FWD_CORE wxGenericMDIClientWindow;
+#endif // wxUSE_GENERIC_MDI_AS_NATIVE/!wxUSE_GENERIC_MDI_AS_NATIVE

 
 

-//-----------------------------------------------------------------------------
+// ----------------------------------------------------------------------------

 // wxGenericMDIParentFrame
 // wxGenericMDIParentFrame

-//-----------------------------------------------------------------------------
+// ----------------------------------------------------------------------------

 
 

-class WXDLLEXPORT wxGenericMDIParentFrame: public wxFrame
+class WXDLLIMPEXP_CORE wxGenericMDIParentFrame : public wxMDIParentFrameBase

 {
 public:
 {
 public:

-    wxGenericMDIParentFrame();
+    wxGenericMDIParentFrame() { Init(); }

     wxGenericMDIParentFrame(wxWindow *parent,
                      wxWindowID winid,
                      const wxString& title,
                      const wxPoint& pos = wxDefaultPosition,
                      const wxSize& size = wxDefaultSize,
                      long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
     wxGenericMDIParentFrame(wxWindow *parent,
                      wxWindowID winid,
                      const wxString& title,
                      const wxPoint& pos = wxDefaultPosition,
                      const wxSize& size = wxDefaultSize,
                      long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,

-                     const wxString& name = wxFrameNameStr);
+                     const wxString& name = wxFrameNameStr)
+    {
+        Init();
+
+        Create(parent, winid, title, pos, size, style, name);
+    }
+
+    bool Create(wxWindow *parent,
+                wxWindowID winid,
+                const wxString& title,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
+                const wxString& name = wxFrameNameStr);

 
 

-    ~wxGenericMDIParentFrame();
-    bool Create( wxWindow *parent,
-                 wxWindowID winid,
-                 const wxString& title,
-                 const wxPoint& pos = wxDefaultPosition,
-                 const wxSize& size = wxDefaultSize,
-                 long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
-                 const wxString& name = wxFrameNameStr );
+    virtual ~wxGenericMDIParentFrame();
+
+    // implement base class pure virtuals
+    static bool IsTDI() { return true; }
+
+    virtual void ActivateNext() { AdvanceActive(true); }
+    virtual void ActivatePrevious() { AdvanceActive(false); }

 
 #if wxUSE_MENUS
 
 #if wxUSE_MENUS

-    wxMenu* GetWindowMenu() const { return m_pWindowMenu; };
-    void SetWindowMenu(wxMenu* pMenu);
+    virtual void SetWindowMenu(wxMenu* pMenu);

 
     virtual void SetMenuBar(wxMenuBar *pMenuBar);
 #endif // wxUSE_MENUS
 
 
     virtual void SetMenuBar(wxMenuBar *pMenuBar);
 #endif // wxUSE_MENUS
 

-    void SetChildMenuBar(wxGenericMDIChildFrame *pChild);
-

     virtual bool ProcessEvent(wxEvent& event);
 
     virtual bool ProcessEvent(wxEvent& event);
 

-    wxGenericMDIChildFrame *GetActiveChild() const;
-    inline void SetActiveChild(wxGenericMDIChildFrame* pChildFrame);
+    virtual wxGenericMDIClientWindow *OnCreateGenericClient();

 
 

-    wxGenericMDIClientWindow *GetClientWindow() const;
-    virtual wxGenericMDIClientWindow *OnCreateClient();

 
 

-    virtual void Cascade() { /* Has no effect */ }
-    virtual void Tile() { /* Has no effect */ }
-    virtual void ArrangeIcons() { /* Has no effect */ }
-    virtual void ActivateNext();
-    virtual void ActivatePrevious();
+    // implementation only from now on
+    void WXSetChildMenuBar(wxGenericMDIChildFrame *child);
+    void WXUpdateChildTitle(wxGenericMDIChildFrame *child);
+    void WXActivateChild(wxGenericMDIChildFrame *child);
+    void WXRemoveChild(wxGenericMDIChildFrame *child);
+    bool WXIsActiveChild(wxGenericMDIChildFrame *child) const;
+    bool WXIsInsideChildHandler(wxGenericMDIChildFrame *child) const;
+
+    // return the book control used by the client window to manage the pages
+    wxBookCtrlBase *GetBookCtrl() const;

 
 protected:
 
 protected:

-    wxGenericMDIClientWindow   *m_pClientWindow;
-    wxGenericMDIChildFrame     *m_pActiveChild;

 #if wxUSE_MENUS
 #if wxUSE_MENUS

-    wxMenu              *m_pWindowMenu;
-    wxMenuBar           *m_pMyMenuBar;
+    wxMenuBar *m_pMyMenuBar;

 #endif // wxUSE_MENUS
 
 #endif // wxUSE_MENUS
 

-protected:
+    // advance the activation forward or backwards
+    void AdvanceActive(bool forward);
+
+private:

     void Init();
 
 #if wxUSE_MENUS
     void RemoveWindowMenu(wxMenuBar *pMenuBar);
     void AddWindowMenu(wxMenuBar *pMenuBar);
 
     void Init();
 
 #if wxUSE_MENUS
     void RemoveWindowMenu(wxMenuBar *pMenuBar);
     void AddWindowMenu(wxMenuBar *pMenuBar);
 

-    void DoHandleMenu(wxCommandEvent &event);
+    void OnWindowMenu(wxCommandEvent& event);

 #endif // wxUSE_MENUS
 
 #endif // wxUSE_MENUS
 

-    virtual void DoGetClientSize(int *width, int *height) const;
+    void OnClose(wxCloseEvent& event);
+
+    // return the client window, may be NULL if we hadn't been created yet
+    wxGenericMDIClientWindow *GetGenericClientWindow() const;
+
+    // close all children, return false if any of them vetoed it
+    bool CloseAll();
+
+
+    // this pointer is non-NULL if we're currently inside our ProcessEvent()
+    // and we forwarded the event to this child (as we do with menu events)
+    wxMDIChildFrameBase *m_childHandler;

 
 

-private:

     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxGenericMDIParentFrame)
 };
 
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxGenericMDIParentFrame)
 };
 

-//-----------------------------------------------------------------------------
+// ----------------------------------------------------------------------------

 // wxGenericMDIChildFrame
 // wxGenericMDIChildFrame

-//-----------------------------------------------------------------------------
+// ----------------------------------------------------------------------------

 
 

-class WXDLLEXPORT wxGenericMDIChildFrame: public wxPanel
+class WXDLLIMPEXP_CORE wxGenericMDIChildFrame : public wxTDIChildFrame

 {
 public:
 {
 public:

-    wxGenericMDIChildFrame();
-    wxGenericMDIChildFrame( wxGenericMDIParentFrame *parent,
-                     wxWindowID winid,
-                     const wxString& title,
-                     const wxPoint& pos = wxDefaultPosition,
-                     const wxSize& size = wxDefaultSize,
-                     long style = wxDEFAULT_FRAME_STYLE,
-                     const wxString& name = wxFrameNameStr );
+    wxGenericMDIChildFrame() { Init(); }
+    wxGenericMDIChildFrame(wxGenericMDIParentFrame *parent,
+                           wxWindowID winid,
+                           const wxString& title,
+                           const wxPoint& pos = wxDefaultPosition,
+                           const wxSize& size = wxDefaultSize,
+                           long style = wxDEFAULT_FRAME_STYLE,
+                           const wxString& name = wxFrameNameStr)
+    {
+        Init();
+
+        Create(parent, winid, title, pos, size, style, name);
+    }
+
+    bool Create(wxGenericMDIParentFrame *parent,
+                wxWindowID winid,
+                const wxString& title,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = wxDEFAULT_FRAME_STYLE,
+                const wxString& name = wxFrameNameStr);

 
     virtual ~wxGenericMDIChildFrame();
 
     virtual ~wxGenericMDIChildFrame();

-    bool Create( wxGenericMDIParentFrame *parent,
-                 wxWindowID winid,
-                 const wxString& title,
-                 const wxPoint& pos = wxDefaultPosition,
-                 const wxSize& size = wxDefaultSize,
-                 long style = wxDEFAULT_FRAME_STYLE,
-                 const wxString& name = wxFrameNameStr );
+
+    // implement MDI operations
+    virtual void Activate();
+

 
 #if wxUSE_MENUS
     virtual void SetMenuBar( wxMenuBar *menu_bar );
     virtual wxMenuBar *GetMenuBar() const;
 #endif // wxUSE_MENUS
 
 
 #if wxUSE_MENUS
     virtual void SetMenuBar( wxMenuBar *menu_bar );
     virtual wxMenuBar *GetMenuBar() const;
 #endif // wxUSE_MENUS
 

+    virtual wxString GetTitle() const { return m_title; }

     virtual void SetTitle(const wxString& title);
     virtual void SetTitle(const wxString& title);

-    virtual wxString GetTitle() const;

 
 

-    virtual void Activate();
+    virtual bool TryParent(wxEvent& event);

 
 

-#if wxUSE_STATUSBAR
-    // no status bars
-    virtual wxStatusBar* CreateStatusBar( int WXUNUSED(number) = 1,
-                                        long WXUNUSED(style) = 1,
-                                        wxWindowID WXUNUSED(winid) = 1,
-                                        const wxString& WXUNUSED(name) = wxEmptyString)
-      { return (wxStatusBar*)NULL; }
-
-    virtual wxStatusBar *GetStatusBar() const { return (wxStatusBar*)NULL; }
-    virtual void SetStatusText( const wxString &WXUNUSED(text), int WXUNUSED(number)=0 ) {}
-    virtual void SetStatusWidths( int WXUNUSED(n), const int WXUNUSED(widths_field)[] ) {}
-#endif
+    // implementation only from now on

 
 

-    // no size hints
-    virtual void SetSizeHints( int WXUNUSED(minW),
-                               int WXUNUSED(minH),
-                               int WXUNUSED(maxW) = -1,
-                               int WXUNUSED(maxH) = -1,
-                               int WXUNUSED(incW) = -1,
-                               int WXUNUSED(incH) = -1) {}
-
-#if wxUSE_TOOLBAR
-    // no toolbar bars
-    virtual wxToolBar* CreateToolBar( long WXUNUSED(style),
-                                       wxWindowID WXUNUSED(winid),
-                                       const wxString& WXUNUSED(name) )
-        { return (wxToolBar*)NULL; }
-    virtual wxToolBar *GetToolBar() const { return (wxToolBar*)NULL; }
+    wxGenericMDIParentFrame* GetGenericMDIParent() const
+    {
+#if wxUSE_GENERIC_MDI_AS_NATIVE
+        return GetMDIParent();
+#else // generic != native
+        return m_mdiParentGeneric;

 #endif
 #endif

-
-    // no icon
-    void SetIcon( const wxIcon& WXUNUSED(icon) ) { }
-    void SetIcons( const wxIconBundle& WXUNUSED(icons) ) { }
-
-    // no maximize etc
-    virtual void Maximize( bool WXUNUSED(maximize) = TRUE) { /* Has no effect */ }
-    virtual void Restore() { /* Has no effect */ }
-    virtual void Iconize(bool WXUNUSED(iconize)  = TRUE) { /* Has no effect */ }
-    virtual bool IsMaximized() const { return TRUE; }
-    virtual bool IsIconized() const { return FALSE; }
-    virtual bool ShowFullScreen(bool WXUNUSED(show), long WXUNUSED(style)) { return FALSE; }
-    virtual bool IsFullScreen() const { return FALSE; }
-
-    virtual bool IsTopLevel() const { return FALSE; }
-
-    void OnMenuHighlight(wxMenuEvent& event);
-    void OnActivate(wxActivateEvent& event);
-
-    // The next 2 are copied from top level...
-    void OnCloseWindow(wxCloseEvent& event);
-    void OnSize(wxSizeEvent& event);
-
-    void SetMDIParentFrame(wxGenericMDIParentFrame* parentFrame);
-    wxGenericMDIParentFrame* GetMDIParentFrame() const;
+    }

 
 protected:
 
 protected:

-    wxGenericMDIParentFrame *m_pMDIParentFrame;
-    wxRect            m_MDIRect;
-    wxString          m_Title;
+    wxString m_title;

 
 #if wxUSE_MENUS
     wxMenuBar        *m_pMenuBar;
 #endif // wxUSE_MENUS
 
 
 #if wxUSE_MENUS
     wxMenuBar        *m_pMenuBar;
 #endif // wxUSE_MENUS
 

+#if !wxUSE_GENERIC_MDI_AS_NATIVE
+    wxGenericMDIParentFrame *m_mdiParentGeneric;
+#endif
+

 protected:
     void Init();
 
 protected:
     void Init();
 

-    virtual void DoMoveWindow(int x, int y, int width, int height);
-
-    // This function needs to be called when a size change is confirmed,
-    // we needed this function to prevent any body from the outside
-    // changing the panel... it messes the UI layout when we would allow it.
-    void ApplyMDIChildFrameRect();
-

 private:
 private:

+    void OnMenuHighlight(wxMenuEvent& event);
+    void OnClose(wxCloseEvent& event);
+

     DECLARE_DYNAMIC_CLASS(wxGenericMDIChildFrame)
     DECLARE_EVENT_TABLE()
 
     friend class wxGenericMDIClientWindow;
 };
 
     DECLARE_DYNAMIC_CLASS(wxGenericMDIChildFrame)
     DECLARE_EVENT_TABLE()
 
     friend class wxGenericMDIClientWindow;
 };
 

-//-----------------------------------------------------------------------------
+// ----------------------------------------------------------------------------

 // wxGenericMDIClientWindow
 // wxGenericMDIClientWindow

-//-----------------------------------------------------------------------------
-
-class WXDLLEXPORT wxGenericMDIClientWindow: public wxNotebook
-{
-public:
-    wxGenericMDIClientWindow();
-    wxGenericMDIClientWindow( wxGenericMDIParentFrame *parent, long style = 0 );
-    ~wxGenericMDIClientWindow();
-    virtual bool CreateClient( wxGenericMDIParentFrame *parent, long style = wxVSCROLL | wxHSCROLL );
-
-    virtual int SetSelection(size_t nPage);
-
-protected:
-    void PageChanged(int OldSelection, int newSelection);
-
-    void OnPageChanged(wxNotebookEvent& event);
-    void OnSize(wxSizeEvent& event);
-
-private:
-    DECLARE_DYNAMIC_CLASS(wxGenericMDIClientWindow)
-    DECLARE_EVENT_TABLE()
-};
-
-
-/*
- * Define normal wxMDI classes based on wxGenericMDI
- */
-
-#ifndef wxUSE_GENERIC_MDI_AS_NATIVE
-#if defined(__WXUNIVERSAL__) || defined(__WXPM__) || defined(__WXCOCOA__)
-#define wxUSE_GENERIC_MDI_AS_NATIVE   1
-#else
-#define wxUSE_GENERIC_MDI_AS_NATIVE   0
-#endif
-#endif // wxUSE_GENERIC_MDI_AS_NATIVE
-
-#if wxUSE_GENERIC_MDI_AS_NATIVE
-
-class wxMDIChildFrame ;
-
-//-----------------------------------------------------------------------------
-// wxMDIParentFrame
-//-----------------------------------------------------------------------------
+// ----------------------------------------------------------------------------

 
 

-class WXDLLEXPORT wxMDIParentFrame: public wxGenericMDIParentFrame
+class WXDLLIMPEXP_CORE wxGenericMDIClientWindow : public wxMDIClientWindowBase

 {
 public:
 {
 public:

-    wxMDIParentFrame() {}
-    wxMDIParentFrame(wxWindow *parent,
-                     wxWindowID winid,
-                     const wxString& title,
-                     const wxPoint& pos = wxDefaultPosition,
-                     const wxSize& size = wxDefaultSize,
-                     long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
-                     const wxString& name = wxFrameNameStr)
-        :wxGenericMDIParentFrame(parent, winid, title, pos, size, style, name)
+    wxGenericMDIClientWindow() { }
+
+    // unfortunately we need to provide our own version of CreateClient()
+    // because of the difference in the type of the first parameter and
+    // implement the base class pure virtual method in terms of it
+    // (CreateGenericClient() is virtual itself to allow customizing the client
+    // window creation by overriding it in the derived classes)
+    virtual bool CreateGenericClient(wxWindow *parent);
+    virtual bool CreateClient(wxMDIParentFrame *parent,
+                              long WXUNUSED(style) = wxVSCROLL | wxHSCROLL)

     {
     {

+        return CreateGenericClient(parent);

     }
 
     }
 

-    wxMDIChildFrame * GetActiveChild() const ;
-    
-    
-private:
-    DECLARE_DYNAMIC_CLASS(wxMDIParentFrame)
-};
+    // implementation only
+    wxBookCtrlBase *GetBookCtrl() const;
+    wxGenericMDIChildFrame *GetChild(size_t pos) const;
+    int FindChild(wxGenericMDIChildFrame *child) const;

 
 

-//-----------------------------------------------------------------------------
-// wxMDIChildFrame
-//-----------------------------------------------------------------------------
+private:
+    void PageChanged(int OldSelection, int newSelection);

 
 

-class WXDLLEXPORT wxMDIChildFrame: public wxGenericMDIChildFrame
-{
-public:
-    wxMDIChildFrame() {}
+    void OnPageChanged(wxBookCtrlEvent& event);
+    void OnSize(wxSizeEvent& event);

 
 

-    wxMDIChildFrame( wxGenericMDIParentFrame *parent,
-                     wxWindowID winid,
-                     const wxString& title,
-                     const wxPoint& pos = wxDefaultPosition,
-                     const wxSize& size = wxDefaultSize,
-                     long style = wxDEFAULT_FRAME_STYLE,
-                     const wxString& name = wxFrameNameStr )
-        :wxGenericMDIChildFrame(parent, winid, title, pos, size, style, name)
-    {
-    }
+    // the notebook containing all MDI children as its pages
+    wxNotebook *m_notebook;

 
 

-private:
-    DECLARE_DYNAMIC_CLASS(wxMDIChildFrame)
+    DECLARE_DYNAMIC_CLASS(wxGenericMDIClientWindow)

 };
 
 };
 

-//-----------------------------------------------------------------------------
-// wxMDIClientWindow
-//-----------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
+// inline functions implementation
+// ----------------------------------------------------------------------------

 
 

-class WXDLLEXPORT wxMDIClientWindow: public wxGenericMDIClientWindow
+inline bool
+wxGenericMDIParentFrame::
+WXIsInsideChildHandler(wxGenericMDIChildFrame *child) const

 {
 {

-public:
-    wxMDIClientWindow() {}
-
-    wxMDIClientWindow( wxGenericMDIParentFrame *parent, long style = 0 )
-        :wxGenericMDIClientWindow(parent, style)
-    {
-    }
-
-private:
-    DECLARE_DYNAMIC_CLASS(wxMDIClientWindow)
-};
+    return child == m_childHandler;
+}

 
 

-#endif
-
-#endif
-    // _WX_MDIG_H_
+#endif // _WX_GENERIC_MDIG_H_