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 GetWindowHMENU() const { return m_windowMenu; }
  72     wxMenu* GetWindowMenu() const { return m_windowMenu; };
  73     void SetWindowMenu(wxMenu* menu) ;
  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
  91     bool HandleActivate(int state, bool minimized, WXHWND activate);
  92     bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);
  93
  94     // override window proc for MDI-specific message processing
  95     virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
  96
  97     virtual long MSWDefWindowProc(WXUINT, WXWPARAM, WXLPARAM);
  98     virtual bool MSWTranslateMessage(WXMSG* msg);
  99
 100 protected:
 101     virtual void InternalSetMenuBar();
 102
 103     wxMDIClientWindow *             m_clientWindow;
 104     wxMDIChildFrame *               m_currentChild;
 105 //    WXHMENU                         m_windowMenu;
 106     wxMenu*                         m_windowMenu;
 107
 108     // TRUE if MDI Frame is intercepting commands, not child
 109     bool m_parentFrameActive;
 110
 111 private:
 112     friend class WXDLLEXPORT wxMDIChildFrame;
 113
 114     DECLARE_EVENT_TABLE()
 115 };
 116
 117 // ---------------------------------------------------------------------------
 118 // wxMDIChildFrame
 119 // ---------------------------------------------------------------------------
 120
 121 class WXDLLEXPORT wxMDIChildFrame : public wxFrame
 122 {
 123 public:
 124     wxMDIChildFrame();
 125     wxMDIChildFrame(wxMDIParentFrame *parent,
 126                     wxWindowID id,
 127                     const wxString& title,
 128                     const wxPoint& pos = wxDefaultPosition,
 129                     const wxSize& size = wxDefaultSize,
 130                     long style = wxDEFAULT_FRAME_STYLE,
 131                     const wxString& name = wxFrameNameStr)
 132     {
 133         Create(parent, id, title, pos, size, style, name);
 134     }
 135
 136     ~wxMDIChildFrame();
 137
 138     bool Create(wxMDIParentFrame *parent,
 139                 wxWindowID id,
 140                 const wxString& title,
 141                 const wxPoint& pos = wxDefaultPosition,
 142                 const wxSize& size = wxDefaultSize,
 143                 long style = wxDEFAULT_FRAME_STYLE,
 144                 const wxString& name = wxFrameNameStr);
 145
 146     virtual bool IsTopLevel() const { return FALSE; }
 147
 148     // MDI operations
 149     virtual void Maximize(bool maximize = TRUE);
 150     virtual void Restore();
 151     virtual void Activate();
 152
 153     // Handlers
 154
 155     bool HandleMDIActivate(long bActivate, WXHWND, WXHWND);
 156     bool HandleWindowPosChanging(void *lpPos);
 157     bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);
 158
 159     virtual long MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
 160     virtual long MSWDefWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
 161     virtual bool MSWTranslateMessage(WXMSG *msg);
 162
 163     virtual void MSWDestroyWindow();
 164
 165     // Implementation
 166     bool ResetWindowStyle(void *vrect);
 167
 168 protected:
 169     virtual void DoGetPosition(int *x, int *y) const;
 170     virtual void DoSetClientSize(int width, int height);
 171     virtual void InternalSetMenuBar();
 172
 173     DECLARE_DYNAMIC_CLASS(wxMDIChildFrame)
 174 };
 175
 176 // ---------------------------------------------------------------------------
 177 // wxMDIClientWindow
 178 // ---------------------------------------------------------------------------
 179
 180 class WXDLLEXPORT wxMDIClientWindow : public wxWindow
 181 {
 182     DECLARE_DYNAMIC_CLASS(wxMDIClientWindow)
 183
 184 public:
 185     wxMDIClientWindow() { Init(); }
 186     wxMDIClientWindow(wxMDIParentFrame *parent, long style = 0)
 187     {
 188         Init();
 189
 190         CreateClient(parent, style);
 191     }
 192
 193     // Note: this is virtual, to allow overridden behaviour.
 194     virtual bool CreateClient(wxMDIParentFrame *parent,
 195                               long style = wxVSCROLL | wxHSCROLL);
 196
 197     // Explicitly call default scroll behaviour
 198     void OnScroll(wxScrollEvent& event);
 199
 200     virtual void DoSetSize(int x, int y,
 201                            int width, int height,
 202                            int sizeFlags = wxSIZE_AUTO);
 203 protected:
 204     void Init() { m_scrollX = m_scrollY = 0; }
 205
 206     int m_scrollX, m_scrollY;
 207
 208 private:
 209     DECLARE_EVENT_TABLE()
 210 };
 211
 212 #endif
 213     // _WX_MDI_H_