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     void SetMenuBar(wxMenuBar *menu_bar);
  62
  63     // Get the active MDI child window (Windows only)
  64     wxMDIChildFrame *GetActiveChild() const ;
  65
  66     // Get the client window
  67     wxMDIClientWindow *GetClientWindow() const { return m_clientWindow; }
  68
  69     // Create the client window class (don't Create the window,
  70     // just return a new class)
  71     virtual wxMDIClientWindow *OnCreateClient(void) ;
  72
  73     WXHMENU GetWindowMenu() const { return m_windowMenu; }
  74
  75     // MDI operations
  76     // --------------
  77     virtual void Cascade();
  78     virtual void Tile();
  79     virtual void ArrangeIcons();
  80     virtual void ActivateNext();
  81     virtual void ActivatePrevious();
  82
  83     // handlers
  84     // --------
  85
  86     // Responds to colour changes
  87     void OnSysColourChanged(wxSysColourChangedEvent& event);
  88
  89     void OnSize(wxSizeEvent& event);
  90     void OnActivate(wxActivateEvent& event);
  91
  92     virtual bool MSWOnActivate(int state, bool minimized, WXHWND activate);
  93     virtual bool MSWOnCommand(WXWORD id, WXWORD cmd, WXHWND control);
  94
  95     // override window proc for MDI-specific message processing
  96     virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
  97
  98     virtual long MSWDefWindowProc(WXUINT, WXWPARAM, WXLPARAM);
  99     virtual bool MSWProcessMessage(WXMSG* msg);
 100     virtual bool MSWTranslateMessage(WXMSG* msg);
 101
 102 protected:
 103     wxMDIClientWindow *             m_clientWindow;
 104     wxMDIChildFrame *               m_currentChild;
 105     WXHMENU                         m_windowMenu;
 106
 107     // TRUE if MDI Frame is intercepting commands, not child
 108     bool m_parentFrameActive;
 109
 110 private:
 111     friend class WXDLLEXPORT wxMDIChildFrame;
 112
 113     DECLARE_EVENT_TABLE()
 114 };
 115
 116 // ---------------------------------------------------------------------------
 117 // wxMDIChildFrame
 118 // ---------------------------------------------------------------------------
 119
 120 class WXDLLEXPORT wxMDIChildFrame : public wxFrame
 121 {
 122     DECLARE_DYNAMIC_CLASS(wxMDIChildFrame)
 123
 124 public:
 125     wxMDIChildFrame();
 126     wxMDIChildFrame(wxMDIParentFrame *parent,
 127                     wxWindowID id,
 128                     const wxString& title,
 129                     const wxPoint& pos = wxDefaultPosition,
 130                     const wxSize& size = wxDefaultSize,
 131                     long style = wxDEFAULT_FRAME_STYLE,
 132                     const wxString& name = wxFrameNameStr)
 133     {
 134         Create(parent, id, title, pos, size, style, name);
 135     }
 136
 137     ~wxMDIChildFrame();
 138
 139     bool Create(wxMDIParentFrame *parent,
 140                 wxWindowID id,
 141                 const wxString& title,
 142                 const wxPoint& pos = wxDefaultPosition,
 143                 const wxSize& size = wxDefaultSize,
 144                 long style = wxDEFAULT_FRAME_STYLE,
 145                 const wxString& name = wxFrameNameStr);
 146
 147     // Set menu bar
 148     void SetMenuBar(wxMenuBar *menu_bar);
 149
 150     // MDI operations
 151     virtual void Maximize();
 152     virtual void Restore();
 153     virtual void Activate();
 154
 155     // Handlers
 156
 157     bool MSWOnMDIActivate(long bActivate, WXHWND, WXHWND);
 158     bool MSWOnSize(int x, int y, WXUINT);
 159     bool MSWOnWindowPosChanging(void *lpPos);
 160     bool MSWOnCommand(WXWORD id, WXWORD cmd, WXHWND control);
 161     long MSWDefWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
 162     bool MSWProcessMessage(WXMSG *msg);
 163     bool MSWTranslateMessage(WXMSG *msg);
 164     void MSWDestroyWindow();
 165
 166     // Implementation
 167     bool ResetWindowStyle(void *vrect);
 168
 169 protected:
 170     virtual void DoGetPosition(int *x, int *y) const ;
 171     virtual void DoSetClientSize(int width, int height);
 172 };
 173
 174 // ---------------------------------------------------------------------------
 175 // wxMDIClientWindow
 176 // ---------------------------------------------------------------------------
 177
 178 class WXDLLEXPORT wxMDIClientWindow : public wxWindow
 179 {
 180     DECLARE_DYNAMIC_CLASS(wxMDIClientWindow)
 181
 182 public:
 183     wxMDIClientWindow();
 184     wxMDIClientWindow(wxMDIParentFrame *parent, long style = 0)
 185     {
 186         CreateClient(parent, style);
 187     }
 188
 189     ~wxMDIClientWindow();
 190
 191     // Note: this is virtual, to allow overridden behaviour.
 192     virtual bool CreateClient(wxMDIParentFrame *parent,
 193                               long style = wxVSCROLL | wxHSCROLL);
 194
 195     // Explicitly call default scroll behaviour
 196     void OnScroll(wxScrollEvent& event);
 197
 198     // Window procedure
 199     virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
 200
 201     // Calls an appropriate default window procedure
 202     virtual long MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
 203
 204 protected:
 205     int m_scrollX, m_scrollY;
 206
 207 private:
 208     DECLARE_EVENT_TABLE()
 209 };
 210
 211 #endif
 212     // _WX_MDI_H_