Mention wxGTK wxAnimation implementation limitations in the docs.

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

diff --git a/include/wx/msw/mdi.h b/include/wx/msw/mdi.h
index fb26c1ef2a85aa0ff6a1e6edc555e9ed300ff508..caf235fd56a68ec7578df102d48bf70b0cdef00d 100644 (file)
--- a/include/wx/msw/mdi.h
+++ b/include/wx/msw/mdi.h
@@ -2,31 +2,29 @@
 // Name:        wx/msw/mdi.h
 // Purpose:     MDI (Multiple Document Interface) classes
 // Author:      Julian Smart
 // 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$
 // Created:     01/02/97
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart
+// Copyright:   (c) 1997 Julian Smart
+//              (c) 2008 Vadim Zeitlin

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // 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"
 
 
 #include "wx/frame.h"
 

-extern WXDLLIMPEXP_DATA_CORE(const char) wxStatusLineNameStr[];
-
-class WXDLLIMPEXP_FWD_CORE wxMDIClientWindow;
-class WXDLLIMPEXP_FWD_CORE wxMDIChildFrame;
+class WXDLLIMPEXP_FWD_CORE wxAcceleratorTable;

 
 // ---------------------------------------------------------------------------
 // wxMDIParentFrame
 // ---------------------------------------------------------------------------
 
 
 // ---------------------------------------------------------------------------
 // wxMDIParentFrame
 // ---------------------------------------------------------------------------
 

-class WXDLLIMPEXP_CORE wxMDIParentFrame : public wxFrame
+class WXDLLIMPEXP_CORE wxMDIParentFrame : public wxMDIParentFrameBase

 {
 public:
 {
 public:

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

     wxMDIParentFrame(wxWindow *parent,
                      wxWindowID id,
                      const wxString& title,
     wxMDIParentFrame(wxWindow *parent,
                      wxWindowID id,
                      const wxString& title,


@@ -35,6 +33,8 @@ public:
                      long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
                      const wxString& name = wxFrameNameStr)
     {
                      long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
                      const wxString& name = wxFrameNameStr)
     {

+        Init();
+

         Create(parent, id, title, pos, size, style, name);
     }
 
         Create(parent, id, title, pos, size, style, name);
     }
 


@@ -48,52 +48,43 @@ public:
                 long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
                 const wxString& name = wxFrameNameStr);
 
                 long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
                 const wxString& name = wxFrameNameStr);
 

-    // accessors
-    // ---------
-
-    // Get the active MDI child window
-    wxMDIChildFrame *GetActiveChild() const;
-
-    // Get the client window
-    wxMDIClientWindow *GetClientWindow() const { return m_clientWindow; }
+    // override/implement base class [pure] virtual methods
+    // ----------------------------------------------------

 
 

-    // Create the client window class (don't Create the window,
-    // just return a new class)
-    virtual wxMDIClientWindow *OnCreateClient();
+    static bool IsTDI() { return false; }

 
 

-    // MDI windows menu functions
-    // --------------------------
+    // we don't store the active child in m_currentChild so override this
+    // function to find it dynamically
+    virtual wxMDIChildFrame *GetActiveChild() const;

 
 

-    // 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; }
-
-    // use the given menu instead of the default window menu
-    //
-    // menu can be NULL to disable the window menu completely
-    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();
 
     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);
+
+    // return the active child menu, if any
+    virtual WXHMENU MSWGetActiveMenu() const;
+#endif // wxUSE_MENUS
+

 
     // implementation only from now on
 
     // MDI helpers
     // -----------
 
 
     // implementation only from now on
 
     // MDI helpers
     // -----------
 

+#if wxUSE_MENUS

     // 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);
     // 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);

+#endif // wxUSE_MENUS

 
     // handlers
     // --------
 
     // handlers
     // --------


@@ -105,7 +96,6 @@ public:
     void OnIconized(wxIconizeEvent& event);
 
     bool HandleActivate(int state, bool minimized, WXHWND activate);
     void OnIconized(wxIconizeEvent& event);
 
     bool HandleActivate(int state, bool minimized, WXHWND activate);

-    bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);

 
     // override window proc for MDI-specific message processing
     virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
 
     // override window proc for MDI-specific message processing
     virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);


@@ -113,10 +103,16 @@ public:
     virtual WXLRESULT MSWDefWindowProc(WXUINT, WXWPARAM, WXLPARAM);
     virtual bool MSWTranslateMessage(WXMSG* msg);
 
     virtual WXLRESULT MSWDefWindowProc(WXUINT, WXWPARAM, WXLPARAM);
     virtual bool MSWTranslateMessage(WXMSG* msg);
 

+#if wxUSE_MENUS

     // override wxFrameBase function to also look in the active child menu bar
     // override wxFrameBase function to also look in the active child menu bar

-    virtual const wxMenuItem *FindItemInMenuBar(int menuId) const;
+    // and the "Window" menu
+    virtual wxMenuItem *FindItemInMenuBar(int menuId) const;
+#endif // wxUSE_MENUS

 
 protected:
 
 protected:

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

 #if wxUSE_MENUS_NATIVE
     virtual void InternalSetMenuBar();
 #endif // wxUSE_MENUS_NATIVE
 #if wxUSE_MENUS_NATIVE
     virtual void InternalSetMenuBar();
 #endif // wxUSE_MENUS_NATIVE


@@ -126,36 +122,45 @@ protected:
     // set the size of the MDI client window to match the frame size
     void UpdateClientSize();
 
     // set the size of the MDI client window to match the frame size
     void UpdateClientSize();
 

+private:
+    // common part of all ctors
+    void Init();

 
 

-    wxMDIClientWindow *             m_clientWindow;
-    wxMDIChildFrame *               m_currentChild;
-
-    // the current window menu or NULL if we are not using it
-    wxMenu *m_windowMenu;
+#if wxUSE_MENUS
+    // "Window" menu commands event handlers
+    void OnMDICommand(wxCommandEvent& event);
+    void OnMDIChild(wxCommandEvent& event);

 
 

-    // true if MDI Frame is intercepting commands, not child
-    bool m_parentFrameActive;

 
 

-private:

     // add/remove window menu if we have it (i.e. m_windowMenu != NULL)
     void AddWindowMenu();
     void RemoveWindowMenu();
 
     // add/remove window menu if we have it (i.e. m_windowMenu != NULL)
     void AddWindowMenu();
     void RemoveWindowMenu();
 

+    // update the window menu (if we have it) to enable or disable the commands
+    // which only make sense when we have more than one child
+    void UpdateWindowMenu(bool enable);
+
+#if wxUSE_ACCEL
+    wxAcceleratorTable *m_accelWindowMenu;
+#endif // wxUSE_ACCEL
+#endif // wxUSE_MENUS
+

     // return the number of child frames we currently have (maybe 0)
     int GetChildFramesCount() const;
 
     // 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)
     friend class WXDLLIMPEXP_FWD_CORE wxMDIChildFrame;
 
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxMDIParentFrame)

-    DECLARE_NO_COPY_CLASS(wxMDIParentFrame)
+    wxDECLARE_NO_COPY_CLASS(wxMDIParentFrame);

 };
 
 // ---------------------------------------------------------------------------
 // wxMDIChildFrame
 // ---------------------------------------------------------------------------
 
 };
 
 // ---------------------------------------------------------------------------
 // wxMDIChildFrame
 // ---------------------------------------------------------------------------
 

-class WXDLLIMPEXP_CORE wxMDIChildFrame : public wxFrame
+class WXDLLIMPEXP_CORE wxMDIChildFrame : public wxMDIChildFrameBase

 {
 public:
     wxMDIChildFrame() { Init(); }
 {
 public:
     wxMDIChildFrame() { Init(); }


@@ -172,8 +177,6 @@ public:
         Create(parent, id, title, pos, size, style, name);
     }
 
         Create(parent, id, title, pos, size, style, name);
     }
 

-    virtual ~wxMDIChildFrame();
-

     bool Create(wxMDIParentFrame *parent,
                 wxWindowID id,
                 const wxString& title,
     bool Create(wxMDIParentFrame *parent,
                 wxWindowID id,
                 const wxString& title,


@@ -182,25 +185,23 @@ public:
                 long style = wxDEFAULT_FRAME_STYLE,
                 const wxString& name = wxFrameNameStr);
 
                 long style = wxDEFAULT_FRAME_STYLE,
                 const wxString& name = wxFrameNameStr);
 

-    virtual bool IsTopLevel() const { return false; }
+    virtual ~wxMDIChildFrame();
+
+    // implement MDI operations
+    virtual void Activate();

 
 

-    // MDI operations
+    // Override some frame operations too

     virtual void Maximize(bool maximize = true);
     virtual void Restore();
     virtual void Maximize(bool maximize = true);
     virtual void Restore();

-    virtual void Activate();
+
+    virtual bool Show(bool show = true);

 
     // Implementation only from now on
     // -------------------------------
 
 
     // Implementation only from now on
     // -------------------------------
 

-    wxMDIParentFrame* GetMDIParent() const
-    {
-        return wxStaticCast(wxFrame::GetParent(), wxMDIParentFrame);
-    }
-

     // Handlers
     bool HandleMDIActivate(long bActivate, WXHWND, WXHWND);
     bool HandleWindowPosChanging(void *lpPos);
     // Handlers
     bool HandleMDIActivate(long bActivate, WXHWND, WXHWND);
     bool HandleWindowPosChanging(void *lpPos);

-    bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);

     bool HandleGetMinMaxInfo(void *mmInfo);
 
     virtual WXLRESULT MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
     bool HandleGetMinMaxInfo(void *mmInfo);
 
     virtual WXLRESULT MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);


@@ -213,11 +214,10 @@ public:
 
     void OnIdle(wxIdleEvent& event);
 
 
     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;
 protected:
     virtual void DoGetScreenPosition(int *x, int *y) const;
     virtual void DoGetPosition(int *x, int *y) const;

+    virtual void DoSetSize(int x, int y, int width, int height, int sizeFlags);

     virtual void DoSetClientSize(int width, int height);
     virtual void InternalSetMenuBar();
     virtual bool IsMDIChild() const { return true; }
     virtual void DoSetClientSize(int width, int height);
     virtual void InternalSetMenuBar();
     virtual bool IsMDIChild() const { return true; }


@@ -240,16 +240,10 @@ private:
 // wxMDIClientWindow
 // ---------------------------------------------------------------------------
 
 // wxMDIClientWindow
 // ---------------------------------------------------------------------------
 

-class WXDLLIMPEXP_CORE wxMDIClientWindow : public wxWindow
+class WXDLLIMPEXP_CORE wxMDIClientWindow : public wxMDIClientWindowBase

 {
 public:
     wxMDIClientWindow() { Init(); }
 {
 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,
 
     // Note: this is virtual, to allow overridden behaviour.
     virtual bool CreateClient(wxMDIParentFrame *parent,


@@ -272,5 +266,4 @@ private:
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxMDIClientWindow)
 };
 
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxMDIClientWindow)
 };
 

-#endif
-    // _WX_MDI_H_
+#endif // _WX_MSW_MDI_H_