include/wx/msw/mdi.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        mdi.h
   3 // Purpose:     MDI (Multiple Document Interface) classes
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_MDI_H_
  13 #define _WX_MDI_H_
  14
  15 #ifdef __GNUG__
  16     #pragma interface "mdi.h"
  17 #endif
  18
  19 #include "wx/frame.h"
  20
  21 WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr;
  22 WXDLLEXPORT_DATA(extern const wxChar*) wxStatusLineNameStr;
  23
  24 class WXDLLEXPORT wxMDIClientWindow;
  25 class WXDLLEXPORT wxMDIChildFrame;
  26
  27 // ---------------------------------------------------------------------------
  28 // wxMDIParentFrame
  29 // ---------------------------------------------------------------------------
  30
  31 class WXDLLEXPORT wxMDIParentFrame : public wxFrame
  32 {
  33     DECLARE_DYNAMIC_CLASS(wxMDIParentFrame)
  34
  35 public:
  36     wxMDIParentFrame();
  37     wxMDIParentFrame(wxWindow *parent,
  38                      wxWindowID id,
  39                      const wxString& title,
  40                      const wxPoint& pos = wxDefaultPosition,
  41                      const wxSize& size = wxDefaultSize,
  42                      long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
  43                      const wxString& name = wxFrameNameStr)
  44     {
  45         Create(parent, id, title, pos, size, style, name);
  46     }
  47
  48     ~wxMDIParentFrame();
  49
  50     bool Create(wxWindow *parent,
  51                 wxWindowID id,
  52                 const wxString& title,
  53                 const wxPoint& pos = wxDefaultPosition,
  54                 const wxSize& size = wxDefaultSize,
  55                 long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
  56                 const wxString& name = wxFrameNameStr);
  57
  58     // accessors
  59     // ---------
  60
  61     // Get the active MDI child window (Windows only)
  62     wxMDIChildFrame *GetActiveChild() const;
  63
  64     // Get the client window
  65     wxMDIClientWindow *GetClientWindow() const { return m_clientWindow; }
  66
  67     // Create the client window class (don't Create the window,
  68     // just return a new class)
  69     virtual wxMDIClientWindow *OnCreateClient(void);
  70
  71     WXHMENU GetWindowMenu() const { return m_windowMenu; }
  72
  73     // MDI operations
  74     // --------------
  75     virtual void Cascade();
  76     virtual void Tile();
  77     virtual void ArrangeIcons();
  78     virtual void ActivateNext();
  79     virtual void ActivatePrevious();
  80
  81     // handlers
  82     // --------
  83
  84     // Responds to colour changes
  85     void OnSysColourChanged(wxSysColourChangedEvent& event);
  86
  87     void OnSize(wxSizeEvent& event);
  88
  89     bool HandleActivate(int state, bool minimized, WXHWND activate);
  90     bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);
  91
  92     // override window proc for MDI-specific message processing
  93     virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
  94
  95     virtual long MSWDefWindowProc(WXUINT, WXWPARAM, WXLPARAM);
  96     virtual bool MSWTranslateMessage(WXMSG* msg);
  97
  98 protected:
  99     virtual void InternalSetMenuBar();
 100
 101     wxMDIClientWindow *             m_clientWindow;
 102     wxMDIChildFrame *               m_currentChild;
 103     WXHMENU                         m_windowMenu;
 104
 105     // TRUE if MDI Frame is intercepting commands, not child
 106     bool m_parentFrameActive;
 107
 108 private:
 109     friend class WXDLLEXPORT wxMDIChildFrame;
 110
 111     DECLARE_EVENT_TABLE()
 112 };
 113
 114 // ---------------------------------------------------------------------------
 115 // wxMDIChildFrame
 116 // ---------------------------------------------------------------------------
 117
 118 class WXDLLEXPORT wxMDIChildFrame : public wxFrame
 119 {
 120     DECLARE_DYNAMIC_CLASS(wxMDIChildFrame)
 121
 122 public:
 123     wxMDIChildFrame();
 124     wxMDIChildFrame(wxMDIParentFrame *parent,
 125                     wxWindowID id,
 126                     const wxString& title,
 127                     const wxPoint& pos = wxDefaultPosition,
 128                     const wxSize& size = wxDefaultSize,
 129                     long style = wxDEFAULT_FRAME_STYLE,
 130                     const wxString& name = wxFrameNameStr)
 131     {
 132         Create(parent, id, title, pos, size, style, name);
 133     }
 134
 135     ~wxMDIChildFrame();
 136
 137     bool Create(wxMDIParentFrame *parent,
 138                 wxWindowID id,
 139                 const wxString& title,
 140                 const wxPoint& pos = wxDefaultPosition,
 141                 const wxSize& size = wxDefaultSize,
 142                 long style = wxDEFAULT_FRAME_STYLE,
 143                 const wxString& name = wxFrameNameStr);
 144
 145     // MDI operations
 146     virtual void Maximize(bool maximize = TRUE);
 147     virtual void Restore();
 148     virtual void Activate();
 149
 150     // Handlers
 151
 152     bool HandleMDIActivate(long bActivate, WXHWND, WXHWND);
 153     bool HandleSize(int x, int y, WXUINT);
 154     bool HandleWindowPosChanging(void *lpPos);
 155     bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);
 156
 157     virtual long MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
 158     virtual long MSWDefWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
 159     virtual bool MSWTranslateMessage(WXMSG *msg);
 160
 161     virtual void MSWDestroyWindow();
 162
 163     // Implementation
 164     bool ResetWindowStyle(void *vrect);
 165
 166 protected:
 167     virtual void DoGetPosition(int *x, int *y) const;
 168     virtual void DoSetClientSize(int width, int height);
 169     virtual void InternalSetMenuBar();
 170 };
 171
 172 // ---------------------------------------------------------------------------
 173 // wxMDIClientWindow
 174 // ---------------------------------------------------------------------------
 175
 176 class WXDLLEXPORT wxMDIClientWindow : public wxWindow
 177 {
 178     DECLARE_DYNAMIC_CLASS(wxMDIClientWindow)
 179
 180 public:
 181     wxMDIClientWindow() { Init(); }
 182     wxMDIClientWindow(wxMDIParentFrame *parent, long style = 0)
 183     {
 184         Init();
 185
 186         CreateClient(parent, style);
 187     }
 188
 189     // Note: this is virtual, to allow overridden behaviour.
 190     virtual bool CreateClient(wxMDIParentFrame *parent,
 191                               long style = wxVSCROLL | wxHSCROLL);
 192
 193     // Explicitly call default scroll behaviour
 194     void OnScroll(wxScrollEvent& event);
 195
 196 protected:
 197     void Init() { m_scrollX = m_scrollY = 0; }
 198
 199     int m_scrollX, m_scrollY;
 200
 201 private:
 202     DECLARE_EVENT_TABLE()
 203 };
 204
 205 #endif
 206     // _WX_MDI_H_