define wxHAS_CONFIG_TEMPLATE_RW if template wxConfig::Read/Write() are available...

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

diff --git a/include/wx/msw/mdi.h b/include/wx/msw/mdi.h
index 828df13b23aa66dfb3ad7f066a6b01880c000366..fb26c1ef2a85aa0ff6a1e6edc555e9ed300ff508 100644 (file)
--- a/include/wx/msw/mdi.h
+++ b/include/wx/msw/mdi.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     MDI (Multiple Document Interface) classes
 // Author:      Julian Smart
 // Modified by:
 // Purpose:     MDI (Multiple Document Interface) classes
 // Author:      Julian Smart
 // Modified by:


@@ -12,26 +12,19 @@
 #ifndef _WX_MDI_H_
 #define _WX_MDI_H_
 
 #ifndef _WX_MDI_H_
 #define _WX_MDI_H_
 

-#ifdef __GNUG__
-    #pragma interface "mdi.h"
-#endif
-

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

-WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr;
-WXDLLEXPORT_DATA(extern const wxChar*) wxStatusLineNameStr;
+extern WXDLLIMPEXP_DATA_CORE(const char) wxStatusLineNameStr[];

 
 

-class WXDLLEXPORT wxMDIClientWindow;
-class WXDLLEXPORT wxMDIChildFrame;
+class WXDLLIMPEXP_FWD_CORE wxMDIClientWindow;
+class WXDLLIMPEXP_FWD_CORE wxMDIChildFrame;

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

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

 {
 {

-    DECLARE_DYNAMIC_CLASS(wxMDIParentFrame)
-

 public:
     wxMDIParentFrame();
     wxMDIParentFrame(wxWindow *parent,
 public:
     wxMDIParentFrame();
     wxMDIParentFrame(wxWindow *parent,


@@ -45,7 +38,7 @@ public:
         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,


@@ -58,7 +51,7 @@ public:
     // accessors
     // ---------
 
     // accessors
     // ---------
 

-    // Get the active MDI child window (Windows only)
+    // Get the active MDI child window

     wxMDIChildFrame *GetActiveChild() const;
 
     // Get the client window
     wxMDIChildFrame *GetActiveChild() const;
 
     // Get the client window


@@ -66,18 +59,42 @@ public:
 
     // Create the client window class (don't Create the window,
     // just return a new class)
 
     // Create the client window class (don't Create the window,
     // just return a new class)

-    virtual wxMDIClientWindow *OnCreateClient(void);
+    virtual wxMDIClientWindow *OnCreateClient();
+
+    // MDI windows menu functions
+    // --------------------------

 
 

-    WXHMENU GetWindowMenu() const { return m_windowMenu; }
+    // 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();
 
     // MDI operations
     // --------------
     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();
 

+
+    // 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
     // --------
 
     // handlers
     // --------
 


@@ -85,42 +102,63 @@ public:
     void OnSysColourChanged(wxSysColourChangedEvent& event);
 
     void OnSize(wxSizeEvent& event);
     void OnSysColourChanged(wxSysColourChangedEvent& event);
 
     void OnSize(wxSizeEvent& event);

+    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
 
     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 long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
+    virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);

 
 

-    virtual long MSWDefWindowProc(WXUINT, WXWPARAM, WXLPARAM);
+    virtual WXLRESULT MSWDefWindowProc(WXUINT, WXWPARAM, WXLPARAM);

     virtual bool MSWTranslateMessage(WXMSG* msg);
 
     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:
 protected:

+#if wxUSE_MENUS_NATIVE

     virtual void InternalSetMenuBar();
     virtual void InternalSetMenuBar();

+#endif // wxUSE_MENUS_NATIVE
+
+    virtual WXHICON GetDefaultIcon() const;
+
+    // set the size of the MDI client window to match the frame size
+    void UpdateClientSize();
+

 
     wxMDIClientWindow *             m_clientWindow;
     wxMDIChildFrame *               m_currentChild;
 
     wxMDIClientWindow *             m_clientWindow;
     wxMDIChildFrame *               m_currentChild;

-    WXHMENU                         m_windowMenu;

 
 

-    // TRUE if MDI Frame is intercepting commands, not child
+    // the current window menu or NULL if we are not using it
+    wxMenu *m_windowMenu;
+
+    // true if MDI Frame is intercepting commands, not child

     bool m_parentFrameActive;
 
 private:
     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_EVENT_TABLE()

+    DECLARE_DYNAMIC_CLASS(wxMDIParentFrame)
+    DECLARE_NO_COPY_CLASS(wxMDIParentFrame)

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

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

 {
 {

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


@@ -129,10 +167,12 @@ 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();
+    virtual ~wxMDIChildFrame();

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


@@ -142,41 +182,66 @@ 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; }
+

     // MDI operations
     // MDI operations

-    virtual void Maximize(bool maximize = TRUE);
+    virtual void Maximize(bool maximize = true);

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

-    // Handlers
+    // Implementation only from now on
+    // -------------------------------

 
 

+    wxMDIParentFrame* GetMDIParent() const
+    {
+        return wxStaticCast(wxFrame::GetParent(), wxMDIParentFrame);
+    }
+
+    // Handlers

     bool HandleMDIActivate(long bActivate, WXHWND, WXHWND);
     bool HandleMDIActivate(long bActivate, WXHWND, WXHWND);

-    bool HandleSize(int x, int y, WXUINT);

     bool HandleWindowPosChanging(void *lpPos);
     bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);
     bool HandleWindowPosChanging(void *lpPos);
     bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);

+    bool HandleGetMinMaxInfo(void *mmInfo);

 
 

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

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

-    // Implementation

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

+    void OnIdle(wxIdleEvent& event);
+
+    virtual bool Show(bool show = true);
+

 protected:
 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();
     virtual void DoGetPosition(int *x, int *y) const;
     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 wxWindow

 {
 {

-    DECLARE_DYNAMIC_CLASS(wxMDIClientWindow)
-

 public:
     wxMDIClientWindow() { Init(); }
     wxMDIClientWindow(wxMDIParentFrame *parent, long style = 0)
 public:
     wxMDIClientWindow() { Init(); }
     wxMDIClientWindow(wxMDIParentFrame *parent, long style = 0)


@@ -194,12 +259,17 @@ public:
     void OnScroll(wxScrollEvent& event);
 
 protected:
     void OnScroll(wxScrollEvent& event);
 
 protected:

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

     void Init() { m_scrollX = m_scrollY = 0; }
 
     int m_scrollX, m_scrollY;
 
 private:
     DECLARE_EVENT_TABLE()
     void Init() { m_scrollX = m_scrollY = 0; }
 
     int m_scrollX, m_scrollY;
 
 private:
     DECLARE_EVENT_TABLE()

+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxMDIClientWindow)

 };
 
 #endif
 };
 
 #endif