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 6664f219f44b55881c69be82a270bca0a391fd6a..fb26c1ef2a85aa0ff6a1e6edc555e9ed300ff508 100644 (file)
--- a/include/wx/msw/mdi.h
+++ b/include/wx/msw/mdi.h
@@ -1,210 +1,276 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     MDI (Multiple Document Interface) classes
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Purpose:     MDI (Multiple Document Interface) classes
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:    wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-#ifndef __MDIH__
-#define __MDIH__
-
-#ifdef __GNUG__
-#pragma interface "mdi.h"
-#endif
+#ifndef _WX_MDI_H_
+#define _WX_MDI_H_

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

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

 
 

-class WXDLLEXPORT wxMDIClientWindow;
-class WXDLLEXPORT wxMDIChildFrame;
+// ---------------------------------------------------------------------------
+// wxMDIParentFrame
+// ---------------------------------------------------------------------------

 
 

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

 {
 {

-  DECLARE_DYNAMIC_CLASS(wxMDIParentFrame)
-
-  friend class WXDLLEXPORT wxMDIChildFrame;
- public:
-
-  wxMDIParentFrame(void);
-  inline wxMDIParentFrame(wxWindow *parent,
-           const wxWindowID id,
-           const wxString& title,
-           const wxPoint& pos = wxDefaultPosition,
-           const wxSize& size = wxDefaultSize,
-           const long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
-           const wxString& name = wxFrameNameStr)
-  {
-      Create(parent, id, title, pos, size, style, name);
-  }
-
-  ~wxMDIParentFrame(void);
-
-  bool Create(wxWindow *parent,
-           const wxWindowID id,
-           const wxString& title,
-           const wxPoint& pos = wxDefaultPosition,
-           const wxSize& size = wxDefaultSize,
-           const long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
-           const wxString& name = wxFrameNameStr);
-
-#if WXWIN_COMPATIBILITY
-  virtual void OldOnActivate(bool flag);
-  virtual void OldOnSize(int x, int y);
-#endif
+public:
+    wxMDIParentFrame();
+    wxMDIParentFrame(wxWindow *parent,
+                     wxWindowID id,
+                     const wxString& title,
+                     const wxPoint& pos = wxDefaultPosition,
+                     const wxSize& size = wxDefaultSize,
+                     long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
+                     const wxString& name = wxFrameNameStr)
+    {
+        Create(parent, id, title, pos, size, style, name);
+    }
+
+    virtual ~wxMDIParentFrame();
+
+    bool Create(wxWindow *parent,
+                wxWindowID id,
+                const wxString& title,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                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; }
+
+    // Create the client window class (don't Create the window,
+    // just return a new class)
+    virtual wxMDIClientWindow *OnCreateClient();
+
+    // MDI windows menu functions
+    // --------------------------
+
+    // 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();
+
+
+    // 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);

 
 

-  void OnSize(wxSizeEvent& event);
-  void OnActivate(wxActivateEvent& event);
+    // handlers
+    // --------

 
 

-  // Toolbar (currently, for use by Windows MDI parent frames ONLY)
-  virtual inline void SetToolBar(wxWindow *toolbar) { m_frameToolBar = toolbar; }
-  virtual inline wxWindow *GetToolBar(void) const { return m_frameToolBar; }
+    // Responds to colour changes
+    void OnSysColourChanged(wxSysColourChangedEvent& event);

 
 

-  void SetMenuBar(wxMenuBar *menu_bar);
+    void OnSize(wxSizeEvent& event);
+    void OnIconized(wxIconizeEvent& event);

 
 

-  // Gets the size available for subwindows after menu size, toolbar size
-  // and status bar size have been subtracted. If you want to manage your own
-  // toolbar(s), don't call SetToolBar.
-  void GetClientSize(int *width, int *height) const;
+    bool HandleActivate(int state, bool minimized, WXHWND activate);
+    bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);

 
 

-  // Get the active MDI child window (Windows only)
-  wxMDIChildFrame *GetActiveChild(void) const ;
+    // override window proc for MDI-specific message processing
+    virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);

 
 

-  // Get the client window
-  inline wxMDIClientWindow *GetClientWindow(void) const ;
+    virtual WXLRESULT MSWDefWindowProc(WXUINT, WXWPARAM, WXLPARAM);
+    virtual bool MSWTranslateMessage(WXMSG* msg);

 
 

-  // Create the client window class (don't Create the window,
-  // just return a new class)
-  virtual wxMDIClientWindow *OnCreateClient(void) ;
+    // override wxFrameBase function to also look in the active child menu bar
+    virtual const wxMenuItem *FindItemInMenuBar(int menuId) const;

 
 

-  inline WXHMENU GetWindowMenu(void) const ;
+protected:
+#if wxUSE_MENUS_NATIVE
+    virtual void InternalSetMenuBar();
+#endif // wxUSE_MENUS_NATIVE

 
 

-  // MDI operations
-  virtual void Cascade(void);
-  virtual void Tile(void);
-  virtual void ArrangeIcons(void);
-  virtual void ActivateNext(void);
-  virtual void ActivatePrevious(void);
+    virtual WXHICON GetDefaultIcon() const;

 
 

-  // Handlers
-  void MSWOnSize(const int x, const int y, const WXUINT flag);
-  bool MSWOnCommand(const WXWORD id, const WXWORD cmd, const WXHWND control);
-  void MSWOnMenuHighlight(const WXWORD item, const WXWORD flags, const WXHMENU sysmenu);
-  bool MSWProcessMessage(WXMSG *msg);
-  void MSWOnCreate(WXLPCREATESTRUCT cs);
-  long MSWDefWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
-  bool MSWOnEraseBkgnd(const WXHDC pDC);
-  bool MSWOnDestroy(void);
-  bool MSWOnActivate(const int state, const bool minimized, const WXHWND activate);
+    // set the size of the MDI client window to match the frame size
+    void UpdateClientSize();

 
 

-  // Responds to colour changes
-  void OnSysColourChanged(wxSysColourChangedEvent& event);

 
 

- protected:

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

-    WXHMENU                         m_windowMenu;
-    bool                            m_parentFrameActive; // TRUE if MDI Frame is intercepting
-                                                         // commands, not child
-    wxWindow *                      m_frameToolBar ;
-DECLARE_EVENT_TABLE()
+
+    // 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:
+    // 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)
+    DECLARE_NO_COPY_CLASS(wxMDIParentFrame)

 };
 
 };
 

-// Inlines
-inline wxMDIClientWindow *wxMDIParentFrame::GetClientWindow(void) const { return m_clientWindow; }
-inline WXHMENU wxMDIParentFrame::GetWindowMenu(void) const { return m_windowMenu; }
+// ---------------------------------------------------------------------------
+// wxMDIChildFrame
+// ---------------------------------------------------------------------------

 
 

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

 {
 {

-  DECLARE_DYNAMIC_CLASS(wxMDIChildFrame)
- public:
-
-  wxMDIChildFrame(void);
-  inline wxMDIChildFrame(wxMDIParentFrame *parent,
-           const wxWindowID id,
-           const wxString& title,
-           const wxPoint& pos = wxDefaultPosition,
-           const wxSize& size = wxDefaultSize,
-           const long style = wxDEFAULT_FRAME_STYLE,
-           const wxString& name = wxFrameNameStr)
-  {
-      Create(parent, id, title, pos, size, style, name);
-  }
-
-  ~wxMDIChildFrame(void);
-
-  bool Create(wxMDIParentFrame *parent,
-           const wxWindowID id,
-           const wxString& title,
-           const wxPoint& pos = wxDefaultPosition,
-           const wxSize& size = wxDefaultSize,
-           const long style = wxDEFAULT_FRAME_STYLE,
-           const wxString& name = wxFrameNameStr);
-
-  // Set menu bar
-  void SetMenuBar(wxMenuBar *menu_bar);
-  void SetClientSize(const int width, const int height);
-  void GetPosition(int *x, int *y) const ;
-
-  // MDI operations
-  virtual void Maximize(void);
-  virtual void Restore(void);
-  virtual void Activate(void);
-
-  // Handlers
-
-    long MSWOnMDIActivate(const long bActivate, const WXHWND, const WXHWND);
-    void MSWOnSize(const int x, const int y, const WXUINT);
-    void MSWOnWindowPosChanging(void *lpPos);
-    bool MSWOnCommand(const WXWORD id, const WXWORD cmd, const WXHWND control);
-    long MSWDefWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
-    bool MSWProcessMessage(WXMSG *msg);
-    void MSWDestroyWindow(void);
-
-    // Implementation
+public:
+    wxMDIChildFrame() { Init(); }
+    wxMDIChildFrame(wxMDIParentFrame *parent,
+                    wxWindowID id,
+                    const wxString& title,
+                    const wxPoint& pos = wxDefaultPosition,
+                    const wxSize& size = wxDefaultSize,
+                    long style = wxDEFAULT_FRAME_STYLE,
+                    const wxString& name = wxFrameNameStr)
+    {
+        Init();
+
+        Create(parent, id, title, pos, size, style, name);
+    }
+
+    virtual ~wxMDIChildFrame();
+
+    bool Create(wxMDIParentFrame *parent,
+                wxWindowID id,
+                const wxString& title,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = wxDEFAULT_FRAME_STYLE,
+                const wxString& name = wxFrameNameStr);
+
+    virtual bool IsTopLevel() const { return false; }
+
+    // MDI operations
+    virtual void Maximize(bool maximize = true);
+    virtual void Restore();
+    virtual void Activate();
+
+    // Implementation only from now on
+    // -------------------------------
+
+    wxMDIParentFrame* GetMDIParent() const
+    {
+        return wxStaticCast(wxFrame::GetParent(), wxMDIParentFrame);
+    }
+
+    // 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);
+    virtual WXLRESULT MSWDefWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
+    virtual bool MSWTranslateMessage(WXMSG *msg);
+
+    virtual void MSWDestroyWindow();
+

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

- protected:
-//    bool            m_active;
-};

 
 

-class WXDLLEXPORT wxMDIClientWindow: public wxWindow
-{
-  DECLARE_DYNAMIC_CLASS(wxMDIClientWindow)
- public:
+    void OnIdle(wxIdleEvent& event);

 
 

-  wxMDIClientWindow(void) ;
-  inline wxMDIClientWindow(wxMDIParentFrame *parent, const long style = 0)
-  {
-      CreateClient(parent, style);
-  }
+    virtual bool Show(bool show = true);

 
 

-  ~wxMDIClientWindow(void);
+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 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)
+};

 
 

-  // Note: this is virtual, to allow overridden behaviour.
-  virtual bool CreateClient(wxMDIParentFrame *parent, const long style = wxVSCROLL | wxHSCROLL);
+// ---------------------------------------------------------------------------
+// wxMDIClientWindow
+// ---------------------------------------------------------------------------

 
 

-  // Explicitly call default scroll behaviour
-  void OnScroll(wxScrollEvent& event);
+class WXDLLIMPEXP_CORE wxMDIClientWindow : public wxWindow
+{
+public:
+    wxMDIClientWindow() { Init(); }
+    wxMDIClientWindow(wxMDIParentFrame *parent, long style = 0)
+    {
+        Init();

 
 

-  // Window procedure
-  virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
+        CreateClient(parent, style);
+    }

 
 

-  // Calls an appropriate default window procedure
-  virtual long MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
+    // Note: this is virtual, to allow overridden behaviour.
+    virtual bool CreateClient(wxMDIParentFrame *parent,
+                              long style = wxVSCROLL | wxHSCROLL);

 
 

-  // Should hand the message to the default proc
-  long MSWOnMDIActivate(const long bActivate, const WXHWND, const WXHWND);
+    // Explicitly call default scroll behaviour
+    void OnScroll(wxScrollEvent& event);

 
 protected:
 
 protected:

-    int m_scrollX;
-    int m_scrollY;
-DECLARE_EVENT_TABLE()
+    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()
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxMDIClientWindow)

 };
 
 #endif
 };
 
 #endif

-    // __MDIH__
+    // _WX_MDI_H_