enum wxWebViewBackend has been removed.

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

diff --git a/include/wx/msw/mdi.h b/include/wx/msw/mdi.h
index f19bf39b8ec1e7530d27ca5bfb0dc1ce02ec7aba..caf235fd56a68ec7578df102d48bf70b0cdef00d 100644 (file)
--- a/include/wx/msw/mdi.h
+++ b/include/wx/msw/mdi.h
@@ -1,39 +1,30 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        mdi.h
+// Name:        wx/msw/mdi.h

 // Purpose:     MDI (Multiple Document Interface) classes
 // Author:      Julian Smart
 // 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_
-
-#ifdef __GNUG__
-    #pragma interface "mdi.h"
-#endif
+#ifndef _WX_MSW_MDI_H_
+#define _WX_MSW_MDI_H_

 
 #include "wx/frame.h"
 
 
 #include "wx/frame.h"
 

-WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr;
-WXDLLEXPORT_DATA(extern const wxChar*) wxStatusLineNameStr;
-
-class WXDLLEXPORT wxMDIClientWindow;
-class WXDLLEXPORT wxMDIChildFrame;
+class WXDLLIMPEXP_FWD_CORE wxAcceleratorTable;

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

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

 {
 {

-    DECLARE_DYNAMIC_CLASS(wxMDIParentFrame)
-

 public:
 public:

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

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


@@ -42,10 +33,12 @@ 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);
     }
 

-    ~wxMDIParentFrame();
+    virtual ~wxMDIParentFrame();

 
     bool Create(wxWindow *parent,
                 wxWindowID id,
 
     bool Create(wxWindow *parent,
                 wxWindowID id,


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

-    // accessors
-    // ---------
-
-    void SetMenuBar(wxMenuBar *menu_bar);
-
-    // Get the active MDI child window (Windows only)
-    wxMDIChildFrame *GetActiveChild() const ;
+    // override/implement base class [pure] virtual methods
+    // ----------------------------------------------------

 
 

-    // Get the client window
-    wxMDIClientWindow *GetClientWindow() const { return m_clientWindow; }
+    static bool IsTDI() { return false; }

 
 

-    // Create the client window class (don't Create the window,
-    // just return a new class)
-    virtual wxMDIClientWindow *OnCreateClient(void) ;
+    // we don't store the active child in m_currentChild so override this
+    // function to find it dynamically
+    virtual wxMDIChildFrame *GetActiveChild() const;

 
 

-    WXHMENU GetWindowMenu() const { return m_windowMenu; }
-
-    // MDI operations
-    // --------------

     virtual void Cascade();
     virtual void Cascade();

-    virtual void Tile();
+    virtual void Tile(wxOrientation orient = wxHORIZONTAL);

     virtual void ArrangeIcons();
     virtual void ActivateNext();
     virtual void ActivatePrevious();
 
     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
+    // -----------
+
+#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);
+#endif // wxUSE_MENUS
+

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


@@ -87,42 +93,77 @@ public:
     void OnSysColourChanged(wxSysColourChangedEvent& event);
 
     void OnSize(wxSizeEvent& event);
     void OnSysColourChanged(wxSysColourChangedEvent& event);
 
     void OnSize(wxSizeEvent& event);

-    void OnActivate(wxActivateEvent& event);
+    void OnIconized(wxIconizeEvent& event);

 
 

-    virtual bool MSWOnActivate(int state, bool minimized, WXHWND activate);
-    virtual bool MSWOnCommand(WXWORD id, WXWORD cmd, WXHWND control);
+    bool HandleActivate(int state, bool minimized, WXHWND activate);

 
     // override window proc for MDI-specific message processing
 
     // override window proc for MDI-specific message processing

-    virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
+    virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);

 
 

-    virtual long MSWDefWindowProc(WXUINT, WXWPARAM, WXLPARAM);
-    virtual bool MSWProcessMessage(WXMSG* msg);
+    virtual WXLRESULT MSWDefWindowProc(WXUINT, WXWPARAM, WXLPARAM);

     virtual bool MSWTranslateMessage(WXMSG* msg);
 
     virtual bool MSWTranslateMessage(WXMSG* msg);
 

+#if wxUSE_MENUS
+    // override wxFrameBase function to also look in the active child menu bar
+    // and the "Window" menu
+    virtual wxMenuItem *FindItemInMenuBar(int menuId) const;
+#endif // wxUSE_MENUS
+

 protected:
 protected:

-    wxMDIClientWindow *             m_clientWindow;
-    wxMDIChildFrame *               m_currentChild;
-    WXHMENU                         m_windowMenu;
+    // 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
+
+    virtual WXHICON GetDefaultIcon() const;

 
 

-    // TRUE if MDI Frame is intercepting commands, not child
-    bool m_parentFrameActive; 
+    // set the size of the MDI client window to match the frame size
+    void UpdateClientSize();

 
 private:
 
 private:

-    friend class WXDLLEXPORT wxMDIChildFrame;
+    // common part of all ctors
+    void Init();
+
+#if wxUSE_MENUS
+    // "Window" menu commands event handlers
+    void OnMDICommand(wxCommandEvent& event);
+    void OnMDIChild(wxCommandEvent& event);
+
+
+    // 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;
+
+
+    friend class WXDLLIMPEXP_FWD_CORE wxMDIChildFrame;

 
     DECLARE_EVENT_TABLE()
 
     DECLARE_EVENT_TABLE()

+    DECLARE_DYNAMIC_CLASS(wxMDIParentFrame)
+    wxDECLARE_NO_COPY_CLASS(wxMDIParentFrame);

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

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

 {
 {

-    DECLARE_DYNAMIC_CLASS(wxMDIChildFrame)
-

 public:
 public:

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

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


@@ -131,11 +172,11 @@ public:
                     long style = wxDEFAULT_FRAME_STYLE,
                     const wxString& name = wxFrameNameStr)
     {
                     long style = wxDEFAULT_FRAME_STYLE,
                     const wxString& name = wxFrameNameStr)
     {

+        Init();
+

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

-    ~wxMDIChildFrame();
-

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


@@ -144,49 +185,65 @@ public:
                 long style = wxDEFAULT_FRAME_STYLE,
                 const wxString& name = wxFrameNameStr);
 
                 long style = wxDEFAULT_FRAME_STYLE,
                 const wxString& name = wxFrameNameStr);
 

-    // Set menu bar
-    void SetMenuBar(wxMenuBar *menu_bar);
+    virtual ~wxMDIChildFrame();

 
 

-    // MDI operations
-    virtual void Maximize();
-    virtual void Restore();
+    // implement MDI operations

     virtual void Activate();
 
     virtual void Activate();
 

+    // Override some frame operations too
+    virtual void Maximize(bool maximize = true);
+    virtual void Restore();
+
+    virtual bool Show(bool show = true);
+
+    // Implementation only from now on
+    // -------------------------------
+

     // Handlers
     // Handlers

+    bool HandleMDIActivate(long bActivate, WXHWND, WXHWND);
+    bool HandleWindowPosChanging(void *lpPos);
+    bool HandleGetMinMaxInfo(void *mmInfo);
+
+    virtual WXLRESULT MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
+    virtual WXLRESULT MSWDefWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
+    virtual bool MSWTranslateMessage(WXMSG *msg);

 
 

-    bool MSWOnMDIActivate(long bActivate, WXHWND, WXHWND);
-    bool MSWOnSize(int x, int y, WXUINT);
-    bool MSWOnWindowPosChanging(void *lpPos);
-    bool MSWOnCommand(WXWORD id, WXWORD cmd, WXHWND control);
-    long MSWDefWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
-    bool MSWProcessMessage(WXMSG *msg);
-    bool MSWTranslateMessage(WXMSG *msg);
-    void MSWDestroyWindow();
+    virtual void MSWDestroyWindow();

 
 

-    // Implementation

     bool ResetWindowStyle(void *vrect);
 
     bool ResetWindowStyle(void *vrect);
 

+    void OnIdle(wxIdleEvent& event);
+

 protected:
 protected:

-    virtual void DoGetPosition(int *x, int *y) const ;
+    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 DoSetClientSize(int width, int height);

+    virtual void InternalSetMenuBar();
+    virtual bool IsMDIChild() const { return true; }
+    virtual void DetachMenuBar();
+
+    virtual WXHICON GetDefaultIcon() const;
+
+    // common part of all ctors
+    void Init();
+
+private:
+    bool m_needsInitialShow; // Show must be called in idle time after Creation
+    bool m_needsResize; // flag which tells us to artificially resize the frame
+
+    DECLARE_EVENT_TABLE()
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxMDIChildFrame)

 };
 
 // ---------------------------------------------------------------------------
 // wxMDIClientWindow
 // ---------------------------------------------------------------------------
 
 };
 
 // ---------------------------------------------------------------------------
 // wxMDIClientWindow
 // ---------------------------------------------------------------------------
 

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

 {
 {

-    DECLARE_DYNAMIC_CLASS(wxMDIClientWindow)
-

 public:
 public:

-    wxMDIClientWindow();
-    wxMDIClientWindow(wxMDIParentFrame *parent, long style = 0)
-    {
-        CreateClient(parent, style);
-    }
-
-    ~wxMDIClientWindow();
+    wxMDIClientWindow() { Init(); }

 
     // 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,


@@ -195,18 +252,18 @@ public:
     // Explicitly call default scroll behaviour
     void OnScroll(wxScrollEvent& event);
 
     // Explicitly call default scroll behaviour
     void OnScroll(wxScrollEvent& event);
 

-    // Window procedure
-    virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
+protected:
+    virtual void DoSetSize(int x, int y,
+                           int width, int height,
+                           int sizeFlags = wxSIZE_AUTO);

 
 

-    // Calls an appropriate default window procedure
-    virtual long MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
+    void Init() { m_scrollX = m_scrollY = 0; }

 
 

-protected:

     int m_scrollX, m_scrollY;
 
 private:
     DECLARE_EVENT_TABLE()
     int m_scrollX, m_scrollY;
 
 private:
     DECLARE_EVENT_TABLE()

+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxMDIClientWindow)

 };
 
 };
 

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